selling-partner-api-models/models/fulfillment-outbound-api-model/fulfillmentOutboundV0.json

4465 lines
165 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"swagger": "2.0",
"info": {
"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",
"contact": {
"name": "Selling Partner API Developer Support",
"url": "https://sellercentral.amazon.com/gp/mws/contactus.html"
},
"license": {
"name": "Apache License 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
}
},
"host": "sellingpartnerapi-na.amazon.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/fba/outbound/v0/fulfillmentOrders/preview": {
"post": {
"tags": [
"fbaOutbound"
],
"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.",
"operationId": "getFulfillmentPreview",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/GetFulfillmentPreviewRequest"
}
}
],
"responses": {
"200": {
"description": "Success.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"body": {
"value": {
"MarketplaceId": "ATVPDKIKX0DER",
"Address": {
"Name": "Amazon",
"Line1": "MeguroKu",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"Items": [
{
"SellerSKU": "PSMM-TEST-SKU-Jan-21_19_39_23-0788",
"SellerFulfillmentOrderItemId": "OrderItemID2",
"Quantity": 1
}
],
"ShippingSpeedCategories": [
"Standard"
]
}
}
}
},
"response": {
"payload": {
"FulfillmentPreviews": [
{
"ShippingSpeedCategory": "Standard",
"IsFulfillable": true,
"EstimatedShippingWeight": {
"Unit": "POUNDS",
"Value": "22"
},
"EstimatedFees": [
{
"Name": "FBAPerUnitFulfillmentFee",
"Amount": {
"CurrencyCode": "USD",
"Value": "19.71"
}
}
],
"FulfillmentPreviewShipments": [
{
"EarliestShipDate": "2020-02-11T18:16:16Z",
"LatestShipDate": "2020-02-11T18:16:16Z",
"EarliestArrivalDate": "2020-02-17T18:16:16Z",
"LatestArrivalDate": "2020-02-17T18:16:16Z",
"FulfillmentPreviewItems": [
{
"SellerSKU": "PSMM-TEST-SKU-Jan-21_19_39_23-0788",
"Quantity": 1,
"SellerFulfillmentOrderItemId": "OrderItemID2",
"EstimatedShippingWeight": {
"Unit": "POUNDS",
"Value": "20"
},
"ShippingWeightCalculationMethod": "Package"
}
]
}
],
"UnfulfillablePreviewItems": [],
"MarketplaceId": "ATVPDKIKX0DER"
}
]
}
}
}
],
"schema": {
"$ref": "#/definitions/GetFulfillmentPreviewResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"body": {
"value": {
"MarketplaceId": "ATVPDKIKX0DER",
"Address": {
"Name": "Amazon",
"Line1": "MeguroKu",
"City": "Troy",
"StateOrProvinceCode": "MI",
"PostalCode": "48084"
},
"Items": [
{
"SellerSKU": "PSMM-TEST-SKU-Jan-21_19_39_23-0788",
"SellerFulfillmentOrderItemId": "OrderItemID2",
"Quantity": 1
}
],
"ShippingSpeedCategories": [
"Standard"
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "The request must contain the parameter Address.CountryCode.",
"details": ""
}
]
}
}
],
"schema": {
"$ref": "#/definitions/GetFulfillmentPreviewResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetFulfillmentPreviewResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/GetFulfillmentPreviewResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetFulfillmentPreviewResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetFulfillmentPreviewResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/GetFulfillmentPreviewResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetFulfillmentPreviewResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/fba/outbound/v0/fulfillmentOrders": {
"get": {
"tags": [
"fbaOutbound"
],
"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.",
"operationId": "listAllFulfillmentOrders",
"parameters": [
{
"name": "QueryStartDateTime",
"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.",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"QueryStartDateTime": {
"value": "2020-01-01T19:46:45Z"
}
}
},
"response": {
"payload": {
"FulfillmentOrders": [
{
"SellerFulfillmentOrderId": "902-6018020-0202003",
"DisplayableOrderId": "mws-test-query-20100713023203751",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-21T21:07:13Z",
"FulfillmentOrderStatus": "RECEIVED",
"StatusUpdatedDateTime": "2020-01-21T21:07:30Z"
},
{
"SellerFulfillmentOrderId": "601-2020200-12345678",
"DisplayableOrderId": "TestOrder-FBAOutbound",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-23T19:56:41Z",
"FulfillmentOrderStatus": "COMPLETE",
"StatusUpdatedDateTime": "2020-01-24T15:28:27Z"
},
{
"SellerFulfillmentOrderId": "501-2020200-12345678",
"DisplayableOrderId": "501-2020200-12345678",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-23T19:26:45Z",
"FulfillmentOrderStatus": "COMPLETE",
"StatusUpdatedDateTime": "2020-01-27T13:58:23Z"
},
{
"SellerFulfillmentOrderId": "902-6018020-03251987",
"DisplayableOrderId": "mws-test-query-20100713023203751",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-23T15:06:04Z",
"FulfillmentOrderStatus": "CANCELLED",
"StatusUpdatedDateTime": "2020-01-27T14:40:37Z"
},
{
"SellerFulfillmentOrderId": "902-6018020-03261987",
"DisplayableOrderId": "mws-test-query-20100713023203751",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-23T17:54:43Z",
"FulfillmentOrderStatus": "COMPLETE",
"StatusUpdatedDateTime": "2020-01-27T14:50:32Z"
},
{
"SellerFulfillmentOrderId": "TestOrder-1",
"DisplayableOrderId": "TestOrder-FBAOutbound",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-27T15:25:11Z",
"FulfillmentOrderStatus": "RECEIVED",
"StatusUpdatedDateTime": "2020-01-27T15:25:23Z"
},
{
"SellerFulfillmentOrderId": "902-6018020-08182019",
"DisplayableOrderId": "mws-test-query-20100713023203751",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-21T20:25:56Z",
"FulfillmentOrderStatus": "CANCELLED",
"StatusUpdatedDateTime": "2020-01-27T18:16:38Z"
},
{
"SellerFulfillmentOrderId": "902-6018020-04162017",
"DisplayableOrderId": "mws-test-query-20100713023203751",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-21T20:59:10Z",
"FulfillmentOrderStatus": "CANCELLED",
"StatusUpdatedDateTime": "2020-01-27T18:16:44Z"
},
{
"SellerFulfillmentOrderId": "902-6018020-04162019",
"DisplayableOrderId": "mws-test-query-2",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-21T21:00:11Z",
"FulfillmentOrderStatus": "COMPLETE",
"StatusUpdatedDateTime": "2020-01-27T18:19:38Z"
},
{
"SellerFulfillmentOrderId": "902-6018020-02020202",
"DisplayableOrderId": "mws-test-query-20100713023203751",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-21T21:05:13Z",
"FulfillmentOrderStatus": "CANCELLED",
"StatusUpdatedDateTime": "2020-01-27T18:28:32Z"
},
{
"SellerFulfillmentOrderId": "TestOrder-2",
"DisplayableOrderId": "TestOrder-FBAOutbound",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-27T18:20:10Z",
"FulfillmentOrderStatus": "COMPLETE",
"StatusUpdatedDateTime": "2020-01-27T18:57:48Z"
},
{
"SellerFulfillmentOrderId": "TestOrder-3",
"DisplayableOrderId": "TestOrder-FBAOutbound",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-28T14:18:54Z",
"FulfillmentOrderStatus": "COMPLETE",
"StatusUpdatedDateTime": "2020-01-28T14:24:18Z"
},
{
"SellerFulfillmentOrderId": "TestOrder-4",
"DisplayableOrderId": "TestOrder-FBAOutbound",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Priya",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-01-29T02:36:57Z",
"FulfillmentOrderStatus": "PLANNING",
"StatusUpdatedDateTime": "2020-01-29T02:52:28Z"
},
{
"SellerFulfillmentOrderId": "TestOrder-7",
"DisplayableOrderId": "TestOrder-FBAOutbound",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Priya",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-02-04T15:59:26Z",
"FulfillmentOrderStatus": "CANCELLED",
"StatusUpdatedDateTime": "2020-02-04T18:28:22Z"
},
{
"SellerFulfillmentOrderId": "TestOrder-5",
"DisplayableOrderId": "TestOrder-FBAOutbound",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-02-04T15:07:50Z",
"FulfillmentOrderStatus": "COMPLETE",
"StatusUpdatedDateTime": "2020-02-05T18:46:10Z"
},
{
"SellerFulfillmentOrderId": "TestOrder-6",
"DisplayableOrderId": "TestOrder-FBAOutbound",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-02-04T15:57:39Z",
"FulfillmentOrderStatus": "COMPLETE",
"StatusUpdatedDateTime": "2020-02-06T20:15:11Z"
}
]
}
}
}
],
"schema": {
"$ref": "#/definitions/ListAllFulfillmentOrdersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"QueryStartDateTime": {
"value": "fdfdsfds"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "timestamp must follow ISO8601",
"details": ""
}
]
}
}
],
"schema": {
"$ref": "#/definitions/ListAllFulfillmentOrdersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/ListAllFulfillmentOrdersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ListAllFulfillmentOrdersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/ListAllFulfillmentOrdersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ListAllFulfillmentOrdersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ListAllFulfillmentOrdersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ListAllFulfillmentOrdersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"post": {
"tags": [
"fbaOutbound"
],
"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.",
"operationId": "createFulfillmentOrder",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateFulfillmentOrderRequest"
}
}
],
"responses": {
"200": {
"description": "Success.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"body": {
"value": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerFulfillmentOrderId": "FBATestOrder-11",
"DisplayableOrderId": "TestOrder-FBAOutbound",
"DisplayableOrderDateTime": "2020-01-09T19:46:45.809Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"City": "Troy",
"PostalCode": "48084"
},
"FulfillmentAction": "Ship",
"CODSettings": {
"IsCODRequired": false,
"CODCharge": {
"CurrencyCode": "USD",
"Value": "10.00"
},
"CODChargeTax": {
"CurrencyCode": "USD",
"Value": "2.00"
},
"ShippingCharge": {
"CurrencyCode": "USD",
"Value": "5.00"
},
"ShippingChargeTax": {
"CurrencyCode": "USD",
"Value": "3.00"
}
},
"NotificationEmailList": [
"test1%40amazon.com",
"test2%40amazon.com"
],
"Items": [
{
"SellerSKU": "CR-47K6-H6QN",
"SellerFulfillmentOrderItemId": "OrderItemID1",
"Quantity": 3
},
{
"SellerSKU": "PSMM-TEST-SKU-Jan-21_19_59_44-0738",
"SellerFulfillmentOrderItemId": "OrderItemID2",
"Quantity": 1
}
]
}
}
}
},
"response": {}
}
],
"schema": {
"$ref": "#/definitions/CreateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"body": {
"value": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerFulfillmentOrderId": "FBATestOrder-1",
"DisplayableOrderId": "TestOrder-FBAOutbound",
"DisplayableOrderDateTime": "2020-01-09T19:46:45.809Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"City": "Troy",
"PostalCode": "48084"
},
"FulfillmentAction": "Ship",
"CODSettings": {
"IsCODRequired": false,
"CODCharge": {
"CurrencyCode": "USD",
"Value": "10.00"
},
"CODChargeTax": {
"CurrencyCode": "USD",
"Value": "2.00"
},
"ShippingCharge": {
"CurrencyCode": "USD",
"Value": "5.00"
},
"ShippingChargeTax": {
"CurrencyCode": "USD",
"Value": "3.00"
}
},
"NotificationEmailList": [
"test1%40amazon.com",
"test2%40amazon.com"
],
"Items": [
{
"SellerSKU": "CR-47K6-H6QN",
"SellerFulfillmentOrderItemId": "OrderItemID1",
"Quantity": 3
},
{
"SellerSKU": "PSMM-TEST-SKU-Jan-21_19_59_44-0738",
"SellerFulfillmentOrderItemId": "OrderItemID2",
"Quantity": 1
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "A create request already exists for MerchantFulfillmentOrderId : FBATestOrder-1",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"body": {
"value": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerFulfillmentOrderId": "FBATestOrder-2",
"DisplayableOrderId": "TestOrder-FBAOutbound",
"DisplayableOrderDateTime": "2020-01-09T19:46:45.809Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"StateOrProvinceCode": "MI",
"City": "Troy",
"PostalCode": "48084"
},
"FulfillmentAction": "Ship",
"CODSettings": {
"IsCODRequired": false,
"CODCharge": {
"CurrencyCode": "USD",
"Value": "10.00"
},
"CODChargeTax": {
"CurrencyCode": "USD",
"Value": "2.00"
},
"ShippingCharge": {
"CurrencyCode": "USD",
"Value": "5.00"
},
"ShippingChargeTax": {
"CurrencyCode": "USD",
"Value": "3.00"
}
},
"NotificationEmailList": [
"test1%40amazon.com",
"test2%40amazon.com"
],
"Items": [
{
"SellerSKU": "CR-47K6-H6QN",
"SellerFulfillmentOrderItemId": "OrderItemID1",
"Quantity": 3
},
{
"SellerSKU": "PSMM-TEST-SKU-Jan-21_19_59_44-0738",
"SellerFulfillmentOrderItemId": "OrderItemID2",
"Quantity": 1
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Value for parameter CountryCode is invalid. Reason: InvalidValue.",
"details": ""
}
]
}
}
],
"schema": {
"$ref": "#/definitions/CreateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/fba/outbound/v0/tracking": {
"get": {
"tags": [
"fbaOutbound"
],
"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.",
"operationId": "getPackageTrackingDetails",
"parameters": [
{
"name": "packageNumber",
"description": "The unencrypted package identifier returned by the getFulfillmentOrder operation.",
"in": "query",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "Success.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"packageNumber": {
"value": 212794778
}
}
},
"response": {
"payload": {
"PackageNumber": 212794778,
"TrackingNumber": "1Z50V7420354708051",
"CarrierCode": "UPS",
"ShipToAddress": {},
"CurrentStatus": "DELIVERED",
"TrackingEvents": [
{
"EventDate": "2020-01-22T00:15:55Z",
"EventAddress": {},
"EventCode": "EVENT_301"
},
{
"EventDate": "2019-10-30T23:33:28Z",
"EventAddress": {},
"EventCode": "EVENT_246"
}
]
}
}
}
],
"schema": {
"$ref": "#/definitions/GetPackageTrackingDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"packageNumber": {
"value": 12222
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "null",
"details": ""
}
]
}
}
],
"schema": {
"$ref": "#/definitions/GetPackageTrackingDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetPackageTrackingDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/GetPackageTrackingDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetPackageTrackingDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetPackageTrackingDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/GetPackageTrackingDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetPackageTrackingDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/fba/outbound/v0/returnReasonCodes": {
"get": {
"tags": [
"fbaOutbound"
],
"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.",
"operationId": "listReturnReasonCodes",
"parameters": [
{
"name": "SellerSKU",
"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"
},
{
"ReturnReasonCode": "CR-MISSED_ESTIMATED_DELIVERY",
"Description": "Missed estimated delivery date"
},
{
"ReturnReasonCode": "CR-MISSING_PARTS",
"Description": "Missing parts or accessories"
},
{
"ReturnReasonCode": "CR-DAMAGED_BY_CARRIER",
"Description": "Damaged during shipping"
},
{
"ReturnReasonCode": "CR-SWITCHEROO",
"Description": "Different from what was ordered"
},
{
"ReturnReasonCode": "CR-EXTRA_ITEM",
"Description": "Arrived in addition to what was ordered"
},
{
"ReturnReasonCode": "CR-UNAUTHORIZED_PURCHASE",
"Description": "Unauthorized purchase"
}
]
}
}
}
],
"schema": {
"$ref": "#/definitions/ListReturnReasonCodesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "The request must contain the parameter SellerSKU.",
"details": ""
}
]
}
}
],
"schema": {
"$ref": "#/definitions/ListReturnReasonCodesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/ListReturnReasonCodesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ListReturnReasonCodesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/ListReturnReasonCodesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ListReturnReasonCodesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ListReturnReasonCodesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ListReturnReasonCodesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/fba/outbound/v0/fulfillmentOrders/{sellerFulfillmentOrderId}/return": {
"put": {
"tags": [
"fbaOutbound"
],
"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.",
"operationId": "createFulfillmentReturn",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateFulfillmentReturnRequest"
}
},
{
"name": "sellerFulfillmentOrderId",
"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.",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"sellerFulfillmentOrderId": {
"value": "TestOrder-6"
},
"body": {
"value": {
"Items": [
{
"SellerReturnItemId": "testReturn11",
"SellerFulfillmentOrderItemId": "OrderItemID2",
"AmazonShipmentId": "D4yZjWZVN",
"ReturnReasonCode": "TestReturn",
"ReturnComment": "TestReturn"
}
]
}
}
}
},
"response": {
"payload": {
"ReturnItemList": [
{
"SellerReturnItemId": "testReturn11",
"SellerFulfillmentOrderItemId": "OrderItemID2",
"AmazonShipmentId": "D4yZjWZVN",
"ReturnComment": "TestReturn",
"AmazonReturnReasonCode": "UNKNOWN_OTHER_REASON",
"Status": "New",
"StatusChangedDate": "2020-02-07T04:14:38Z",
"ReturnAuthorizationId": "RMA3JTIPBJM42UU6"
}
],
"InvalidReturnItemList": [],
"ReturnAuthorizationList": [
{
"ReturnAuthorizationId": "RMA3JTIPBJM42UU6",
"FulfillmentCenterId": "TUS1",
"ReturnToAddress": {
"Name": "Returns Department",
"Line1": "5333 W. Lower Buckeye Road",
"DistrictOrCounty": "US",
"City": "Phoenix",
"StateOrProvinceCode": "AZ",
"CountryCode": "US",
"PostalCode": "85043"
},
"AmazonRmaId": "D50WttPHRRMA",
"RmaPageURL": "https://www.amazon.com/gp/orc/rml/D50WttPHRRMA"
}
]
}
}
}
],
"schema": {
"$ref": "#/definitions/CreateFulfillmentReturnResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"sellerFulfillmentOrderId": {
"value": "FBATestOrder-11"
},
"body": {
"value": {
"Items":
[
{
"SellerReturnItemId": "testReturn11",
"SellerFulfillmentOrderItemId": "OrderItemID2",
"AmazonShipmentId": "Dr0dZBZWN",
"ReturnReasonCode": "TestReturn",
"ReturnComment":"TestReturn"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "No inventory available for Items.SellerFulfillmentOrderItemId: FBATestOrder-11.",
"details": ""
}
]
}
}
],
"schema": {
"$ref": "#/definitions/CreateFulfillmentReturnResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentReturnResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentReturnResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentReturnResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentReturnResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentReturnResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentReturnResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/fba/outbound/v0/fulfillmentOrders/{sellerFulfillmentOrderId}": {
"get": {
"tags": [
"fbaOutbound"
],
"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.",
"operationId": "getFulfillmentOrder",
"parameters": [
{
"name": "sellerFulfillmentOrderId",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created.",
"in": "path",
"required": true,
"type": "string",
"maxLength": 40
}
],
"responses": {
"200": {
"description": "Success.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"sellerFulfillmentOrderId": {
"value": "FBATestOrder-1"
}
}
},
"response": {
"payload": {
"FulfillmentOrder": {
"SellerFulfillmentOrderId": "FBATestOrder-1",
"MarketplaceId": "ATVPDKIKX0DER",
"DisplayableOrderId": "TestOrder-FBAOutbound",
"DisplayableOrderDateTime": "2020-01-09T19:46:45Z",
"DisplayableOrderComment": "TestOrder",
"ShippingSpeedCategory": "Standard",
"DestinationAddress": {
"Name": "Amazon",
"Line1": "MeguroKu",
"Line2": "Building2010",
"Line3": "Lane1",
"City": "Troy",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48084"
},
"FulfillmentAction": "Ship",
"FulfillmentPolicy": "FillOrKill",
"FulfillmentMethod": "Consumer",
"ReceivedDateTime": "2020-02-07T01:23:30Z",
"FulfillmentOrderStatus": "PROCESSING",
"StatusUpdatedDateTime": "2020-02-07T02:33:31Z",
"NotificationEmailList": [
"test2@amazon.com",
"test1@amazon.com"
]
},
"FulfillmentOrderItem": [
{
"SellerSKU": "PSMM-TEST-SKU-Jan-21_19_59_44-0738",
"SellerFulfillmentOrderItemId": "OrderItemID2",
"Quantity": 1,
"FulfillmentNetworkSKU": "B07CGHKWZP",
"OrderItemDisposition": "Sellable",
"CancelledQuantity": 0,
"UnfulfillableQuantity": 0,
"EstimatedShipDateTime": "2020-02-08T01:23:31Z",
"EstimatedArrivalDateTime": "2020-02-15T01:23:31Z",
"PerUnitDeclaredValue": {
"CurrencyCode": "USD",
"Value": "18.99"
}
},
{
"SellerSKU": "CR-47K6-H6QN",
"SellerFulfillmentOrderItemId": "OrderItemID1",
"Quantity": 3,
"FulfillmentNetworkSKU": "X0014BIZ8T",
"OrderItemDisposition": "Sellable",
"CancelledQuantity": 0,
"UnfulfillableQuantity": 0,
"EstimatedShipDateTime": "2020-02-08T01:23:31Z",
"EstimatedArrivalDateTime": "2020-02-15T01:23:31Z",
"PerUnitDeclaredValue": {
"CurrencyCode": "USD",
"Value": "2.00"
}
}
],
"FulfillmentShipment": [
{
"AmazonShipmentId": "DchKfcZ9N",
"FulfillmentCenterId": "RNO1",
"FulfillmentShipmentStatus": "PENDING",
"ShippingDateTime": "2020-02-07T02:33:23Z",
"EstimatedArrivalDateTime": "2020-02-07T02:33:23Z",
"FulfillmentShipmentItem": [
{
"SellerSKU": "PSMM-TEST-SKU-Jan-21_19_59_44-0738",
"SellerFulfillmentOrderItemId": "OrderItemID2",
"Quantity": 1,
"PackageNumber": 0
},
{
"SellerSKU": "CR-47K6-H6QN",
"SellerFulfillmentOrderItemId": "OrderItemID1",
"Quantity": 3,
"PackageNumber": 0
}
]
}
],
"ReturnItemList": [],
"ReturnAuthorizationList": []
}
}
}
],
"schema": {
"$ref": "#/definitions/GetFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"sellerFulfillmentOrderId": {
"value": "FBATestOrder-10"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Requested order 'FBATestOrder-10' not found",
"details": ""
}
]
}
}
],
"schema": {
"$ref": "#/definitions/GetFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/GetFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/GetFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"put": {
"tags": [
"fbaOutbound"
],
"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.",
"operationId": "updateFulfillmentOrder",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateFulfillmentOrderRequest"
}
},
{
"name": "sellerFulfillmentOrderId",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created.",
"in": "path",
"required": true,
"type": "string",
"maxLength": 40
}
],
"responses": {
"200": {
"description": "Success.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"sellerFulfillmentOrderId": {
"value": "FBATestOrder-1"
},
"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": {}
}
],
"schema": {
"$ref": "#/definitions/UpdateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"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.",
"details": ""
}
]
}
}
],
"schema": {
"$ref": "#/definitions/UpdateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/UpdateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/UpdateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/UpdateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/UpdateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/UpdateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/UpdateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/fba/outbound/v0/fulfillmentOrders/{sellerFulfillmentOrderId}/cancel": {
"put": {
"tags": [
"fbaOutbound"
],
"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.",
"operationId": "cancelFulfillmentOrder",
"parameters": [
{
"name": "sellerFulfillmentOrderId",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created.",
"in": "path",
"required": true,
"type": "string",
"maxLength": 40
}
],
"responses": {
"200": {
"description": "Success.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"sellerFulfillmentOrderId": {
"value": "TestOrder-7"
}
}
},
"response": {}
}
],
"schema": {
"$ref": "#/definitions/CancelFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"sellerFulfillmentOrderId": {
"value": "FBATestOrder-11"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Value FBATestOrder-11 for parameter SellerFulfillmentOrderId is invalid. Reason: DuplicateCancelRequest.", "details": ""
}
]
}
}
],
"schema": {
"$ref": "#/definitions/CancelFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/CancelFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/CancelFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/CancelFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/CancelFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/CancelFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/CancelFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
}
},
"definitions": {
"Error": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "An error code that identifies the type of error that occured."
},
"message": {
"type": "string",
"description": "A message that describes the error condition."
},
"details": {
"type": "string",
"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.",
"type": "array",
"items": {
"$ref": "#/definitions/CreateFulfillmentOrderItem"
}
},
"FulfillmentPolicy": {
"description": "The FulfillmentPolicy value specified when you submitted the createFulfillmentOrder operation.",
"type": "string",
"enum": [
"FillOrKill",
"FillAll",
"FillAllAvailable"
],
"x-docgen-enum-table-extension": [
{
"value": "FillOrKill",
"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."
}
]
},
"FulfillmentOrderStatus": {
"description": "The current status of the fulfillment order.",
"type": "string",
"enum": [
"New",
"Received",
"Planning",
"Processing",
"Cancelled",
"Complete",
"CompletePartialled",
"Unfulfillable",
"Invalid"
],
"x-docgen-enum-table-extension": [
{
"value": "New",
"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."
}
]
},
"CreateFulfillmentOrderRequest": {
"description": "The request body schema for the createFulfillmentOrder operation.",
"type": "object",
"required": [
"DestinationAddress",
"DisplayableOrderComment",
"DisplayableOrderDateTime",
"DisplayableOrderId",
"Items",
"SellerFulfillmentOrderId",
"ShippingSpeedCategory"
],
"properties": {
"MarketplaceId": {
"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.",
"$ref": "#/definitions/CreateFulfillmentOrderItemList"
}
}
},
"CreateFulfillmentReturnRequest": {
"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.",
"$ref": "#/definitions/CreateFulfillmentReturnResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the createFulfillmentReturn operation.",
"$ref": "#/definitions/ErrorList"
}
}
},
"CreateReturnItem": {
"description": "An item that Amazon accepted for return.",
"type": "object",
"required": [
"AmazonShipmentId",
"ReturnReasonCode",
"SellerFulfillmentOrderItemId",
"SellerReturnItemId"
],
"properties": {
"SellerReturnItemId": {
"description": "An identifier assigned by the seller to the return item.",
"type": "string",
"maxLength": 80
},
"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"
},
"ReturnReasonCode": {
"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",
"maxLength": 1000
}
}
},
"CreateReturnItemList": {
"description": "A list of items to be returned.",
"type": "array",
"items": {
"$ref": "#/definitions/CreateReturnItem"
}
},
"Currency": {
"description": "Currency type and amount.",
"type": "object",
"required": [
"CurrencyCode",
"Value"
],
"properties": {
"CurrencyCode": {
"description": "Three-digit currency code in ISO 4217 format.",
"type": "string"
},
"Value": {
"description": "The currency amount.",
"type": "string"
}
}
},
"DeliveryWindow": {
"description": "The time range within which a Scheduled Delivery fulfillment order should be delivered.",
"type": "object",
"required": [
"EndDateTime",
"StartDateTime"
],
"properties": {
"StartDateTime": {
"description": "The date and time of the start of the Scheduled Delivery window, in ISO 8601 date time format.",
"$ref": "#/definitions/Timestamp"
},
"EndDateTime": {
"description": "The date and time of the end of the Scheduled Delivery window, in ISO 8601 date time format.",
"$ref": "#/definitions/Timestamp"
}
}
},
"DeliveryWindowList": {
"description": "A list of delivery windows.",
"type": "array",
"items": {
"$ref": "#/definitions/DeliveryWindow"
}
},
"Fee": {
"description": "Fee type and cost.",
"type": "object",
"required": [
"Amount",
"Name"
],
"properties": {
"Name": {
"description": "The type of fee.",
"type": "string",
"enum": [
"FBAPerUnitFulfillmentFee",
"FBAPerOrderFulfillmentFee",
"FBATransportationFee",
"FBAFulfillmentCODFee"
],
"x-docgen-enum-table-extension": [
{
"value": "FBAPerUnitFulfillmentFee",
"description": "Estimated fee for each unit in the fulfillment order."
},
{
"value": "FBAPerOrderFulfillmentFee",
"description": "Estimated order-level fee."
},
{
"value": "FBATransportationFee",
"description": "Estimated shipping fee."
},
{
"value": "FBAFulfillmentCODFee",
"description": "Estimated COD (Cash On Delivery) fee. This fee applies only to fulfillment order previews for COD."
}
]
},
"Amount": {
"description": "The amount of the fee.",
"$ref": "#/definitions/Currency"
}
}
},
"FeeList": {
"description": "A list of fee type and cost pairs.",
"type": "array",
"items": {
"$ref": "#/definitions/Fee"
}
},
"FulfillmentAction": {
"description": "Specifies whether the fulfillment order should ship now or have an order hold put on it.",
"type": "string",
"enum": [
"Ship",
"Hold"
],
"x-docgen-enum-table-extension": [
{
"value": "Ship",
"description": "The fulfillment order ships now."
},
{
"value": "Hold",
"description": "An order hold is put on the fulfillment order."
}
]
},
"FulfillmentOrder": {
"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.",
"$ref": "#/definitions/FeeList"
},
"FulfillmentPreviewShipments": {
"$ref": "#/definitions/FulfillmentPreviewShipmentList"
},
"UnfulfillablePreviewItems": {
"$ref": "#/definitions/UnfulfillablePreviewItemList"
},
"OrderUnfulfillableReasons": {
"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.",
"$ref": "#/definitions/Weight"
},
"ShippingWeightCalculationMethod": {
"description": "The method used to calculate EstimatedShippingWeight.",
"type": "string",
"enum": [
"Package",
"Dimensional"
],
"x-docgen-enum-table-extension": [
{
"value": "Package",
"description": "Based on the actual weight of the items."
},
{
"value": "Dimensional",
"description": "Based on the cubic space that the items occupy."
}
]
}
}
},
"FulfillmentPreviewItemList": {
"description": "A list of fulfillment preview item information.",
"type": "array",
"items": {
"$ref": "#/definitions/FulfillmentPreviewItem"
}
},
"FulfillmentPreviewList": {
"description": "A list of fulfillment preview information.",
"type": "array",
"items": {
"$ref": "#/definitions/FulfillmentPreview"
}
},
"FulfillmentPreviewShipment": {
"description": "Delivery and item information for a shipment in a fulfillment order preview.",
"type": "object",
"required": [
"EarliestArrivalDate",
"EarliestShipDate",
"FulfillmentPreviewItems",
"LatestArrivalDate",
"LatestShipDate"
],
"properties": {
"EarliestShipDate": {
"description": "The earliest date that the shipment is expected to be sent from the fulfillment center, in ISO 8601 date time format.",
"$ref": "#/definitions/Timestamp"
},
"LatestShipDate": {
"description": "The latest date that the shipment is expected to be sent from the fulfillment center, in ISO 8601 date time format.",
"$ref": "#/definitions/Timestamp"
},
"EarliestArrivalDate": {
"description": "The earliest date that the shipment is expected to arrive at its destination.",
"$ref": "#/definitions/Timestamp"
},
"LatestArrivalDate": {
"description": "The latest date that the shipment is expected to arrive at its destination, in ISO 8601 date time format.",
"$ref": "#/definitions/Timestamp"
},
"FulfillmentPreviewItems": {
"description": "Information about the items in the shipment.",
"$ref": "#/definitions/FulfillmentPreviewItemList"
}
}
},
"FulfillmentPreviewShipmentList": {
"description": "A list of fulfillment preview shipment information.",
"type": "array",
"items": {
"$ref": "#/definitions/FulfillmentPreviewShipment"
}
},
"FulfillmentReturnItemStatus": {
"description": "Indicates if the return item has been processed by a fulfillment center.",
"type": "string",
"enum": [
"New",
"Processed"
],
"x-docgen-enum-table-extension": [
{
"value": "New",
"description": "The return item has not yet been processed by a fulfillment center."
},
{
"value": "Processed",
"description": "The return item has been processed by a fulfillment center."
}
]
},
"FulfillmentShipment": {
"description": "Delivery and item information for a shipment in a fulfillment order.",
"type": "object",
"required": [
"AmazonShipmentId",
"FulfillmentCenterId",
"FulfillmentShipmentItem",
"FulfillmentShipmentStatus"
],
"properties": {
"AmazonShipmentId": {
"description": "A shipment identifier assigned by Amazon.",
"type": "string"
},
"FulfillmentCenterId": {
"description": "An identifier for the fulfillment center that the shipment will be sent from.",
"type": "string"
},
"FulfillmentShipmentStatus": {
"description": "The current status of the shipment.",
"type": "string",
"enum": [
"PENDING",
"SHIPPED",
"CANCELLED_BY_FULFILLER",
"CANCELLED_BY_SELLER"
],
"x-docgen-enum-table-extension": [
{
"value": "PENDING",
"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."
}
]
},
"ShippingDateTime": {
"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.",
"$ref": "#/definitions/Timestamp"
},
"EstimatedArrivalDateTime": {
"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.",
"$ref": "#/definitions/Timestamp"
},
"FulfillmentShipmentItem": {
"$ref": "#/definitions/FulfillmentShipmentItemList"
},
"FulfillmentShipmentPackage": {
"$ref": "#/definitions/FulfillmentShipmentPackageList"
}
}
},
"FulfillmentShipmentItem": {
"description": "Item information for a shipment in a fulfillment order.",
"type": "object",
"required": [
"Quantity",
"SellerFulfillmentOrderItemId",
"SellerSKU"
],
"properties": {
"SellerSKU": {
"description": "The seller SKU of the item.",
"type": "string"
},
"SellerFulfillmentOrderItemId": {
"description": "The fulfillment order item identifier that the seller created and submitted with a call to the createFulfillmentOrder operation.",
"type": "string"
},
"Quantity": {
"$ref": "#/definitions/Quantity"
},
"PackageNumber": {
"description": "An identifier for the package that contains the item quantity.",
"type": "integer",
"format": "int32"
}
}
},
"FulfillmentShipmentItemList": {
"description": "A list of fulfillment shipment item information.",
"type": "array",
"items": {
"$ref": "#/definitions/FulfillmentShipmentItem"
}
},
"FulfillmentShipmentList": {
"description": "A list of fulfillment shipment information.",
"type": "array",
"items": {
"$ref": "#/definitions/FulfillmentShipment"
}
},
"FulfillmentShipmentPackage": {
"description": "Package information for a shipment in a fulfillment order.",
"type": "object",
"required": [
"CarrierCode",
"PackageNumber"
],
"properties": {
"PackageNumber": {
"description": "Identifies a package in a shipment.",
"type": "integer",
"format": "int32"
},
"CarrierCode": {
"description": "Identifies the carrier who will deliver the shipment to the recipient.",
"type": "string"
},
"TrackingNumber": {
"description": "The tracking number, if provided, can be used to obtain tracking and delivery information.",
"type": "string"
},
"EstimatedArrivalDateTime": {
"description": "The estimated arrival date and time of the package, in ISO 8601 date time format.",
"$ref": "#/definitions/Timestamp"
}
}
},
"FulfillmentShipmentPackageList": {
"description": "A list of fulfillment shipment package information.",
"type": "array",
"items": {
"$ref": "#/definitions/FulfillmentShipmentPackage"
}
},
"GetFulfillmentOrderResult": {
"type": "object",
"required": [
"FulfillmentOrder",
"FulfillmentOrderItem",
"ReturnAuthorizationList",
"ReturnItemList"
],
"properties": {
"FulfillmentOrder": {
"$ref": "#/definitions/FulfillmentOrder"
},
"FulfillmentOrderItem": {
"$ref": "#/definitions/FulfillmentOrderItemList"
},
"FulfillmentShipment": {
"$ref": "#/definitions/FulfillmentShipmentList"
},
"ReturnItemList": {
"$ref": "#/definitions/ReturnItemList"
},
"ReturnAuthorizationList": {
"$ref": "#/definitions/ReturnAuthorizationList"
}
}
},
"GetFulfillmentOrderResponse": {
"description": "The response schema for the getFulfillmentOrder operation.",
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getFulfillmentOrder operation.",
"$ref": "#/definitions/GetFulfillmentOrderResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the getFulfillmentOrder operation.",
"$ref": "#/definitions/ErrorList"
}
}
},
"GetFulfillmentPreviewItem": {
"description": "Item information for 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 that the seller creates to track items in the fulfillment preview.",
"type": "string",
"maxLength": 50
}
}
},
"GetFulfillmentPreviewItemList": {
"description": "A list of fulfillment preview item information.",
"type": "array",
"items": {
"$ref": "#/definitions/GetFulfillmentPreviewItem"
}
},
"GetFulfillmentPreviewRequest": {
"type": "object",
"required": [
"Address",
"Items"
],
"properties": {
"MarketplaceId": {
"description": "The marketplace the fulfillment order is placed against.",
"type": "string"
},
"Address": {
"description": "The destination address for the fulfillment order preview.",
"$ref": "#/definitions/Address"
},
"Items": {
"description": "Identifying information and quantity information for the items in the fulfillment order preview.",
"$ref": "#/definitions/GetFulfillmentPreviewItemList"
},
"ShippingSpeedCategories": {
"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.",
"$ref": "#/definitions/ShippingSpeedCategoryList"
},
"IncludeCODFulfillmentPreview": {
"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.",
"$ref": "#/definitions/GetFulfillmentPreviewResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the getFulfillmentPreview operation.",
"$ref": "#/definitions/ErrorList"
}
}
},
"InvalidItemReasonCode": {
"description": "A code for why the item is invalid for return.",
"type": "string",
"enum": [
"InvalidValues",
"DuplicateRequest",
"NoCompletedShipItems",
"NoReturnableQuantity"
],
"x-docgen-enum-table-extension": [
{
"value": "InvalidValues",
"description": "The item was not found in a fulfillment order."
},
{
"value": "DuplicateRequest",
"description": "A fulfillment return has already been requested for this item."
},
{
"value": "NoCompletedShipItems",
"description": "The fulfillment order containing this item has not yet shipped."
},
{
"value": "NoReturnableQuantity",
"description": "All item quantity available for return has been allocated to other return items."
}
]
},
"InvalidItemReason": {
"description": "The reason that the item is invalid for return.",
"type": "object",
"required": [
"Description",
"InvalidItemReasonCode"
],
"properties": {
"InvalidItemReasonCode": {
"$ref": "#/definitions/InvalidItemReasonCode"
},
"Description": {
"description": "A human readable description of the invalid item reason code.",
"type": "string"
}
}
},
"InvalidReturnItem": {
"description": "An item that is invalid for return.",
"type": "object",
"required": [
"InvalidItemReason",
"SellerFulfillmentOrderItemId",
"SellerReturnItemId"
],
"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"
},
"InvalidItemReason": {
"$ref": "#/definitions/InvalidItemReason"
}
}
},
"InvalidReturnItemList": {
"description": "A list of invalid return item information.",
"type": "array",
"items": {
"$ref": "#/definitions/InvalidReturnItem"
}
},
"ListAllFulfillmentOrdersResult": {
"type": "object",
"properties": {
"NextToken": {
"description": "When present and not empty, pass this string token in the next request to return the next response page.",
"type": "string"
},
"FulfillmentOrders": {
"description": "A list of fulfillment order information.",
"$ref": "#/definitions/FulfillmentOrderList"
}
}
},
"ListAllFulfillmentOrdersResponse": {
"description": "The response schema for the listAllFulfillmentOrders operation.",
"type": "object",
"properties": {
"payload": {
"description": "The payload for the listAllFulfillmentOrders operation.",
"$ref": "#/definitions/ListAllFulfillmentOrdersResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the listAllFulfillmentOrders operation.",
"$ref": "#/definitions/ErrorList"
}
}
},
"ListReturnReasonCodesResult": {
"type": "object",
"properties": {
"ReasonCodeDetailsList": {
"$ref": "#/definitions/ReasonCodeDetailsList"
}
}
},
"ListReturnReasonCodesResponse": {
"description": "The response schema for the listReturnReasonCodes operation.",
"type": "object",
"properties": {
"payload": {
"description": "The payload for the listReturnReasonCodes operation.",
"$ref": "#/definitions/ListReturnReasonCodesResult"
},
"errors": {
"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.",
"type": "array",
"items": {
"type": "string",
"maxLength": 64
}
},
"CurrentStatus": {
"description": "The current delivery status of the package.",
"type": "string",
"enum": [
"IN_TRANSIT",
"DELIVERED",
"RETURNING",
"RETURNED",
"UNDELIVERABLE",
"DELAYED",
"AVAILABLE_FOR_PICKUP",
"CUSTOMER_ACTION"
],
"x-docgen-enum-table-extension": [
{
"value": "IN_TRANSIT",
"description": "In transit to the destination address."
},
{
"value": "DELIVERED",
"description": "Delivered to the destination address."
},
{
"value": "RETURNING",
"description": "In the process of being returned to Amazon's fulfillment network."
},
{
"value": "RETURNED",
"description": "Returned to Amazon's fulfillment network."
},
{
"value": "UNDELIVERABLE",
"description": "Undeliverable because package was lost or destroyed."
},
{
"value": "DELAYED",
"description": "Delayed."
},
{
"value": "AVAILABLE_FOR_PICKUP",
"description": "Available for pickup."
},
{
"value": "CUSTOMER_ACTION",
"description": "Requires customer action."
}
]
},
"AdditionalLocationInfo": {
"description": "Additional location information.",
"type": "string",
"enum": [
"AS_INSTRUCTED",
"CARPORT",
"CUSTOMER_PICKUP",
"DECK",
"DOOR_PERSON",
"FRONT_DESK",
"FRONT_DOOR",
"GARAGE",
"GUARD",
"MAIL_ROOM",
"MAIL_SLOT",
"MAILBOX",
"MC_BOY",
"MC_GIRL",
"MC_MAN",
"MC_WOMAN",
"NEIGHBOR",
"OFFICE",
"OUTBUILDING",
"PATIO",
"PORCH",
"REAR_DOOR",
"RECEPTIONIST",
"RECEIVER",
"SECURE_LOCATION",
"SIDE_DOOR"
],
"x-docgen-enum-table-extension": [
{
"value": "AS_INSTRUCTED",
"description": "As instructed."
},
{
"value": "CARPORT",
"description": "Carport."
},
{
"value": "CUSTOMER_PICKUP",
"description": "Picked up by customer."
},
{
"value": "DECK",
"description": "Deck."
},
{
"value": "DOOR_PERSON",
"description": "Resident."
},
{
"value": "FRONT_DESK",
"description": "Front desk."
},
{
"value": "FRONT_DOOR",
"description": "Front door."
},
{
"value": "GARAGE",
"description": "Garage."
},
{
"value": "GUARD",
"description": "Residential guard."
},
{
"value": "MAIL_ROOM",
"description": "Mail room."
},
{
"value": "MAIL_SLOT",
"description": "Mail slot."
},
{
"value": "MAILBOX",
"description": "Mailbox."
},
{
"value": "MC_BOY",
"description": "Delivered to male child."
},
{
"value": "MC_GIRL",
"description": "Delivered to female child."
},
{
"value": "MC_MAN",
"description": "Delivered to male adult."
},
{
"value": "MC_WOMAN",
"description": "Delivered to female adult."
},
{
"value": "NEIGHBOR",
"description": "Delivered to neighbor."
},
{
"value": "OFFICE",
"description": "Office."
},
{
"value": "OUTBUILDING",
"description": "Outbuilding."
},
{
"value": "PATIO",
"description": "Patio."
},
{
"value": "PORCH",
"description": "Porch."
},
{
"value": "REAR_DOOR",
"description": "Rear door."
},
{
"value": "RECEPTIONIST",
"description": "Receptionist."
},
{
"value": "RECEIVER",
"description": "Resident."
},
{
"value": "SECURE_LOCATION",
"description": "Secure location."
},
{
"value": "SIDE_DOOR",
"description": "Side door."
}
]
},
"PackageTrackingDetails": {
"type": "object",
"required": [
"PackageNumber"
],
"properties": {
"PackageNumber": {
"description": "The package identifier.",
"type": "integer",
"format": "int32"
},
"TrackingNumber": {
"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 carriers 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.",
"$ref": "#/definitions/FulfillmentReturnItemStatus"
},
"StatusChangedDate": {
"description": "Indicates when the status last changed.",
"$ref": "#/definitions/Timestamp"
},
"ReturnAuthorizationId": {
"description": "Identifies the return authorization used to return this item. See ReturnAuthorization.",
"type": "string"
},
"ReturnReceivedCondition": {
"$ref": "#/definitions/ReturnItemDisposition"
},
"FulfillmentCenterId": {
"description": "The identifier for the Amazon fulfillment center that processed the return item.",
"type": "string"
}
}
},
"ReturnItemDisposition": {
"description": "The condition of the return item when received by an Amazon fulfillment center.",
"type": "string",
"enum": [
"Sellable",
"Defective",
"CustomerDamaged",
"CarrierDamaged",
"FulfillerDamaged"
],
"x-docgen-enum-table-extension": [
{
"value": "Sellable",
"description": "Item is in sellable condition."
},
{
"value": "Defective",
"description": "Item is defective."
},
{
"value": "CustomerDamaged",
"description": "Item was damaged by the buyer or the seller."
},
{
"value": "CarrierDamaged",
"description": "Item was damaged by the carrier."
},
{
"value": "FulfillerDamaged",
"description": "Item was damaged by Amazon."
}
]
},
"ReturnItemList": {
"description": "A list of items that Amazon accepted for return. Returns empty if no items were accepted for return.",
"type": "array",
"items": {
"$ref": "#/definitions/ReturnItem"
}
},
"ScheduledDeliveryInfo": {
"description": "Delivery information for a Scheduled Delivery.",
"type": "object",
"required": [
"DeliveryTimeZone",
"DeliveryWindows"
],
"properties": {
"DeliveryTimeZone": {
"description": "The time zone of the destination address for the fulfillment order preview. Must be an IANA time zone name. Example: Asia/Tokyo.",
"type": "string"
},
"DeliveryWindows": {
"description": "A list of time ranges that are available for Scheduled Delivery.",
"$ref": "#/definitions/DeliveryWindowList"
}
}
},
"ShippingSpeedCategoryList": {
"type": "array",
"items": {
"$ref": "#/definitions/ShippingSpeedCategory"
}
},
"StringList": {
"type": "array",
"items": {
"type": "string"
}
},
"Timestamp": {
"type": "string",
"format": "date-time"
},
"TrackingAddress": {
"description": "Address information for tracking the package.",
"type": "object",
"required": [
"City",
"Country",
"State"
],
"properties": {
"City": {
"description": "The city.",
"type": "string",
"maxLength": 150
},
"State": {
"description": "The state.",
"type": "string",
"maxLength": 150
},
"Country": {
"description": "The country.",
"type": "string",
"maxLength": 6
}
}
},
"EventCode": {
"description": "The event code for the delivery event.",
"type": "string",
"enum": [
"EVENT_101",
"EVENT_102",
"EVENT_201",
"EVENT_202",
"EVENT_203",
"EVENT_204",
"EVENT_205",
"EVENT_206",
"EVENT_301",
"EVENT_302",
"EVENT_304",
"EVENT_306",
"EVENT_307",
"EVENT_308",
"EVENT_309",
"EVENT_401",
"EVENT_402",
"EVENT_403",
"EVENT_404",
"EVENT_405",
"EVENT_406",
"EVENT_407",
"EVENT_408",
"EVENT_409",
"EVENT_411",
"EVENT_412",
"EVENT_413",
"EVENT_414",
"EVENT_415",
"EVENT_416",
"EVENT_417",
"EVENT_418",
"EVENT_419"
],
"x-docgen-enum-table-extension": [
{
"value": "EVENT_101",
"description": "Carrier notified to pick up package."
},
{
"value": "EVENT_102",
"description": "Shipment picked up from seller's facility."
},
{
"value": "EVENT_201",
"description": "Arrival scan."
},
{
"value": "EVENT_202",
"description": "Departure scan."
},
{
"value": "EVENT_203",
"description": "Arrived at destination country."
},
{
"value": "EVENT_204",
"description": "Initiated customs clearance process."
},
{
"value": "EVENT_205",
"description": "Completed customs clearance process."
},
{
"value": "EVENT_206",
"description": "In transit to pickup location."
},
{
"value": "EVENT_301",
"description": "Delivered."
},
{
"value": "EVENT_302",
"description": "Out for delivery."
},
{
"value": "EVENT_304",
"description": "Delivery attempted."
},
{
"value": "EVENT_306",
"description": "Customer contacted to arrange delivery."
},
{
"value": "EVENT_307",
"description": "Delivery appointment scheduled."
},
{
"value": "EVENT_308",
"description": "Available for pickup."
},
{
"value": "EVENT_309",
"description": "Returned to seller."
},
{
"value": "EVENT_401",
"description": "Held by carrier - incorrect address."
},
{
"value": "EVENT_402",
"description": "Customs clearance delay."
},
{
"value": "EVENT_403",
"description": "Customer moved."
},
{
"value": "EVENT_404",
"description": "Delay in delivery due to external factors."
},
{
"value": "EVENT_405",
"description": "Shipment damaged."
},
{
"value": "EVENT_406",
"description": "Held by carrier."
},
{
"value": "EVENT_407",
"description": "Customer refused delivery."
},
{
"value": "EVENT_408",
"description": "Returning to seller."
},
{
"value": "EVENT_409",
"description": "Lost by carrier."
},
{
"value": "EVENT_411",
"description": "Paperwork received - did not receive shipment."
},
{
"value": "EVENT_412",
"description": "Shipment received - did not receive paperwork."
},
{
"value": "EVENT_413",
"description": "Held by carrier - customer refused shipment due to customs charges."
},
{
"value": "EVENT_414",
"description": "Missorted by carrier."
},
{
"value": "EVENT_415",
"description": "Received from prior carrier."
},
{
"value": "EVENT_416",
"description": "Undeliverable."
},
{
"value": "EVENT_417",
"description": "Shipment missorted."
},
{
"value": "EVENT_418",
"description": "Shipment delayed."
},
{
"value": "EVENT_419",
"description": "Address corrected - delivery rescheduled."
}
]
},
"TrackingEvent": {
"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.",
"$ref": "#/definitions/UpdateFulfillmentOrderItemList"
}
}
},
"UpdateFulfillmentOrderResponse": {
"description": "The response schema for the updateFulfillmentOrder operation.",
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the updateFulfillmentOrder operation.",
"$ref": "#/definitions/ErrorList"
}
}
},
"CreateFulfillmentOrderResponse": {
"description": "The response schema for the createFulfillmentOrder operation.",
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the createFulfillmentOrder operation.",
"$ref": "#/definitions/ErrorList"
}
}
},
"CancelFulfillmentOrderResponse": {
"description": "The response schema for the cancelFulfillmentOrder operation.",
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the cancelFulfillmentOrder operation.",
"$ref": "#/definitions/ErrorList"
}
}
},
"Weight": {
"type": "object",
"required": [
"Unit",
"Value"
],
"properties": {
"Unit": {
"description": "The unit of weight.",
"type": "string",
"enum": [
"KG",
"LB"
],
"x-docgen-enum-table-extension": [
{
"value": "KG",
"description": "Kilograms."
},
{
"value": "LB",
"description": "Pounds."
}
]
},
"Value": {
"description": "The weight value.",
"type": "string"
}
}
},
"boolean": {
"type": "boolean"
},
"Quantity": {
"description": "The item quantity.",
"type": "integer",
"format": "int32"
},
"ShippingSpeedCategory": {
"description": "The shipping method used for the fulfillment order.",
"type": "string",
"enum": [
"Standard",
"Expedited",
"Priority",
"ScheduledDelivery"
],
"x-docgen-enum-table-extension": [
{
"value": "Standard",
"description": "Standard shipping method."
},
{
"value": "Expedited",
"description": "Expedited shipping method."
},
{
"value": "Priority",
"description": "Priority shipping method."
},
{
"value": "ScheduledDelivery",
"description": "Scheduled Delivery shipping method."
}
]
}
}
}