Fulfillment Inbound API v0 Model
Swagger model for the Fulfillment Inbound API v0.
{
"swagger": "2.0",
"info": {
"description": "The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon's fulfillment network.",
"version": "v0",
"title": "Selling Partner API for Fulfillment Inbound",
"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/inbound/v0/plans": {
"post": {
"tags": [
"fbaInbound"
],
"description": "Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon's fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory.\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 see higher rate and burst values than those shown here. For more information, see [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": "createInboundShipmentPlan",
"deprecated": true,
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateInboundShipmentPlanRequest"
},
"description": "The request schema for the CreateInboundShipmentPlanRequest operation."
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/CreateInboundShipmentPlanResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"ShipFromAddress": {
"Name": "Name",
"AddressLine1": "123 any st",
"AddressLine2": "AddressLine2",
"DistrictOrCounty": "Washtenaw",
"City": "Ann Arbor",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48188"
},
"LabelPrepPreference": "SELLER_LABEL",
"ShipToCountryCode": "ShipToCountryCode",
"ShipToCountrySubdivisionCode": "ShipToCountrySubdivisionCode",
"InboundShipmentPlanRequestItems": [
{
"SellerSKU": "SellerSKU",
"ASIN": "ASIN",
"Condition": "NewItem",
"Quantity": 1,
"QuantityInCase": 1,
"PrepDetailsList": [
{
"PrepInstruction": "Polybagging",
"PrepOwner": "AMAZON"
}
]
}
]
}
}
}
},
"response": {
"payload": {
"InboundShipmentPlans": [
{
"ShipmentId": "ShipmentId",
"DestinationFulfillmentCenterId": "ABE2",
"ShipToAddress": {
"Name": "John Doe",
"AddressLine1": "123 any s",
"AddressLine2": "",
"DistrictOrCounty": "Wayne",
"City": "Detroit",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48110"
},
"LabelPrepType": "NO_LABEL",
"Items": [
{
"SellerSKU": "SellerSKU",
"FulfillmentNetworkSKU": "FulfillmentNetworkSKU",
"Quantity": 10,
"PrepDetailsList": [
{
"PrepInstruction": "Polybagging",
"PrepOwner": "AMAZON"
}
]
}
],
"EstimatedBoxContentsFee": {
"TotalUnits": 10,
"FeePerUnit": {
"CurrencyCode": "USD",
"Value": 10
},
"TotalFee": {
"CurrencyCode": "USD",
"Value": 10
}
}
}
]
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/CreateInboundShipmentPlanResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"ShipFromAddress": {
"Name": "BADBAD NAME",
"AddressLine1": "BADAddressLine1",
"AddressLine2": "BADAddressLine2",
"DistrictOrCounty": "BADDistrictOrCounty",
"City": "BADCity",
"StateOrProvinceCode": "BADStateOrProvinceCode",
"CountryCode": "BADCountryCode",
"PostalCode": "BADPostalCodeg"
},
"LabelPrepPreference": "BADSELLER_LABEL",
"ShipToCountryCode": "BADShipToCountryCode",
"ShipToCountrySubdivisionCode": "BADShipToCountrySubdivisionCode",
"InboundShipmentPlanRequestItems": [
{
"SellerSKU": "BADSellerSKU",
"ASIN": "BADASIN",
"Condition": "BADNewItem",
"Quantity": 0,
"QuantityInCase": 0,
"PrepDetailsList": [
{
"PrepInstruction": "BADPolybagging",
"PrepOwner": "BADAMAZON"
}
]
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Invalid data. Please check details"
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/CreateInboundShipmentPlanResponse"
},
"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/CreateInboundShipmentPlanResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/CreateInboundShipmentPlanResponse"
},
"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/CreateInboundShipmentPlanResponse"
},
"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/CreateInboundShipmentPlanResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/CreateInboundShipmentPlanResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/shipments/{shipmentId}": {
"post": {
"tags": [
"fbaInbound"
],
"description": "Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation.\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 see higher rate and burst values than those shown here. For more information, see [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": "createInboundShipment",
"deprecated": true,
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InboundShipmentRequest"
},
"description": "The request schema for the InboundShipmentRequest operation."
},
{
"name": "shipmentId",
"in": "path",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/InboundShipmentResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"InboundShipmentHeader": {
"ShipmentName": "43545345",
"ShipFromAddress": {
"Name": "35435345",
"AddressLine1": "123 any st",
"DistrictOrCounty": "Washtenaw",
"City": "Ann Arbor",
"StateOrProvinceCode": "Test",
"CountryCode": "US",
"PostalCode": "48103"
},
"DestinationFulfillmentCenterId": "AEB2",
"AreCasesRequired": true,
"ShipmentStatus": "WORKING",
"LabelPrepPreference": "SELLER_LABEL",
"IntendedBoxContentsSource": "NONE"
},
"InboundShipmentItems": [
{
"ShipmentId": "345453",
"SellerSKU": "34534545",
"FulfillmentNetworkSKU": "435435435",
"QuantityShipped": 0,
"QuantityReceived": 0,
"QuantityInCase": 0,
"ReleaseDate": "2020-04-23",
"PrepDetailsList": [
{
"PrepInstruction": "Polybagging",
"PrepOwner": "AMAZON"
}
]
}
],
"MarketplaceId": "MarketplaceId"
}
}
}
},
"response": {
"payload": {
"ShipmentId": "ShipmentId"
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/InboundShipmentResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"MarketplaceId": "BADATVPDKIKX0DER",
"InboundShipmentHeader": {
"ShipmentName": "Shipment for FBA15DJCQ1ZF",
"ShipFromAddress": {
"Name": "Uma Test",
"AddressLine1": "123 any st",
"AddressLine2": "",
"DistrictOrCounty": "Washtenaw",
"City": "Ann Arbor",
"StateOrProvinceCode": "MI",
"CountryCode": "US",
"PostalCode": "48103"
},
"DestinationFulfillmentCenterId": "ABE2",
"ShipmentStatus": "WORKING",
"LabelPrepPreference": "SELLER_LABEL"
},
"InboundShipmentItems": [
{
"ShipmentId": "FBA15DJCQ1ZF",
"SellerSKU": "PSMM-TEST-SKU-Apr-03_21_17_20-0379",
"FulfillmentNetworkSKU": "X0014ENQ7B",
"QuantityShipped": 1,
"QuantityReceived": 1,
"QuantityInCase": 1,
"ReleaseDate": "2020-02-27"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/InboundShipmentResponse"
},
"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/InboundShipmentResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/InboundShipmentResponse"
},
"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/InboundShipmentResponse"
},
"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/InboundShipmentResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/InboundShipmentResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"put": {
"tags": [
"fbaInbound"
],
"description": "Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new items is not supported.\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 see higher rate and burst values than those shown here. For more information, see [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": "updateInboundShipment",
"deprecated": true,
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InboundShipmentRequest"
},
"description": "The request schema for the InboundShipmentRequest operation."
},
{
"name": "shipmentId",
"in": "path",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/InboundShipmentResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"MarketplaceId": "ATVPDKIKX0DER",
"InboundShipmentHeader": {
"ShipmentName": "Shipment for FBA15DJCQ1ZF",
"ShipFromAddress": {
"Name": "Uma Test",
"AddressLine1": "123 any st",
"AddressLine2": "",
"DistrictOrCounty": "Washtenaw",
"City": "Ann Arbor",
"StateOrProvinceCode": "CO",
"CountryCode": "US",
"PostalCode": "48104"
},
"DestinationFulfillmentCenterId": "ABE2",
"ShipmentStatus": "WORKING",
"LabelPrepPreference": "SELLER_LABEL"
},
"InboundShipmentItems": [
{
"SellerSKU": "PSMM-TEST-SKU-Apr-03_21_17_20-0379",
"QuantityShipped": 1
}
]
}
}
}
},
"response": {
"payload": {
"ShipmentId": "FBA15DJCQ1ZF"
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/InboundShipmentResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"MarketplaceId": "BADID",
"InboundShipmentHeader": {
"ShipmentName": "Shipment for FBA15DJCQ1ZF",
"ShipFromAddress": {
"Name": "Uma Test",
"AddressLine1": "123 any st",
"AddressLine2": "",
"DistrictOrCounty": "Washtenaw",
"City": "Ann Arbor",
"StateOrProvinceCode": "CO",
"CountryCode": "US",
"PostalCode": "48104"
},
"DestinationFulfillmentCenterId": "ABE2",
"ShipmentStatus": "WORKING",
"LabelPrepPreference": "SELLER_LABEL"
},
"InboundShipmentItems": [
{
"SellerSKU": "PSMM-TEST-SKU-Apr-03_21_17_20-0379",
"QuantityShipped": 1
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/InboundShipmentResponse"
},
"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/InboundShipmentResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/InboundShipmentResponse"
},
"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/InboundShipmentResponse"
},
"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/InboundShipmentResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/InboundShipmentResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/shipments/{shipmentId}/preorder": {
"get": {
"tags": [
"fbaInbound"
],
"description": "Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-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 see higher rate and burst values than those shown here. For more information, see [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": "getPreorderInfo",
"deprecated": true,
"parameters": [
{
"name": "shipmentId",
"in": "path",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"required": true,
"type": "string"
},
{
"name": "MarketplaceId",
"in": "query",
"description": "A marketplace identifier. Specifies the marketplace the shipment is tied to.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetPreorderInfoResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "shipmentId1"
},
"MarketplaceId": {
"value": "MarketplaceId1"
}
}
},
"response": {
"payload": {
"ShipmentContainsPreorderableItems": true,
"ShipmentConfirmedForPreorder": true,
"NeedByDate": "2020-04-23",
"ConfirmedFulfillableDate": "2020-04-23"
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetPreorderInfoResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "BADshipmentId1"
},
"MarketplaceId": {
"value": "BADMarketplaceId1"
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetPreorderInfoResponse"
},
"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/GetPreorderInfoResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetPreorderInfoResponse"
},
"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/GetPreorderInfoResponse"
},
"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/GetPreorderInfoResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetPreorderInfoResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/shipments/{shipmentId}/preorder/confirm": {
"put": {
"tags": [
"fbaInbound"
],
"description": "Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment.\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 see higher rate and burst values than those shown here. For more information, see [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": "confirmPreorder",
"deprecated": true,
"parameters": [
{
"name": "shipmentId",
"in": "path",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"required": true,
"type": "string"
},
{
"name": "NeedByDate",
"in": "query",
"description": "Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value.",
"required": true,
"type": "string",
"format": "date"
},
{
"name": "MarketplaceId",
"in": "query",
"description": "A marketplace identifier. Specifies the marketplace the shipment is tied to.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/ConfirmPreorderResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "shipmentId1"
},
"NeedByDate": {
"value": "2020-10-10"
},
"MarketplaceId": {
"value": "MarketplaceId1"
}
}
},
"response": {
"payload": {
"ConfirmedNeedByDate": "2020-04-23",
"ConfirmedFulfillableDate": "2020-04-23"
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/ConfirmPreorderResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "BADshipmentId1"
},
"NeedByDate": {
"value": "2020-10-10"
},
"MarketplaceId": {
"value": "BADMarketplaceId1"
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/ConfirmPreorderResponse"
},
"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/ConfirmPreorderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/ConfirmPreorderResponse"
},
"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/ConfirmPreorderResponse"
},
"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/ConfirmPreorderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ConfirmPreorderResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/prepInstructions": {
"get": {
"tags": [
"fbaInbound"
],
"description": "Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network.\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 see higher rate and burst values than those shown here. For more information, see [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": "getPrepInstructions",
"parameters": [
{
"name": "ShipToCountryCode",
"in": "query",
"description": "The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.",
"required": true,
"type": "string",
"format": "[A-Z]{2}"
},
{
"name": "SellerSKUList",
"in": "query",
"description": "A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API.\n\nNote: Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the InvalidSKUList property in the response.",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 50
},
{
"name": "ASINList",
"in": "query",
"description": "A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions.\n\nNote: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 50
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetPrepInstructionsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"ShipToCountryCode": {
"value": "US"
},
"ASINList": {
"value": [
"ASIN1"
]
}
}
},
"response": {
"payload": {
"SKUPrepInstructionsList": [
{
"SellerSKU": "SellerSKU",
"ASIN": "ASIN1",
"BarcodeInstruction": "RequiresFNSKULabel",
"PrepGuidance": "ConsultHelpDocuments",
"PrepInstructionList": [
"Polybagging"
],
"AmazonPrepFeesDetailsList": [
{
"PrepInstruction": "Polybagging",
"FeePerUnit": {
"CurrencyCode": "USD",
"Value": 10
}
}
]
}
],
"InvalidSKUList": [
{
"SellerSKU": "SellerSKU",
"ErrorReason": "DoesNotExist"
}
],
"ASINPrepInstructionsList": [
{
"ASIN": "ASIN1",
"BarcodeInstruction": "RequiresFNSKULabel",
"PrepGuidance": "ConsultHelpDocuments",
"PrepInstructionList": [
"Polybagging"
]
}
],
"InvalidASINList": [
{
"ASIN": "ASIN1",
"ErrorReason": "DoesNotExist"
}
]
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetPrepInstructionsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"ShipToCountryCode": {
"value": "US"
},
"ASINList": {
"value": [
"BADASIN"
]
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetPrepInstructionsResponse"
},
"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/GetPrepInstructionsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetPrepInstructionsResponse"
},
"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/GetPrepInstructionsResponse"
},
"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/GetPrepInstructionsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetPrepInstructionsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/shipments/{shipmentId}/transport": {
"get": {
"tags": [
"fbaInbound"
],
"description": "Returns current transportation information about an inbound shipment.\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 see higher rate and burst values than those shown here. For more information, see [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": "getTransportDetails",
"deprecated": true,
"parameters": [
{
"name": "shipmentId",
"in": "path",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetTransportDetailsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "shipmentId1"
}
}
},
"response": {
"payload": {
"TransportContent": {
"TransportHeader": {
"SellerId": "A3O2V2ZBRHE3NZ",
"ShipmentId": "FBA15DJCPTRK",
"IsPartnered": true,
"ShipmentType": "SP"
},
"TransportDetails": {
"PartneredSmallParcelData": {
"PackageList": [
{
"Dimensions": {
"Length": 11.0,
"Width": 11.0,
"Height": 11.0,
"Unit": "IN"
},
"Weight": {
"Value": 11.0,
"Unit": "pounds"
},
"CarrierName": "UNITED_PARCEL_SERVICE_INC",
"PackageStatus": "SHIPPED"
}
]
}
},
"TransportResult": {
"TransportStatus": "WORKING"
}
}
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetTransportDetailsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "BADshipmentId1"
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetTransportDetailsResponse"
},
"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/GetTransportDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetTransportDetailsResponse"
},
"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/GetTransportDetailsResponse"
},
"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/GetTransportDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetTransportDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"put": {
"tags": [
"fbaInbound"
],
"description": "Sends transportation information to Amazon about an inbound shipment.\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 see higher rate and burst values than those shown here. For more information, see [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": "putTransportDetails",
"deprecated": true,
"parameters": [
{
"name": "shipmentId",
"in": "path",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PutTransportDetailsRequest"
},
"description": "The request schema for the PutTransportDetailsRequest operation."
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/PutTransportDetailsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "shipmentId1"
},
"body": {
"value": {
"IsPartnered": true,
"ShipmentType": "SP",
"TransportDetails": {
"PartneredSmallParcelData": {
"PackageList": [
{
"Dimensions": {
"Length": 11,
"Width": 11,
"Height": 11,
"Unit": "inches"
},
"Weight": {
"Value": 11,
"Unit": "pounds"
}
}
],
"CarrierName": "string"
},
"NonPartneredSmallParcelData": {
"CarrierName": "USPS",
"PackageList": [
{
"TrackingId": "werwrwerwrwrer"
}
]
},
"PartneredLtlData": {
"Contact": {
"Name": "Test1",
"Phone": "234-343-3434",
"Email": "[email protected]",
"Fax": "234-343-3434"
},
"BoxCount": 1,
"SellerFreightClass": "50",
"FreightReadyDate": "2020-03-27",
"PalletList": [
{
"Dimensions": {
"Length": 13,
"Width": 13,
"Height": 13,
"Unit": "inches"
},
"Weight": {
"Value": 13,
"Unit": "pounds"
},
"IsStacked": true
}
],
"TotalWeight": {
"Value": 13,
"Unit": "pounds"
},
"SellerDeclaredValue": {
"CurrencyCode": "USD",
"Value": 20
}
},
"NonPartneredLtlData": {
"CarrierName": "USPS",
"ProNumber": "3746274"
}
}
}
}
}
},
"response": {
"payload": {
"TransportResult": {
"TransportStatus": "WORKING"
}
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/PutTransportDetailsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "BADshipmentId1"
},
"body": {
"value": {
"IsPartnered": true,
"ShipmentType": "SP",
"TransportDetails": {
"PartneredSmallParcelData": {
"PackageList": [
{
"Dimensions": {
"Length": 11,
"Width": 11,
"Height": 11,
"Unit": "inches"
},
"Weight": {
"Value": 11,
"Unit": "pounds"
}
}
],
"CarrierName": "string"
},
"NonPartneredSmallParcelData": {
"CarrierName": "USPS",
"PackageList": [
{
"TrackingId": "werwrwerwrwrer"
}
]
},
"PartneredLtlData": {
"Contact": {
"Name": "Test1",
"Phone": "234-343-3434",
"Email": "[email protected]",
"Fax": "234-343-3434"
},
"BoxCount": 1,
"SellerFreightClass": "50",
"FreightReadyDate": "2020-03-27",
"PalletList": [
{
"Dimensions": {
"Length": 13,
"Width": 13,
"Height": 13,
"Unit": "inches"
},
"Weight": {
"Value": 13,
"Unit": "pounds"
},
"IsStacked": true
}
],
"TotalWeight": {
"Value": 13,
"Unit": "pounds"
},
"SellerDeclaredValue": {
"CurrencyCode": "USD",
"Value": 20
}
},
"NonPartneredLtlData": {
"CarrierName": "USPS",
"ProNumber": "3746274"
}
}
}
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/PutTransportDetailsResponse"
},
"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/PutTransportDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/PutTransportDetailsResponse"
},
"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/PutTransportDetailsResponse"
},
"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/PutTransportDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/PutTransportDetailsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/shipments/{shipmentId}/transport/void": {
"post": {
"tags": [
"fbaInbound"
],
"description": "Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier.\n\nTo be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation.\n\nImportant: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping cost.\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 see higher rate and burst values than those shown here. For more information, see [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": "voidTransport",
"deprecated": true,
"parameters": [
{
"name": "shipmentId",
"in": "path",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/VoidTransportResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "shipmentId1"
}
}
},
"response": {
"payload": {
"TransportResult": {
"TransportStatus": "VOIDING"
}
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/VoidTransportResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "badshipmentId1"
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/VoidTransportResponse"
},
"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/VoidTransportResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/VoidTransportResponse"
},
"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/VoidTransportResponse"
},
"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/VoidTransportResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/VoidTransportResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/shipments/{shipmentId}/transport/estimate": {
"post": {
"tags": [
"fbaInbound"
],
"description": "Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier.\n\nPrior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment.\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 see higher rate and burst values than those shown here. For more information, see [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": "estimateTransport",
"deprecated": true,
"parameters": [
{
"name": "shipmentId",
"in": "path",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/EstimateTransportResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "shipmentId1"
}
}
},
"response": {
"payload": {
"TransportResult": {
"TransportStatus": "ESTIMATING"
}
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/EstimateTransportResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "BadshipmentId1"
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/EstimateTransportResponse"
},
"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/EstimateTransportResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/EstimateTransportResponse"
},
"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/EstimateTransportResponse"
},
"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/EstimateTransportResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/EstimateTransportResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/shipments/{shipmentId}/transport/confirm": {
"post": {
"tags": [
"fbaInbound"
],
"description": "Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment.\n\nPrior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate.\n\nImportant: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller's account will be charged for the shipping cost.\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 see higher rate and burst values than those shown here. For more information, see [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": "confirmTransport",
"deprecated": true,
"parameters": [
{
"name": "shipmentId",
"in": "path",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/ConfirmTransportResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "shipmentId1"
}
}
},
"response": {
"payload": {
"TransportResult": {
"TransportStatus": "CONFIRMING"
}
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/ConfirmTransportResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "BADshipmentId1"
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/ConfirmTransportResponse"
},
"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/ConfirmTransportResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/ConfirmTransportResponse"
},
"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/ConfirmTransportResponse"
},
"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/ConfirmTransportResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ConfirmTransportResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/shipments/{shipmentId}/labels": {
"get": {
"tags": [
"fbaInbound"
],
"description": "Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.\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 see higher rate and burst values than those shown here. For more information, see [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": "getLabels",
"parameters": [
{
"name": "shipmentId",
"in": "path",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"required": true,
"type": "string"
},
{
"name": "PageType",
"in": "query",
"description": "The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.",
"required": true,
"type": "string",
"enum": [
"PackageLabel_Letter_2",
"PackageLabel_Letter_4",
"PackageLabel_Letter_6",
"PackageLabel_Letter_6_CarrierLeft",
"PackageLabel_A4_2",
"PackageLabel_A4_4",
"PackageLabel_Plain_Paper",
"PackageLabel_Plain_Paper_CarrierBottom",
"PackageLabel_Thermal",
"PackageLabel_Thermal_Unified",
"PackageLabel_Thermal_NonPCP",
"PackageLabel_Thermal_No_Carrier_Rotation"
],
"x-docgen-enum-table-extension": [
{
"value": "PackageLabel_Letter_2",
"description": "Two labels per US Letter label sheet. This is the only valid value for Amazon-partnered shipments in the US that use United Parcel Service (UPS) as the carrier. Supported in Canada and the US."
},
{
"value": "PackageLabel_Letter_4",
"description": "Four labels per US Letter label sheet. This is the only valid value for non-Amazon-partnered shipments in the US. Supported in Canada and the US."
},
{
"value": "PackageLabel_Letter_6",
"description": "Six labels per US Letter label sheet. This is the only valid value for non-Amazon-partnered shipments in the US. Supported in Canada and the US."
},
{
"value": "PackageLabel_Letter_6_CarrierLeft",
"description": "PackageLabel_Letter_6_CarrierLeft"
},
{
"value": "PackageLabel_A4_2",
"description": "Two labels per A4 label sheet."
},
{
"value": "PackageLabel_A4_4",
"description": "Four labels per A4 label sheet."
},
{
"value": "PackageLabel_Plain_Paper",
"description": "One label per sheet of US Letter paper. Only for non-Amazon-partnered shipments. "
},
{
"value": "PackageLabel_Plain_Paper_CarrierBottom",
"description": "PackageLabel_Plain_Paper_CarrierBottom"
},
{
"value": "PackageLabel_Thermal",
"description": "For use of a thermal printer. Supports Amazon-partnered shipments with UPS."
},
{
"value": "PackageLabel_Thermal_Unified",
"description": "For use of a thermal printer. Supports shipments with ATS."
},
{
"value": "PackageLabel_Thermal_NonPCP",
"description": "For use of a thermal printer. Supports non-Amazon-partnered shipments."
},
{
"value": "PackageLabel_Thermal_No_Carrier_Rotation",
"description": "For use of a thermal printer. Supports Amazon-partnered shipments with DHL."
}
]
},
{
"name": "LabelType",
"in": "query",
"description": "The type of labels requested. ",
"required": true,
"type": "string",
"enum": [
"BARCODE_2D",
"UNIQUE",
"PALLET"
],
"x-docgen-enum-table-extension": [
{
"value": "BARCODE_2D",
"description": "This option is provided only for shipments where 2D Barcodes will be applied to all packages. Amazon strongly recommends using the UNIQUE option to get package labels instead of the BARCODE_2D option."
},
{
"value": "UNIQUE",
"description": "Document data for printing unique shipping labels and carrier labels for an inbound shipment."
},
{
"value": "PALLET",
"description": "Document data for printing pallet labels for a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment."
}
]
},
{
"name": "NumberOfPackages",
"in": "query",
"description": "The number of packages in the shipment.",
"required": false,
"type": "integer"
},
{
"name": "PackageLabelsToPrint",
"in": "query",
"description": "A list of identifiers that specify packages for which you want package labels printed.\n\nIf you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then `PackageLabelsToPrint` must match the `CartonId` values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then `PackageLabelsToPrint` must match the `boxID` values from the [`listShipmentBoxes`](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentboxes) response. If these values do not match as required, the operation returns the `IncorrectPackageIdentifier` error code.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "NumberOfPallets",
"in": "query",
"description": "The number of pallets in the shipment. This returns four identical labels for each pallet.",
"required": false,
"type": "integer"
},
{
"name": "PageSize",
"description": "The page size for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.",
"in": "query",
"required": false,
"type": "integer"
},
{
"name": "PageStartIndex",
"description": "The page start index for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments.",
"in": "query",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetLabelsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "348975493"
},
"PageType": {
"value": "PackageLabel_Letter_2"
},
"LabelType": {
"value": "BARCODE_2D"
}
}
},
"response": {
"payload": {
"DownloadURL": "http://www.labels.url.com"
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetLabelsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "BADVALUE"
},
"PageType": {
"value": "PackageLabel_Letter_2"
},
"LabelType": {
"value": "BARCODE_2D"
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetLabelsResponse"
},
"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/GetLabelsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetLabelsResponse"
},
"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/GetLabelsResponse"
},
"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/GetLabelsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetLabelsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/shipments/{shipmentId}/billOfLading": {
"get": {
"tags": [
"fbaInbound"
],
"description": "Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment.\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 see higher rate and burst values than those shown here. For more information, see [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": "getBillOfLading",
"parameters": [
{
"name": "shipmentId",
"in": "path",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetBillOfLadingResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "shipmentId"
}
}
},
"response": {
"payload": {
"DownloadURL": "http://bill-of.lading.url.com"
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetBillOfLadingResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"shipmentId": {
"value": "badid1"
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetBillOfLadingResponse"
},
"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/GetBillOfLadingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetBillOfLadingResponse"
},
"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/GetBillOfLadingResponse"
},
"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/GetBillOfLadingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetBillOfLadingResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/shipments": {
"get": {
"tags": [
"fbaInbound"
],
"description": "Returns a list of inbound shipments based on 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 see higher rate and burst values than those shown here. For more information, see [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": "getShipments",
"parameters": [
{
"name": "ShipmentStatusList",
"in": "query",
"description": "A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"WORKING",
"READY_TO_SHIP",
"SHIPPED",
"RECEIVING",
"CANCELLED",
"DELETED",
"CLOSED",
"ERROR",
"IN_TRANSIT",
"DELIVERED",
"CHECKED_IN"
],
"x-docgen-enum-table-extension": [
{
"value": "WORKING",
"description": "The shipment was created by the seller, but has not yet shipped."
},
{
"value": "READY_TO_SHIP",
"description": "The seller has printed box labels (for Small parcel shipments) or pallet labels (for Less Than Truckload shipments)."
},
{
"value": "SHIPPED",
"description": "The shipment was picked up by the carrier."
},
{
"value": "RECEIVING",
"description": "The shipment has arrived at the fulfillment center, but not all items have been marked as received."
},
{
"value": "CANCELLED",
"description": "The shipment was cancelled by the seller after the shipment was sent to the fulfillment center."
},
{
"value": "DELETED",
"description": "The shipment was cancelled by the seller before the shipment was sent to the fulfillment center."
},
{
"value": "CLOSED",
"description": "The shipment has arrived at the fulfillment center and all items have been marked as received."
},
{
"value": "ERROR",
"description": "There was an error with the shipment and it was not processed by Amazon."
},
{
"value": "IN_TRANSIT",
"description": "The carrier has notified the fulfillment center that it is aware of the shipment."
},
{
"value": "DELIVERED",
"description": "The shipment was delivered by the carrier to the fulfillment center."
},
{
"value": "CHECKED_IN",
"description": "The shipment was checked-in at the receiving dock of the fulfillment center."
}
]
}
},
{
"name": "ShipmentIdList",
"in": "query",
"description": "A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 999
},
{
"name": "LastUpdatedAfter",
"in": "query",
"description": "A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "LastUpdatedBefore",
"in": "query",
"description": "A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "QueryType",
"in": "query",
"description": "Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.",
"required": true,
"type": "string",
"enum": [
"SHIPMENT",
"DATE_RANGE",
"NEXT_TOKEN"
],
"x-docgen-enum-table-extension": [
{
"value": "SHIPMENT",
"description": "Returns shipments based on the shipment information provided by the ShipmentStatusList or ShipmentIdList parameters."
},
{
"value": "DATE_RANGE",
"description": "Returns shipments based on the date range information provided by the LastUpdatedAfter and LastUpdatedBefore parameters."
},
{
"value": "NEXT_TOKEN",
"description": "Returns shipments by using NextToken to continue returning items specified in a previous request."
}
]
},
{
"name": "NextToken",
"in": "query",
"description": "A string token returned in the response to your previous request.",
"required": false,
"type": "string"
},
{
"name": "MarketplaceId",
"in": "query",
"description": "A marketplace identifier. Specifies the marketplace where the product would be stored.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetShipmentsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
},
"QueryType": {
"value": "SHIPMENT"
}
}
},
"response": {
"payload": {
"ShipmentData": [
{
"ShipmentId": "FBA15DJ9S3J5",
"ShipmentName": "FBA (2/11/20, 11:18 AM) - 1",
"ShipFromAddress": {
"Name": "vungu+naperfectUS",
"AddressLine1": "501 Fairview Ave N",
"City": "Seattle",
"StateOrProvinceCode": "WA",
"CountryCode": "US",
"PostalCode": "98109"
},
"DestinationFulfillmentCenterId": "MKC6",
"ShipmentStatus": "SHIPPED",
"LabelPrepType": "SELLER_LABEL",
"BoxContentsSource": "INTERACTIVE"
}
],
"NextToken": "AAAAAAAAAADwtRhfSFJXzbRgKc+wYysmXwEAAAAAAACLuoztkDYG/ClQt9ELs4kYW6MrmpJdFf1QQYk6hSIZSsy5ipek26YvTwmkD9i4cbQny1EWwuuU88wghPxa7770q5R+YYCuP4pYWVy3AVAzWzAib6BRlDr4B0msx6sOKcYCy6ms4J021964JOS9nZhRBGfJ86d96S91rhJPli55+r7Jp+VHPly2FCJ2mAuC53sGTsNP108IUuPdbZqq2myWZ5U+EggLjhRBvXhHFFxRclETG7XfyX46A9nCKKhJYEjDFmMPQoQPtqSuxtMAUMDLPs4MttashstL96Oiu79VYhjV84L13mdMNZS6g21HKgU5E6CDivHvsgS5kC7joXHrXGjwpXMeLcfJqwg+DocBFiU2NELMEbfksrIGXVVjFqiLxHtTiDBsuDxDLbYeVepW0E9oA/ppbZJK4c0nDbgT3WSxxfsgpmAZ42O6iVMhW/KVlJZFDjKsmmHATcq5S5c="
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetShipmentsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "BADATVPDKIKX0DER"
},
"QueryType": {
"value": "BADSHIPMENT"
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetShipmentsResponse"
},
"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/GetShipmentsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetShipmentsResponse"
},
"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/GetShipmentsResponse"
},
"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/GetShipmentsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetShipmentsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/shipments/{shipmentId}/items": {
"get": {
"tags": [
"fbaInbound"
],
"description": "Returns a list of items in a specified inbound shipment.\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 see higher rate and burst values than those shown here. For more information, see [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": "getShipmentItemsByShipmentId",
"parameters": [
{
"name": "shipmentId",
"in": "path",
"description": "A shipment identifier used for selecting items in a specific inbound shipment.",
"required": true,
"type": "string"
},
{
"name": "MarketplaceId",
"in": "query",
"description": "A marketplace identifier. Specifies the marketplace where the product would be stored.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetShipmentItemsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
},
"shipmentId": {
"value": "FBA15DJ9SVVD"
}
}
},
"response": {
"payload": {
"ItemData": [
{
"ShipmentId": "FBA15DF2763D",
"SellerSKU": "CR-47K6-H6QN",
"FulfillmentNetworkSKU": "X0014BIZ8T",
"QuantityShipped": 4,
"QuantityReceived": 0,
"QuantityInCase": 0,
"ReleaseDate": "2013-05-29",
"PrepDetailsList": [
{
"PrepInstruction": "Labeling",
"PrepOwner": "SELLER"
},
{
"PrepInstruction": "Polybagging",
"PrepOwner": "SELLER"
}
]
}
],
"NextToken": "AAAAAAAAAABtqoY6CcWi1L8mJB7Nnt2gaQEAAAAAAAD6ehPTas9PliWJK6+QPwRpOgJJTgQphGOQ+9o1k7PBrBe5GrNyGDQYBmz2D4yDT4FVSHVhpbKi8Mgrw3tfRTLrkcMQOn5CvEySS5ePVzv8WhjCDxM9FGwBzoeDWLKx9OEy29XlAFkeBdwaxOAxEMF97uQkxGhUQS5sGeXdSAXNXMgCoOXMgw+JlsgzIq3Byt/yObIt8z9T0GPk440bqiQZl3ceVEiLX2g2LAa5qNwJBtCgYtizJsYSu/tX9zbR0Fe13bSqTOUEAXykYvQSTYCbuEPC3UFukVLobuP0lW+WZzZxcbWRxEzBTHnlgorzdsCc4cBnWVhTdp5nxTPeiYGbda9KilRFXtVl1vgXCHq5npDNV9yULsgjAqFPDBaz8YMlKoJgCe2E1GmbHzenJW21IHcIo3gtmujx+ib3Y9j23SwCfEbsUR9OrFNvGxiZ0VS7qYzm+fvElsU9jBx1PFrOigHnGD71Yq+y"
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetShipmentItemsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "BADATVPDKIKX0DER"
},
"shipmentId": {
"value": "BADFBA15DJ9SVVD"
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetShipmentItemsResponse"
},
"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/GetShipmentItemsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetShipmentItemsResponse"
},
"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/GetShipmentItemsResponse"
},
"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/GetShipmentItemsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetShipmentItemsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inbound/v0/shipmentItems": {
"get": {
"tags": [
"fbaInbound"
],
"description": "Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame.\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 see higher rate and burst values than those shown here. For more information, see [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": "getShipmentItems",
"parameters": [
{
"name": "LastUpdatedAfter",
"in": "query",
"description": "A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "LastUpdatedBefore",
"in": "query",
"description": "A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "QueryType",
"in": "query",
"description": "Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.",
"required": true,
"type": "string",
"enum": [
"DATE_RANGE",
"NEXT_TOKEN"
],
"x-docgen-enum-table-extension": [
{
"value": "DATE_RANGE",
"description": "Returns items based on the date range information provided by the LastUpdatedAfter and LastUpdatedBefore parameters."
},
{
"value": "NEXT_TOKEN",
"description": "Returns items by using NextToken to continue returning items specified in a previous request."
}
]
},
{
"name": "NextToken",
"in": "query",
"description": "A string token returned in the response to your previous request.",
"required": false,
"type": "string"
},
{
"name": "MarketplaceId",
"in": "query",
"description": "A marketplace identifier. Specifies the marketplace where the product would be stored.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetShipmentItemsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
},
"QueryType": {
"value": "SHIPMENT"
},
"NextToken": {
"value": "NextToken"
}
}
},
"response": {
"payload": {
"ItemData": [
{
"ShipmentId": "FBA15DF2763D",
"SellerSKU": "CR-47K6-H6QN",
"FulfillmentNetworkSKU": "X0014BIZ8T",
"QuantityShipped": 4,
"QuantityReceived": 0,
"QuantityInCase": 0,
"ReleaseDate": "2013-05-29",
"PrepDetailsList": [
{
"PrepInstruction": "Labeling",
"PrepOwner": "SELLER"
},
{
"PrepInstruction": "Polybagging",
"PrepOwner": "SELLER"
}
]
}
],
"NextToken": "AAAAAAAAAABtqoY6CcWi1L8mJB7Nnt2gaQEAAAAAAAD6ehPTas9PliWJK6QPwRpOgJJTgQphGOQ9o1k7PBrBe5GrNyGDQYBmz2D4yDT4FVSHVhpbKi8Mgrw3tfRTLrkcMQOn5CvEySS5ePVzv8WhjCDxM9FGwBzoeDWLKx9OEy29XlAFkeBdwaxOAxEMF97uQkxGhUQS5sGeXdSAXNXMgCoOXMgwJlsgzIq3BytyObIt8z9T0GPk440bqiQZl3ceVEiLX2g2LAa5qNwJBtCgYtizJsYSutX9zbR0Fe13bSqTOUEAXykYvQSTYCbuEPC3UFukVLobuP0lWWZzZxcbWRxEzBTHnlgorzdsCc4cBnWVhTdp5nxTPeiYGbda9KilRFXtVl1vgXCHq5npDNV9yULsgjAqFPDBaz8YMlKoJgCe2E1GmbHzenJW21IHcIo3gtmujxib3Y9j23SwCfEbsUR9OrFNvGxiZ0VS7qYzmfvElsU9jBx1PFrOigHnGD71Yq"
}
}
},
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "ATVPDKIKX0DER"
},
"QueryType": {
"value": "SHIPMENT"
},
"NextToken": {
"value": "AAAAAAAAAABtqoY6CcWi1L8mJB7Nnt2gaQEAAAAAAAD6ehPTas9PliWJK6QPwRpOgJJTgQphGOQ9o1k7PBrBe5GrNyGDQYBmz2D4yDT4FVSHVhpbKi8Mgrw3tfRTLrkcMQOn5CvEySS5ePVzv8WhjCDxM9FGwBzoeDWLKx9OEy29XlAFkeBdwaxOAxEMF97uQkxGhUQS5sGeXdSAXNXMgCoOXMgwJlsgzIq3BytyObIt8z9T0GPk440bqiQZl3ceVEiLX2g2LAa5qNwJBtCgYtizJsYSutX9zbR0Fe13bSqTOUEAXykYvQSTYCbuEPC3UFukVLobuP0lWWZzZxcbWRxEzBTHnlgorzdsCc4cBnWVhTdp5nxTPeiYGbda9KilRFXtVl1vgXCHq5npDNV9yULsgjAqFPDBaz8YMlKoJgCe2E1GmbHzenJW21IHcIo3gtmujxib3Y9j23SwCfEbsUR9OrFNvGxiZ0VS7qYzmfvElsU9jBx1PFrOigHnGD71Yq"
}
}
},
"response": {
"payload": {
"ItemData": [
{
"ShipmentId": "FBA15DF2763D",
"SellerSKU": "CR-47K6-H6QN",
"FulfillmentNetworkSKU": "X0014BIZ8T",
"QuantityShipped": 4,
"QuantityReceived": 0,
"QuantityInCase": 0,
"ReleaseDate": "2013-05-29",
"PrepDetailsList": [
{
"PrepInstruction": "Labeling",
"PrepOwner": "SELLER"
},
{
"PrepInstruction": "Polybagging",
"PrepOwner": "SELLER"
}
]
}
]
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetShipmentItemsResponse"
},
"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."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"MarketplaceId": {
"value": "BADATVPDKIKX0DER"
},
"QueryType": {
"value": "BADSHIPMENT"
},
"NextToken": {
"value": "BADNextToken"
}
}
},
"response": {
"errors": [
{
"code": "Invalid Input",
"message": "Data is invalid. Please check."
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetShipmentItemsResponse"
},
"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/GetShipmentItemsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetShipmentItemsResponse"
},
"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/GetShipmentItemsResponse"
},
"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/GetShipmentItemsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetShipmentItemsResponse"
},
"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 occured."
},
"message": {
"type": "string",
"description": "A message that describes the error condition in a human-readable form."
},
"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"
}
},
"ASINInboundGuidance": {
"type": "object",
"required": [
"ASIN",
"InboundGuidance"
],
"properties": {
"ASIN": {
"type": "string",
"description": "The Amazon Standard Identification Number (ASIN) of the item."
},
"InboundGuidance": {
"$ref": "#/definitions/InboundGuidance"
},
"GuidanceReasonList": {
"description": "A list of reasons for the current inbound guidance for this item.",
"$ref": "#/definitions/GuidanceReasonList"
}
},
"description": "Reasons why a given ASIN is not recommended for shipment to Amazon's fulfillment network."
},
"ASINInboundGuidanceList": {
"type": "array",
"description": "A list of ASINs and their associated inbound guidance.",
"items": {
"$ref": "#/definitions/ASINInboundGuidance"
}
},
"ASINPrepInstructions": {
"type": "object",
"properties": {
"ASIN": {
"type": "string",
"description": "The Amazon Standard Identification Number (ASIN) of the item."
},
"BarcodeInstruction": {
"$ref": "#/definitions/BarcodeInstruction"
},
"PrepGuidance": {
"$ref": "#/definitions/PrepGuidance"
},
"PrepInstructionList": {
"$ref": "#/definitions/PrepInstructionList"
}
},
"description": "Item preparation instructions to help with item sourcing decisions."
},
"ASINPrepInstructionsList": {
"type": "array",
"description": "A list of item preparation instructions.",
"items": {
"$ref": "#/definitions/ASINPrepInstructions"
}
},
"Address": {
"type": "object",
"description": "Specific details to identify a place.",
"required": [
"AddressLine1",
"City",
"CountryCode",
"Name",
"PostalCode",
"StateOrProvinceCode"
],
"properties": {
"Name": {
"type": "string",
"description": "Name of the individual or business.",
"maxLength": 50
},
"AddressLine1": {
"type": "string",
"description": "The street address information.",
"maxLength": 180
},
"AddressLine2": {
"type": "string",
"description": "Additional street address information, if required.",
"maxLength": 60
},
"DistrictOrCounty": {
"type": "string",
"description": "The district or county.",
"maxLength": 25
},
"City": {
"type": "string",
"description": "The city.",
"maxLength": 30
},
"StateOrProvinceCode": {
"type": "string",
"description": "The state or province code.\n\nIf state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan."
},
"CountryCode": {
"type": "string",
"description": "The country code in two-character ISO 3166-1 alpha-2 format."
},
"PostalCode": {
"type": "string",
"description": "The postal code.\n\nIf postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan.",
"maxLength": 30
}
}
},
"AmazonPrepFeesDetails": {
"type": "object",
"properties": {
"PrepInstruction": {
"$ref": "#/definitions/PrepInstruction"
},
"FeePerUnit": {
"description": "The fee for Amazon to prepare 1 unit.",
"$ref": "#/definitions/Amount"
}
},
"description": "The fees for Amazon to prep goods for shipment."
},
"AmazonPrepFeesDetailsList": {
"type": "array",
"description": "A list of preparation instructions and fees for Amazon to prep goods for shipment.",
"items": {
"$ref": "#/definitions/AmazonPrepFeesDetails"
}
},
"Amount": {
"type": "object",
"required": [
"CurrencyCode",
"Value"
],
"properties": {
"CurrencyCode": {
"$ref": "#/definitions/CurrencyCode"
},
"Value": {
"description": "The amount.",
"$ref": "#/definitions/BigDecimalType"
}
},
"description": "The monetary value."
},
"BarcodeInstruction": {
"type": "string",
"description": "Labeling requirements for the item. For more information about FBA labeling requirements, see the Seller Central Help for your marketplace.",
"enum": [
"RequiresFNSKULabel",
"CanUseOriginalBarcode",
"MustProvideSellerSKU"
],
"x-docgen-enum-table-extension": [
{
"value": "RequiresFNSKULabel",
"description": "Indicates that a scannable FBA product label must be applied to the item. Cover any original bar codes on the item."
},
{
"value": "CanUseOriginalBarcode",
"description": "Indicates that the item does not require a scannable FBA product label. The original manufacturer's bar code can be used."
},
{
"value": "MustProvideSellerSKU",
"description": "Amazon is unable to return labeling requirements. To get labeling requirements for items, call the getPrepInstructions operation."
}
]
},
"BigDecimalType": {
"type": "number",
"format": "double",
"description": "Number format that supports decimal."
},
"BoxContentsFeeDetails": {
"type": "object",
"properties": {
"TotalUnits": {
"description": "The number of units to ship.",
"$ref": "#/definitions/Quantity"
},
"FeePerUnit": {
"description": "The manual processing fee per unit.",
"$ref": "#/definitions/Amount"
},
"TotalFee": {
"description": "The total manual processing fee for the shipment.",
"$ref": "#/definitions/Amount"
}
},
"description": "The manual processing fee per unit and total fee for a shipment."
},
"BoxContentsSource": {
"type": "string",
"description": "Where the seller provided box contents information for a shipment.",
"enum": [
"NONE",
"FEED",
"2D_BARCODE",
"INTERACTIVE"
],
"x-docgen-enum-table-extension": [
{
"value": "NONE",
"description": "There is no box contents information for this shipment. Amazon will manually process the box contents information. This may incur a fee."
},
{
"value": "FEED",
"description": "Box contents information is provided through the _POST_FBA_INBOUND_CARTON_CONTENTS_ feed."
},
{
"value": "2D_BARCODE",
"description": "Box contents information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central."
},
{
"value": "INTERACTIVE",
"description": "Box contents information is provided by an interactive source, such as a web tool."
}
]
},
"Condition": {
"type": "string",
"description": "The condition of the item.",
"enum": [
"NewItem",
"NewWithWarranty",
"NewOEM",
"NewOpenBox",
"UsedLikeNew",
"UsedVeryGood",
"UsedGood",
"UsedAcceptable",
"UsedPoor",
"UsedRefurbished",
"CollectibleLikeNew",
"CollectibleVeryGood",
"CollectibleGood",
"CollectibleAcceptable",
"CollectiblePoor",
"RefurbishedWithWarranty",
"Refurbished",
"Club"
],
"x-docgen-enum-table-extension": [
{
"value": "NewItem",
"description": "NewItem"
},
{
"value": "NewWithWarranty",
"description": "NewWithWarranty"
},
{
"value": "NewOEM",
"description": "NewOEM"
},
{
"value": "NewOpenBox",
"description": "NewOpenBox"
},
{
"value": "UsedLikeNew",
"description": "UsedLikeNew"
},
{
"value": "UsedVeryGood",
"description": "UsedVeryGood"
},
{
"value": "UsedGood",
"description": "UsedGood"
},
{
"value": "UsedAcceptable",
"description": "UsedAcceptable"
},
{
"value": "UsedPoor",
"description": "UsedPoor"
},
{
"value": "UsedRefurbished",
"description": "UsedRefurbished"
},
{
"value": "CollectibleLikeNew",
"description": "CollectibleLikeNew"
},
{
"value": "CollectibleVeryGood",
"description": "CollectibleVeryGood"
},
{
"value": "CollectibleGood",
"description": "CollectibleGood"
},
{
"value": "CollectibleAcceptable",
"description": "CollectibleAcceptable"
},
{
"value": "CollectiblePoor",
"description": "CollectiblePoor"
},
{
"value": "RefurbishedWithWarranty",
"description": "RefurbishedWithWarranty"
},
{
"value": "Refurbished",
"description": "Refurbished"
},
{
"value": "Club",
"description": "Club"
}
]
},
"ConfirmPreorderResult": {
"type": "object",
"properties": {
"ConfirmedNeedByDate": {
"description": "Date passed in with the NeedByDate parameter. The confirmed shipment must arrive at the Amazon fulfillment center by this date to avoid delivery promise breaks for pre-ordered items. In YYYY-MM-DD format.",
"$ref": "#/definitions/DateStringType"
},
"ConfirmedFulfillableDate": {
"description": "Date that determines which pre-order items in the shipment are eligible for pre-order. The pre-order Buy Box will appear for any pre-order item in the shipment with a release date on or after this date. In YYYY-MM-DD format.",
"$ref": "#/definitions/DateStringType"
}
},
"description": "Result for confirm preorder operation"
},
"ConfirmPreorderResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the confirmPreorder operation.",
"$ref": "#/definitions/ConfirmPreorderResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the confirmPreorder operation."
},
"CommonTransportResult": {
"type": "object",
"properties": {
"TransportResult": {
"$ref": "#/definitions/TransportResult"
}
},
"description": "Common container for transport result"
},
"ConfirmTransportResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the confirmTransport operation.",
"$ref": "#/definitions/CommonTransportResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the confirmTransport operation."
},
"Contact": {
"type": "object",
"required": [
"Email",
"Name",
"Phone"
],
"properties": {
"Name": {
"type": "string",
"description": "The name of the contact person.",
"maxLength": 50
},
"Phone": {
"type": "string",
"description": "The phone number of the contact person.",
"maxLength": 20
},
"Email": {
"type": "string",
"description": "The email address of the contact person.",
"maxLength": 50
},
"Fax": {
"type": "string",
"description": "The fax number of the contact person.",
"maxLength": 20
}
},
"description": "Contact information for the person in the seller's organization who is responsible for a Less Than Truckload/Full Truckload (LTL/FTL) shipment."
},
"CreateInboundShipmentPlanRequest": {
"type": "object",
"required": [
"InboundShipmentPlanRequestItems",
"LabelPrepPreference",
"ShipFromAddress"
],
"properties": {
"ShipFromAddress": {
"description": "The address from which the inbound shipment will be sent.",
"$ref": "#/definitions/Address"
},
"LabelPrepPreference": {
"description": "The seller's preference for label preparation for an inbound shipment.",
"$ref": "#/definitions/LabelPrepPreference"
},
"ShipToCountryCode": {
"type": "string",
"description": "The two-character country code for the country where the inbound shipment is to be sent.\n\nNote: Not required. Specifying both ShipToCountryCode and ShipToCountrySubdivisionCode returns an error.\n\n Values:\n\n ShipToCountryCode values for North America:\n * CA – Canada\n * MX - Mexico\n * US - United States\n\nShipToCountryCode values for MCI sellers in Europe:\n * DE – Germany\n * ES – Spain\n * FR – France\n * GB – United Kingdom\n * IT – Italy\n\nDefault: The country code for the seller's home marketplace."
},
"ShipToCountrySubdivisionCode": {
"type": "string",
"description": "The two-character country code, followed by a dash and then up to three characters that represent the subdivision of the country where the inbound shipment is to be sent. For example, \"IN-MH\". In full ISO 3166-2 format.\n\nNote: Not required. Specifying both ShipToCountryCode and ShipToCountrySubdivisionCode returns an error."
},
"InboundShipmentPlanRequestItems": {
"$ref": "#/definitions/InboundShipmentPlanRequestItemList"
}
},
"description": "The request schema for the createInboundShipmentPlan operation."
},
"CreateInboundShipmentPlanResult": {
"type": "object",
"properties": {
"InboundShipmentPlans": {
"$ref": "#/definitions/InboundShipmentPlanList"
}
},
"description": "Result for the create inbound shipment operation"
},
"CreateInboundShipmentPlanResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the createInboundShipmentPlan operation.",
"$ref": "#/definitions/CreateInboundShipmentPlanResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the createInboundShipmentPlan operation."
},
"InboundShipmentRequest": {
"type": "object",
"required": [
"InboundShipmentHeader",
"InboundShipmentItems",
"MarketplaceId"
],
"properties": {
"InboundShipmentHeader": {
"$ref": "#/definitions/InboundShipmentHeader"
},
"InboundShipmentItems": {
"$ref": "#/definitions/InboundShipmentItemList"
},
"MarketplaceId": {
"type": "string",
"description": "A marketplace identifier. Specifies the marketplace where the product would be stored."
}
},
"description": "The request schema for an inbound shipment."
},
"InboundShipmentResult": {
"type": "object",
"required": [
"ShipmentId"
],
"properties": {
"ShipmentId": {
"type": "string",
"description": "The shipment identifier submitted in the request."
}
},
"description": "Result of an inbound shipment operation"
},
"InboundShipmentResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for this operation.",
"$ref": "#/definitions/InboundShipmentResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for this operation."
},
"CurrencyCode": {
"type": "string",
"description": "The currency code.",
"enum": [
"USD",
"GBP"
],
"x-docgen-enum-table-extension": [
{
"value": "USD",
"description": "United States Dollar."
},
{
"value": "GBP",
"description": "British pound sterling."
}
]
},
"DateStringType": {
"type": "string",
"format": "date",
"description": "Type containing date in string format"
},
"Dimensions": {
"type": "object",
"required": [
"Height",
"Length",
"Unit",
"Width"
],
"properties": {
"Length": {
"description": "The length dimension.",
"$ref": "#/definitions/BigDecimalType"
},
"Width": {
"description": "The width dimension.",
"$ref": "#/definitions/BigDecimalType"
},
"Height": {
"description": "The height dimension.",
"$ref": "#/definitions/BigDecimalType"
},
"Unit": {
"description": "The unit of measurement for the dimensions.",
"$ref": "#/definitions/UnitOfMeasurement"
}
},
"description": "The dimension values and unit of measurement."
},
"ErrorReason": {
"type": "string",
"description": "The reason that the ASIN is invalid.",
"enum": [
"DoesNotExist",
"InvalidASIN"
],
"x-docgen-enum-table-extension": [
{
"value": "DoesNotExist",
"description": "Indicates that the ASIN is not included in the Amazon product catalog for any of the marketplaces that the seller participates in."
},
{
"value": "InvalidASIN",
"description": "The ASIN is invalid."
}
]
},
"EstimateTransportResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the estimateTransport operation.",
"$ref": "#/definitions/CommonTransportResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the estimateTransport operation."
},
"GetBillOfLadingResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getBillOfLading operation.",
"$ref": "#/definitions/BillOfLadingDownloadURL"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getBillOfLading operation."
},
"GetInboundGuidanceResult": {
"type": "object",
"properties": {
"SKUInboundGuidanceList": {
"$ref": "#/definitions/SKUInboundGuidanceList"
},
"InvalidSKUList": {
"$ref": "#/definitions/InvalidSKUList"
},
"ASINInboundGuidanceList": {
"$ref": "#/definitions/ASINInboundGuidanceList"
},
"InvalidASINList": {
"$ref": "#/definitions/InvalidASINList"
}
},
"description": "Result for the get inbound guidance operation"
},
"LabelDownloadURL": {
"type": "object",
"properties": {
"DownloadURL": {
"type": "string",
"description": "URL to download the label for the package. Note: The URL will only be valid for 15 seconds"
}
},
"description": "Download URL for a label"
},
"BillOfLadingDownloadURL": {
"type": "object",
"properties": {
"DownloadURL": {
"type": "string",
"description": "URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds"
}
},
"description": "Download URL for the bill of lading."
},
"GetLabelsResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getLabels operation.",
"$ref": "#/definitions/LabelDownloadURL"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getLabels operation."
},
"GetPreorderInfoResult": {
"type": "object",
"properties": {
"ShipmentContainsPreorderableItems": {
"type": "boolean",
"description": "Indicates whether the shipment contains items that have been enabled for pre-order. For more information about enabling items for pre-order, see the Seller Central Help."
},
"ShipmentConfirmedForPreorder": {
"type": "boolean",
"description": "Indicates whether this shipment has been confirmed for pre-order."
},
"NeedByDate": {
"description": "Date that the shipment would need to arrive at an Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items if this shipment is later confirmed for pre-order. In YYYY-MM-DD format. See also the confirmPreorder operation.",
"$ref": "#/definitions/DateStringType"
},
"ConfirmedFulfillableDate": {
"description": "Date in YYYY-MM-DD format that determines which pre-order items in the shipment are eligible for pre-order. If this shipment is confirmed for pre-order with a subsequent call to the confirmPreorder operation, the pre-order Buy Box will appear for any pre-order items in the shipment with a release date on or after this date. Call the getShipmentItems operation to get the release dates for the pre-order items in this shipment.",
"$ref": "#/definitions/DateStringType"
}
},
"description": "Result for the get preorder info operation"
},
"GetPreorderInfoResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getPreorderInfo operation.",
"$ref": "#/definitions/GetPreorderInfoResult"
},
"errors": {
"description": "One or more unexpected errors occurred during the operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getPreorderInfo operation."
},
"GetPrepInstructionsResult": {
"type": "object",
"properties": {
"SKUPrepInstructionsList": {
"$ref": "#/definitions/SKUPrepInstructionsList"
},
"InvalidSKUList": {
"$ref": "#/definitions/InvalidSKUList"
},
"ASINPrepInstructionsList": {
"$ref": "#/definitions/ASINPrepInstructionsList"
},
"InvalidASINList": {
"$ref": "#/definitions/InvalidASINList"
}
},
"description": "Result for the get prep instructions operation"
},
"GetPrepInstructionsResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getPrepInstructions operation.",
"$ref": "#/definitions/GetPrepInstructionsResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getPrepInstructions operation."
},
"GetTransportDetailsResult": {
"type": "object",
"properties": {
"TransportContent": {
"$ref": "#/definitions/TransportContent"
}
},
"description": "Result for the get transport details operation"
},
"GetTransportDetailsResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getTransportDetails operation.",
"$ref": "#/definitions/GetTransportDetailsResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getTransportDetails operation."
},
"GuidanceReason": {
"type": "string",
"description": "A reason for the current inbound guidance for an item.",
"enum": [
"SlowMovingASIN",
"NoApplicableGuidance"
],
"x-docgen-enum-table-extension": [
{
"value": "SlowMovingASIN",
"description": "The ASIN is well stocked and/or not selling quickly."
},
{
"value": "NoApplicableGuidance",
"description": "No applicable guidance."
}
]
},
"GuidanceReasonList": {
"type": "array",
"description": "A list of inbound guidance reason information.",
"items": {
"$ref": "#/definitions/GuidanceReason"
}
},
"InboundGuidance": {
"type": "string",
"description": "Specific inbound guidance for an item.",
"enum": [
"InboundNotRecommended",
"InboundOK"
],
"x-docgen-enum-table-extension": [
{
"value": "InboundNotRecommended",
"description": "Shipping this item to Amazon's fulfillment network is not recommended."
},
{
"value": "InboundOK",
"description": "Shipping this item to Amazon's fulfillment network should not cause any problems."
}
]
},
"InboundShipmentHeader": {
"type": "object",
"required": [
"DestinationFulfillmentCenterId",
"LabelPrepPreference",
"ShipFromAddress",
"ShipmentName",
"ShipmentStatus"
],
"properties": {
"ShipmentName": {
"type": "string",
"description": "The name for the shipment. Use a naming convention that helps distinguish between shipments over time, such as the date the shipment was created."
},
"ShipFromAddress": {
"description": "The return address.",
"$ref": "#/definitions/Address"
},
"DestinationFulfillmentCenterId": {
"type": "string",
"description": "The identifier for the fulfillment center to which the shipment will be shipped. Get this value from the InboundShipmentPlan object in the response returned by the createInboundShipmentPlan operation."
},
"AreCasesRequired": {
"type": "boolean",
"description": "Indicates whether or not an inbound shipment contains case-packed boxes. Note: A shipment must contain either all case-packed boxes or all individually packed boxes.\n\nPossible values:\n\ntrue - All boxes in the shipment must be case packed.\n\nfalse - All boxes in the shipment must be individually packed.\n\nNote: If AreCasesRequired = true for an inbound shipment, then the value of QuantityInCase must be greater than zero for every item in the shipment. Otherwise the service returns an error."
},
"ShipmentStatus": {
"$ref": "#/definitions/ShipmentStatus"
},
"LabelPrepPreference": {
"description": "The preference for label preparation for an inbound shipment.",
"$ref": "#/definitions/LabelPrepPreference"
},
"IntendedBoxContentsSource": {
"$ref": "#/definitions/IntendedBoxContentsSource"
}
},
"description": "Inbound shipment information used to create and update inbound shipments."
},
"InboundShipmentInfo": {
"type": "object",
"required": [
"AreCasesRequired",
"ShipFromAddress"
],
"properties": {
"ShipmentId": {
"type": "string",
"description": "The shipment identifier submitted in the request."
},
"ShipmentName": {
"type": "string",
"description": "The name for the inbound shipment."
},
"ShipFromAddress": {
"description": "The return address.",
"$ref": "#/definitions/Address"
},
"DestinationFulfillmentCenterId": {
"type": "string",
"description": "An Amazon fulfillment center identifier created by Amazon."
},
"ShipmentStatus": {
"$ref": "#/definitions/ShipmentStatus"
},
"LabelPrepType": {
"$ref": "#/definitions/LabelPrepType"
},
"AreCasesRequired": {
"type": "boolean",
"description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed."
},
"ConfirmedNeedByDate": {
"description": "Date by which the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items.",
"$ref": "#/definitions/DateStringType"
},
"BoxContentsSource": {
"$ref": "#/definitions/BoxContentsSource"
},
"EstimatedBoxContentsFee": {
"description": "An estimate of the manual processing fee charged by Amazon for boxes without box content information. This is only returned when BoxContentsSource is NONE.",
"$ref": "#/definitions/BoxContentsFeeDetails"
}
},
"description": "Information about the seller's inbound shipments. Returned by the listInboundShipments operation."
},
"InboundShipmentItem": {
"type": "object",
"required": [
"QuantityShipped",
"SellerSKU"
],
"properties": {
"ShipmentId": {
"type": "string",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation."
},
"SellerSKU": {
"type": "string",
"description": "The seller SKU of the item."
},
"FulfillmentNetworkSKU": {
"type": "string",
"description": "Amazon's fulfillment network SKU of the item."
},
"QuantityShipped": {
"description": "The item quantity that you are shipping.",
"$ref": "#/definitions/Quantity"
},
"QuantityReceived": {
"description": "The item quantity that has been received at an Amazon fulfillment center.",
"$ref": "#/definitions/Quantity"
},
"QuantityInCase": {
"description": "The item quantity in each case, for case-packed items. Note that QuantityInCase multiplied by the number of boxes in the inbound shipment equals QuantityShipped. Also note that all of the boxes of an inbound shipment must either be case packed or individually packed. For that reason, when you submit the createInboundShipment or the updateInboundShipment operation, the value of QuantityInCase must be provided for every item in the shipment or for none of the items in the shipment.",
"$ref": "#/definitions/Quantity"
},
"ReleaseDate": {
"description": "The date that a pre-order item will be available for sale.",
"$ref": "#/definitions/DateStringType"
},
"PrepDetailsList": {
"$ref": "#/definitions/PrepDetailsList"
}
},
"description": "Item information for an inbound shipment. Submitted with a call to the createInboundShipment or updateInboundShipment operation."
},
"InboundShipmentItemList": {
"type": "array",
"description": "A list of inbound shipment item information.",
"items": {
"$ref": "#/definitions/InboundShipmentItem"
}
},
"InboundShipmentList": {
"type": "array",
"description": "A list of inbound shipment information.",
"items": {
"$ref": "#/definitions/InboundShipmentInfo"
}
},
"InboundShipmentPlan": {
"type": "object",
"required": [
"DestinationFulfillmentCenterId",
"Items",
"LabelPrepType",
"ShipToAddress",
"ShipmentId"
],
"properties": {
"ShipmentId": {
"type": "string",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation."
},
"DestinationFulfillmentCenterId": {
"type": "string",
"description": "An Amazon fulfillment center identifier created by Amazon."
},
"ShipToAddress": {
"description": "The address of the Amazon fulfillment center to which to ship the items.",
"$ref": "#/definitions/Address"
},
"LabelPrepType": {
"$ref": "#/definitions/LabelPrepType"
},
"Items": {
"description": "SKU and quantity information for the items in the shipment.",
"$ref": "#/definitions/InboundShipmentPlanItemList"
},
"EstimatedBoxContentsFee": {
"$ref": "#/definitions/BoxContentsFeeDetails"
}
},
"description": "Inbound shipment information used to create an inbound shipment. Returned by the createInboundShipmentPlan operation."
},
"InboundShipmentPlanItem": {
"type": "object",
"required": [
"FulfillmentNetworkSKU",
"Quantity",
"SellerSKU"
],
"properties": {
"SellerSKU": {
"type": "string",
"description": "The seller SKU of the item."
},
"FulfillmentNetworkSKU": {
"type": "string",
"description": "Amazon's fulfillment network SKU of the item."
},
"Quantity": {
"description": "The item quantity that you are shipping.",
"$ref": "#/definitions/Quantity"
},
"PrepDetailsList": {
"$ref": "#/definitions/PrepDetailsList"
}
},
"description": "Item information used to create an inbound shipment. Returned by the createInboundShipmentPlan operation."
},
"InboundShipmentPlanItemList": {
"type": "array",
"description": "A list of inbound shipment plan item information.",
"items": {
"$ref": "#/definitions/InboundShipmentPlanItem"
}
},
"InboundShipmentPlanList": {
"type": "array",
"description": "A list of inbound shipment plan information",
"items": {
"$ref": "#/definitions/InboundShipmentPlan"
}
},
"InboundShipmentPlanRequestItem": {
"type": "object",
"required": [
"ASIN",
"Condition",
"Quantity",
"SellerSKU"
],
"properties": {
"SellerSKU": {
"type": "string",
"description": "The seller SKU of the item."
},
"ASIN": {
"type": "string",
"description": "The Amazon Standard Identification Number (ASIN) of the item."
},
"Condition": {
"$ref": "#/definitions/Condition"
},
"Quantity": {
"$ref": "#/definitions/Quantity"
},
"QuantityInCase": {
"description": "The item quantity in each case, for case-packed items. Note that QuantityInCase multiplied by the number of cases in the inbound shipment equals Quantity. Also note that all of the boxes of an inbound shipment must either be case packed or individually packed. For that reason, when you submit the createInboundShipmentPlan operation, the value of QuantityInCase must be provided for every item in the shipment or for none of the items in the shipment.",
"$ref": "#/definitions/Quantity"
},
"PrepDetailsList": {
"$ref": "#/definitions/PrepDetailsList"
}
},
"description": "Item information for creating an inbound shipment plan. Submitted with a call to the createInboundShipmentPlan operation."
},
"InboundShipmentPlanRequestItemList": {
"type": "array",
"items": {
"$ref": "#/definitions/InboundShipmentPlanRequestItem"
},
"description": "List of inbound shipment plan requests"
},
"IntendedBoxContentsSource": {
"type": "string",
"description": "How the seller intends to provide box contents information for a shipment. Leaving this field blank is equivalent to selecting `NONE`, which will incur a fee if the seller does not provide box contents information.",
"enum": [
"NONE",
"FEED",
"2D_BARCODE"
],
"x-docgen-enum-table-extension": [
{
"value": "NONE",
"description": "There is no box content information for this shipment. Amazon will manually process the box contents. This will incur a fee if the seller does not provide box contents information."
},
{
"value": "FEED",
"description": "Box content information is provided through the _POST_FBA_INBOUND_CARTON_CONTENTS_ feed."
},
{
"value": "2D_BARCODE",
"description": "Box content information is provided by a barcode on the shipment."
}
]
},
"InvalidASIN": {
"type": "object",
"properties": {
"ASIN": {
"type": "string",
"description": "The Amazon Standard Identification Number (ASIN) of the item."
},
"ErrorReason": {
"description": "The reason that the ASIN is invalid.",
"$ref": "#/definitions/ErrorReason"
}
},
"description": "Contains details about an invalid ASIN"
},
"InvalidASINList": {
"type": "array",
"description": "A list of invalid ASIN values and the reasons they are invalid.",
"items": {
"$ref": "#/definitions/InvalidASIN"
}
},
"InvalidSKU": {
"type": "object",
"properties": {
"SellerSKU": {
"type": "string",
"description": "The seller SKU of the item."
},
"ErrorReason": {
"description": "The reason why the seller SKU is invalid.",
"$ref": "#/definitions/ErrorReason"
}
},
"description": "Contains detail about an invalid SKU"
},
"InvalidSKUList": {
"type": "array",
"description": "A list of invalid SKU values and the reason they are invalid.",
"items": {
"$ref": "#/definitions/InvalidSKU"
}
},
"LabelPrepPreference": {
"type": "string",
"description": "The preference for label preparation for an inbound shipment.",
"enum": [
"SELLER_LABEL",
"AMAZON_LABEL_ONLY",
"AMAZON_LABEL_PREFERRED"
],
"x-docgen-enum-table-extension": [
{
"value": "SELLER_LABEL",
"description": "The seller labels the items in the inbound shipment when labels are required."
},
{
"value": "AMAZON_LABEL_ONLY",
"description": "Amazon attempts to label the items in the inbound shipment when labels are required. If Amazon determines that it does not have the information required to successfully label an item, that item is not included in the inbound shipment plan."
},
{
"value": "AMAZON_LABEL_PREFERRED",
"description": "Amazon attempts to label the items in the inbound shipment when labels are required. If Amazon determines that it does not have the information required to successfully label an item, that item is included in the inbound shipment plan and the seller must label it."
}
]
},
"LabelPrepType": {
"type": "string",
"description": "The type of label preparation that is required for the inbound shipment.",
"enum": [
"NO_LABEL",
"SELLER_LABEL",
"AMAZON_LABEL"
],
"x-docgen-enum-table-extension": [
{
"value": "NO_LABEL",
"description": "No label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory."
},
{
"value": "SELLER_LABEL",
"description": "Label preparation by the seller is required."
},
{
"value": "AMAZON_LABEL",
"description": "Label preparation by Amazon is required.\n\n Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. For more information about the FBA Label Service, see the Seller Central Help for your marketplace."
}
]
},
"GetShipmentItemsResult": {
"type": "object",
"properties": {
"ItemData": {
"description": "A list of item information for an inbound shipment.",
"$ref": "#/definitions/InboundShipmentItemList"
},
"NextToken": {
"type": "string",
"description": "When present and not empty, pass this string token in the next request to return the next response page."
}
},
"description": "Result for the get shipment items operation"
},
"GetShipmentItemsResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getShipmentItems operation.",
"$ref": "#/definitions/GetShipmentItemsResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getShipmentItems operation."
},
"GetShipmentsResult": {
"type": "object",
"properties": {
"ShipmentData": {
"description": "Information about your inbound shipments.",
"$ref": "#/definitions/InboundShipmentList"
},
"NextToken": {
"type": "string",
"description": "When present and not empty, pass this string token in the next request to return the next response page."
}
},
"description": "Result for the get shipments operation"
},
"GetShipmentsResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getShipments operation.",
"$ref": "#/definitions/GetShipmentsResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getShipments operation."
},
"NonPartneredLtlDataInput": {
"type": "object",
"required": [
"CarrierName",
"ProNumber"
],
"properties": {
"CarrierName": {
"type": "string",
"description": "The carrier that you are using for the inbound shipment."
},
"ProNumber": {
"$ref": "#/definitions/ProNumber"
}
},
"description": "Information that you provide to Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by a carrier that has not partnered with Amazon."
},
"NonPartneredLtlDataOutput": {
"type": "object",
"required": [
"CarrierName",
"ProNumber"
],
"properties": {
"CarrierName": {
"type": "string",
"description": "The carrier that you are using for the inbound shipment."
},
"ProNumber": {
"$ref": "#/definitions/ProNumber"
}
},
"description": "Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment shipped by a carrier that has not partnered with Amazon."
},
"NonPartneredSmallParcelDataInput": {
"type": "object",
"required": [
"CarrierName",
"PackageList"
],
"properties": {
"CarrierName": {
"type": "string",
"description": "The carrier that you are using for the inbound shipment."
},
"PackageList": {
"$ref": "#/definitions/NonPartneredSmallParcelPackageInputList"
}
},
"description": "Information that you provide to Amazon about a Small Parcel shipment shipped by a carrier that has not partnered with Amazon."
},
"NonPartneredSmallParcelDataOutput": {
"type": "object",
"required": [
"PackageList"
],
"properties": {
"PackageList": {
"$ref": "#/definitions/NonPartneredSmallParcelPackageOutputList"
}
},
"description": "Information returned by Amazon about a Small Parcel shipment by a carrier that has not partnered with Amazon."
},
"NonPartneredSmallParcelPackageInput": {
"type": "object",
"required": [
"TrackingId"
],
"properties": {
"TrackingId": {
"$ref": "#/definitions/TrackingId"
}
},
"description": "The tracking number of the package, provided by the carrier."
},
"NonPartneredSmallParcelPackageInputList": {
"type": "array",
"description": "A list of package tracking information.",
"items": {
"$ref": "#/definitions/NonPartneredSmallParcelPackageInput"
}
},
"NonPartneredSmallParcelPackageOutput": {
"type": "object",
"required": [
"CarrierName",
"PackageStatus",
"TrackingId"
],
"properties": {
"CarrierName": {
"type": "string",
"description": "The carrier that you are using for the inbound shipment."
},
"TrackingId": {
"$ref": "#/definitions/TrackingId"
},
"PackageStatus": {
"$ref": "#/definitions/PackageStatus"
}
},
"description": "Carrier, tracking number, and status information for the package."
},
"NonPartneredSmallParcelPackageOutputList": {
"type": "array",
"description": "A list of packages, including carrier, tracking number, and status information for each package.",
"items": {
"$ref": "#/definitions/NonPartneredSmallParcelPackageOutput"
}
},
"PackageStatus": {
"type": "string",
"description": "The shipment status of the package.",
"enum": [
"SHIPPED",
"IN_TRANSIT",
"DELIVERED",
"CHECKED_IN",
"RECEIVING",
"CLOSED",
"DELETED"
],
"x-docgen-enum-table-extension": [
{
"value": "SHIPPED",
"description": "The carrier has picked up the package from your facility."
},
{
"value": "IN_TRANSIT",
"description": "The carrier has made an appointment for delivery to an Amazon fulfillment center."
},
{
"value": "DELIVERED",
"description": "The carrier has delivered the package to the loading dock of an Amazon fulfillment center."
},
{
"value": "CHECKED_IN",
"description": "The Amazon fulfillment center has accepted delivery of the package from the carrier."
},
{
"value": "RECEIVING",
"description": "The Amazon fulfillment center has begun the receiving process on the package."
},
{
"value": "CLOSED",
"description": "The Amazon fulfillment center has completed the receiving process on the package."
},
{
"value": "DELETED",
"description": "The shipment has been deleted."
}
]
},
"Pallet": {
"type": "object",
"required": [
"Dimensions",
"IsStacked"
],
"properties": {
"Dimensions": {
"description": "The dimensions of the pallet. Length and width must be 40 inches by 48 inches. Height must be less than or equal to 60 inches.",
"$ref": "#/definitions/Dimensions"
},
"Weight": {
"description": "The weight of the pallet.",
"$ref": "#/definitions/Weight"
},
"IsStacked": {
"type": "boolean",
"description": "Indicates whether pallets will be stacked when carrier arrives for pick-up."
}
},
"description": "Pallet information."
},
"PalletList": {
"type": "array",
"description": "A list of pallet information.",
"items": {
"$ref": "#/definitions/Pallet"
}
},
"PartneredEstimate": {
"type": "object",
"required": [
"Amount"
],
"properties": {
"Amount": {
"description": "The amount that the Amazon-partnered carrier will charge to ship the inbound shipment.",
"$ref": "#/definitions/Amount"
},
"ConfirmDeadline": {
"description": "The date in ISO 8601 date time format by which this estimate must be confirmed. After this date the estimate is no longer valid and cannot be confirmed.\n\nReturned only if the TransportStatus value of the inbound shipment is ESTIMATED.",
"$ref": "#/definitions/TimeStampStringType"
},
"VoidDeadline": {
"description": "The date in ISO 8601 date time format after which a confirmed transportation request can no longer be voided. This date is 24 hours after a Small Parcel shipment transportation request is confirmed or one hour after a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request is confirmed. After the void deadline passes the seller's account will be charged for the shipping cost.\n\nReturned only if the TransportStatus value of the inbound shipment is CONFIRMED.",
"$ref": "#/definitions/TimeStampStringType"
}
},
"description": "The estimated shipping cost for a shipment using an Amazon-partnered carrier."
},
"PartneredLtlDataInput": {
"type": "object",
"properties": {
"Contact": {
"description": "Contact information for the person in the seller's organization who is responsible for the shipment. Used by the carrier if they have questions about the shipment.",
"$ref": "#/definitions/Contact"
},
"BoxCount": {
"description": "The number of boxes in the shipment.",
"$ref": "#/definitions/UnsignedIntType"
},
"SellerFreightClass": {
"$ref": "#/definitions/SellerFreightClass"
},
"FreightReadyDate": {
"description": "The date on which the shipment is ready for carrier pickup. Must be in YYYY-MM-DD format.",
"$ref": "#/definitions/DateStringType"
},
"PalletList": {
"$ref": "#/definitions/PalletList"
},
"TotalWeight": {
"description": "The total weight of the shipment.",
"$ref": "#/definitions/Weight"
},
"SellerDeclaredValue": {
"description": "The declaration of the total value of the inventory in the shipment.",
"$ref": "#/definitions/Amount"
}
},
"description": "Information that is required by an Amazon-partnered carrier to ship a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment."
},
"PartneredLtlDataOutput": {
"type": "object",
"required": [
"AmazonReferenceId",
"BoxCount",
"CarrierName",
"Contact",
"FreightReadyDate",
"IsBillOfLadingAvailable",
"PalletList",
"PreviewDeliveryDate",
"PreviewFreightClass",
"PreviewPickupDate",
"TotalWeight"
],
"properties": {
"Contact": {
"description": "Contact information for the person in the seller's organization who is responsible for the shipment. Used by the carrier if they have questions about the shipment.",
"$ref": "#/definitions/Contact"
},
"BoxCount": {
"description": "The number of boxes in the shipment.",
"$ref": "#/definitions/UnsignedIntType"
},
"SellerFreightClass": {
"$ref": "#/definitions/SellerFreightClass"
},
"FreightReadyDate": {
"description": "The date on which the shipment is ready for carrier pickup. Must be in YYYY-MM-DD format.",
"$ref": "#/definitions/DateStringType"
},
"PalletList": {
"$ref": "#/definitions/PalletList"
},
"TotalWeight": {
"description": "The total weight of the shipment.",
"$ref": "#/definitions/Weight"
},
"SellerDeclaredValue": {
"description": "Your declaration of the total value of the inventory in the shipment.",
"$ref": "#/definitions/Amount"
},
"AmazonCalculatedValue": {
"description": "Estimate by Amazon of the total value of the inventory in the shipment.",
"$ref": "#/definitions/Amount"
},
"PreviewPickupDate": {
"description": "The estimated date that the shipment will be picked up by the carrier, in YYYY-MM-DD format.",
"$ref": "#/definitions/DateStringType"
},
"PreviewDeliveryDate": {
"description": "The estimated date that the shipment will be delivered to an Amazon fulfillment center, in YYYY-MM-DD format.",
"$ref": "#/definitions/DateStringType"
},
"PreviewFreightClass": {
"description": "The freight class of the shipment as estimated by Amazon if you did not include a freight class when you called the putTransportDetails operation.",
"$ref": "#/definitions/SellerFreightClass"
},
"AmazonReferenceId": {
"type": "string",
"description": "A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment."
},
"IsBillOfLadingAvailable": {
"type": "boolean",
"description": "Indicates whether the bill of lading for the shipment is available."
},
"PartneredEstimate": {
"description": "The estimated shipping cost using an Amazon-partnered carrier.",
"$ref": "#/definitions/PartneredEstimate"
},
"CarrierName": {
"type": "string",
"description": "The carrier for the inbound shipment."
}
},
"description": "Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by an Amazon-partnered carrier."
},
"PartneredSmallParcelDataInput": {
"type": "object",
"properties": {
"PackageList": {
"$ref": "#/definitions/PartneredSmallParcelPackageInputList"
},
"CarrierName": {
"type": "string",
"description": "The Amazon-partnered carrier to use for the inbound shipment. **`CarrierName`** values in France (FR), Italy (IT), Spain (ES), the United Kingdom (UK), and the United States (US): `UNITED_PARCEL_SERVICE_INC`. <br> **`CarrierName`** values in Germany (DE): `DHL_STANDARD`,`UNITED_PARCEL_SERVICE_INC`. <br>Default: `UNITED_PARCEL_SERVICE_INC`."
}
},
"description": "Information that is required by an Amazon-partnered carrier to ship a Small Parcel inbound shipment."
},
"PartneredSmallParcelDataOutput": {
"type": "object",
"required": [
"PackageList"
],
"properties": {
"PackageList": {
"$ref": "#/definitions/PartneredSmallParcelPackageOutputList"
},
"PartneredEstimate": {
"$ref": "#/definitions/PartneredEstimate"
}
},
"description": "Information returned by Amazon about a Small Parcel shipment by an Amazon-partnered carrier."
},
"PartneredSmallParcelPackageInput": {
"type": "object",
"required": [
"Dimensions",
"Weight"
],
"properties": {
"Dimensions": {
"$ref": "#/definitions/Dimensions"
},
"Weight": {
"$ref": "#/definitions/Weight"
}
},
"description": "Dimension and weight information for the package."
},
"PartneredSmallParcelPackageInputList": {
"type": "array",
"description": "A list of dimensions and weight information for packages.",
"items": {
"$ref": "#/definitions/PartneredSmallParcelPackageInput"
}
},
"PartneredSmallParcelPackageOutput": {
"type": "object",
"required": [
"CarrierName",
"Dimensions",
"PackageStatus",
"TrackingId",
"Weight"
],
"properties": {
"Dimensions": {
"$ref": "#/definitions/Dimensions"
},
"Weight": {
"$ref": "#/definitions/Weight"
},
"CarrierName": {
"type": "string",
"description": "The carrier specified with a previous call to putTransportDetails."
},
"TrackingId": {
"$ref": "#/definitions/TrackingId"
},
"PackageStatus": {
"$ref": "#/definitions/PackageStatus"
}
},
"description": "Dimension, weight, and shipping information for the package."
},
"PartneredSmallParcelPackageOutputList": {
"type": "array",
"description": "A list of packages, including shipping information from the Amazon-partnered carrier.",
"items": {
"$ref": "#/definitions/PartneredSmallParcelPackageOutput"
}
},
"PrepDetails": {
"type": "object",
"required": [
"PrepInstruction",
"PrepOwner"
],
"properties": {
"PrepInstruction": {
"$ref": "#/definitions/PrepInstruction"
},
"PrepOwner": {
"$ref": "#/definitions/PrepOwner"
}
},
"description": "Preparation instructions and who is responsible for the preparation."
},
"PrepDetailsList": {
"type": "array",
"description": "A list of preparation instructions and who is responsible for that preparation.",
"items": {
"$ref": "#/definitions/PrepDetails"
}
},
"PrepGuidance": {
"type": "string",
"description": "Item preparation instructions.",
"enum": [
"ConsultHelpDocuments",
"NoAdditionalPrepRequired",
"SeePrepInstructionsList"
],
"x-docgen-enum-table-extension": [
{
"value": "ConsultHelpDocuments",
"description": "Indicates that Amazon is currently unable to determine the preparation instructions for this item. Amazon might be able to provide guidance at a future date, after evaluating the item."
},
{
"value": "NoAdditionalPrepRequired",
"description": "Indicates that the item does not require preparation in addition to any item labeling that might be required."
},
{
"value": "SeePrepInstructionsList",
"description": "Indicates that the item requires preparation in addition to any item labeling that might be required. See the PrepInstructionList in the response for item preparation instructions."
}
]
},
"PrepInstruction": {
"type": "string",
"description": "Preparation instructions for shipping an item to Amazon's fulfillment network. For more information about preparing items for shipment to Amazon's fulfillment network, see the Seller Central Help for your marketplace.",
"enum": [
"Polybagging",
"BubbleWrapping",
"Taping",
"BlackShrinkWrapping",
"Labeling",
"HangGarment",
"SetCreation",
"Boxing",
"RemoveFromHanger",
"Debundle",
"SuffocationStickering",
"CapSealing",
"SetStickering",
"BlankStickering",
"ShipsInProductPackaging",
"NoPrep"
],
"x-docgen-enum-table-extension": [
{
"value": "Polybagging",
"description": "Indicates that polybagging is required."
},
{
"value": "BubbleWrapping",
"description": "Indicates that bubble wrapping is required."
},
{
"value": "Taping",
"description": "Indicates that taping is required."
},
{
"value": "BlackShrinkWrapping",
"description": "Indicates that black shrink wrapping is required."
},
{
"value": "Labeling",
"description": "Indicates that the FNSKU label should be applied to the item."
},
{
"value": "HangGarment",
"description": "Indicates that the item should be placed on a hanger."
},
{
"value": "SetCreation",
"description": "Units that are sets must be labeled as sets on their packaging. The barcodes on the individual items must 1) not face outward and 2) not require covering."
},
{
"value": "Boxing",
"description": "Products may require overboxing when there are safety concerns over sharp items, fragile items, hazardous liquids, and vinyl records. For items over 4.5 kg, use double-wall corrugated boxes."
},
{
"value": "RemoveFromHanger",
"description": "Indicates that the item cannot be shipped on a hanger."
},
{
"value": "Debundle",
"description": "Indicates requiring taking apart a set of items labeled for individual sale. Remove tape or shrink wrap that groups multiple inventory units together."
},
{
"value": "SuffocationStickering",
"description": "Poly bags with an opening of 12 cm or larger (measured when flat) must have a suffocation warning. This warning must be printed on the bag or attached as a label."
},
{
"value": "CapSealing",
"description": "To prevent leakage, product needs to have a secondary seal in one of the following types: Induction seal, safety ring, clips, heat shrink plastic band, or boxing."
},
{
"value": "SetStickering",
"description": "Products that are sets (for example, a set of six unique toy cars that is sold as one unit) must be marked as sets on their packaging. Add a label to the unit that clearly states that the products are to be received and sold as a single unit."
},
{
"value": "BlankStickering",
"description": "Indicates applying a blank sticker to obscure a bad barcode that cannot be covered by another sticker."
},
{
"value": "ShipsInProductPackaging",
"description": "Indicates that item ships in its original product packaging."
},
{
"value": "NoPrep",
"description": "Indicates that the item does not require any prep."
}
]
},
"PrepInstructionList": {
"type": "array",
"description": "A list of preparation instructions to help with item sourcing decisions.",
"items": {
"$ref": "#/definitions/PrepInstruction"
}
},
"PrepOwner": {
"type": "string",
"description": "Indicates who will prepare the item.",
"enum": [
"AMAZON",
"SELLER"
],
"x-docgen-enum-table-extension": [
{
"value": "AMAZON",
"description": "Indicates Amazon will prepare the item."
},
{
"value": "SELLER",
"description": "Indicates the seller will prepare the item."
}
]
},
"ProNumber": {
"type": "string",
"description": "The PRO number (\"progressive number\" or \"progressive ID\") assigned to the shipment by the carrier."
},
"PutTransportDetailsRequest": {
"type": "object",
"required": [
"IsPartnered",
"ShipmentType",
"TransportDetails"
],
"properties": {
"IsPartnered": {
"type": "boolean",
"description": "Indicates whether a putTransportDetails request is for an Amazon-partnered carrier."
},
"ShipmentType": {
"$ref": "#/definitions/ShipmentType"
},
"TransportDetails": {
"description": "Information required to create an Amazon-partnered carrier shipping estimate, or to alert the Amazon fulfillment center to the arrival of an inbound shipment by a non-Amazon-partnered carrier.",
"$ref": "#/definitions/TransportDetailInput"
}
},
"description": "The request schema for a putTransportDetails operation."
},
"PutTransportDetailsResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the putTransportDetails operation.",
"$ref": "#/definitions/CommonTransportResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "Workflow status for a shipment with an Amazon-partnered carrier."
},
"Quantity": {
"type": "integer",
"format": "int32",
"description": "The item quantity."
},
"SKUInboundGuidance": {
"type": "object",
"required": [
"ASIN",
"InboundGuidance",
"SellerSKU"
],
"properties": {
"SellerSKU": {
"type": "string",
"description": "The seller SKU of the item."
},
"ASIN": {
"type": "string",
"description": "The Amazon Standard Identification Number (ASIN) of the item."
},
"InboundGuidance": {
"description": "Specific inbound guidance for an item.",
"$ref": "#/definitions/InboundGuidance"
},
"GuidanceReasonList": {
"description": "A list of reasons for the current inbound guidance for this item.",
"$ref": "#/definitions/GuidanceReasonList"
}
},
"description": "Reasons why a given seller SKU is not recommended for shipment to Amazon's fulfillment network."
},
"SKUInboundGuidanceList": {
"type": "array",
"description": "A list of SKU inbound guidance information.",
"items": {
"$ref": "#/definitions/SKUInboundGuidance"
}
},
"SKUPrepInstructions": {
"type": "object",
"properties": {
"SellerSKU": {
"type": "string",
"description": "The seller SKU of the item."
},
"ASIN": {
"type": "string",
"description": "The Amazon Standard Identification Number (ASIN) of the item."
},
"BarcodeInstruction": {
"$ref": "#/definitions/BarcodeInstruction"
},
"PrepGuidance": {
"$ref": "#/definitions/PrepGuidance"
},
"PrepInstructionList": {
"$ref": "#/definitions/PrepInstructionList"
},
"AmazonPrepFeesDetailsList": {
"$ref": "#/definitions/AmazonPrepFeesDetailsList"
}
},
"description": "Labeling requirements and item preparation instructions to help you prepare items for shipment to Amazon's fulfillment network."
},
"SKUPrepInstructionsList": {
"type": "array",
"description": "A list of SKU labeling requirements and item preparation instructions.",
"items": {
"$ref": "#/definitions/SKUPrepInstructions"
}
},
"SellerFreightClass": {
"type": "string",
"description": "The freight class of the shipment. For information about determining the freight class, contact the carrier.",
"enum": [
"50",
"55",
"60",
"65",
"70",
"77.5",
"85",
"92.5",
"100",
"110",
"125",
"150",
"175",
"200",
"250",
"300",
"400",
"500"
],
"x-docgen-enum-table-extension": [
{
"value": "50",
"description": "50"
},
{
"value": "55",
"description": "55"
},
{
"value": "60",
"description": "60"
},
{
"value": "65",
"description": "65"
},
{
"value": "70",
"description": "70"
},
{
"value": "77.5",
"description": "77.5"
},
{
"value": "85",
"description": "85"
},
{
"value": "92.5",
"description": "92.5"
},
{
"value": "100",
"description": "100"
},
{
"value": "110",
"description": "110"
},
{
"value": "125",
"description": "125"
},
{
"value": "150",
"description": "150"
},
{
"value": "175",
"description": "175"
},
{
"value": "200",
"description": "200"
},
{
"value": "250",
"description": "250"
},
{
"value": "300",
"description": "300"
},
{
"value": "400",
"description": "400"
},
{
"value": "500",
"description": "500"
}
]
},
"ShipmentStatus": {
"type": "string",
"description": "Indicates the status of the inbound shipment. When used with the createInboundShipment operation, WORKING is the only valid value. When used with the updateInboundShipment operation, possible values are WORKING, SHIPPED or CANCELLED.",
"enum": [
"WORKING",
"SHIPPED",
"RECEIVING",
"CANCELLED",
"DELETED",
"CLOSED",
"ERROR",
"IN_TRANSIT",
"DELIVERED",
"CHECKED_IN"
],
"x-docgen-enum-table-extension": [
{
"value": "WORKING",
"description": "The shipment was created by the seller, but has not yet shipped."
},
{
"value": "SHIPPED",
"description": "The shipment was picked up by the carrier."
},
{
"value": "RECEIVING",
"description": "The shipment has arrived at the fulfillment center, but not all items have been marked as received."
},
{
"value": "CANCELLED",
"description": "The shipment was cancelled by the seller after the shipment was sent to the fulfillment center."
},
{
"value": "DELETED",
"description": "The shipment was cancelled by the seller before the shipment was sent to the fulfillment center."
},
{
"value": "CLOSED",
"description": "The shipment has arrived at the fulfillment center and all items have been marked as received."
},
{
"value": "ERROR",
"description": "There was an error with the shipment and it was not processed by Amazon."
},
{
"value": "IN_TRANSIT",
"description": "The carrier has notified the fulfillment center that it is aware of the shipment."
},
{
"value": "DELIVERED",
"description": "The shipment was delivered by the carrier to the fulfillment center."
},
{
"value": "CHECKED_IN",
"description": "The shipment was checked-in at the receiving dock of the fulfillment center."
}
]
},
"ShipmentType": {
"type": "string",
"description": "Specifies the carrier shipment type in a putTransportDetails request.",
"enum": [
"SP",
"LTL"
],
"x-docgen-enum-table-extension": [
{
"value": "SP",
"description": "Small Parcel."
},
{
"value": "LTL",
"description": "Less Than Truckload/Full Truckload (LTL/FTL)."
}
]
},
"TimeStampStringType": {
"type": "string",
"format": "date-time",
"description": "Timestamp in ISO 8601 format."
},
"TrackingId": {
"type": "string",
"description": "The tracking number of the package, provided by the carrier."
},
"TransportContent": {
"type": "object",
"required": [
"TransportDetails",
"TransportHeader",
"TransportResult"
],
"properties": {
"TransportHeader": {
"$ref": "#/definitions/TransportHeader"
},
"TransportDetails": {
"$ref": "#/definitions/TransportDetailOutput"
},
"TransportResult": {
"$ref": "#/definitions/TransportResult"
}
},
"description": "Inbound shipment information, including carrier details, shipment status, and the workflow status for a request for shipment with an Amazon-partnered carrier."
},
"TransportDetailInput": {
"type": "object",
"properties": {
"PartneredSmallParcelData": {
"$ref": "#/definitions/PartneredSmallParcelDataInput"
},
"NonPartneredSmallParcelData": {
"$ref": "#/definitions/NonPartneredSmallParcelDataInput"
},
"PartneredLtlData": {
"$ref": "#/definitions/PartneredLtlDataInput"
},
"NonPartneredLtlData": {
"$ref": "#/definitions/NonPartneredLtlDataInput"
}
},
"description": "Information required to create an Amazon-partnered carrier shipping estimate, or to alert the Amazon fulfillment center to the arrival of an inbound shipment by a non-Amazon-partnered carrier."
},
"TransportDetailOutput": {
"type": "object",
"properties": {
"PartneredSmallParcelData": {
"$ref": "#/definitions/PartneredSmallParcelDataOutput"
},
"NonPartneredSmallParcelData": {
"$ref": "#/definitions/NonPartneredSmallParcelDataOutput"
},
"PartneredLtlData": {
"$ref": "#/definitions/PartneredLtlDataOutput"
},
"NonPartneredLtlData": {
"$ref": "#/definitions/NonPartneredLtlDataOutput"
}
},
"description": "Inbound shipment information, including carrier details and shipment status."
},
"TransportHeader": {
"type": "object",
"required": [
"IsPartnered",
"SellerId",
"ShipmentId",
"ShipmentType"
],
"properties": {
"SellerId": {
"type": "string",
"description": "The Amazon seller identifier."
},
"ShipmentId": {
"type": "string",
"description": "A shipment identifier originally returned by the createInboundShipmentPlan operation."
},
"IsPartnered": {
"type": "boolean",
"description": "Indicates whether a putTransportDetails request is for a partnered carrier.\n\nPossible values:\n\n* true – Request is for an Amazon-partnered carrier.\n\n* false – Request is for a non-Amazon-partnered carrier."
},
"ShipmentType": {
"$ref": "#/definitions/ShipmentType"
}
},
"description": "The shipping identifier, information about whether the shipment is by an Amazon-partnered carrier, and information about whether the shipment is Small Parcel or Less Than Truckload/Full Truckload (LTL/FTL)."
},
"TransportResult": {
"type": "object",
"required": [
"TransportStatus"
],
"properties": {
"TransportStatus": {
"$ref": "#/definitions/TransportStatus"
},
"ErrorCode": {
"type": "string",
"description": "An error code that identifies the type of error that occured."
},
"ErrorDescription": {
"type": "string",
"description": "A message that describes the error condition."
}
},
"description": "The workflow status for a shipment with an Amazon-partnered carrier."
},
"TransportStatus": {
"type": "string",
"description": "Indicates the status of the Amazon-partnered carrier shipment.",
"enum": [
"WORKING",
"ESTIMATING",
"ESTIMATED",
"ERROR_ON_ESTIMATING",
"CONFIRMING",
"CONFIRMED",
"ERROR_ON_CONFIRMING",
"VOIDING",
"VOIDED",
"ERROR_IN_VOIDING",
"ERROR"
],
"x-docgen-enum-table-extension": [
{
"value": "WORKING",
"description": "You have successfully called the putTransportDetails operation for this shipment but have not yet called the estimateTransport operation"
},
{
"value": "ESTIMATING",
"description": "You have successfully called the estimateTransport operation for this shipment and the carrier is in the process of estimating the shipment cost."
},
{
"value": "ESTIMATED",
"description": "The carrier has completed the process of estimating the shipment cost. Your transportation request is ready to be confirmed by you."
},
{
"value": "ERROR_ON_ESTIMATING",
"description": "There was a problem with your call to the estimateTransport operation and an error was returned."
},
{
"value": "CONFIRMING",
"description": "You have successfully called the confirmTransport operation but the confirmation process is not yet complete."
},
{
"value": "CONFIRMED",
"description": "Your transportation request has been confirmed. Important: For a Small Parcel shipment, you can void your transportation request up to 24 hours after you confirm it. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, you can void your transportation request up to one hour after you confirm it. After the grace period has expired the seller's account will be charged for the shipping cost"
},
{
"value": "ERROR_ON_CONFIRMING",
"description": "There was a problem with your call to the confirmTransport operation and an error was returned."
},
{
"value": "VOIDING",
"description": "You have successfully called the voidTransport operation for a confirmed carrier shipment but the voiding process is not yet complete."
},
{
"value": "VOIDED",
"description": "Your confirmed carrier shipment has been voided. The seller's account will not be charged for the shipping cost."
},
{
"value": "ERROR_IN_VOIDING",
"description": "There was a problem with your call to the voidTransport operation and an error was returned."
},
{
"value": "ERROR",
"description": "There was a problem with your call and an error was returned."
}
]
},
"UnitOfMeasurement": {
"type": "string",
"description": "Indicates the unit of measurement.",
"enum": [
"inches",
"centimeters"
],
"x-docgen-enum-table-extension": [
{
"value": "inches",
"description": "The unit of measurement is inches."
},
{
"value": "centimeters",
"description": "The unit of measurement is centimeters."
}
]
},
"UnitOfWeight": {
"type": "string",
"description": "Indicates the unit of weight.",
"enum": [
"pounds",
"kilograms"
],
"x-docgen-enum-table-extension": [
{
"value": "pounds",
"description": "The unit of weight is pounds."
},
{
"value": "kilograms",
"description": "The unit of weight is kilograms."
}
]
},
"UnsignedIntType": {
"type": "integer",
"format": "int64",
"description": "Contains an unsigned integer"
},
"VoidTransportResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the voidTransport operation.",
"$ref": "#/definitions/CommonTransportResult"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the voidTransport operation."
},
"Weight": {
"type": "object",
"required": [
"Unit",
"Value"
],
"properties": {
"Value": {
"description": "The weight value.",
"$ref": "#/definitions/BigDecimalType"
},
"Unit": {
"$ref": "#/definitions/UnitOfWeight"
}
},
"description": "The weight of the package."
}
}
}
Updated about 1 month ago