"description":"The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon's fulfillment network. You can get information on both potential and existing fulfillment orders.",
"version":"v0",
"title":"Selling Partner API for Fulfillment Outbound",
"description":"Returns a list of fulfillment order previews based on shipping criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"A date and time used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order.",
"in":"query",
"required":false,
"type":"string",
"format":"date-time"
},
{
"name":"FulfillmentMethod",
"description":"Indicates the intended recipient channel for the order.",
"in":"query",
"required":false,
"type":"array",
"items":{
"type":"string"
}
},
{
"name":"NextToken",
"description":"A string token returned in the response to your previous request.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Returns a list of return reason codes for a seller SKU in a given marketplace.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"The seller SKU for which return reason codes are required.",
"in":"query",
"required":true,
"type":"string"
},
{
"name":"MarketplaceId",
"description":"The marketplace for which the seller wants return reason codes.",
"in":"query",
"required":false,
"type":"string"
},
{
"name":"SellerFulfillmentOrderId",
"description":"The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes.",
"in":"query",
"required":false,
"type":"string"
},
{
"name":"Language",
"description":"The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into.",
"in":"query",
"required":true,
"type":"string"
}
],
"responses":{
"200":{
"description":"Success.",
"x-amazon-spds-sandbox-behaviors":[
{
"request":{
"parameters":{
"SellerSKU":{
"value":"PSMM-TEST-SKU-Jan-21_19_39_23-0788"
},
"MarketplaceId":{
"value":"ATVPDKIKX0DER"
}
}
},
"response":{
"payload":{
"ReasonCodeDetailsList":[
{
"ReturnReasonCode":"CR-UNWANTED_ITEM",
"Description":"No longer needed/wanted"
},
{
"ReturnReasonCode":"AMZ-PG-BAD-DESC",
"Description":"Different from website description"
},
{
"ReturnReasonCode":"CR-DEFECTIVE",
"Description":"Defective/Does not work properly"
},
{
"ReturnReasonCode":"CR-ORDERED_WRONG_ITEM",
"Description":"Accidental order"
},
{
"ReturnReasonCode":"CR-FOUND_BETTER_PRICE",
"Description":"Better price available"
},
{
"ReturnReasonCode":"CR-DAMAGED_BY_FC",
"Description":"Damaged due to inappropriate packaging"
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Creates a fulfillment return. \n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct SellerFulfillmentOrderId value based on the buyer's request to return items.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Returns the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Updates and/or requests shipment for a fulfillment order with an order hold on it.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors":[
{
"request":{
"parameters":{
"sellerFulfillmentOrderId":{
"value":"FBATestOrder-3"
},
"body":{
"value":{
"MarketplaceId":"ATVPDKIKX0DER",
"DestinationAddress":{
"Name":"NameChangeTest",
"Line1":"MeguroKu",
"Line2":"Building2010",
"Line3":"Lane1",
"StateOrProvinceCode":"MI",
"CountryCode":"US",
"City":"Troy",
"PostalCode":"48084"
},
"Items":[
{
"SellerFulfillmentOrderItemId":"OrderItemID1",
"Quantity":2
}
]
}
}
}
},
"response":{
"errors":[
{
"code":"InvalidInput",
"message":"Value OrderNotUpdatable for parameter is invalid. Reason: 1 error:\nThis order is not updatable. Items in the order are already in working or completed shipments. \n.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Additional details that can help the caller understand or fix the issue."
}
},
"description":"Error response returned when the request is unsuccessful."
},
"ErrorList":{
"type":"array",
"description":"A list of error responses returned when a request is unsuccessful.",
"items":{
"$ref":"#/definitions/Error"
}
},
"Address":{
"type":"object",
"required":[
"CountryCode",
"Line1",
"Name",
"StateOrProvinceCode"
],
"properties":{
"Name":{
"description":"Recipient's name.",
"type":"string",
"maxLength":50
},
"Line1":{
"description":"Recipient's street address information.",
"type":"string",
"maxLength":60
},
"Line2":{
"description":"Additional street address information, if required.",
"type":"string",
"maxLength":60
},
"Line3":{
"description":"Additional street address information, if required.",
"type":"string",
"maxLength":60
},
"DistrictOrCounty":{
"description":"Recipient's district or county.",
"type":"string",
"maxLength":150
},
"City":{
"description":"Recipient's city.",
"type":"string",
"maxLength":50
},
"StateOrProvinceCode":{
"description":"Recipient's state or province code.",
"type":"string",
"maxLength":150
},
"CountryCode":{
"description":"Recipient's country code.",
"type":"string",
"maxLength":2
},
"PostalCode":{
"description":"The postal code (required for shipments to the U.S.).",
"type":"string",
"maxLength":20
},
"PhoneNumber":{
"description":"Recipient's phone number.",
"type":"string",
"maxLength":20
}
}
},
"CODSettings":{
"description":"The COD (Cash On Delivery) charges that you associate with a COD fulfillment order.",
"type":"object",
"required":[
"IsCODRequired"
],
"properties":{
"IsCODRequired":{
"description":"Indicates whether this fulfillment order requires COD (Cash On Delivery) payment.",
"type":"boolean"
},
"CODCharge":{
"description":"The amount of the COD charge to be collected from the recipient for a COD order.",
"$ref":"#/definitions/Currency"
},
"CODChargeTax":{
"description":"The amount of the tax on the COD charge to be collected from the recipient for a COD order.",
"$ref":"#/definitions/Currency"
},
"ShippingCharge":{
"description":"The amount of the tax on the COD charge to be collected from the recipient for a COD order.",
"$ref":"#/definitions/Currency"
},
"ShippingChargeTax":{
"description":"The amount of the tax on the shipping charge to be collected from the recipient for a COD order.",
"$ref":"#/definitions/Currency"
}
}
},
"CreateFulfillmentOrderItem":{
"description":"Item information for creating a fulfillment order.",
"type":"object",
"required":[
"Quantity",
"SellerFulfillmentOrderItemId",
"SellerSKU"
],
"properties":{
"SellerSKU":{
"description":"The seller SKU of the item.",
"type":"string",
"maxLength":50
},
"SellerFulfillmentOrderItemId":{
"description":"A fulfillment order item identifier that the seller creates to track fulfillment order items. Used to disambiguate multiple fulfillment items that have the same seller SKU. For example, the seller might assign different SellerFulfillmentOrderItemId values to two items in a fulfillment order that share the same seller SKU but have different GiftMessage values.",
"type":"string",
"maxLength":50
},
"Quantity":{
"$ref":"#/definitions/Quantity"
},
"GiftMessage":{
"description":"A message to the gift recipient, if applicable.",
"type":"string",
"maxLength":512
},
"DisplayableComment":{
"description":"Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.",
"type":"string",
"maxLength":250
},
"FulfillmentNetworkSKU":{
"description":"Amazon's fulfillment network SKU of the item.",
"type":"string"
},
"PerUnitDeclaredValue":{
"description":"The monetary value assigned by the seller to this item.",
"$ref":"#/definitions/Currency"
},
"PerUnitPrice":{
"description":"The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.",
"$ref":"#/definitions/Currency"
},
"PerUnitTax":{
"description":"The tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.",
"$ref":"#/definitions/Currency"
}
}
},
"CreateFulfillmentOrderItemList":{
"description":"A list of item information for creating a fulfillment order.",
"description":"If an item in a fulfillment order is determined to be unfulfillable before any shipment in the order has acquired the status of Pending (the process of picking units from inventory has begun), then the entire order is considered unfulfillable. However, if an item in a fulfillment order is determined to be unfulfillable after a shipment in the order has acquired the status of Pending, Amazon cancels as much of the fulfillment order as possible. See the FulfillmentShipment datatype for shipment status definitions."
},
{
"value":"FillAll",
"description":"All fulfillable items in the fulfillment order are shipped. The fulfillment order remains in a processing state until all items are either shipped by Amazon or cancelled by the seller."
},
{
"value":"FillAllAvailable",
"description":"All fulfillable items in the fulfillment order are shipped. All unfulfillable items in the order are cancelled."
"description":"The fulfillment order was received but not yet validated."
},
{
"value":"Received",
"description":"The fulfillment order was received and validated. Validation includes determining that the destination address is valid and that Amazon's records indicate that the seller has enough sellable (undamaged) inventory to fulfill the order. The seller can cancel a fulfillment order that has a status of Received."
},
{
"value":"Planning",
"description":"The fulfillment order has been sent to Amazon's fulfillment network to begin shipment planning, but no unit in any shipment has been picked from inventory yet. The seller can cancel a fulfillment order that has a status of Planning."
},
{
"value":"Processing",
"description":"The process of picking units from inventory has begun on at least one shipment in the fulfillment order. The seller cannot cancel a fulfillment order that has a status of Processing."
},
{
"value":"Cancelled",
"description":"The fulfillment order has been cancelled by the seller."
},
{
"value":"Complete",
"description":"All item quantities in the fulfillment order have been fulfilled."
},
{
"value":"CompletePartialled",
"description":"Some item quantities in the fulfillment order were fulfilled; the rest were either cancelled or unfulfillable."
},
{
"value":"Unfulfillable",
"description":"No item quantities in the fulfillment order could be fulfilled because the Amazon fulfillment center workers found no inventory for those items or found no inventory that was in sellable (undamaged) condition."
},
{
"value":"Invalid",
"description":"The fulfillment order was received but could not be validated. The reasons for this include an invalid destination address or Amazon's records indicating that the seller does not have enough sellable inventory to fulfill the order. When this happens, the fulfillment order is invalid and no items in the order will ship."
"description":"The marketplace the fulfillment order is placed against.",
"type":"string"
},
"SellerFulfillmentOrderId":{
"description":"A fulfillment order identifier that the seller creates to track their fulfillment order. The SellerFulfillmentOrderId must be unique for each fulfillment order that a seller creates. If the seller's system already creates unique order identifiers, then these might be good values for them to use.",
"type":"string",
"maxLength":40
},
"DisplayableOrderId":{
"description":"A fulfillment order identifier that the seller creates. This value displays as the order identifier in recipient-facing materials such as the outbound shipment packing slip. The value of DisplayableOrderId should match the order identifier that the seller provides to the recipient. The seller can use the SellerFulfillmentOrderId for this value or they can specify an alternate value if they want the recipient to reference an alternate order identifier.\n\nThe value must be an alpha-numeric or ISO 8859-1 compliant string from one to 40 characters in length. Cannot contain two spaces in a row. Leading and trailing white space is removed.",
"type":"string",
"maxLength":40
},
"DisplayableOrderDateTime":{
"description":"The date and time of the fulfillment order. Displays as the order date in recipient-facing materials such as the outbound shipment packing slip.",
"$ref":"#/definitions/Timestamp"
},
"DisplayableOrderComment":{
"description":"Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.",
"type":"string",
"maxLength":1000
},
"ShippingSpeedCategory":{
"description":"The shipping method for the fulfillment order.",
"$ref":"#/definitions/ShippingSpeedCategory"
},
"DeliveryWindow":{
"$ref":"#/definitions/DeliveryWindow"
},
"DestinationAddress":{
"description":"The destination address for the fulfillment order.",
"$ref":"#/definitions/Address"
},
"FulfillmentAction":{
"$ref":"#/definitions/FulfillmentAction"
},
"FulfillmentPolicy":{
"$ref":"#/definitions/FulfillmentPolicy"
},
"FulfillmentMethod":{
"description":"Indicates the intended recipient channel for the order.",
"type":"string"
},
"CODSettings":{
"$ref":"#/definitions/CODSettings"
},
"ShipFromCountryCode":{
"description":"The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format.",
"type":"string"
},
"NotificationEmailList":{
"$ref":"#/definitions/NotificationEmailList"
},
"Items":{
"description":"A list of items to include in the fulfillment order preview, including quantity.",
"description":"The createFulfillmentReturn operation creates a fulfillment return for items that were fulfilled using the createFulfillmentOrder operation. For calls to createFulfillmentReturn, you must include ReturnReasonCode values returned by a previous call to the listReturnReasonCodes operation.",
"type":"object",
"required":[
"Items"
],
"properties":{
"Items":{
"$ref":"#/definitions/CreateReturnItemList"
}
}
},
"CreateFulfillmentReturnResult":{
"type":"object",
"properties":{
"ReturnItemList":{
"$ref":"#/definitions/ReturnItemList"
},
"InvalidReturnItemList":{
"$ref":"#/definitions/InvalidReturnItemList"
},
"ReturnAuthorizationList":{
"$ref":"#/definitions/ReturnAuthorizationList"
}
}
},
"CreateFulfillmentReturnResponse":{
"description":"The response schema for the createFulfillmentReturn operation.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the createFulfillmentReturn operation.",
"description":"General information about a fulfillment order, including its status.",
"type":"object",
"required":[
"DestinationAddress",
"DisplayableOrderComment",
"DisplayableOrderDateTime",
"DisplayableOrderId",
"FulfillmentOrderStatus",
"MarketplaceId",
"ReceivedDateTime",
"SellerFulfillmentOrderId",
"ShippingSpeedCategory",
"StatusUpdatedDateTime"
],
"properties":{
"SellerFulfillmentOrderId":{
"description":"The fulfillment order identifier submitted with the createFulfillmentOrder operation.",
"type":"string"
},
"MarketplaceId":{
"description":"The identifier for the marketplace the fulfillment order is placed against.",
"type":"string"
},
"DisplayableOrderId":{
"description":"A fulfillment order identifier submitted with the createFulfillmentOrder operation. Displays as the order identifier in recipient-facing materials such as the packing slip.",
"type":"string"
},
"DisplayableOrderDateTime":{
"description":"A date and time submitted with the createFulfillmentOrder operation. Displays as the order date in recipient-facing materials such as the packing slip.",
"$ref":"#/definitions/Timestamp"
},
"DisplayableOrderComment":{
"description":"A text block submitted with the createFulfillmentOrder operation. Displays in recipient-facing materials such as the packing slip.",
"type":"string"
},
"ShippingSpeedCategory":{
"$ref":"#/definitions/ShippingSpeedCategory"
},
"DeliveryWindow":{
"$ref":"#/definitions/DeliveryWindow"
},
"DestinationAddress":{
"description":"The destination address submitted with the createFulfillmentOrder operation.",
"$ref":"#/definitions/Address"
},
"FulfillmentAction":{
"$ref":"#/definitions/FulfillmentAction"
},
"FulfillmentPolicy":{
"$ref":"#/definitions/FulfillmentPolicy"
},
"FulfillmentMethod":{
"description":"Indicates the intended recipient channel for the order.",
"type":"string"
},
"CODSettings":{
"$ref":"#/definitions/CODSettings"
},
"ReceivedDateTime":{
"description":"The date and time that the fulfillment order was received by an Amazon fulfillment center.",
"$ref":"#/definitions/Timestamp"
},
"FulfillmentOrderStatus":{
"$ref":"#/definitions/FulfillmentOrderStatus"
},
"StatusUpdatedDateTime":{
"description":"The date and time that the status of the fulfillment order last changed, in ISO 8601 date time format.",
"$ref":"#/definitions/Timestamp"
},
"NotificationEmailList":{
"$ref":"#/definitions/NotificationEmailList"
}
}
},
"FulfillmentOrderItem":{
"description":"Item information for a fulfillment order.",
"type":"object",
"required":[
"CancelledQuantity",
"Quantity",
"SellerFulfillmentOrderItemId",
"SellerSKU",
"UnfulfillableQuantity"
],
"properties":{
"SellerSKU":{
"description":"The seller SKU of the item.",
"type":"string"
},
"SellerFulfillmentOrderItemId":{
"description":"A fulfillment order item identifier submitted with a call to the createFulfillmentOrder operation.",
"type":"string"
},
"Quantity":{
"$ref":"#/definitions/Quantity"
},
"GiftMessage":{
"description":"A message to the gift recipient, if applicable.",
"type":"string"
},
"DisplayableComment":{
"description":"Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.",
"type":"string"
},
"FulfillmentNetworkSKU":{
"description":"Amazon's fulfillment network SKU of the item.",
"type":"string"
},
"OrderItemDisposition":{
"description":"Indicates whether the item is sellable or unsellable.",
"type":"string"
},
"CancelledQuantity":{
"description":"The item quantity that was cancelled by the seller.",
"$ref":"#/definitions/Quantity"
},
"UnfulfillableQuantity":{
"description":"The item quantity that is unfulfillable.",
"$ref":"#/definitions/Quantity"
},
"EstimatedShipDateTime":{
"description":"The estimated date and 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.",
"$ref":"#/definitions/Timestamp"
},
"EstimatedArrivalDateTime":{
"description":"The estimated arrival date and 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.",
"$ref":"#/definitions/Timestamp"
},
"PerUnitPrice":{
"description":"The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.",
"$ref":"#/definitions/Currency"
},
"PerUnitTax":{
"description":"The tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.",
"$ref":"#/definitions/Currency"
},
"PerUnitDeclaredValue":{
"description":"The monetary value assigned by the seller to this item.",
"$ref":"#/definitions/Currency"
}
}
},
"FulfillmentOrderItemList":{
"description":"A list of fulfillment order item information.",
"type":"array",
"items":{
"$ref":"#/definitions/FulfillmentOrderItem"
}
},
"FulfillmentOrderList":{
"description":"A list of fulfillment order information.",
"type":"array",
"items":{
"$ref":"#/definitions/FulfillmentOrder"
}
},
"FulfillmentPreview":{
"description":"Information about a fulfillment order preview, including delivery and fee information based on shipping method.",
"type":"object",
"required":[
"IsCODCapable",
"IsFulfillable",
"MarketplaceId",
"ShippingSpeedCategory"
],
"properties":{
"ShippingSpeedCategory":{
"$ref":"#/definitions/ShippingSpeedCategory"
},
"ScheduledDeliveryInfo":{
"$ref":"#/definitions/ScheduledDeliveryInfo"
},
"IsFulfillable":{
"description":"When true, this fulfillment order preview is fulfillable.",
"type":"boolean"
},
"IsCODCapable":{
"description":"When true, this fulfillment order preview is for COD (Cash On Delivery).",
"type":"boolean"
},
"EstimatedShippingWeight":{
"description":"Estimated shipping weight for this fulfillment order preview.",
"$ref":"#/definitions/Weight"
},
"EstimatedFees":{
"description":"The estimated fulfillment fees for this fulfillment order preview, if applicable.",
"description":"Error codes associated with the fulfillment order preview that indicate why the order is not fulfillable.\n\nError code examples:\n\nDeliverySLAUnavailable\n\nInvalidDestinationAddress",
"$ref":"#/definitions/StringList"
},
"MarketplaceId":{
"description":"The marketplace the fulfillment order is placed against.",
"type":"string"
}
}
},
"FulfillmentPreviewItem":{
"description":"Item information for a shipment in a fulfillment order preview.",
"type":"object",
"required":[
"Quantity",
"SellerFulfillmentOrderItemId",
"SellerSKU"
],
"properties":{
"SellerSKU":{
"description":"The seller SKU of the item.",
"type":"string"
},
"Quantity":{
"description":"The item quantity.",
"$ref":"#/definitions/Quantity"
},
"SellerFulfillmentOrderItemId":{
"description":"A fulfillment order item identifier that the seller created with a call to the createFulfillmentOrder operation.",
"type":"string"
},
"EstimatedShippingWeight":{
"description":"The estimated shipping weight of the item quantity for a single item, as identified by sellerSKU, in a shipment.",
"description":"The process of picking units from inventory has begun."
},
{
"value":"SHIPPED",
"description":"All packages in the shipment have left the fulfillment center."
},
{
"value":"CANCELLED_BY_FULFILLER",
"description":"The Amazon fulfillment center could not fulfill the shipment as planned. This might be because the inventory was not at the expected location in the fulfillment center. After cancelling the fulfillment order, Amazon immediately creates a new fulfillment shipment and again attempts to fulfill the order."
},
{
"value":"CANCELLED_BY_SELLER",
"description":"The shipment was cancelled using the CancelFulfillmentOrder request."
"description":"The meaning of the ShippingDateTime value depends on the current status of the shipment. If the current value of FulfillmentShipmentStatus is:\n\n* Pending - ShippingDateTime represents the estimated time that the shipment will leave the Amazon fulfillment center.\n\n* Shipped - ShippingDateTime represents the date that the shipment left the Amazon fulfillment center.\nIf a shipment includes more than one package, ShippingDateTime applies to all of the packages in the shipment. If the value of FulfillmentShipmentStatus is CancelledByFulfiller or CancelledBySeller, ShippingDateTime is not returned. The value must be in ISO 8601 date time format.",
"description":"The estimated arrival date and time of the shipment, in ISO 8601 date time format. 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.",
"description":"A list of shipping methods used for creating fulfillment order previews.\nNote: Shipping method service level agreements vary by marketplace. Sellers should see the Seller Central website in their marketplace for shipping method service level agreements and fulfillment fees.",
"description":"Specifies whether to return fulfillment order previews that are for COD (Cash On Delivery).\n\nPossible values:\n\ntrue - Returns all fulfillment order previews (both for COD and not for COD).\n\nfalse - Returns only fulfillment order previews that are not for COD.",
"type":"boolean"
},
"IncludeDeliveryWindows":{
"description":"Specifies whether to return the ScheduledDeliveryInfo response object, which contains the available delivery windows for a Scheduled Delivery. The ScheduledDeliveryInfo response object can only be returned for fulfillment order previews with ShippingSpeedCategories = ScheduledDelivery.",
"type":"boolean"
}
}
},
"GetFulfillmentPreviewResult":{
"description":"A list of fulfillment order previews, including estimated shipping weights, estimated shipping fees, and estimated ship dates and arrival dates.",
"type":"object",
"properties":{
"FulfillmentPreviews":{
"$ref":"#/definitions/FulfillmentPreviewList"
}
}
},
"GetFulfillmentPreviewResponse":{
"description":"The response schema for the getFulfillmentPreview operation.",
"type":"object",
"properties":{
"payload":{
"description":"The response payload for the getFulfillmentPreview operation.",
"description":"One or more unexpected errors occurred during the listReturnReasonCodes operation.",
"$ref":"#/definitions/ErrorList"
}
}
},
"NotificationEmailList":{
"description":"A list of email addresses that the seller provides that are used by Amazon to send ship-complete notifications to recipients on behalf of the seller.",
"description":"The tracking number for the package.",
"type":"string"
},
"CarrierCode":{
"description":"The name of the carrier.",
"type":"string"
},
"CarrierPhoneNumber":{
"description":"The phone number of the carrier.",
"type":"string"
},
"CarrierURL":{
"description":"The URL of the carrier’s website.",
"type":"string"
},
"ShipDate":{
"description":"The shipping date for the package.",
"$ref":"#/definitions/Timestamp"
},
"EstimatedArrivalDate":{
"description":"The estimated arrival date.",
"$ref":"#/definitions/Timestamp"
},
"ShipToAddress":{
"description":"The destination city for the package.",
"$ref":"#/definitions/TrackingAddress"
},
"CurrentStatus":{
"$ref":"#/definitions/CurrentStatus"
},
"SignedForBy":{
"description":"The name of the person who signed for the package.",
"type":"string"
},
"AdditionalLocationInfo":{
"$ref":"#/definitions/AdditionalLocationInfo"
},
"TrackingEvents":{
"$ref":"#/definitions/TrackingEventList"
}
}
},
"GetPackageTrackingDetailsResponse":{
"description":"The response schema for the getPackageTrackingDetails operation.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the getPackageTrackingDetails operation.",
"$ref":"#/definitions/PackageTrackingDetails"
},
"errors":{
"description":"One or more unexpected errors occurred during the getPackageTrackingDetails operation.",
"$ref":"#/definitions/ErrorList"
}
}
},
"ReasonCodeDetails":{
"description":"A return reason code, a description, and an optional description translation.",
"type":"object",
"required":[
"Description",
"ReturnReasonCode"
],
"properties":{
"ReturnReasonCode":{
"description":"A code that indicates a valid return reason.",
"type":"string"
},
"Description":{
"description":"A human readable description of the return reason code.",
"type":"string"
},
"TranslatedDescription":{
"description":"A translation of the description. The translation is in the language specified in the Language request parameter.",
"type":"string"
}
}
},
"ReasonCodeDetailsList":{
"description":"A list of return reason code details.",
"type":"array",
"items":{
"$ref":"#/definitions/ReasonCodeDetails"
}
},
"ReturnAuthorization":{
"description":"Return authorization information for items accepted for return.",
"type":"object",
"required":[
"AmazonRmaId",
"FulfillmentCenterId",
"ReturnAuthorizationId",
"ReturnToAddress",
"RmaPageURL"
],
"properties":{
"ReturnAuthorizationId":{
"description":"An identifier for the return authorization. This identifier associates return items with the return authorization used to return them.",
"type":"string"
},
"FulfillmentCenterId":{
"description":"An identifier for the Amazon fulfillment center that the return items should be sent to.",
"type":"string"
},
"ReturnToAddress":{
"description":"The address of the Amazon fulfillment center that the return items should be sent to.",
"$ref":"#/definitions/Address"
},
"AmazonRmaId":{
"description":"The return merchandise authorization (RMA) that Amazon needs to process the return.",
"type":"string"
},
"RmaPageURL":{
"description":"A URL for a web page that contains the return authorization barcode and the mailing label. This does not include pre-paid shipping.",
"type":"string"
}
}
},
"ReturnAuthorizationList":{
"description":"A list of return authorization information.",
"type":"array",
"items":{
"$ref":"#/definitions/ReturnAuthorization"
}
},
"ReturnItem":{
"description":"An item that Amazon accepted for return.",
"type":"object",
"required":[
"AmazonShipmentId",
"SellerFulfillmentOrderItemId",
"SellerReturnItemId",
"SellerReturnReasonCode",
"Status",
"StatusChangedDate"
],
"properties":{
"SellerReturnItemId":{
"description":"An identifier assigned by the seller to the return item.",
"type":"string"
},
"SellerFulfillmentOrderItemId":{
"description":"The identifier assigned to the item by the seller when the fulfillment order was created.",
"type":"string"
},
"AmazonShipmentId":{
"description":"The identifier for the shipment that is associated with the return item.",
"type":"string"
},
"SellerReturnReasonCode":{
"description":"The return reason code assigned to the return item by the seller.",
"type":"string"
},
"ReturnComment":{
"description":"An optional comment about the return item.",
"type":"string"
},
"AmazonReturnReasonCode":{
"description":"The return reason code that the Amazon fulfillment center assigned to the return item.",
"type":"string"
},
"Status":{
"description":"Indicates if the return item has been processed by an Amazon fulfillment center.",
"description":"Information for tracking package deliveries.",
"type":"object",
"required":[
"EventAddress",
"EventCode",
"EventDate"
],
"properties":{
"EventDate":{
"description":"The date and time that the delivery event took place, in ISO 8601 date time format.",
"$ref":"#/definitions/Timestamp"
},
"EventAddress":{
"description":"The city where the delivery event took place.",
"$ref":"#/definitions/TrackingAddress"
},
"EventCode":{
"description":"The event code for the delivery event.",
"$ref":"#/definitions/EventCode"
}
}
},
"TrackingEventList":{
"description":"A list of tracking event information.",
"type":"array",
"items":{
"$ref":"#/definitions/TrackingEvent"
}
},
"UnfulfillablePreviewItem":{
"description":"Information about unfulfillable items in a fulfillment order preview.",
"type":"object",
"required":[
"Quantity",
"SellerFulfillmentOrderItemId",
"SellerSKU"
],
"properties":{
"SellerSKU":{
"description":"The seller SKU of the item.",
"type":"string",
"maxLength":50
},
"Quantity":{
"$ref":"#/definitions/Quantity"
},
"SellerFulfillmentOrderItemId":{
"description":"A fulfillment order item identifier created with a call to the getFulfillmentPreview operation.",
"type":"string",
"maxLength":50
},
"ItemUnfulfillableReasons":{
"description":"Error codes associated with the fulfillment order preview that indicate why the item is unfulfillable.",
"$ref":"#/definitions/StringList"
}
}
},
"UnfulfillablePreviewItemList":{
"description":"A list of unfulfillable preview item information.",
"type":"array",
"items":{
"$ref":"#/definitions/UnfulfillablePreviewItem"
}
},
"UpdateFulfillmentOrderItem":{
"description":"Item information for updating a fulfillment order.",
"type":"object",
"required":[
"Quantity",
"SellerFulfillmentOrderItemId"
],
"properties":{
"SellerSKU":{
"description":"The seller SKU of the item.",
"type":"string"
},
"SellerFulfillmentOrderItemId":{
"description":"Identifies the fulfillment order item to update. Created with a previous call to the createFulfillmentOrder operation.",
"type":"string",
"maxLength":50
},
"Quantity":{
"$ref":"#/definitions/Quantity"
},
"GiftMessage":{
"description":"A message to the gift recipient, if applicable.",
"type":"string",
"maxLength":512
},
"DisplayableComment":{
"description":"Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.",
"type":"string",
"maxLength":250
},
"FulfillmentNetworkSKU":{
"description":"Amazon's fulfillment network SKU of the item.",
"type":"string"
},
"OrderItemDisposition":{
"description":"Indicates whether the item is sellable or unsellable.",
"type":"string"
},
"PerUnitDeclaredValue":{
"description":"The monetary value assigned by the seller to this item.",
"$ref":"#/definitions/Currency"
},
"PerUnitPrice":{
"description":"The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.",
"$ref":"#/definitions/Currency"
},
"PerUnitTax":{
"description":"The tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.",
"$ref":"#/definitions/Currency"
}
}
},
"UpdateFulfillmentOrderItemList":{
"description":"A list of fulfillment order item information for updating a fulfillment order.",
"type":"array",
"items":{
"$ref":"#/definitions/UpdateFulfillmentOrderItem"
}
},
"UpdateFulfillmentOrderRequest":{
"type":"object",
"properties":{
"MarketplaceId":{
"description":"The marketplace the fulfillment order is placed against.",
"type":"string"
},
"DisplayableOrderId":{
"description":"A fulfillment order identifier that the seller creates. This value displays as the order identifier in recipient-facing materials such as the outbound shipment packing slip. The value of DisplayableOrderId should match the order identifier that the seller provides to the recipient. The seller can use the SellerFulfillmentOrderId for this value or they can specify an alternate value if they want the recipient to reference an alternate order identifier.",
"type":"string",
"maxLength":40
},
"DisplayableOrderDateTime":{
"description":"The date of the fulfillment order. Displays as the order date in recipient-facing materials such as the outbound shipment packing slip.",
"$ref":"#/definitions/Timestamp"
},
"DisplayableOrderComment":{
"description":"Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.",
"type":"string",
"maxLength":1000
},
"ShippingSpeedCategory":{
"$ref":"#/definitions/ShippingSpeedCategory"
},
"DestinationAddress":{
"description":"The destination address for the fulfillment order.",
"$ref":"#/definitions/Address"
},
"FulfillmentAction":{
"$ref":"#/definitions/FulfillmentAction"
},
"FulfillmentPolicy":{
"$ref":"#/definitions/FulfillmentPolicy"
},
"FulfillmentMethod":{
"description":"Indicates the intended recipient channel for the order.",
"type":"string"
},
"ShipFromCountryCode":{
"description":"The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format.",
"type":"string"
},
"NotificationEmailList":{
"$ref":"#/definitions/NotificationEmailList"
},
"Items":{
"description":"A list of items to include in the fulfillment order preview, including quantity.",