Amazon Marketplace Web Service (MWS) will no longer be available after March 31, 2024. All MWS developers must migrate to Selling Partner API (SP-API) to avoid service disruptions. Refer to the Migration Hub for more information.
The following datatypes are used in the request parameters and response elements of the Amazon Marketplace Web Service (Amazon MWS) Fulfillment Outbound Shipment API section:
Datatype | Description |
---|---|
Address | Postal address information. |
CODSettings | The COD (Cash On Delivery) charges that you associate with a COD fulfillment order. Note that COD fulfillment orders are available only in Japan (JP). |
CreateFulfillmentOrderItem | Item information for creating a fulfillment order. |
CreateReturnItem | An item to be returned. |
Currency | Currency type and amount. |
DeliveryWindow | The time range within which your Scheduled Delivery fulfillment order should be delivered. |
Fee | Fee type and cost. |
FulfillmentOrder | General information about a fulfillment order, including its status. |
FulfillmentOrderItem | Item information for a fulfillment order. |
FulfillmentPreview | Information about a fulfillment order preview, including delivery and fee information based on shipping method. |
FulfillmentPreviewItem | Item information for a shipment in a fulfillment order preview. |
FulfillmentPreviewShipment | Delivery and item information for a shipment in a fulfillment order preview. |
FulfillmentShipment | Delivery and item information for a shipment in a fulfillment order. |
FulfillmentShipmentItem | Item information for a shipment in a fulfillment order. |
FulfillmentShipmentPackage | Package information for a shipment in a fulfillment order. |
GetFulfillmentPreviewItem | Item information for a fulfillment order preview. |
InvalidItemReason | The reason that the item is invalid for return. |
InvalidItemReasonCode | A code for why the item is invalid for return. |
InvalidReturnItem | An item that is invalid for return. |
ReasonCodeDetails | A return reason code, a description, and an optional description translation. |
ReturnAuthorization | Return authorization information for items accepted for return. |
ReturnItem | An item that Amazon accepted for return. |
ReturnReceivedCondition | The condition that the return item was received by an Amazon fulfillment center. |
ScheduledDeliveryInfo | Delivery information for a Scheduled Delivery. |
Status | Indicates if the return item has been processed by an Amazon fulfillment center. |
TrackingAddress | Address information for tracking the package. |
TrackingEvent | Information for tracking package deliveries. |
UnfulfillablePreviewItem | Information about unfulfillable items in a fulfillment order preview. |
UpdateFulfillmentOrderItem | Item information for updating a fulfillment order. |
Weight | Weight unit and amount. |
Postal address information.
The Address datatype is used in a request parameter or a response element of the following operations:
The following table shows the elements of the Address datatype:
Name | Description | Required | Values |
---|---|---|---|
Name | Recipient's name. | Yes | Maximum: 50 characters Type: xs:string |
Line1 | Recipient's street address information. | Yes | Maximum: 60 characters Type: xs:string |
Line2 | Additional street address information, if required. | No | Maximum: 60 characters Type: xs:string |
Line3 | Additional street address information, if required. | No | Maximum: 60 characters Type: xs:string |
DistrictOrCounty | Recipient's district or county. | No | Maximum: 150 characters Type: xs:string |
City | Recipient's city. | Required, except in JP. Do not use in JP. | Maximum: 50 characters Type: xs:string |
StateOrProvinceCode | Recipient's state or province code. | Yes | Maximum: 150 characters Type: xs:string |
CountryCode | Recipient's country code. | Yes | A two-character country code, in ISO 3166-1 alpha-2
format. Type: xs:string |
PostalCode | The postal code (required for shipments to the U.S.). | No | Maximum: 20 characters Type: xs:string |
PhoneNumber | Recipient's phone number. | No | Maximum: 20 characters Type: xs:string |
The COD (Cash On Delivery) charges that you associate with a COD fulfillment order. Note that COD fulfillment orders are available only in Japan (JP).
The CODSettings datatype is used in a request parameter or response element in the following operations:
The following table shows the elements of the CODSettings datatype:
Name | Description | Required | Values |
---|---|---|---|
IsCODRequired | Indicates whether this fulfillment order requires COD (Cash On Delivery) payment. | No | IsCODRequired values:
Note: true is a valid value for
IsCODRequired only in Japan
(JP). Specifying
IsCODRequired=true
with a call to CreateFulfillmentOrder
in any other marketplace returns an
error.
Note: If you specify
IsCODRequired=true,
then you must also specify
PerUnitPrice. For more
information about PerUnitPrice, see
CreateFulfillmentOrderItem.
Type: xs:boolean |
CODCharge | The amount of the COD charge to be collected from the customer for a COD order. | No | Default: zero Note: CODCharge is valid only in
JP.
Type: Currency |
CODChargeTax | The amount of the tax on the COD charge to be collected from the customer for a COD order. | No | Default: zero Note: CODChargeTax is valid only in
JP.
Type: Currency |
ShippingCharge | The amount of the shipping charge to be collected from the customer for a COD order. | No | Default: zero Note: ShippingCharge is valid only in
JP.
Type: Currency |
ShippingChargeTax | The amount of the tax on the shipping charge to be collected from the customer for a COD order. | No | Default: zero Note: ShippingChargeTax is valid only in
JP.
Type: Currency |
Item information for creating a fulfillment order.
The CreateFulfillmentOrderItem datatype is used in a request parameter of the following operation:
The following table shows the elements of the CreateFulfillmentOrderItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerSKU | The seller SKU of the item. | Yes | Maximum: 50 characters Type: xs:string |
SellerFulfillmentOrderItemId | A fulfillment order item identifier that you create to track your fulfillment order items. You can use this value to disambiguate multiple fulfillment items that have the same SellerSKU. For example, you might assign different SellerFulfillmentOrderItemId values to two items in a fulfillment order that share the same SellerSKU but have different GiftMessage values. | Yes | Maximum: 50 characters Type: xs:string |
Quantity | The item quantity. | Yes | Type: xs:int |
GiftMessage | A message to the gift recipient, if applicable. | No | Maximum: 512 characters Type: xs:string |
DisplayableComment | Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip. | No | Maximum: 250 characters Type: xs:string |
FulfillmentNetworkSKU | Amazon's fulfillment network SKU of the item. | No | Type: xs:string |
PerUnitDeclaredValue | The monetary value assigned by the seller to this item. | No. For sellers in Europe: Required only if the destination country is outside of the 26-country set of supported destination countries for FBA Export for EU. For more information, see FBA Export in Seller Central Help. For sellers outside of Europe: Required only if the destination country differs from the country from which the fulfillment order originates. |
Default: zero Type: Currency |
PerUnitPrice | The amount to be collected from the customer for this item in a COD (Cash On
Delivery) order. Type: Currency Note: COD fulfillment orders are available only in Japan
(JP).
|
No | Default: zero Type: Currency |
PerUnitTax | The tax on the amount to be collected from the customer for this item in a COD (Cash
On Delivery) order. Type: Currency Note: COD fulfillment orders are available only in
JP.
|
No | Default: zero Type: Currency |
An item to be returned.
The CreateReturnItem datatype is used in a request parameter of the following operation:
The following table shows the elements of the CreateReturnItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerReturnItemId | An identifier that the seller assigns to the return item. This identifier must be unique in the context of the fulfillment order. | Yes | Maximum: 80 characters Type: xs:string |
SellerFulfillmentOrderItemId | The identifier assigned to the item by the seller when the fulfillment order was created. The seller uses their own records to find the correct SellerFulfillmentOrderItemId values based on the buyer's request to return items. See Creating a fulfillment return. | Yes | Type: xs:string |
AmazonShipmentId | The Amazon shipment ID for the shipment that was associated with the fulfillment order. Get this value by calling the GetFulfillmentOrder operation. See Creating a fulfillment return. | Yes | Type: xs:string |
ReturnReasonCode | The return reason code assigned to the return item by the seller. Get valid return reason codes by calling the ListReturnReasonCodes operation. See Creating a fulfillment return. | Yes | Type: xs:string |
ReturnComment | An optional comment about the return item. | No | Maximum: 1000 characters Type: xs:string |
Currency type and amount.
The Currency datatype is used in a request parameter or a response element of the following operations:
The following table shows the elements of the Currency datatype:
Name | Description | Required | Values |
---|---|---|---|
CurrencyCode | Three-digit currency code. | Yes | In
ISO 4217 format
. Type: xs:string |
Value | The currency amount. | Yes | Type: xs:string |
The time range within which your Scheduled Delivery fulfillment order should be delivered.
The DeliveryWindow datatype is used in a request parameter or a response element of the following operations:
The following table shows the elements of the DeliveryWindow datatype:
Name | Description | Required | Values |
---|---|---|---|
StartDateTime | The date and time of the start of the Scheduled Delivery window. | Yes | In ISO 8601 date time format. Type: xs:dateTime |
EndDateTime | The date and time of the end of the Scheduled Delivery window. | Yes | In ISO 8601 date time format. Type: xs:dateTime |
Fee type and cost.
The Fee datatype is used in a response element of the following operation:
The following table shows the elements of the Fee datatype:
Name | Description | Required | Values |
---|---|---|---|
Name | The type of fee. | Yes | Name values:
Type: xs:string |
Amount | The amount of the fee. | Yes | Type: Currency |
General information about a fulfillment order, including its status.
The FulfillmentOrder datatype is used in a response element of the following operations:
The following table shows the elements of the FulfillmentOrder datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerFulfillmentOrderId | The fulfillment order identifier that you created and submitted using the CreateFulfillmentOrder operation. | Yes | Type: xs:string |
MarketplaceId | The marketplace the fulfillment order is placed against. | Yes | MarketplaceId values: see
Amazon MWS endpoints and MarketplaceId values. Type: xs:string |
DisplayableOrderId | A fulfillment order identifier that you created when you submitted the CreateFulfillmentOrder operation. Displays as the order identifier in recipient-facing materials such as the packing slip. | Yes | Type: xs:string |
DisplayableOrderDateTime | A date that you created when you submitted the CreateFulfillmentOrder operation. Displays as the order date in recipient-facing materials such as the packing slip. | Yes | Type: xs:dateTime |
DisplayableOrderComment | A text block that you created when you submitted the CreateFulfillmentOrder operation. Displays in recipient-facing materials such as the packing slip. | Yes | Type: xs:string |
ShippingSpeedCategory | The shipping method that you selected when you submitted the CreateFulfillmentOrder operation. | Yes | ShippingSpeedCategory values:
Note: Shipping method service level agreements vary by
marketplace. See the Amazon Seller Central website in your marketplace for shipping
method service level agreements and fulfillment fees.
Type: xs:string |
DeliveryWindow | The time range within which your Scheduled Delivery fulfillment order should be delivered. | No | Type: DeliveryWindow |
DestinationAddress | The destination address that you created when you submitted the CreateFulfillmentOrder operation. | Yes | Type: Address |
FulfillmentAction | Specifies whether an order was created to ship immediately or to be held for later. Only returned by GetFulfillmentOrder. | No | FulfillmentAction values:
Type: xs:string |
FulfillmentPolicy | The FulfillmentPolicy value that you chose when you submitted the CreateFulfillmentOrder operation. | No | FulfillmentPolicy values:
Default: FillOrKill Type: xs:string |
ReceivedDateTime | The date that the fulfillment order was received by an Amazon fulfillment center. | Yes | In ISO 8601 date time format. Type: xs:dateTime |
FulfillmentOrderStatus | The current status of the fulfillment order. | Yes | FulfillmentOrderStatus values:
Type: xs:string |
StatusUpdatedDateTime | The date that the status of the fulfillment order last changed. | Yes | In ISO 8601 date time format. Type: xs:dateTime |
NotificationEmailList | The NotificationEmailList value that you created when you submitted the CreateFulfillmentOrder operation. | No | Type: xs:string |
CODSettings | The COD (Cash On Delivery) charges that you associated with a COD order. | No | CODSettings is returned only for COD orders. COD orders are
available only in Japan (JP). Type: CODSettings |
Item information for a fulfillment order.
The FulfillmentOrderItem datatype is used in a response element of the following operation:
The following table shows the elements of the FulfillmentOrderItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerSKU | The seller SKU of the item. | Yes | Type: xs:string |
SellerFulfillmentOrderItemId | The fulfillment order item identifier that you created and submitted with the CreateFulfillmentOrder operation. | Yes | Type: xs:string |
Quantity | The item quantity. | Yes | Type: xs:int |
GiftMessage | A message to the gift recipient, if applicable. | No | Type: xs:string |
DisplayableComment | Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip. | No | Type: xs:string |
FulfillmentNetworkSKU | Amazon's fulfillment network SKU of the item. | No | Type: xs:string |
CancelledQuantity | The item quantity that was cancelled by the seller. | Yes | Type: xs:int |
UnfulfillableQuantity | The item quantity that is unfulfillable. | Yes | Type: xs:int |
EstimatedShipDateTime | The estimated time that the item quantity is scheduled to ship from the fulfillment center. Note that this value can change over time. If the shipment that contains the item quantity has been cancelled, EstimatedShipDateTime is not returned. | No | In ISO 8601 date time format Type: xs:dateTime |
EstimatedArrivalDateTime | The estimated arrival time of the item quantity, . Note that this value can change over time. If the shipment that contains the item quantity has been cancelled, EstimatedArrivalDateTime is not returned. | No | In ISO 8601 date time format. Type: xs:dateTime |
PerUnitDeclaredValue | The monetary value assigned by the seller to this item. | No | Default: zero Type: Currency |
PerUnitPrice | The amount to be collected from the customer for this item in a COD (Cash On
Delivery) order. Note: COD fulfillment orders are available
only in Japan (JP).
|
No | Default: zero Type: Currency |
PerUnitTax | The tax on the amount to be collected from the customer for this item in a COD (Cash
On Delivery) order. Note: COD fulfillment orders are
available only in JP.
|
No | Default: zero Type: Currency |
Information about a fulfillment order preview, including delivery and fee information based on shipping method.
The FulfillmentPreview datatype is used in a response element of the following operation:
The following table shows the elements of the FulfillmentPreview datatype:
Name | Description | Required | Values |
---|---|---|---|
ShippingSpeedCategory | The shipping method for your fulfillment order. | Yes | ShippingSpeedCategory values:
Note: Shipping method service level agreements vary by
marketplace. See the Amazon Seller Central website in your marketplace for shipping
method service level agreements and fulfillment fees.
Type: xs:string |
IsFulfillable | Indicates whether this fulfillment order preview is fulfillable. | Yes | IsFulfillable values:
Type: xs:boolean |
IsCODCapable | Indicates whether this fulfillment order preview is for COD (Cash On Delivery). | Yes | IsCODCapable values:
Note: COD fulfillment orders are available only in
Japan (JP).
Type: xs:boolean |
MarketplaceId | The marketplace the fulfillment order is placed against. | Yes | MarketplaceId values: see
Amazon MWS endpoints and MarketplaceId values. Type: xs:string |
EstimatedShippingWeight | Estimated shipping weight for this fulfillment order preview. | No | Type: Weight |
EstimatedFees | The estimated fulfillment fees for this fulfillment order preview, if applicable. | No | Type: List of Fee |
FulfillmentPreviewShipments | A list of fulfillable outbound shipments for this fulfillment order preview. | No | Type: List of FulfillmentPreviewShipment |
UnfulfillablePreviewItems | A list of unfulfillable items for this fulfillment order preview. | No | Type: List of UnfulfillablePreviewItem |
OrderUnfulfillableReasons | Error codes associated with the fulfillment order preview that indicate why the order is not fulfillable. | No | Error code examples: DeliverySLAUnavailable InvalidDestinationAddress Type: List of type: xs:string |
ScheduledDeliveryInfo | Delivery information for a Scheduled Delivery. | No | Type: ScheduledDeliveryInfo |
Item information for a shipment in a fulfillment order preview.
The FulfillmentPreviewItem datatype is used in a response element of the following operation:
The following table shows the elements of the FulfillmentPreviewItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerSKU | The seller SKU of the item. | Yes | Type: xs:string |
SellerFulfillmentOrderItemId | A fulfillment order item identifier that you created with a call to the GetFulfillmentPreview operation. | Yes | Type: xs:string |
Quantity | The item quantity. | Yes | Type: xs:int |
EstimatedShippingWeight | The estimated shipping weight of the item quantity for a single item, as identified by SellerSKU, in a shipment. | Type: Weight | |
ShippingWeightCalculationMethod | The method used to calculate EstimatedShippingWeight. | ShippingWeightCalculationMethod values:
Type: xs:string |
Delivery and item information for a shipment in a fulfillment order preview.
The FulfillmentPreviewShipment datatype is used in a response element of the following operation:
The following table shows the elements of the FulfillmentPreviewShipment datatype:
Name | Description | Required | Values |
---|---|---|---|
EarliestShipDate | The earliest date that the shipment is expected to be sent from the fulfillment center. | Yes | In ISO 8601 date time format. Type: xs:dateTime |
LatestShipDate | The latest date that the shipment is expected to be sent from the fulfillment center. | Yes | In ISO 8601 date time format. Type: xs:dateTime |
EarliestArrivalDate | The earliest date that the shipment is expected to arrive at its destination. | Yes | In ISO 8601 date time format. Type: xs:dateTime |
LatestArrivalDate | The latest date that the shipment is expected to arrive at its destination. | Yes | In ISO 8601 date time format. Type: xs:dateTime |
FulfillmentPreviewItems | Information about the items in the shipment. | Yes | Type: List of FulfillmentPreviewItem |
Delivery and item information for a shipment in a fulfillment order.
The FulfillmentShipment datatype is used in a response element of the following operation:
The following table shows the elements of the FulfillmentShipment datatype:
Name | Description | Required | Values |
---|---|---|---|
AmazonShipmentId | A shipment identifier assigned by Amazon. | Yes | Type: xs:string |
FulfillmentCenterId | An identifier for the Amazon fulfillment center that the shipment will be sent from. | Yes | Type: xs:string |
FulfillmentShipmentStatus | The current status of the shipment. | Yes | FulfillmentShipmentStatus values:
Type: xs:string |
ShippingDateTime | The meaning of the ShippingDateTime
value depends on the current status of the shipment. If the
current value of
FulfillmentShipmentStatus is:
|
No | In ISO 8601 date time format. Type: xs:dateTime |
EstimatedArrivalDateTime | The estimated arrival time of the shipment. Note that this value can change over time. If a shipment includes more than one package, EstimatedArrivalDateTime applies to all of the packages in the shipment. If the shipment has been cancelled, EstimatedArrivalDateTime is not returned. | No | In ISO 8601 date time format. Type: xs:dateTime |
FulfillmentShipmentItem | Information about the items in the shipment. | Yes | Type: List of FulfillmentShipmentItem |
FulfillmentShipmentPackage | Information about a single package in the shipment. | No | Type: List of FulfillmentShipmentPackage |
Item information for a shipment in a fulfillment order.
The FulfillmentShipmentItem datatype is used in a response element of the following operation:
The following table shows the elements of the FulfillmentShipmentItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerSKU | The seller SKU of the item. | No | Type: xs:string |
SellerFulfillmentOrderItemId | The fulfillment order item identifier that you created and submitted with the CreateFulfillmentOrder operation. | Yes | Type: xs:string |
Quantity | The item quantity. | Yes | Type: xs:int |
PackageNumber | An identifier for the package that contains the item quantity. | No | Type: xs:int |
Package information for a shipment in a fulfillment order.
The FulfillmentShipmentPackage datatype is used in a response element of the following operation:
The following table shows the elements of the FulfillmentShipmentPackage datatype:
Name | Description | Required | Values |
---|---|---|---|
PackageNumber | Identifies a package in a shipment. | Yes | Type: xs:int |
CarrierCode | Identifies the carrier who will deliver the shipment to the recipient. | Yes | Type: xs:string |
TrackingNumber | The tracking number, if provided, can be used to obtain tracking and delivery information. | No | Type: xs:string |
EstimatedArrivalDateTime | The estimated arrival time of the package. | No | In ISO 8601 date time format. Type: xs:dateTime |
Item information for a fulfillment order preview.
The GetFulfillmentPreviewItem datatype is used in a request parameter of the following operation:
The following table shows the elements of the GetFulfillmentPreviewItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerSKU | The seller SKU of the item. | Yes | Maximum: 50 characters Type: xs:string |
SellerFulfillmentOrderItemId | A fulfillment order item identifier that you create to track items in your fulfillment preview. | Yes | Maximum: 50 characters Each SellerFulfillmentOrderItemId value must be unique within a given request. Type: xs:string |
Quantity | The item quantity. | Yes | Type: xs:int |
The reason that the item is invalid for return.
The InvalidItemReason datatype is used in a response element of the following operations:
The following table shows the elements of the InvalidItemReason datatype:
Name | Description | Required | Values |
---|---|---|---|
InvalidItemReasonCode | A code for why the item is invalid for return. | Yes | Type: InvalidItemReasonCode |
Description | A human readable description of the invalid item reason code. | Yes | Type: xs:string |
A code for why the item is invalid for return.
Type: xs:string
Values:
An item that is invalid for return.
The InvalidReturnItem datatype is used in a response element of the following operations:
The following table shows the elements of the InvalidReturnItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerReturnItemId | An identifier assigned by the seller to the return item. | Yes | Type: xs:string |
SellerFulfillmentOrderItemId | The identifier assigned to the item by the seller when the fulfillment order was created. | Yes | Type: xs:string |
InvalidItemReason | The reason that the item is invalid for return. | Yes | Type: InvalidItemReason |
A return reason code, a description, and an optional description translation.
The ReasonCodeDetails datatype is used in a response element of the following operation:
The following table shows the elements of the ReasonCodeDetails datatype:
Name | Description | Required | Values |
---|---|---|---|
ReturnReasonCode | A code for a valid return reason. | Yes | Type: xs:string |
Description | A human readable description of the return reason code. | Yes | Type: xs:string |
TranslatedDescription | A translation of the description. The translation is in the language passed in using the Language request parameter. | No. Only returned if a valid language code was passed in. | Type: xs:string |
Return authorization information for items accepted for return.
The ReturnAuthorization datatype is used in a response element of the following operations:
The following table shows the elements of the ReturnAuthorization datatype:
Name | Description | Required | Values |
---|---|---|---|
ReturnAuthorizationId | An identifier for the return authorization. This identifier associates return items with the return authorization used to return them. See ReturnItem. | Yes | Type: xs:string |
FulfillmentCenterId | An identifier for the Amazon fulfillment center that the return items should be sent to. | Yes | Type: xs:string |
ReturnToAddress | The address of the Amazon fulfillment center that the return items should be sent to. | Yes | Type: Address |
AmazonRmaId | The return merchandise authorization (RMA) that Amazon needs to process the return. | Yes | Type: xs:string |
RmaPageURL | A URL for a web page that contains the return authorization barcode and the mailing label. This does not include pre-paid shipping. | Yes | Type: xs:string |
An item that Amazon accepted for return.
The ReturnItem datatype is used in a response element of the following operations:
The following table shows the elements of the ReturnItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerReturnItemId | An identifier assigned by the seller to the return item. | Yes | Type: xs:string |
SellerFulfillmentOrderItemId | The identifier assigned to the item by the seller when the fulfillment order was created. | Yes | Type: xs:string |
AmazonShipmentId | The identifier for the shipment that is associated with the return item. | Yes | Type: xs:string |
SellerReturnReasonCode | The return reason code assigned to the return item by the seller. | Yes | Type: xs:string |
ReturnComment | An optional comment about the return item. | No | Type: xs:string |
AmazonReturnReasonCode | The return reason code that the Amazon fulfillment center assigned to the return item. | No | Type: xs:string |
Status | Indicates if the return item has been processed by an Amazon fulfillment center. | Yes | Type: Status |
StatusChangedDate | Indicates when the status last changed. | Yes | In ISO 8601 date time format. Type: xs:dateTime |
ReturnAuthorizationId | Identifies the return authorization used to return this item. See ReturnAuthorization. | No | Type: xs:string |
ReturnReceivedCondition | The condition that the return item was received by an Amazon fulfillment center. | No | Type: ReturnReceivedCondition |
FulfillmentCenterId | The identifier for the Amazon fulfillment center that processed the return item. | No | Type: xs:string |
The condition that the return item was received by an Amazon fulfillment center.
Type: xs:string
Values:
Delivery information for a Scheduled Delivery.
The ScheduledDeliveryInfo datatype is used in a response element of the following operation:
The following table shows the elements of the ScheduledDeliveryInfo datatype:
Name | Description | Required | Values |
---|---|---|---|
DeliveryTimeZone | The time zone of the destination address for the fulfillment order preview. | Yes | IANA time zone name. Example: Asia/Tokyo. Type: xs:string |
DeliveryWindows | A list of time ranges that are available for Scheduled Delivery. | Yes | Type: List of DeliveryWindow |
Indicates if the return item has been processed by an Amazon fulfillment center.
Type: xs:string
Values:
Address information for tracking the package.
The TrackingAddress datatype is used in a response element of the following operation:
The following table shows the elements of the TrackingAddress datatype:
Name | Description | Required | Values |
---|---|---|---|
City | The city. | Yes | Maximum: 150 characters Type: xs:string |
State | The state. | Yes | Maximum: 150 characters Type: xs:string |
Country | The country. | Yes | Maximum: 6 characters Type: xs:string |
Information for tracking package deliveries.
The TrackingEvent datatype is used in a response element of the following operation:
The following table shows the elements of the TrackingEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
EventDate | The date and time that the delivery event took place. | Yes | In ISO 8601 date time format. Type: xs:dateTime |
EventAddress | The city where the delivery event took place. | Yes | Type: TrackingAddress |
EventCode | The event code for the delivery event. | Yes | EventCode values:
Type: xs:string |
Information about unfulfillable items in a fulfillment order preview.
The UnfulfillablePreviewItem datatype is used in a response element of the following operation:
The following table shows the elements of the UnfulfillablePreviewItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerSKU | The seller SKU of the item. | Yes | Maximum: 50 characters Type: xs:string |
SellerFulfillmentOrderItemId | A fulfillment order item identifier that you created with a call to the GetFulfillmentPreview operation. | Yes | Maximum: 50 characters Type: xs:string |
Quantity | The item quantity. | Yes | Type: xs:int |
ItemUnfulfillableReasons | Error codes associated with the fulfillment order preview that indicate why the item is unfulfillable. | No | Error code examples:
Type: xs:string |
Item information for updating a fulfillment order.
The UpdateFulfillmentOrderItem datatype is used in a request parameter of the following operation:
The following table shows the elements of the UpdateFulfillmentOrderItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerFulfillmentOrderItemId | Identifies the fulfillment order item that you want to update. Created with a previous call to the CreateFulfillmentOrder operation. | Yes | Maximum: 50 characters Type: xs:string |
Quantity | The item quantity. | Yes | Must be less than or equal to the quantity specified for this order item when the
fulfillment order was originally created. Must be greater
than zero. Type: xs:int |
GiftMessage | A message to the gift recipient, if applicable. | No | Maximum: 512 characters Default: If you specified a value with a previous call to the CreateFulfillmentOrder or UpdateFulfillmentOrder operation, then that value is the default. Otherwise the default is null. Type: xs:string |
DisplayableComment | Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip. | No | Maximum: 250 characters Default: If you specified a value with a previous call to the CreateFulfillmentOrder or UpdateFulfillmentOrder operation, then that value is the default. Otherwise the default is null. Type: xs:string |
PerUnitDeclaredValue | The monetary value assigned by the seller to this item. | No | Default: If you specified a value with a previous call to
the CreateFulfillmentOrder or
UpdateFulfillmentOrder operation,
then that value is the default. Otherwise the default is
zero. Type: Currency |
PerUnitPrice | The amount to be collected from the customer for this item in a COD (Cash On
Delivery) order. Note: COD fulfillment orders are available
only in Japan (JP).
|
No | Default: If you specified a value with a previous call to
the CreateFulfillmentOrder or
UpdateFulfillmentOrder operation,
then that value is the default. Otherwise the default is
zero. Type: Currency |
PerUnitTax | The tax on the amount to be collected from the customer for this item in a COD (Cash
On Delivery) order. Note: COD fulfillment orders are
available only in JP.
|
No | Default: If you specified a value with a previous call to
the CreateFulfillmentOrder or
UpdateFulfillmentOrder operation,
then that value is the default. Otherwise the default is
zero. Type: Currency |
Weight unit and amount.
The Weight datatype is used in a response element of the following operation:
The following table shows the elements of the Weight datatype:
Name | Description | Required | Values |
---|---|---|---|
Unit | Indicates the unit of weight. | Yes | Unit values:
Type: xs:string |
Value | The numeric value of the item's weight. | Yes | Type: xs:string |