shipping_models

type AcceptedRate struct {

	// The weight that was used to calculate the totalCharge.
	BilledWeight *Weight `json:"billedWeight,omitempty"`

	// promise
	Promise *ShippingPromiseSet `json:"promise,omitempty"`

	// service type
	ServiceType ServiceType `json:"serviceType,omitempty"`

	// The total charge that will be billed for the rate.
	TotalCharge *Currency `json:"totalCharge,omitempty"`
}

type Account struct {

	// account Id
	// Required: true
	AccountID *AccountID `json:"accountId"`
}

type AccountID string

type Address struct {

	// First line of that address.
	// Required: true
	// Max Length: 60
	// Min Length: 1
	AddressLine1 *string `json:"addressLine1"`

	// Additional address information, if required.
	// Max Length: 60
	// Min Length: 1
	AddressLine2 string `json:"addressLine2,omitempty"`

	// Additional address information, if required.
	// Max Length: 60
	// Min Length: 1
	AddressLine3 string `json:"addressLine3,omitempty"`

	// city
	// Required: true
	City *City `json:"city"`

	// The email cc addresses of the contact associated with the address.
	// Max Items: 2
	CopyEmails []string `json:"copyEmails"`

	// country code
	// Required: true
	CountryCode *CountryCode `json:"countryCode"`

	// The email address of the contact associated with the address.
	// Max Length: 64
	Email string `json:"email,omitempty"`

	// The name of the person, business or institution at that address.
	// Required: true
	// Max Length: 50
	// Min Length: 1
	Name *string `json:"name"`

	// The phone number of the person, business or institution located at that address.
	// Max Length: 20
	// Min Length: 1
	PhoneNumber string `json:"phoneNumber,omitempty"`

	// postal code
	// Required: true
	PostalCode *PostalCode `json:"postalCode"`

	// state or region
	// Required: true
	StateOrRegion *StateOrRegion `json:"stateOrRegion"`
}

type CancelShipmentResponse struct {

	// Encountered errors for the operation.
	Errors ErrorList `json:"errors,omitempty"`
}

type City string

type ClientReferenceID string

type Container struct {

	// container reference Id
	// Required: true
	ContainerReferenceID *ContainerReferenceID `json:"containerReferenceId"`

	// The type of physical container being used. (always 'PACKAGE')
	// Enum: [PACKAGE]
	ContainerType string `json:"containerType,omitempty"`

	// The length, width, height, and weight of the container.
	// Required: true
	Dimensions *Dimensions `json:"dimensions"`

	// A list of the items in the container.
	// Required: true
	Items []*ContainerItem `json:"items"`

	// The total value of all items in the container.
	// Required: true
	Value *Currency `json:"value"`

	// The weight of the container.
	// Required: true
	Weight *Weight `json:"weight"`
}

type ContainerItem struct {

	// The quantity of the items of this type in the container.
	// Required: true
	Quantity *float64 `json:"quantity"`

	// A descriptive title of the item.
	// Required: true
	// Max Length: 30
	Title *string `json:"title"`

	// The unit price of an item of this type (the total value of this item type in the container is unitPrice * quantity).
	// Required: true
	UnitPrice *Currency `json:"unitPrice"`

	// The unit weight of an item of this type (the total weight of this item type in the container is unitWeight * quantity).
	// Required: true
	UnitWeight *Weight `json:"unitWeight"`
}

type ContainerList []*Container

type ContainerReferenceID string

type ContainerSpecification struct {

	// The length, width, and height of the container.
	// Required: true
	Dimensions *Dimensions `json:"dimensions"`

	// The weight of the container.
	// Required: true
	Weight *Weight `json:"weight"`
}

type ContainerSpecificationList []*ContainerSpecification

type CountryCode string

type CreateShipmentRequest struct {

	// client reference Id
	// Required: true
	ClientReferenceID *ClientReferenceID `json:"clientReferenceId"`

	// containers
	// Required: true
	Containers ContainerList `json:"containers"`

	// ship from
	// Required: true
	ShipFrom *Address `json:"shipFrom"`

	// ship to
	// Required: true
	ShipTo *Address `json:"shipTo"`
}

type CreateShipmentResponse struct {

	// Encountered errors for the operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for createShipment operation
	Payload *CreateShipmentResult `json:"payload,omitempty"`
}

type CreateShipmentResult struct {

	// eligible rates
	// Required: true
	EligibleRates RateList `json:"eligibleRates"`

	// shipment Id
	// Required: true
	ShipmentID *ShipmentID `json:"shipmentId"`
}

type Currency struct {

	// A 3-character currency code.
	// Required: true
	// Max Length: 3
	// Min Length: 3
	Unit *string `json:"unit"`

	// The amount of currency.
	// Required: true
	Value *float64 `json:"value"`
}

type Dimensions struct {

	// The height of the container.
	// Required: true
	Height *float64 `json:"height"`

	// The length of the container.
	// Required: true
	Length *float64 `json:"length"`

	// The unit of these measurements.
	// Required: true
	// Enum: [IN CM]
	Unit *string `json:"unit"`

	// The width of the container.
	// Required: true
	Width *float64 `json:"width"`
}

type Error struct {

	// An error code that identifies the type of error that occured.
	// Required: true
	Code *string `json:"code"`

	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`

	// A message that describes the error condition in a human-readable form.
	// Required: true
	Message *string `json:"message"`
}

type ErrorList []*Error

type Event struct {

	// event code
	// Required: true
	EventCode *EventCode `json:"eventCode"`

	// The date and time of an event for a shipment.
	// Required: true
	// Format: date-time
	EventTime *strfmt.DateTime `json:"eventTime"`

	// location
	Location *Location `json:"location,omitempty"`
}

type EventCode string

type EventList []*Event

type GetAccountResponse struct {

	// Encountered errors for the operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for getAccount operation
	Payload *Account `json:"payload,omitempty"`
}

type GetRatesRequest struct {

	// container specifications
	// Required: true
	ContainerSpecifications ContainerSpecificationList `json:"containerSpecifications"`

	// service types
	// Required: true
	ServiceTypes ServiceTypeList `json:"serviceTypes"`

	// The start date and time. This defaults to the current date and time.
	// Format: date-time
	ShipDate strfmt.DateTime `json:"shipDate,omitempty"`

	// ship from
	// Required: true
	ShipFrom *Address `json:"shipFrom"`

	// ship to
	// Required: true
	ShipTo *Address `json:"shipTo"`
}

type GetRatesResponse struct {

	// Encountered errors for the operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for getRates operation
	Payload *GetRatesResult `json:"payload,omitempty"`
}

type GetRatesResult struct {

	// service rates
	// Required: true
	ServiceRates ServiceRateList `json:"serviceRates"`
}

type GetShipmentResponse struct {

	// Encountered errors for the operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for getShipment operation
	Payload *Shipment `json:"payload,omitempty"`
}

type GetTrackingInformationResponse struct {

	// Encountered errors for the operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for getTrackingInformation operation
	Payload *TrackingInformation `json:"payload,omitempty"`
}

type Label struct {

	// label specification
	LabelSpecification *LabelSpecification `json:"labelSpecification,omitempty"`

	// label stream
	LabelStream LabelStream `json:"labelStream,omitempty"`
}

type LabelResult struct {

	// container reference Id
	ContainerReferenceID ContainerReferenceID `json:"containerReferenceId,omitempty"`

	// label
	Label *Label `json:"label,omitempty"`

	// The tracking identifier assigned to the container.
	TrackingID string `json:"trackingId,omitempty"`
}

type LabelResultList []*LabelResult

type LabelSpecification struct {

	// The format of the label. Enum of PNG only for now.
	// Required: true
	// Enum: [PNG]
	LabelFormat *string `json:"labelFormat"`

	// The label stock size specification in length and height. Enum of 4x6 only for now.
	// Required: true
	// Enum: [4x6]
	LabelStockSize *string `json:"labelStockSize"`
}

type LabelStream string

type Location struct {

	// city
	City City `json:"city,omitempty"`

	// country code
	CountryCode CountryCode `json:"countryCode,omitempty"`

	// postal code
	PostalCode PostalCode `json:"postalCode,omitempty"`

	// state or region
	StateOrRegion StateOrRegion `json:"stateOrRegion,omitempty"`
}

type Party struct {

	// account Id
	AccountID AccountID `json:"accountId,omitempty"`
}

type PostalCode string

type PromisedDeliveryDate strfmt.DateTime

type PurchaseLabelsRequest struct {

	// label specification
	// Required: true
	LabelSpecification *LabelSpecification `json:"labelSpecification"`

	// rate Id
	// Required: true
	RateID *RateID `json:"rateId"`
}

type PurchaseLabelsResponse struct {

	// Encountered errors for the operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for purchaseLabels operation
	Payload *PurchaseLabelsResult `json:"payload,omitempty"`
}

type PurchaseLabelsResult struct {

	// accepted rate
	// Required: true
	AcceptedRate *AcceptedRate `json:"acceptedRate"`

	// client reference Id
	ClientReferenceID ClientReferenceID `json:"clientReferenceId,omitempty"`

	// label results
	// Required: true
	LabelResults LabelResultList `json:"labelResults"`

	// shipment Id
	// Required: true
	ShipmentID *ShipmentID `json:"shipmentId"`
}

type PurchaseShipmentRequest struct {

	// client reference Id
	// Required: true
	ClientReferenceID *ClientReferenceID `json:"clientReferenceId"`

	// containers
	// Required: true
	Containers ContainerList `json:"containers"`

	// label specification
	// Required: true
	LabelSpecification *LabelSpecification `json:"labelSpecification"`

	// service type
	// Required: true
	ServiceType *ServiceType `json:"serviceType"`

	// The start date and time. This defaults to the current date and time.
	// Format: date-time
	ShipDate strfmt.DateTime `json:"shipDate,omitempty"`

	// ship from
	// Required: true
	ShipFrom *Address `json:"shipFrom"`

	// ship to
	// Required: true
	ShipTo *Address `json:"shipTo"`
}

type PurchaseShipmentResponse struct {

	// Encountered errors for the operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for purchaseShipment operation
	Payload *PurchaseShipmentResult `json:"payload,omitempty"`
}

type PurchaseShipmentResult struct {

	// label results
	// Required: true
	LabelResults LabelResultList `json:"labelResults"`

	// service rate
	// Required: true
	ServiceRate *ServiceRate `json:"serviceRate"`

	// shipment Id
	// Required: true
	ShipmentID *ShipmentID `json:"shipmentId"`
}

type Rate struct {

	// The weight that was used to calculate the totalCharge.
	BilledWeight *Weight `json:"billedWeight,omitempty"`

	// The time after which the offering will expire.
	// Format: date-time
	ExpirationTime strfmt.DateTime `json:"expirationTime,omitempty"`

	// promise
	Promise *ShippingPromiseSet `json:"promise,omitempty"`

	// An identifier for the rate.
	RateID string `json:"rateId,omitempty"`

	// service type
	ServiceType ServiceType `json:"serviceType,omitempty"`

	// The total charge that will be billed for the rate.
	TotalCharge *Currency `json:"totalCharge,omitempty"`
}

type RateID string

type RateList []*Rate

type RetrieveShippingLabelRequest struct {

	// label specification
	// Required: true
	LabelSpecification *LabelSpecification `json:"labelSpecification"`
}

type RetrieveShippingLabelResponse struct {

	// Encountered errors for the operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for retrieveShippingLabel operation
	Payload *RetrieveShippingLabelResult `json:"payload,omitempty"`
}

type RetrieveShippingLabelResult struct {

	// label specification
	// Required: true
	LabelSpecification *LabelSpecification `json:"labelSpecification"`

	// label stream
	// Required: true
	LabelStream *LabelStream `json:"labelStream"`
}

type ServiceRate struct {

	// The weight that was used to calculate the totalCharge.
	// Required: true
	BillableWeight *Weight `json:"billableWeight"`

	// promise
	// Required: true
	Promise *ShippingPromiseSet `json:"promise"`

	// service type
	// Required: true
	ServiceType *ServiceType `json:"serviceType"`

	// The total charge that will be billed for the rate.
	// Required: true
	TotalCharge *Currency `json:"totalCharge"`
}

type ServiceRateList []*ServiceRate

type ServiceType string

type ServiceTypeList []ServiceType

type Shipment struct {

	// accepted rate
	AcceptedRate *AcceptedRate `json:"acceptedRate,omitempty"`

	// client reference Id
	// Required: true
	ClientReferenceID *ClientReferenceID `json:"clientReferenceId"`

	// containers
	// Required: true
	Containers ContainerList `json:"containers"`

	// ship from
	// Required: true
	ShipFrom *Address `json:"shipFrom"`

	// ship to
	// Required: true
	ShipTo *Address `json:"shipTo"`

	// shipment Id
	// Required: true
	ShipmentID *ShipmentID `json:"shipmentId"`

	// shipper
	Shipper *Party `json:"shipper,omitempty"`
}

type ShipmentID string

type ShippingPromiseSet struct {

	// The time window in which the shipment will be delivered.
	DeliveryWindow *TimeRange `json:"deliveryWindow,omitempty"`

	// The time window in which Amazon Shipping will pick up the shipment.
	ReceiveWindow *TimeRange `json:"receiveWindow,omitempty"`
}

type StateOrRegion string

type TimeRange struct {

	// The end date and time. This must come after the value of start. This defaults to the next business day from the start.
	// Format: date-time
	End strfmt.DateTime `json:"end,omitempty"`

	// The start date and time. This defaults to the current date and time.
	// Format: date-time
	Start strfmt.DateTime `json:"start,omitempty"`
}

type TrackingID string

type TrackingInformation struct {

	// event history
	// Required: true
	EventHistory EventList `json:"eventHistory"`

	// promised delivery date
	// Required: true
	// Format: date-time
	PromisedDeliveryDate *PromisedDeliveryDate `json:"promisedDeliveryDate"`

	// summary
	// Required: true
	Summary *TrackingSummary `json:"summary"`

	// tracking Id
	// Required: true
	TrackingID *TrackingID `json:"trackingId"`
}

type TrackingSummary struct {

	// The derived status based on the events in the eventHistory.
	// Max Length: 60
	// Min Length: 1
	Status string `json:"status,omitempty"`
}

type Weight struct {

	// The unit of measurement.
	// Required: true
	// Enum: [g kg oz lb]
	Unit *string `json:"unit"`

	// The measurement value.
	// Required: true
	Value *float64 `json:"value"`
}