Fulfillment Outbound API v2020-07-01 Model
Swagger model for Fulfillment Outbound API v2020-07-01.
{
"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": "2020-07-01",
"title": "Selling Partner APIs 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/2020-07-01/fulfillmentOrders/preview": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getFulfillmentPreview",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/GetFulfillmentPreviewRequest"
},
"description": "GetFulfillmentPreviewRequest parameter"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetFulfillmentPreviewResponse"
},
"examples": {
"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",
"featureConstraints": [
{
"featureName": "BLANK_BOX",
"featureFulfillmentPolicy": "NotRequired"
},
{
"featureName": "BLOCK_AMZL",
"featureFulfillmentPolicy": "Required"
}
]
}
]
}
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetFulfillmentPreviewResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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."
}
}
}
}
}
},
"/fba/outbound/2020-07-01/deliveryOffers": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"post": {
"tags": [
"fbaOutbound"
],
"description": "Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "deliveryOffers",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/GetDeliveryOffersRequest"
},
"description": "GetDeliveryOffersRequest parameter"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetDeliveryOffersResponse"
},
"examples": {
"payload": {
"deliveryOffers": [{
"expiresAt": "2023-10-11T18:00:00Z",
"dateRange": {
"earliest": "2023-10-13T10:00:00Z",
"latest": "2023-10-14T16:00:00Z"
},
"policy": {
"messaging": {
"text": "Get it as soon as Wed, Aug 23",
"locale": "en_US"
}
}
}]
}
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetDeliveryOffersResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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/GetDeliveryOffersResponse"
},
"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/GetDeliveryOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetDeliveryOffersResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetDeliveryOffersResponse"
},
"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/GetDeliveryOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetDeliveryOffersResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/outbound/2020-07-01/fulfillmentOrders": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)",
"operationId": "listAllFulfillmentOrders",
"parameters": [
{
"name": "queryStartDate",
"in": "query",
"description": "A date 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.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "nextToken",
"in": "query",
"description": "A string token returned in the response to your previous request.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/ListAllFulfillmentOrdersResponse"
},
"examples": {
"payload": {
"fulfillmentOrders": [
{
"sellerFulfillmentOrderId": "902-6018020-0202003",
"displayableOrderId": "mws-test-query-20100713023203751",
"displayableOrderDate": "2020-01-09T19:46:45Z",
"displayableOrderComment": "TestOrder",
"shippingSpeedCategory": "Standard",
"destinationAddress": {
"name": "Amazon",
"addressLine1": "1234 Amazon Way",
"addressLine2": "Suite 123",
"addressLine3": "Lane1",
"city": "Troy",
"stateOrRegion": "MI",
"countryCode": "US",
"postalCode": "48084"
},
"fulfillmentPolicy": "FillOrKill",
"receivedDate": "2020-01-21T21:07:13Z",
"fulfillmentOrderStatus": "RECEIVED",
"statusUpdatedDate": "2020-01-21T21:07:30Z",
"featureConstraints": [
{
"featureName": "BLANK_BOX",
"featureFulfillmentPolicy": "Required"
},
{
"featureName": "BLOCK_AMZL",
"featureFulfillmentPolicy": "Required"
}
]
},
{
"sellerFulfillmentOrderId": "601-2020200-12345678",
"displayableOrderId": "TestOrder-FBAOutbound",
"displayableOrderDate": "2020-01-09T19:46:45Z",
"displayableOrderComment": "TestOrder",
"shippingSpeedCategory": "Standard",
"destinationAddress": {
"name": "Amazon",
"addressLine1": "1234 Amazon Way",
"addressLine2": "Suite 123",
"addressLine3": "Lane1",
"city": "Troy",
"stateOrRegion": "MI",
"countryCode": "US",
"postalCode": "48084"
},
"fulfillmentPolicy": "FillOrKill",
"receivedDate": "2020-01-23T19:56:41Z",
"fulfillmentOrderStatus": "COMPLETE",
"statusUpdatedDate": "2020-01-24T15:28:27Z",
"featureConstraints": null
}
]
}
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/ListAllFulfillmentOrdersResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)",
"operationId": "createFulfillmentOrder",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateFulfillmentOrderRequest"
},
"description": "CreateFulfillmentOrderRequest parameter"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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."
}
}
}
}
}
},
"/fba/outbound/2020-07-01/tracking": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getPackageTrackingDetails",
"parameters": [
{
"name": "packageNumber",
"in": "query",
"description": "The unencrypted package identifier returned by the `getFulfillmentOrder` operation.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetPackageTrackingDetailsResponse"
},
"examples": {
"payload": {
"packageNumber": 212794778,
"trackingNumber": "1Z50V7420354708051",
"customerTrackingLink": "https%3A%2F%2Fwww.swiship.com%2Ftrack%3Fid%3D1Z50V7420354708051%0A",
"carrierCode": "UPS",
"shipToAddress": {
"name": "Amazon",
"addressLine1": "1234 Amazon Way",
"addressLine2": "Suite 123",
"addressLine3": "Lane1",
"city": "Troy",
"stateOrRegion": "MI",
"countryCode": "US",
"postalCode": "48084"
},
"currentStatus": "DELIVERED",
"currentStatusDescription": "Delivered to the destination address",
"additionalLocationInfo": "AS_INSTRUCTED",
"trackingEvents": [
{
"eventDate": "2020-01-22T00:15:55Z",
"eventAddress": {
"city": "Troy",
"state": "MI",
"country": "US"
},
"eventCode": "EVENT_301",
"eventDescription": "Delivered."
},
{
"eventDate": "2019-10-30T23:33:28Z",
"eventAddress": {
"city": "Phoenix",
"state": "AZ",
"country": "US"
},
"eventCode": "EVENT_206",
"eventDescription": "In transit to pickup location"
}
]
}
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetPackageTrackingDetailsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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."
}
}
}
}
}
},
"/fba/outbound/2020-07-01/returnReasonCodes": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"get": {
"tags": [
"fbaOutbound"
],
"description": "Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "listReturnReasonCodes",
"parameters": [
{
"name": "sellerSku",
"in": "query",
"description": "The seller SKU for which return reason codes are required.",
"required": true,
"type": "string"
},
{
"name": "marketplaceId",
"in": "query",
"description": "The marketplace for which the seller wants return reason codes.",
"required": false,
"type": "string"
},
{
"name": "sellerFulfillmentOrderId",
"in": "query",
"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.",
"required": false,
"type": "string"
},
{
"name": "language",
"in": "query",
"description": "The language that the `TranslatedDescription` property of the `ReasonCodeDetails` response object should be translated into.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/ListReturnReasonCodesResponse"
},
"examples": {
"payload": {
"reasonCodeDetails": [
{
"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"
}
]
}
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/ListReturnReasonCodesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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."
}
}
}
}
}
},
"/fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/return": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"put": {
"tags": [
"fbaOutbound"
],
"description": "Creates a fulfillment return.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "createFulfillmentReturn",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateFulfillmentReturnRequest"
},
"description": "CreateFulfillmentReturnRequest parameter"
},
{
"name": "sellerFulfillmentOrderId",
"in": "path",
"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.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentReturnResponse"
},
"examples": {
"payload": {
"returnItems": [
{
"sellerReturnItemId": "testReturn11",
"sellerFulfillmentOrderItemId": "OrderItemID2",
"amazonShipmentId": "D4yZjWZVN",
"returnComment": "TestReturn",
"amazonReturnReasonCode": "UNKNOWN_OTHER_REASON",
"status": "New",
"statusChangedDate": "2020-02-07T04:14:38Z",
"returnAuthorizationId": "RMA3JTIPBJM42UU6"
}
],
"invalidReturnItems": [],
"returnAuthorizations": [
{
"returnAuthorizationId": "RMA3JTIPBJM42UU6",
"fulfillmentCenterId": "TUS1",
"returnToAddress": {
"name": "Returns Department",
"addressLine1": "5333 W. Lower Buckeye Road",
"districtOrCounty": "US",
"city": "Phoenix",
"stateOrRegion": "AZ",
"countryCode": "US",
"postalCode": "85043"
},
"amazonRmaId": "D50WttPHRRMA",
"rmaPageURL": "https://www.amazon.com/gp/orc/rml/D50WttPHRRMA"
}
]
}
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/CreateFulfillmentReturnResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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."
}
}
}
}
}
},
"/fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getFulfillmentOrder",
"parameters": [
{
"name": "sellerFulfillmentOrderId",
"in": "path",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created.",
"required": true,
"type": "string",
"maxLength": 40
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetFulfillmentOrderResponse"
},
"examples": {
"payload": {
"fulfillmentOrder": {
"sellerFulfillmentOrderId": "FBATestOrder-1",
"marketplaceId": "ATVPDKIKX0DER",
"displayableOrderId": "TestOrder-FBAOutbound",
"displayableOrderDate": "2020-01-09T19:46:45Z",
"displayableOrderComment": "TestOrder",
"shippingSpeedCategory": "Standard",
"destinationAddress": {
"name": "Amazon",
"addressLine1": "1234 Amazon Way",
"addressLine2": "Suite 123",
"addressLine3": "Lane1",
"city": "Troy",
"stateOrRegion": "MI",
"countryCode": "US",
"postalCode": "48084"
},
"fulfillmentAction": "Ship",
"fulfillmentPolicy": "FillOrKill",
"receivedDate": "2020-02-07T01:23:30Z",
"fulfillmentOrderStatus": "PROCESSING",
"statusUpdatedDate": "2020-02-07T02:33:31Z",
"notificationEmails": [
"[email protected]",
"[email protected]"
]
},
"fulfillmentOrderItems": [
{
"sellerSku": "PSMM-TEST-SKU-Jan-21_19_59_44-0738",
"sellerFulfillmentOrderItemId": "OrderItemID2",
"quantity": 1,
"fulfillmentNetworkSku": "B07CGHKWZP",
"orderItemDisposition": "Sellable",
"cancelledQuantity": 0,
"unfulfillableQuantity": 0,
"estimatedShipDate": "2020-02-08T01:23:31Z",
"estimatedArrivalDate": "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,
"estimatedShipDate": "2020-02-08T01:23:31Z",
"estimatedArrivalDate": "2020-02-15T01:23:31Z",
"perUnitDeclaredValue": {
"currencyCode": "USD",
"value": "2.00"
}
}
],
"fulfillmentShipments": [
{
"amazonShipmentId": "DchKfcZ9N",
"fulfillmentCenterId": "RNO1",
"fulfillmentShipmentStatus": "PENDING",
"shippingDate": "2020-02-07T02:33:23Z",
"estimatedArrivalDate": "2020-02-07T02:33:23Z",
"fulfillmentShipmentItem": [
{
"sellerSku": "PSMM-TEST-SKU-Jan-21_19_59_44-0738",
"sellerFulfillmentOrderItemId": "OrderItemID2",
"quantity": 1,
"packageNumber": 0,
"serialNumber": "a1b2c"
},
{
"sellerSku": "CR-47K6-H6QN",
"sellerFulfillmentOrderItemId": "OrderItemID1",
"quantity": 3,
"packageNumber": 0,
"serialNumber": "",
"manufacturerLotCodes": ["LOT0822-1234", "LOT1030-5678"]
}
]
}
],
"returnItems": [],
"returnAuthorizations": []
}
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "updateFulfillmentOrder",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateFulfillmentOrderRequest"
},
"description": "UpdateFulfillmentOrderRequest parameter"
},
{
"name": "sellerFulfillmentOrderId",
"in": "path",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created.",
"required": true,
"type": "string",
"maxLength": 40
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/UpdateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/UpdateFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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."
}
}
}
}
}
},
"/fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/cancel": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "cancelFulfillmentOrder",
"parameters": [
{
"name": "sellerFulfillmentOrderId",
"in": "path",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created.",
"required": true,
"type": "string",
"maxLength": 40
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/CancelFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/CancelFulfillmentOrderResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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."
}
}
}
}
}
},
"/fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/status": {
"x-amzn-api-sandbox-only": true,
"x-amzn-api-sandbox": {
"dynamic": {}
},
"put": {
"tags": [
"fbaOutbound"
],
"description": "Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.",
"operationId": "submitFulfillmentOrderStatusUpdate",
"parameters": [
{
"name": "sellerFulfillmentOrderId",
"in": "path",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created.",
"required": true,
"type": "string",
"maxLength": 40
},
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateRequest"
},
"description": "The identifier assigned to the item by the seller when the fulfillment order was created."
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateResponse"
},
"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/SubmitFulfillmentOrderStatusUpdateResponse"
},
"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/SubmitFulfillmentOrderStatusUpdateResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateResponse"
},
"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/SubmitFulfillmentOrderStatusUpdateResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/outbound/2020-07-01/features": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"get": {
"tags": [
"fbaOutbound"
],
"description": "Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getFeatures",
"parameters": [
{
"name": "marketplaceId",
"in": "query",
"description": "The marketplace for which to return the list of features.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetFeaturesResponse"
},
"examples": {
"payload": {
"features": [
{
"featureName": "BLANK_BOX",
"featureDescription": "Provides the ability to ship in non-Amazon branded packaging (blank boxes).",
"sellerEligible": true
},
{
"featureName": "PSLIP",
"featureDescription": "Provides the ability to insert customized packing slips with messages.",
"sellerEligible": true
}
],
"schema": null
}
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetFeaturesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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/GetFeaturesResponse"
},
"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/GetFeaturesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetFeaturesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetFeaturesResponse"
},
"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/GetFeaturesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetFeaturesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/outbound/2020-07-01/features/inventory/{featureName}": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"get": {
"tags": [
"fbaOutbound"
],
"description": "Returns a list of inventory items that are eligible for the fulfillment feature you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..",
"operationId": "getFeatureInventory",
"parameters": [
{
"name": "marketplaceId",
"in": "query",
"description": "The marketplace for which to return a list of the inventory that is eligible for the specified feature.",
"required": true,
"type": "string"
},
{
"name": "featureName",
"in": "path",
"description": "The name of the feature for which to return a list of eligible inventory.",
"required": true,
"type": "string"
},
{
"name": "nextToken",
"in": "query",
"description": "A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.",
"required": false,
"type": "string"
},
{
"name": "queryStartDate",
"in": "query",
"description": "A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ",
"required": false,
"type": "string",
"format": "date-time"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetFeatureInventoryResponse"
},
"examples": {
"payload": {
"marketplaceId": "ATVPDKIKX0DER",
"featureName": "TEST_FEATURE",
"nextToken": null,
"featureSkus": [
{
"sellerSku": "sellerSku1",
"fnSku": "fnSku",
"asin": "asin",
"skuCount": 23,
"overlappingSkus": [
"sellerSku2",
"sellerSku3",
"sellerSku4"
]
},
{
"sellerSku": "sellerSku2",
"fnSku": "sadf",
"asin": "ssss",
"skuCount": 1,
"overlappingSkus": [
"sellerSku1",
"sellerSku3",
"sellerSku4"
]
}
]
}
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetFeatureInventoryResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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/GetFeatureInventoryResponse"
},
"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/GetFeatureInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetFeatureInventoryResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetFeatureInventoryResponse"
},
"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/GetFeatureInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetFeatureInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/outbound/2020-07-01/features/inventory/{featureName}/{sellerSku}": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"get": {
"tags": [
"fbaOutbound"
],
"description": "Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn't eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getFeatureSKU",
"parameters": [
{
"name": "marketplaceId",
"in": "query",
"description": "The marketplace for which to return the count.",
"required": true,
"type": "string"
},
{
"name": "featureName",
"in": "path",
"description": "The name of the feature.",
"required": true,
"type": "string"
},
{
"name": "sellerSku",
"in": "path",
"description": "Used to identify an item in the given marketplace. `SellerSKU` is qualified by the seller's `SellerId`, which is included with every operation that you submit.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetFeatureSkuResponse"
},
"examples": {
"payload": {
"marketplaceId": "ATVPDKIKX0DER",
"featureName": "BLANK_BOX",
"isEligible": true,
"ineligibleReasons": [],
"skuInfo": {
"sellerSku": "TEST_SKU",
"fnSku": "TEST_fnSku",
"asin": "TEST_asin",
"skuCount": 33
}
}
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetFeatureSkuResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"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/GetFeatureSkuResponse"
},
"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/GetFeatureSkuResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetFeatureSkuResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetFeatureSkuResponse"
},
"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/GetFeatureSkuResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetFeatureSkuResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
}
},
"definitions": {
"Error": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "An error code that identifies the type of error that occurred."
},
"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": [
"addressLine1",
"countryCode",
"stateOrRegion",
"name",
"postalCode"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the person, business or institution at the address."
},
"addressLine1": {
"type": "string",
"description": "The first line of the address."
},
"addressLine2": {
"type": "string",
"description": "Additional address information, if required."
},
"addressLine3": {
"type": "string",
"description": "Additional address information, if required."
},
"city": {
"type": "string",
"description": "The city where the person, business, or institution is located. This property is required in all countries except Japan. It should not be used in Japan."
},
"districtOrCounty": {
"type": "string",
"description": "The district or county where the person, business, or institution is located."
},
"stateOrRegion": {
"type": "string",
"description": "The state or region where the person, business or institution is located."
},
"postalCode": {
"type": "string",
"description": "The postal code of the address."
},
"countryCode": {
"type": "string",
"description": "The two digit country code. In ISO 3166-1 alpha-2 format."
},
"phone": {
"type": "string",
"description": "The phone number of the person, business, or institution located at the address."
}
},
"description": "A physical address."
},
"CODSettings": {
"type": "object",
"required": [
"isCodRequired"
],
"properties": {
"isCodRequired": {
"type": "boolean",
"description": "When true, this fulfillment order requires a COD (Cash On Delivery) payment."
},
"codCharge": {
"description": "The amount of the COD charge to be collected from the recipient for a COD order.",
"$ref": "#/definitions/Money"
},
"codChargeTax": {
"description": "The amount of the tax on the COD charge to be collected from the recipient for a COD order.",
"$ref": "#/definitions/Money"
},
"shippingCharge": {
"description": "The amount of the tax on the COD charge to be collected from the recipient for a COD order.",
"$ref": "#/definitions/Money"
},
"shippingChargeTax": {
"description": "The amount of the tax on the shipping charge to be collected from the recipient for a COD order.",
"$ref": "#/definitions/Money"
}
},
"description": "The COD (Cash On Delivery) charges that you associate with a COD fulfillment order."
},
"CreateFulfillmentOrderItem": {
"type": "object",
"required": [
"quantity",
"sellerFulfillmentOrderItemId",
"sellerSku"
],
"properties": {
"sellerSku": {
"type": "string",
"description": "The seller SKU of the item.",
"maxLength": 50
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"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 `SellerSKU`. For example, the seller might assign different `SellerFulfillmentOrderItemId` values to two items in a fulfillment order that share the same `SellerSKU` but have different `GiftMessage` values.",
"maxLength": 50
},
"quantity": {
"$ref": "#/definitions/Quantity"
},
"giftMessage": {
"type": "string",
"description": "A message to the gift recipient, if applicable.",
"maxLength": 512
},
"displayableComment": {
"type": "string",
"description": "Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.",
"maxLength": 250
},
"fulfillmentNetworkSku": {
"type": "string",
"description": "Amazon's fulfillment network SKU of the item."
},
"perUnitDeclaredValue": {
"description": "The monetary value assigned by the seller to this item. This is a required field for India MCF orders.",
"$ref": "#/definitions/Money"
},
"perUnitPrice": {
"description": "The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.",
"$ref": "#/definitions/Money"
},
"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/Money"
}
},
"description": "Item information for creating a fulfillment order."
},
"CreateFulfillmentOrderItemList": {
"type": "array",
"description": "An array of item information for creating a fulfillment order.",
"items": {
"$ref": "#/definitions/CreateFulfillmentOrderItem"
}
},
"FulfillmentPolicy": {
"type": "string",
"description": "The `FulfillmentPolicy` value specified when you submitted the `createFulfillmentOrder` operation.",
"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. Refer to the `FulfillmentShipment` object 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": {
"type": "string",
"description": "The current status of the fulfillment order.",
"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": {
"type": "object",
"required": [
"destinationAddress",
"displayableOrderComment",
"displayableOrderDate",
"displayableOrderId",
"items",
"sellerFulfillmentOrderId",
"shippingSpeedCategory"
],
"properties": {
"marketplaceId": {
"type": "string",
"description": "The marketplace the fulfillment order is placed against."
},
"sellerFulfillmentOrderId": {
"type": "string",
"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.",
"maxLength": 40
},
"displayableOrderId": {
"type": "string",
"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.",
"maxLength": 40
},
"displayableOrderDate": {
"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": {
"type": "string",
"description": "Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.",
"maxLength": 750
},
"shippingSpeedCategory": {
"description": "The shipping method for the fulfillment order. When this value is `ScheduledDelivery`, choose Ship for the `fulfillmentAction`. Hold is not a valid `fulfillmentAction` value when the `shippingSpeedCategory` value is `ScheduledDelivery`.\nNote: Shipping method service level agreements vary by marketplace. Sellers can refer to [Seller Central]( https://developer-docs.amazon.com/sp-api/docs/seller-central-urls) for shipping method service-level agreements and multi-channel fulfillment fees.",
"$ref": "#/definitions/ShippingSpeedCategory"
},
"deliveryWindow": {
"$ref": "#/definitions/DeliveryWindow"
},
"destinationAddress": {
"description": "The destination address for the fulfillment order.",
"$ref": "#/definitions/Address"
},
"deliveryPreferences": {
"description": "The delivery preferences applied to the destination address. These preferences are applied when possible and are best effort. For eligible orders, the default delivery preference is to leave the package unattended at the front door.\nThis feature is currently supported only in the JP marketplace and not applicable for other marketplaces.\nFor eligible orders, the default delivery preference will be to deliver the package unattended at the front door, unless you specify otherwise.",
"$ref": "#/definitions/DeliveryPreferences"
},
"fulfillmentAction": {
"$ref": "#/definitions/FulfillmentAction"
},
"fulfillmentPolicy": {
"$ref": "#/definitions/FulfillmentPolicy"
},
"codSettings": {
"$ref": "#/definitions/CODSettings"
},
"shipFromCountryCode": {
"type": "string",
"description": "The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format."
},
"notificationEmails": {
"$ref": "#/definitions/NotificationEmailList"
},
"featureConstraints": {
"type": "array",
"description": "A list of features and their fulfillment policies to apply to the order.",
"items": {
"$ref": "#/definitions/FeatureSettings"
}
},
"items": {
"description": "A list of items to include in the fulfillment order preview, including quantity. Maximum of 100 line items with a maximum of 250 units per order.",
"$ref": "#/definitions/CreateFulfillmentOrderItemList"
},
"paymentInformation": {
"description": "An array of various payment attributes related to this fulfillment order. This property is required if the order is placed against the India marketplace.",
"$ref": "#/definitions/PaymentInformationList"
}
},
"description": "The request body schema for the `createFulfillmentOrder` operation."
},
"CreateFulfillmentReturnRequest": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"$ref": "#/definitions/CreateReturnItemList"
}
},
"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."
},
"CreateFulfillmentReturnResult": {
"description": "The result for the createFulfillmentReturn operation.",
"type": "object",
"properties": {
"returnItems": {
"$ref": "#/definitions/ReturnItemList"
},
"invalidReturnItems": {
"$ref": "#/definitions/InvalidReturnItemList"
},
"returnAuthorizations": {
"$ref": "#/definitions/ReturnAuthorizationList"
}
}
},
"CreateFulfillmentReturnResponse": {
"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"
}
},
"description": "The response schema for the `createFulfillmentReturn` operation."
},
"CreateReturnItem": {
"type": "object",
"required": [
"amazonShipmentId",
"returnReasonCode",
"sellerFulfillmentOrderItemId",
"sellerReturnItemId"
],
"properties": {
"sellerReturnItemId": {
"type": "string",
"description": "An identifier assigned by the seller to the return item.",
"maxLength": 80
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created."
},
"amazonShipmentId": {
"type": "string",
"description": "The identifier for the shipment that is associated with the return item."
},
"returnReasonCode": {
"type": "string",
"description": "The return reason code assigned to the return item by the seller."
},
"returnComment": {
"type": "string",
"description": "An optional comment about the return item.",
"maxLength": 1000
}
},
"description": "An item that Amazon accepted for return."
},
"CreateReturnItemList": {
"type": "array",
"description": "An array of items to be returned.",
"items": {
"$ref": "#/definitions/CreateReturnItem"
}
},
"Money": {
"type": "object",
"required": [
"currencyCode",
"value"
],
"properties": {
"currencyCode": {
"type": "string",
"description": "Three digit currency code in ISO 4217 format."
},
"value": {
"$ref": "#/definitions/Decimal"
}
},
"description": "An amount of money, including units in the form of currency."
},
"Decimal": {
"type": "string",
"description": "A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation."
},
"DeliveryWindow": {
"type": "object",
"required": [
"endDate",
"startDate"
],
"properties": {
"startDate": {
"description": "The date and time of the start of the Scheduled Delivery window. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
},
"endDate": {
"description": "The date and time of the end of the Scheduled Delivery window. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
}
},
"description": "The time range within which a Scheduled Delivery fulfillment order should be delivered. This is only available in the JP marketplace."
},
"DeliveryWindowList": {
"type": "array",
"description": "An array of delivery windows.",
"items": {
"$ref": "#/definitions/DeliveryWindow"
}
},
"DeliveryPreferences": {
"type": "object",
"properties": {
"deliveryInstructions": {
"type": "string",
"description": "Additional delivery instructions. For example, this could be instructions on how to enter a building, nearby landmark or navigation instructions, 'Beware of dogs', etc.",
"maxLength": 250
},
"dropOffLocation": {
"description": "The preferred location to leave packages at the destination address.",
"$ref": "#/definitions/DropOffLocation"
}
},
"description": "The delivery preferences applied to the destination address. These preferences are applied when possible and are best effort.\nThis feature is currently supported only in the JP marketplace and not applicable for other marketplaces.\nFor eligible orders, the default delivery preference will be to deliver the package unattended at the front door, unless you specify otherwise."
},
"DropOffLocation": {
"type": "object",
"required": ["type"],
"properties": {
"type": {
"type": "string",
"description": "Specifies the preferred location to leave the package at the destination address.",
"enum": ["FRONT_DOOR", "DELIVERY_BOX", "GAS_METER_BOX", "BICYCLE_BASKET", "GARAGE", "RECEPTIONIST", "FALLBACK_NEIGHBOR_DELIVERY", "DO_NOT_LEAVE_UNATTENDED"],
"x-docgen-enum-table-extension": [{
"value": "FRONT_DOOR",
"description": "Indicates delivery preferred to front door."
}, {
"value": "DELIVERY_BOX",
"description": "Indicates delivery preferred to a delivery box."
}, {
"value": "GAS_METER_BOX",
"description": "Indicates delivery preferred to a gas meter box."
}, {
"value": "BICYCLE_BASKET",
"description": "Indicates delivery preferred to a bicycle basket."
}, {
"value": "GARAGE",
"description": "Indicates delivery preferred to a garage."
}, {
"value": "RECEPTIONIST",
"description": "Indicates delivery preferred with a receptionist."
}, {
"value": "FALLBACK_NEIGHBOR_DELIVERY",
"description": "Indicates delivery preferred with a designated neighbor if the recipient is not available at the destination address."
}, {
"value": "DO_NOT_LEAVE_UNATTENDED",
"description": "Indicates delivery preferred as attended."
}]
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Additional information about the drop-off location that can vary depending on the type of drop-off location specified in the `type` field.\nIf the `type` is set to `FALLBACK_NEIGHBOR_DELIVERY`, the `attributes` object should include the exact keys `neighborName` and `houseNumber` to provide the name and house number of the designated neighbor."
}
},
"description": "The preferred location to leave packages at the destination address."
},
"Fee": {
"type": "object",
"required": [
"amount",
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The type of fee.",
"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/Money"
}
},
"description": "Fee type and cost."
},
"FeeList": {
"type": "array",
"description": "An array of fee type and cost pairs.",
"items": {
"$ref": "#/definitions/Fee"
}
},
"FulfillmentAction": {
"type": "string",
"description": "Specifies whether the fulfillment order should ship now or have an order hold put on it.",
"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": {
"type": "object",
"required": [
"destinationAddress",
"displayableOrderComment",
"displayableOrderDate",
"displayableOrderId",
"fulfillmentOrderStatus",
"marketplaceId",
"receivedDate",
"sellerFulfillmentOrderId",
"shippingSpeedCategory",
"statusUpdatedDate"
],
"properties": {
"sellerFulfillmentOrderId": {
"type": "string",
"description": "The fulfillment order identifier submitted with the `createFulfillmentOrder` operation."
},
"marketplaceId": {
"type": "string",
"description": "The identifier for the marketplace the fulfillment order is placed against."
},
"displayableOrderId": {
"type": "string",
"description": "A fulfillment order identifier submitted with the `createFulfillmentOrder` operation. Displays as the order identifier in recipient-facing materials such as the packing slip."
},
"displayableOrderDate": {
"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": {
"type": "string",
"description": "A text block submitted with the `createFulfillmentOrder` operation. Displays in recipient-facing materials such as the packing slip."
},
"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"
},
"codSettings": {
"$ref": "#/definitions/CODSettings"
},
"receivedDate": {
"description": "The date and time that the fulfillment order was received by an Amazon fulfillment center.",
"$ref": "#/definitions/Timestamp"
},
"fulfillmentOrderStatus": {
"$ref": "#/definitions/FulfillmentOrderStatus"
},
"statusUpdatedDate": {
"description": "The date and time that the status of the fulfillment order last changed. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
},
"notificationEmails": {
"$ref": "#/definitions/NotificationEmailList"
},
"featureConstraints": {
"type": "array",
"description": "A list of features and their fulfillment policies to apply to the order.",
"items": {
"$ref": "#/definitions/FeatureSettings"
}
}
},
"description": "General information about a fulfillment order, including its status."
},
"FulfillmentOrderItem": {
"type": "object",
"required": [
"cancelledQuantity",
"quantity",
"sellerFulfillmentOrderItemId",
"sellerSku",
"unfulfillableQuantity"
],
"properties": {
"sellerSku": {
"type": "string",
"description": "The seller SKU of the item."
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "A fulfillment order item identifier submitted with a call to the `createFulfillmentOrder` operation."
},
"quantity": {
"$ref": "#/definitions/Quantity"
},
"giftMessage": {
"type": "string",
"description": "A message to the gift recipient, if applicable."
},
"displayableComment": {
"type": "string",
"description": "Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip."
},
"fulfillmentNetworkSku": {
"type": "string",
"description": "Amazon's fulfillment network SKU of the item."
},
"orderItemDisposition": {
"type": "string",
"description": "Indicates whether the item is sellable or unsellable."
},
"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"
},
"estimatedShipDate": {
"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, `estimatedShipDate` is not returned.",
"$ref": "#/definitions/Timestamp"
},
"estimatedArrivalDate": {
"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, `estimatedArrivalDate` 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/Money"
},
"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/Money"
},
"perUnitDeclaredValue": {
"description": "The monetary value assigned by the seller to this item. This is a required field for India MCF orders.",
"$ref": "#/definitions/Money"
}
},
"description": "Item information for a fulfillment order."
},
"FulfillmentOrderItemList": {
"type": "array",
"description": "An array of fulfillment order item information.",
"items": {
"$ref": "#/definitions/FulfillmentOrderItem"
}
},
"FulfillmentPreview": {
"type": "object",
"required": [
"isCODCapable",
"isFulfillable",
"marketplaceId",
"shippingSpeedCategory"
],
"properties": {
"shippingSpeedCategory": {
"$ref": "#/definitions/ShippingSpeedCategory"
},
"scheduledDeliveryInfo": {
"$ref": "#/definitions/ScheduledDeliveryInfo"
},
"isFulfillable": {
"type": "boolean",
"description": "When true, this fulfillment order preview is fulfillable."
},
"isCODCapable": {
"type": "boolean",
"description": "When true, this fulfillment order preview is for COD (Cash On Delivery)."
},
"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. The fees data will not be available for IN marketplace orders.",
"$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\n`DeliverySLAUnavailable`\n`InvalidDestinationAddress`",
"$ref": "#/definitions/StringList"
},
"marketplaceId": {
"type": "string",
"description": "The marketplace the fulfillment order is placed against."
},
"featureConstraints": {
"type": "array",
"description": "A list of features and their fulfillment policies to apply to the order.",
"items": {
"$ref": "#/definitions/FeatureSettings"
}
}
},
"description": "Information about a fulfillment order preview, including delivery and fee information based on shipping method."
},
"FulfillmentPreviewItem": {
"type": "object",
"required": [
"quantity",
"sellerFulfillmentOrderItemId",
"sellerSku"
],
"properties": {
"sellerSku": {
"type": "string",
"description": "The seller SKU of the item."
},
"quantity": {
"description": "The item quantity.",
"$ref": "#/definitions/Quantity"
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "A fulfillment order item identifier that the seller created with a call to the `createFulfillmentOrder` operation."
},
"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": {
"type": "string",
"description": "The method used to calculate the estimated shipping weight.",
"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."
}
]
}
},
"description": "Item information for a shipment in a fulfillment order preview."
},
"FulfillmentPreviewItemList": {
"type": "array",
"description": "An array of fulfillment preview item information.",
"items": {
"$ref": "#/definitions/FulfillmentPreviewItem"
}
},
"FulfillmentPreviewList": {
"type": "array",
"description": "An array of fulfillment preview information.",
"items": {
"$ref": "#/definitions/FulfillmentPreview"
}
},
"FulfillmentPreviewShipment": {
"type": "object",
"required": [
"fulfillmentPreviewItems"
],
"properties": {
"earliestShipDate": {
"description": "The earliest date that the shipment is expected to be sent from the fulfillment center. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
},
"latestShipDate": {
"description": "The latest date that the shipment is expected to be sent from the fulfillment center. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> 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. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
},
"shippingNotes": {
"type": "array",
"description": "Provides additional insight into the shipment timeline when exact delivery dates are not able to be precomputed.",
"items": {
"type": "string"
}
},
"fulfillmentPreviewItems": {
"description": "Information about the items in the shipment.",
"$ref": "#/definitions/FulfillmentPreviewItemList"
}
},
"description": "Delivery and item information for a shipment in a fulfillment order preview."
},
"FulfillmentPreviewShipmentList": {
"type": "array",
"description": "An array of fulfillment preview shipment information.",
"items": {
"$ref": "#/definitions/FulfillmentPreviewShipment"
}
},
"FulfillmentReturnItemStatus": {
"type": "string",
"description": "Indicates if the return item has been processed by a fulfillment center.",
"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": {
"type": "object",
"required": [
"amazonShipmentId",
"fulfillmentCenterId",
"fulfillmentShipmentItem",
"fulfillmentShipmentStatus"
],
"properties": {
"amazonShipmentId": {
"type": "string",
"description": "A shipment identifier assigned by Amazon."
},
"fulfillmentCenterId": {
"type": "string",
"description": "An identifier for the fulfillment center that the shipment will be sent from."
},
"fulfillmentShipmentStatus": {
"type": "string",
"description": "The current status of the shipment.",
"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."
}
]
},
"shippingDate": {
"description": "The meaning of the `shippingDate` value depends on the current status of the shipment. If the current value of `FulfillmentShipmentStatus` is:\n\n* Pending - `shippingDate` represents the estimated time that the shipment will leave the Amazon fulfillment center.\n\n* Shipped - `shippingDate` represents the date that the shipment left the Amazon fulfillment center.\nIf a shipment includes more than one package, `shippingDate` applies to all of the packages in the shipment. If the value of `FulfillmentShipmentStatus` is `CancelledByFulfiller` or `CancelledBySeller`, `shippingDate` is not returned. The value must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
},
"estimatedArrivalDate": {
"description": "The estimated arrival date and time of the shipment. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. Note that this value can change over time. If a shipment includes more than one package, `estimatedArrivalDate` applies to all of the packages in the shipment. If the shipment has been cancelled, `estimatedArrivalDate` is not returned.",
"$ref": "#/definitions/Timestamp"
},
"shippingNotes": {
"type": "array",
"description": "Provides additional insight into shipment timeline. Primairly used to communicate that actual delivery dates aren't available.",
"items": {
"type": "string"
}
},
"fulfillmentShipmentItem": {
"$ref": "#/definitions/FulfillmentShipmentItemList"
},
"fulfillmentShipmentPackage": {
"$ref": "#/definitions/FulfillmentShipmentPackageList"
}
},
"description": "Delivery and item information for a shipment in a fulfillment order."
},
"FulfillmentShipmentItem": {
"type": "object",
"required": [
"quantity",
"sellerFulfillmentOrderItemId",
"sellerSku"
],
"properties": {
"sellerSku": {
"type": "string",
"description": "The seller SKU of the item."
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "The fulfillment order item identifier that the seller created and submitted with a call to the `createFulfillmentOrder` operation."
},
"quantity": {
"$ref": "#/definitions/Quantity"
},
"packageNumber": {
"type": "integer",
"format": "int32",
"description": "An identifier for the package that contains the item quantity."
},
"serialNumber": {
"type": "string",
"description": "The serial number of the shipped item."
},
"manufacturerLotCodes": {
"description": "The manufacturer lot codes of the shipped items.",
"$ref": "#/definitions/StringList"
}
},
"description": "Item information for a shipment in a fulfillment order."
},
"FulfillmentShipmentItemList": {
"type": "array",
"description": "An array of fulfillment shipment item information.",
"items": {
"$ref": "#/definitions/FulfillmentShipmentItem"
}
},
"FulfillmentShipmentList": {
"type": "array",
"description": "An array of fulfillment shipment information.",
"items": {
"$ref": "#/definitions/FulfillmentShipment"
}
},
"FulfillmentShipmentPackage": {
"type": "object",
"required": [
"carrierCode",
"packageNumber"
],
"properties": {
"packageNumber": {
"type": "integer",
"format": "int32",
"description": "Identifies a package in a shipment."
},
"carrierCode": {
"type": "string",
"description": "Identifies the carrier who will deliver the shipment to the recipient."
},
"trackingNumber": {
"type": "string",
"description": "The tracking number, if provided, can be used to obtain tracking and delivery information."
},
"estimatedArrivalDate": {
"description": "The estimated arrival date and time of the package. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"$ref": "#/definitions/Timestamp"
},
"lockerDetails": {
"description": "The locker details, if provided can be used to access locker delivery box.",
"$ref": "#/definitions/LockerDetails"
},
"deliveryInformation": {
"description": "The delivery information for the package. This information is available after the package is delivered.",
"$ref": "#/definitions/DeliveryInformation"
}
},
"description": "Package information for a shipment in a fulfillment order."
},
"FulfillmentShipmentPackageList": {
"type": "array",
"description": "An array of fulfillment shipment package information.",
"items": {
"$ref": "#/definitions/FulfillmentShipmentPackage"
}
},
"GetFulfillmentOrderResult": {
"description": "The request for the getFulfillmentOrder operation.",
"type": "object",
"required": [
"fulfillmentOrder",
"fulfillmentOrderItems",
"returnAuthorizations",
"returnItems"
],
"properties": {
"fulfillmentOrder": {
"$ref": "#/definitions/FulfillmentOrder"
},
"fulfillmentOrderItems": {
"$ref": "#/definitions/FulfillmentOrderItemList"
},
"fulfillmentShipments": {
"$ref": "#/definitions/FulfillmentShipmentList"
},
"returnItems": {
"$ref": "#/definitions/ReturnItemList"
},
"returnAuthorizations": {
"$ref": "#/definitions/ReturnAuthorizationList"
},
"paymentInformation": {
"$ref": "#/definitions/PaymentInformationList"
}
}
},
"GetFulfillmentOrderResponse": {
"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"
}
},
"description": "The response schema for the `getFulfillmentOrder` operation."
},
"GetFulfillmentPreviewItem": {
"type": "object",
"required": [
"quantity",
"sellerFulfillmentOrderItemId",
"sellerSku"
],
"properties": {
"sellerSku": {
"type": "string",
"description": "The seller SKU of the item.",
"maxLength": 50
},
"quantity": {
"$ref": "#/definitions/Quantity"
},
"perUnitDeclaredValue": {
"description": "The monetary value assigned by the seller to this item. This is a required field if this order is an export order or an India MCF order.",
"$ref": "#/definitions/Money"
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "A fulfillment order item identifier that the seller creates to track items in the fulfillment preview.",
"maxLength": 50
}
},
"description": "Item information for a fulfillment order preview."
},
"GetFulfillmentPreviewItemList": {
"type": "array",
"description": "An array of fulfillment preview item information.",
"items": {
"$ref": "#/definitions/GetFulfillmentPreviewItem"
}
},
"GetFulfillmentPreviewRequest": {
"type": "object",
"required": [
"address",
"items"
],
"properties": {
"marketplaceId": {
"type": "string",
"description": "The marketplace the fulfillment order is placed against."
},
"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. Maximum of 100 line items with a maximum of 250 units per order. ",
"$ref": "#/definitions/GetFulfillmentPreviewItemList"
},
"shippingSpeedCategories": {
"description": "A list of shipping methods used for creating fulfillment order previews.\n\nPossible values:\n\n* `Standard` - Standard shipping method.\n* `Expedited` - Expedited shipping method.\n* `Priority` - Priority shipping method.\n* `ScheduledDelivery` - Scheduled Delivery shipping method.\nNote: Shipping method service level agreements vary by marketplace. Sellers should refer to the Seller Central website in their marketplace for shipping method service level agreements and fulfillment fees.",
"$ref": "#/definitions/ShippingSpeedCategoryList"
},
"includeCODFulfillmentPreview": {
"type": "boolean",
"description": "When true, returns all fulfillment order previews both for COD and not for COD. Otherwise, returns only fulfillment order previews that are not for COD."
},
"includeDeliveryWindows": {
"type": "boolean",
"description": "When true, returns 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`."
},
"featureConstraints": {
"type": "array",
"description": "A list of features and their fulfillment policies to apply to the order.",
"items": {
"$ref": "#/definitions/FeatureSettings"
}
}
},
"description": "The request body schema for the `getFulfillmentPreview` operation."
},
"GetFulfillmentPreviewResult": {
"type": "object",
"properties": {
"fulfillmentPreviews": {
"$ref": "#/definitions/FulfillmentPreviewList"
}
},
"description": "A list of fulfillment order previews, including estimated shipping weights, estimated shipping fees, and estimated ship dates and arrival dates."
},
"GetFulfillmentPreviewResponse": {
"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"
}
},
"description": "The response schema for the `getFulfillmentPreview` operation."
},
"GetDeliveryOffersRequest": {
"type": "object",
"required": [
"product",
"terms"
],
"properties": {
"product": {
"$ref": "#/definitions/GetDeliveryOffersProduct",
"description": "The product details for the delivery offer."
},
"terms": {
"$ref": "#/definitions/GetDeliveryOffersTerms",
"description": "The terms for the delivery offer."
}
},
"description": "The request body schema for the getDeliveryOffers operation."
},
"GetDeliveryOffersResponse": {
"type": "object",
"properties": {
"payload": {
"$ref": "#/definitions/GetDeliveryOffersResult",
"description": "The response payload for the getDeliveryOffers operation."
},
"errors": {
"$ref": "#/definitions/ErrorList",
"description": "One or more unexpected errors occurred during the getDeliveryOffers operation."
}
},
"description": "The response schema for the getDeliveryOffers operation."
},
"GetDeliveryOffersResult": {
"type": "object",
"properties": {
"deliveryOffers": {
"$ref": "#/definitions/DeliveryOffersList",
"description": "An array of delivery offers."
}
},
"description": "A list of delivery offers, including offer expiration, earliest and latest date and time range, and the delivery offer policy."
},
"DeliveryOffersList": {
"type": "array",
"description": "An array of delivery offer information.",
"items": {
"$ref": "#/definitions/DeliveryOffer"
}
},
"DeliveryOffer": {
"type": "object",
"properties": {
"expiresAt": {
"$ref": "#/definitions/Timestamp",
"description": "The timestamp at which a delivery offer expires."
},
"dateRange": {
"$ref": "#/definitions/DateRange",
"description": "The range between which delivery is expected."
},
"policy": {
"$ref": "#/definitions/DeliveryPolicy",
"description": "The policy for a delivery offer, including localized messaging."
}
},
"description": "An available offer for delivery of a product."
},
"GetDeliveryOffersProduct": {
"type": "object",
"required": [
"productIdentifier"
],
"properties": {
"productIdentifier": {
"$ref": "#/definitions/ProductIdentifier",
"description": "Product identifier input that locates a product for MCF."
},
"amount": {
"$ref": "#/definitions/Amount",
"description": "The amount of the requested product."
}
},
"description": "The product details for the delivery offer."
},
"Amount": {
"type": "object",
"required": [
"unitOfMeasure",
"value"
],
"properties": {
"unitOfMeasure": {
"type": "string",
"description": "The unit of measure for the amount.",
"enum": [
"Eaches"
],
"x-docgen-enum-table-extension": [
{
"value": "Eaches",
"description": "Specifies an integer count of units."
}
]
},
"value": {
"$ref": "#/definitions/Decimal",
"description": "The amount of a product in the associated unit of measure."
}
},
"description": "A quantity based on unit of measure."
},
"GetDeliveryOffersTerms": {
"type": "object",
"required": [
"origin",
"destination"
],
"properties": {
"origin": {
"$ref": "#/definitions/Origin",
"description": "The origin for the delivery offer."
},
"destination": {
"$ref": "#/definitions/Destination",
"description": "The destination for the delivery offer."
}
},
"description": "The delivery terms for the delivery offer."
},
"IpAddress": {
"type": "string",
"format": "ip",
"description": "An IP Address."
},
"Destination": {
"type": "object",
"properties": {
"deliveryAddress": {
"$ref": "#/definitions/VariablePrecisionAddress"
},
"ipAddress": {
"$ref": "#/definitions/IpAddress",
"description": "The IP address of the customer."
}
},
"description": "The destination for the delivery offer."
},
"ProductIdentifier": {
"type": "object",
"required": [
"merchantSku"
],
"properties": {
"merchantSku": {
"type": "string",
"description": "The merchant SKU for the product.",
"maxLength": 50
}
},
"description": "Product identifier input that locates a product for MCF."
},
"Origin": {
"type": "object",
"required": [
"countryCode"
],
"description": "The origin for the delivery offer.",
"properties": {
"countryCode": {
"type": "string",
"description": "The two digit country code the items should ship from. In ISO 3166-1 alpha-2 format.",
"minLength": 2,
"maxLength": 2
}
}
},
"VariablePrecisionAddress": {
"type": "object",
"required": [
"countryCode",
"postalCode"
],
"properties": {
"addressLine1": {
"type": "string",
"description": "The first line of the address."
},
"addressLine2": {
"type": "string",
"description": "Additional address information, if required."
},
"addressLine3": {
"type": "string",
"description": "Additional address information, if required."
},
"city": {
"type": "string",
"description": "The city where the person, business, or institution is located. This property should not be used in Japan."
},
"districtOrCounty": {
"type": "string",
"description": "The district or county where the person, business, or institution is located."
},
"stateOrRegion": {
"type": "string",
"description": "The state or region where the person, business or institution is located."
},
"postalCode": {
"type": "string",
"description": "The postal code of the address."
},
"countryCode": {
"type": "string",
"description": "The two digit country code. In ISO 3166-1 alpha-2 format.",
"minLength": 2,
"maxLength": 2
}
},
"description": "A physical address with varying degrees of precision. A more precise address can provide more accurate results than country code and postal code alone."
},
"DateRange": {
"type": "object",
"required": [
"earliest",
"latest"
],
"properties": {
"earliest": {
"$ref": "#/definitions/Timestamp",
"description": "The earliest point in a date range."
},
"latest": {
"$ref": "#/definitions/Timestamp",
"description": "The latest point in a date range."
}
},
"description": "The time range within which something (for example, a delivery) will occur."
},
"DeliveryPolicy": {
"type": "object",
"properties": {
"message": {
"$ref": "#/definitions/DeliveryMessage",
"description": "Localized messaging for a delivery offering."
}
},
"description": "The policy for a delivery offering."
},
"DeliveryMessage": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The message content for a delivery offering."
},
"locale": {
"type": "string",
"description": "The locale for the message (for example, en_US)."
}
},
"description": "Localized messaging for a delivery offering."
},
"InvalidItemReasonCode": {
"type": "string",
"description": "A code for why the item is invalid for return.",
"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": {
"type": "object",
"required": [
"description",
"invalidItemReasonCode"
],
"properties": {
"invalidItemReasonCode": {
"$ref": "#/definitions/InvalidItemReasonCode"
},
"description": {
"type": "string",
"description": "A human readable description of the invalid item reason code."
}
},
"description": "The reason that the item is invalid for return."
},
"InvalidReturnItem": {
"type": "object",
"required": [
"invalidItemReason",
"sellerFulfillmentOrderItemId",
"sellerReturnItemId"
],
"properties": {
"sellerReturnItemId": {
"type": "string",
"description": "An identifier assigned by the seller to the return item."
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created."
},
"invalidItemReason": {
"$ref": "#/definitions/InvalidItemReason"
}
},
"description": "An item that is invalid for return."
},
"InvalidReturnItemList": {
"type": "array",
"description": "An array of invalid return item information.",
"items": {
"$ref": "#/definitions/InvalidReturnItem"
}
},
"ListAllFulfillmentOrdersResult": {
"description": "The request for the listAllFulfillmentOrders operation.",
"type": "object",
"properties": {
"nextToken": {
"type": "string",
"description": "When present and not empty, pass this string token in the next request to return the next response page."
},
"fulfillmentOrders": {
"type": "array",
"description": "An array of fulfillment order information.",
"items": {
"$ref": "#/definitions/FulfillmentOrder"
}
}
}
},
"ListAllFulfillmentOrdersResponse": {
"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"
}
},
"description": "The response schema for the `listAllFulfillmentOrders` operation."
},
"ListReturnReasonCodesResult": {
"description": "The request for the listReturnReasonCodes operation.",
"type": "object",
"properties": {
"reasonCodeDetails": {
"$ref": "#/definitions/ReasonCodeDetailsList"
}
}
},
"ListReturnReasonCodesResponse": {
"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"
}
},
"description": "The response schema for the `listReturnReasonCodes` operation."
},
"LockerDetails": {
"type": "object",
"properties": {
"lockerNumber": {
"type": "string",
"description": "Indicates the locker number"
},
"lockerAccessCode": {
"type": "string",
"description": "Indicates the locker access code"
}
},
"description": "The locker details, which you can use to access the locker delivery box."
},
"DeliveryInformation": {
"type": "object",
"properties": {
"deliveryDocumentList": {
"description": "All of the delivery documents for a package.",
"$ref": "#/definitions/DeliveryDocumentList"
},
"dropOffLocation": {
"description": "The drop off location for a package.",
"$ref": "#/definitions/DropOffLocation"
}
},
"description": "The delivery information for the package. This information is available after the package is delivered."
},
"DeliveryDocumentList": {
"type": "array",
"description": "A list of delivery documents for a package.",
"items": {
"$ref": "#/definitions/DeliveryDocument"
}
},
"DeliveryDocument": {
"type": "object",
"required": [
"documentType"
],
"properties": {
"documentType": {
"type": "string",
"description": "The delivery document type. Values are `SIGNATURE` and `DELIVERY_IMAGE`."
},
"url": {
"type": "string",
"description": "A URL that you can use to download the document. This URL has a `Content-Type` header. Note that the URL expires after one hour. To get a new URL, you must call the API again."
}
},
"description": "A delivery document for a package."
},
"NotificationEmailList": {
"type": "array",
"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.",
"items": {
"type": "string",
"maxLength": 64
}
},
"CurrentStatus": {
"type": "string",
"description": "The current delivery status of the package.",
"enum": [
"IN_TRANSIT",
"DELIVERED",
"RETURNING",
"RETURNED",
"UNDELIVERABLE",
"DELAYED",
"AVAILABLE_FOR_PICKUP",
"CUSTOMER_ACTION",
"UNKNOWN",
"OUT_FOR_DELIVERY",
"DELIVERY_ATTEMPTED",
"PICKUP_SUCCESSFUL",
"PICKUP_CANCELLED",
"PICKUP_ATTEMPTED",
"PICKUP_SCHEDULED",
"RETURN_REQUEST_ACCEPTED",
"REFUND_ISSUED",
"RETURN_RECEIVED_IN_FC"
],
"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."
},
{
"value": "UNKNOWN",
"description": "Unknown Status Code was returned."
},
{
"value": "OUT_FOR_DELIVERY",
"description": "Out for Delivery."
},
{
"value": "DELIVERY_ATTEMPTED",
"description": "Delivery Attempted."
},
{
"value": "PICKUP_SUCCESSFUL",
"description": "Pickup Successful."
},
{
"value": "PICKUP_CANCELLED",
"description": "Pickup Cancelled."
},
{
"value": "PICKUP_ATTEMPTED",
"description": "Pickup Attempted."
},
{
"value": "PICKUP_SCHEDULED",
"description": "Pickup Scheduled."
},
{
"value": "RETURN_REQUEST_ACCEPTED",
"description": "Return Request Accepted."
},
{
"value": "REFUND_ISSUED",
"description": "Refund Issued."
},
{
"value": "RETURN_RECEIVED_IN_FC",
"description": "Return Received In FC."
}
]
},
"AdditionalLocationInfo": {
"type": "string",
"description": "Additional location information.",
"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": {
"description": "Tracking details of package",
"type": "object",
"required": [
"packageNumber"
],
"properties": {
"packageNumber": {
"type": "integer",
"format": "int32",
"description": "The package identifier."
},
"trackingNumber": {
"type": "string",
"description": "The tracking number for the package."
},
"customerTrackingLink": {
"type": "string",
"description": "Link on swiship.com that allows customers to track the package."
},
"carrierCode": {
"type": "string",
"description": "The name of the carrier."
},
"carrierPhoneNumber": {
"type": "string",
"description": "The phone number of the carrier."
},
"carrierURL": {
"type": "string",
"description": "The URL of the carrier's website."
},
"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"
},
"currentStatusDescription": {
"type": "string",
"description": "Description corresponding to the `CurrentStatus` value."
},
"signedForBy": {
"type": "string",
"description": "The name of the person who signed for the package."
},
"additionalLocationInfo": {
"$ref": "#/definitions/AdditionalLocationInfo"
},
"trackingEvents": {
"$ref": "#/definitions/TrackingEventList"
}
}
},
"GetPackageTrackingDetailsResponse": {
"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"
}
},
"description": "The response schema for the `getPackageTrackingDetails` operation."
},
"ReasonCodeDetails": {
"type": "object",
"required": [
"description",
"returnReasonCode"
],
"properties": {
"returnReasonCode": {
"type": "string",
"description": "A code that indicates a valid return reason."
},
"description": {
"type": "string",
"description": "A human readable description of the return reason code."
},
"translatedDescription": {
"type": "string",
"description": "A translation of the description. The translation is in the language specified in the Language request parameter."
}
},
"description": "A return reason code, a description, and an optional description translation."
},
"ReasonCodeDetailsList": {
"type": "array",
"description": "An array of return reason code details.",
"items": {
"$ref": "#/definitions/ReasonCodeDetails"
}
},
"PaymentInformation": {
"type": "object",
"required": [
"paymentTransactionId",
"paymentMode",
"paymentDate"
],
"properties": {
"paymentTransactionId": {
"type": "string",
"description": "The transaction identifier of this payment."
},
"paymentMode": {
"type": "string",
"description": "The transaction mode of this payment."
},
"paymentDate": {
"description": "The transaction date of this payment.",
"$ref": "#/definitions/Timestamp"
}
},
"description": "The attributes related to the payment made from customer to seller for this order."
},
"ReturnAuthorization": {
"type": "object",
"required": [
"amazonRmaId",
"fulfillmentCenterId",
"returnAuthorizationId",
"returnToAddress",
"rmaPageURL"
],
"properties": {
"returnAuthorizationId": {
"type": "string",
"description": "An identifier for the return authorization. This identifier associates return items with the return authorization used to return them."
},
"fulfillmentCenterId": {
"type": "string",
"description": "An identifier for the Amazon fulfillment center that the return items should be sent to."
},
"returnToAddress": {
"description": "The address of the Amazon fulfillment center that the return items should be sent to.",
"$ref": "#/definitions/Address"
},
"amazonRmaId": {
"type": "string",
"description": "The return merchandise authorization (RMA) that Amazon needs to process the return."
},
"rmaPageURL": {
"type": "string",
"description": "A URL for a web page that contains the return authorization barcode and the mailing label. This does not include pre-paid shipping."
}
},
"description": "Return authorization information for items accepted for return."
},
"PaymentInformationList": {
"type": "array",
"description": "An array of various payment attributes related to this fulfillment order.",
"items": {
"$ref": "#/definitions/PaymentInformation"
}
},
"ReturnAuthorizationList": {
"type": "array",
"description": "An array of return authorization information.",
"items": {
"$ref": "#/definitions/ReturnAuthorization"
}
},
"ReturnItem": {
"type": "object",
"required": [
"amazonShipmentId",
"sellerFulfillmentOrderItemId",
"sellerReturnItemId",
"sellerReturnReasonCode",
"status",
"statusChangedDate"
],
"properties": {
"sellerReturnItemId": {
"type": "string",
"description": "An identifier assigned by the seller to the return item."
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created."
},
"amazonShipmentId": {
"type": "string",
"description": "The identifier for the shipment that is associated with the return item."
},
"sellerReturnReasonCode": {
"type": "string",
"description": "The return reason code assigned to the return item by the seller."
},
"returnComment": {
"type": "string",
"description": "An optional comment about the return item."
},
"amazonReturnReasonCode": {
"type": "string",
"description": "The return reason code that the Amazon fulfillment center assigned to the return item."
},
"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": {
"type": "string",
"description": "Identifies the return authorization used to return this item. Refer to `ReturnAuthorization`."
},
"returnReceivedCondition": {
"$ref": "#/definitions/ReturnItemDisposition"
},
"fulfillmentCenterId": {
"type": "string",
"description": "The identifier for the Amazon fulfillment center that processed the return item."
}
},
"description": "An item that Amazon accepted for return."
},
"ReturnItemDisposition": {
"type": "string",
"description": "The condition of the return item when received by an Amazon fulfillment center.",
"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": {
"type": "array",
"description": "An array of items that Amazon accepted for return. Returns empty if no items were accepted for return.",
"items": {
"$ref": "#/definitions/ReturnItem"
}
},
"ScheduledDeliveryInfo": {
"type": "object",
"required": [
"deliveryTimeZone",
"deliveryWindows"
],
"properties": {
"deliveryTimeZone": {
"type": "string",
"description": "The time zone of the destination address for the fulfillment order preview. Must be an IANA time zone name. Example: Asia/Tokyo."
},
"deliveryWindows": {
"description": "An array of time ranges that are available for scheduled delivery.",
"$ref": "#/definitions/DeliveryWindowList"
}
},
"description": "Delivery information for a scheduled delivery. This is only available in the JP marketplace."
},
"ShippingSpeedCategoryList": {
"description": "ShippingSpeedCategory List",
"type": "array",
"items": {
"$ref": "#/definitions/ShippingSpeedCategory"
}
},
"StringList": {
"description": "String list",
"type": "array",
"items": {
"type": "string"
}
},
"Timestamp": {
"description": "Date timestamp",
"type": "string",
"format": "date-time"
},
"TrackingAddress": {
"type": "object",
"required": [
"city",
"country",
"state"
],
"properties": {
"city": {
"type": "string",
"description": "The city.",
"maxLength": 150
},
"state": {
"type": "string",
"description": "The state.",
"maxLength": 150
},
"country": {
"type": "string",
"description": "The country.",
"maxLength": 6
}
},
"description": "Address information for tracking the package."
},
"EventCode": {
"type": "string",
"description": "The event code for the delivery event.",
"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": {
"type": "object",
"required": [
"eventAddress",
"eventCode",
"eventDate",
"eventDescription"
],
"properties": {
"eventDate": {
"description": "The date and time that the delivery event took place. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> 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"
},
"eventDescription": {
"type": "string",
"description": "A description for the corresponding event code."
}
},
"description": "Information for tracking package deliveries."
},
"TrackingEventList": {
"type": "array",
"description": "An array of tracking event information.",
"items": {
"$ref": "#/definitions/TrackingEvent"
}
},
"UnfulfillablePreviewItem": {
"type": "object",
"required": [
"quantity",
"sellerFulfillmentOrderItemId",
"sellerSku"
],
"properties": {
"sellerSku": {
"type": "string",
"description": "The seller SKU of the item.",
"maxLength": 50
},
"quantity": {
"$ref": "#/definitions/Quantity"
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "A fulfillment order item identifier created with a call to the `getFulfillmentPreview` operation.",
"maxLength": 50
},
"itemUnfulfillableReasons": {
"description": "Error codes associated with the fulfillment order preview that indicate why the item is unfulfillable.",
"$ref": "#/definitions/StringList"
}
},
"description": "Information about unfulfillable items in a fulfillment order preview."
},
"UnfulfillablePreviewItemList": {
"type": "array",
"description": "An array of unfulfillable preview item information.",
"items": {
"$ref": "#/definitions/UnfulfillablePreviewItem"
}
},
"UpdateFulfillmentOrderItem": {
"type": "object",
"required": [
"quantity",
"sellerFulfillmentOrderItemId"
],
"properties": {
"sellerSku": {
"type": "string",
"description": "The seller SKU of the item."
},
"sellerFulfillmentOrderItemId": {
"type": "string",
"description": "Identifies the fulfillment order item to update. Created with a previous call to the `createFulfillmentOrder` operation.",
"maxLength": 50
},
"quantity": {
"$ref": "#/definitions/Quantity"
},
"giftMessage": {
"type": "string",
"description": "A message to the gift recipient, if applicable.",
"maxLength": 512
},
"displayableComment": {
"type": "string",
"description": "Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.",
"maxLength": 250
},
"fulfillmentNetworkSku": {
"type": "string",
"description": "Amazon's fulfillment network SKU of the item."
},
"orderItemDisposition": {
"type": "string",
"description": "Indicates whether the item is sellable or unsellable."
},
"perUnitDeclaredValue": {
"description": "The monetary value assigned by the seller to this item. This is a required field for India MCF orders.",
"$ref": "#/definitions/Money"
},
"perUnitPrice": {
"description": "The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.",
"$ref": "#/definitions/Money"
},
"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/Money"
}
},
"description": "Item information for updating a fulfillment order."
},
"UpdateFulfillmentOrderItemList": {
"type": "array",
"description": "An array of fulfillment order item information for updating a fulfillment order.",
"items": {
"$ref": "#/definitions/UpdateFulfillmentOrderItem"
}
},
"UpdateFulfillmentOrderRequest": {
"type": "object",
"description": "The request body schema for the `updateFulfillmentOrder` operation.",
"properties": {
"marketplaceId": {
"type": "string",
"description": "The marketplace the fulfillment order is placed against."
},
"displayableOrderId": {
"type": "string",
"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.",
"maxLength": 40
},
"displayableOrderDate": {
"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": {
"type": "string",
"description": "Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.",
"maxLength": 750
},
"shippingSpeedCategory": {
"$ref": "#/definitions/ShippingSpeedCategory"
},
"destinationAddress": {
"description": "The destination address for the fulfillment order.",
"$ref": "#/definitions/Address"
},
"fulfillmentAction": {
"$ref": "#/definitions/FulfillmentAction"
},
"fulfillmentPolicy": {
"$ref": "#/definitions/FulfillmentPolicy"
},
"shipFromCountryCode": {
"type": "string",
"description": "The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format."
},
"notificationEmails": {
"$ref": "#/definitions/NotificationEmailList"
},
"featureConstraints": {
"type": "array",
"description": "A list of features and their fulfillment policies to apply to the order.",
"items": {
"$ref": "#/definitions/FeatureSettings"
}
},
"items": {
"description": "A list of items to include in the fulfillment order preview, including quantity.",
"$ref": "#/definitions/UpdateFulfillmentOrderItemList"
}
}
},
"UpdateFulfillmentOrderResponse": {
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the `updateFulfillmentOrder` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the `updateFulfillmentOrder` operation."
},
"CreateFulfillmentOrderResponse": {
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the `createFulfillmentOrder` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the `createFulfillmentOrder` operation."
},
"CancelFulfillmentOrderResponse": {
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the `cancelFulfillmentOrder` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the `cancelFulfillmentOrder` operation."
},
"Weight": {
"type": "object",
"required": [
"unit",
"value"
],
"properties": {
"unit": {
"type": "string",
"description": "The unit of weight.",
"enum": [
"KG",
"KILOGRAMS",
"LB",
"POUNDS"
],
"x-docgen-enum-table-extension": [
{
"value": "KG",
"description": "Kilograms."
},
{
"value": "KILOGRAMS",
"description": "Kilograms."
},
{
"value": "LB",
"description": "Pounds."
},
{
"value": "POUNDS",
"description": "Pounds."
}
]
},
"value": {
"type": "string",
"description": "The weight value."
}
},
"description": "The weight."
},
"Quantity": {
"type": "integer",
"format": "int32",
"description": "The item quantity."
},
"ShippingSpeedCategory": {
"type": "string",
"description": "The shipping method used for the fulfillment order. When this value is `ScheduledDelivery`, choose `Ship` for the `fulfillmentAction`. `Hold` is not a valid `fulfillmentAction` value when the `shippingSpeedCategory` value is `ScheduledDelivery`.\nNote: Shipping method service level agreements vary by marketplace. Sellers should refer to the [Seller Central](https://developer-docs.amazon.com/sp-api/docs/seller-central-urls) website in their marketplace for shipping method service level agreements and fulfillment fees.",
"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. This is only available in the JP marketplace."
}
]
},
"GetFeatureInventoryResponse": {
"type": "object",
"properties": {
"payload": {
"$ref": "#/definitions/GetFeatureInventoryResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the `getFeatureInventory` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The breakdown of eligibility inventory by feature."
},
"GetFeatureInventoryResult": {
"type": "object",
"required": [
"featureName",
"marketplaceId"
],
"properties": {
"marketplaceId": {
"type": "string",
"description": "The requested marketplace."
},
"featureName": {
"type": "string",
"description": "The name of the feature."
},
"nextToken": {
"type": "string",
"description": "When present and not empty, pass this string token in the next request to return the next response page."
},
"featureSkus": {
"type": "array",
"description": "An array of SKUs eligible for this feature and the quantity available.",
"items": {
"$ref": "#/definitions/FeatureSku"
}
}
},
"description": "The payload for the `getEligibileInventory` operation."
},
"FeatureSku": {
"type": "object",
"properties": {
"sellerSku": {
"type": "string",
"description": "Used to identify an item in the given marketplace. `SellerSKU` is qualified by the seller's SellerId, which is included with every operation that you submit."
},
"fnSku": {
"type": "string",
"description": "The unique SKU used by Amazon's fulfillment network."
},
"asin": {
"type": "string",
"description": "The Amazon Standard Identification Number (ASIN) of the item."
},
"skuCount": {
"type": "number",
"description": "The number of SKUs available for this service."
},
"overlappingSkus": {
"type": "array",
"description": "Other seller SKUs that are shared across the same inventory.",
"items": {
"type": "string"
}
}
},
"description": "Information about an SKU, including the count available, identifiers, and a list of overlapping SKUs that share the same inventory pool."
},
"GetFeaturesResponse": {
"type": "object",
"properties": {
"payload": {
"$ref": "#/definitions/GetFeaturesResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the `getFeatures` operation."
},
"GetFeaturesResult": {
"type": "object",
"required": [
"features"
],
"properties": {
"features": {
"$ref": "#/definitions/Features"
}
},
"description": "The payload for the `getFeatures` operation."
},
"Features": {
"type": "array",
"description": "An array of features.",
"items": {
"$ref": "#/definitions/Feature"
}
},
"Feature": {
"type": "object",
"required": [
"featureDescription",
"featureName"
],
"properties": {
"featureName": {
"type": "string",
"description": "The feature name."
},
"featureDescription": {
"type": "string",
"description": "The feature description."
},
"sellerEligible": {
"type": "boolean",
"description": "When true, indicates that the seller is eligible to use the feature."
}
},
"description": "A Multi-Channel Fulfillment feature."
},
"GetFeatureSkuResponse": {
"type": "object",
"properties": {
"payload": {
"$ref": "#/definitions/GetFeatureSkuResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the `getFeatureSKU` operation."
},
"GetFeatureSkuResult": {
"type": "object",
"required": [
"featureName",
"isEligible",
"marketplaceId"
],
"properties": {
"marketplaceId": {
"type": "string",
"description": "The requested marketplace."
},
"featureName": {
"type": "string",
"description": "The name of the feature."
},
"isEligible": {
"type": "boolean",
"description": "When true, the seller SKU is eligible for the requested feature."
},
"ineligibleReasons": {
"type": "array",
"description": "A list of one or more reasons that the seller SKU is ineligibile for the feature.\n\nPossible values:\n* `MERCHANT_NOT_ENROLLED` - The merchant isn't enrolled for the feature.\n* `SKU_NOT_ELIGIBLE` - The SKU doesn't reside in a warehouse that supports the feature.\n* `INVALID_SKU` - There is an issue with the SKU provided.",
"items": {
"type": "string"
}
},
"skuInfo": {
"description": "Information about the SKU, including the count available, identifiers, and a list of overlapping SKUs that share the same inventory pool.",
"$ref": "#/definitions/FeatureSku"
}
},
"description": "The payload for the `getFeatureSKU` operation."
},
"FeatureSettings": {
"type": "object",
"properties": {
"featureName": {
"type": "string",
"description": "The name of the feature."
},
"featureFulfillmentPolicy": {
"type": "string",
"description": "Specifies the policy to use when fulfilling an order.",
"enum": [
"Required",
"NotRequired"
],
"x-docgen-enum-table-extension": [
{
"value": "Required",
"description": "If the offer can't be shipped with the selected feature, reject the order."
},
{
"value": "NotRequired",
"description": "The feature is not required for shipping."
}
]
}
},
"description": "`FeatureSettings` allows users to apply fulfillment features to an order. To block an order from being shipped using Amazon Logistics (AMZL) and an AMZL tracking number, use `featureName` as `BLOCK_AMZL` and `featureFulfillmentPolicy` as `Required`. Blocking AMZL will incur an additional fee surcharge on your MCF orders and increase the risk of some of your orders being unfulfilled or delivered late if there are no alternative carriers available. Using `BLOCK_AMZL` in an order request will take precedence over your Seller Central account setting. To ship in non-Amazon branded packaging (blank boxes), use featureName `BLANK_BOX`."
},
"SubmitFulfillmentOrderStatusUpdateRequest": {
"type": "object",
"description":"The request body schema for the `submitFulfillmentOrderStatusUpdate` operation.",
"properties": {
"fulfillmentOrderStatus": {
"$ref": "#/definitions/FulfillmentOrderStatus"
}
}
},
"SubmitFulfillmentOrderStatusUpdateResponse": {
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the `SubmitFulfillmentOrderStatusUpdate` operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the `SubmitFulfillmentOrderStatusUpdate` operation."
}
}
}
Updated 14 days ago