"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.",
"description":"Returns information that lets a seller know if Amazon recommends sending an item to a given marketplace. In some cases, Amazon provides guidance for why a given SellerSKU or ASIN is not recommended for shipment to Amazon's fulfillment network. Sellers may still ship items that are not recommended, at their discretion.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"A marketplace identifier. Specifies the marketplace where the product would be stored.",
"required":true,
"type":"string"
},
{
"name":"SellerSKUList",
"in":"query",
"description":"A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. ",
"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 inbound guidance for shipment to Amazon's fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Returns a 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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Adds, updates, or removes items from the inbound shipment identified by the specified shipment identifier. \n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Returns 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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"in":"path",
"required":true,
"type":"string"
},
{
"name":"NeedByDate",
"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.",
"in":"query",
"required":true,
"type":"string",
"format":"date"
},
{
"name":"MarketplaceId",
"in":"query",
"description":"A marketplace identifier. Specifies the marketplace the shipment is tied to.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"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.",
"in":"query",
"required":true,
"type":"string",
"format":"[A-Z]{2}"
},
{
"name":"SellerSKUList",
"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.",
"in":"query",
"required":false,
"type":"array",
"items":{
"type":"string"
},
"maxItems":50
},
{
"name":"ASINList",
"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.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Returns 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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"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. "
"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."
"description":"The number of packages in the shipment.",
"in":"query",
"required":false,
"type":"integer"
},
{
"name":"PackageLabelsToPrint",
"description":"A list of identifiers that specify packages for which you want package labels printed.\n\nMust match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code.",
"in":"query",
"required":false,
"type":"array",
"items":{
"type":"string"
},
"maxItems":999
},
{
"name":"NumberOfPallets",
"description":"The number of pallets in the shipment. This returns four identical labels for each pallet.",
"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.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Returns a list of inbound shipments based on criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"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.",
"in":"query",
"required":false,
"type":"array",
"items":{
"type":"string"
}
},
{
"name":"LastUpdatedAfter",
"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.",
"in":"query",
"required":false,
"type":"string",
"format":"date-time"
},
{
"name":"LastUpdatedBefore",
"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.",
"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.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Returns a list of items in a specified inbound shipment.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Returns a list of 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\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"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.",
"in":"query",
"required":false,
"type":"string",
"format":"date-time"
},
{
"name":"LastUpdatedBefore",
"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.",
"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.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"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":{
"description":"Reasons why a given ASIN is not recommended for shipment to Amazon's fulfillment network.",
"type":"object",
"required":[
"ASIN",
"InboundGuidance"
],
"properties":{
"ASIN":{
"description":"The Amazon Standard Identification Number (ASIN) of the item.",
"type":"string"
},
"InboundGuidance":{
"$ref":"#/definitions/InboundGuidance"
},
"GuidanceReasonList":{
"description":"A list of reasons for the current inbound guidance for this item.",
"$ref":"#/definitions/GuidanceReasonList"
}
}
},
"ASINInboundGuidanceList":{
"description":"A list of ASINs and their associated inbound guidance.",
"type":"array",
"items":{
"$ref":"#/definitions/ASINInboundGuidance"
}
},
"ASINPrepInstructions":{
"description":"Item preparation instructions to help with item sourcing decisions.",
"type":"object",
"properties":{
"ASIN":{
"description":"The Amazon Standard Identification Number (ASIN) of the item.",
"type":"string"
},
"BarcodeInstruction":{
"$ref":"#/definitions/BarcodeInstruction"
},
"PrepGuidance":{
"$ref":"#/definitions/PrepGuidance"
},
"PrepInstructionList":{
"$ref":"#/definitions/PrepInstructionList"
}
}
},
"ASINPrepInstructionsList":{
"description":"A list of item preparation instructions.",
"type":"array",
"items":{
"$ref":"#/definitions/ASINPrepInstructions"
}
},
"Address":{
"type":"object",
"required":[
"AddressLine1",
"City",
"CountryCode",
"Name",
"PostalCode",
"StateOrProvinceCode"
],
"properties":{
"Name":{
"description":"Name of the individual or business.",
"type":"string",
"maxLength":50
},
"AddressLine1":{
"description":"The street address information.",
"type":"string",
"maxLength":180
},
"AddressLine2":{
"description":"Additional street address information, if required.",
"type":"string",
"maxLength":60
},
"DistrictOrCounty":{
"description":"The district or county.",
"type":"string",
"maxLength":25
},
"City":{
"description":"The city.",
"type":"string",
"maxLength":30
},
"StateOrProvinceCode":{
"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.",
"type":"string"
},
"CountryCode":{
"description":"The country code in two-character ISO 3166-1 alpha-2 format.",
"type":"string"
},
"PostalCode":{
"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.",
"type":"string",
"maxLength":30
}
}
},
"AmazonPrepFeesDetails":{
"description":"The fees for Amazon to prep goods for shipment.",
"type":"object",
"properties":{
"PrepInstruction":{
"$ref":"#/definitions/PrepInstruction"
},
"FeePerUnit":{
"description":"The fee for Amazon to prepare 1 unit.",
"$ref":"#/definitions/Amount"
}
}
},
"AmazonPrepFeesDetailsList":{
"description":"A list of preparation instructions and fees for Amazon to prep goods for shipment.",
"type":"array",
"items":{
"$ref":"#/definitions/AmazonPrepFeesDetails"
}
},
"Amount":{
"description":"The monetary value.",
"type":"object",
"required":[
"CurrencyCode",
"Value"
],
"properties":{
"CurrencyCode":{
"$ref":"#/definitions/CurrencyCode"
},
"Value":{
"description":"The amount.",
"$ref":"#/definitions/BigDecimalType"
}
}
},
"BarcodeInstruction":{
"description":"Labeling requirements for the item. For more information about FBA labeling requirements, see the Seller Central Help for your marketplace.",
"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."
"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"
}
}
},
"ConfirmPreorderResponse":{
"description":"The response schema for the confirmPreorder operation.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the confirmPreorder operation.",
"$ref":"#/definitions/ConfirmPreorderResult"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
}
},
"CommonTransportResult":{
"type":"object",
"properties":{
"TransportResult":{
"$ref":"#/definitions/TransportResult"
}
}
},
"ConfirmTransportResponse":{
"description":"The response schema for the confirmTransport operation.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the confirmTransport operation.",
"$ref":"#/definitions/CommonTransportResult"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
}
},
"Contact":{
"description":"Contact information for the person in the seller's organization who is responsible for a Less Than Truckload/Full Truckload (LTL/FTL) shipment.",
"type":"object",
"required":[
"Email",
"Name",
"Phone"
],
"properties":{
"Name":{
"description":"The name of the contact person.",
"type":"string",
"maxLength":50
},
"Phone":{
"description":"The phone number of the contact person.",
"type":"string",
"maxLength":20
},
"Email":{
"description":"The email address of the contact person.",
"type":"string",
"maxLength":50
},
"Fax":{
"description":"The fax number of the contact person.",
"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.",
"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.",
"description":"The response schema for the estimateTransport operation.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the estimateTransport operation.",
"$ref":"#/definitions/CommonTransportResult"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
}
},
"GetBillOfLadingResponse":{
"description":"The response schema for the getBillOfLading operation.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the getBillOfLading operation.",
"$ref":"#/definitions/BillOfLadingDownloadURL"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
}
},
"GetInboundGuidanceResult":{
"type":"object",
"properties":{
"SKUInboundGuidanceList":{
"$ref":"#/definitions/SKUInboundGuidanceList"
},
"InvalidSKUList":{
"$ref":"#/definitions/InvalidSKUList"
},
"ASINInboundGuidanceList":{
"$ref":"#/definitions/ASINInboundGuidanceList"
},
"InvalidASINList":{
"$ref":"#/definitions/InvalidASINList"
}
}
},
"GetInboundGuidanceResponse":{
"description":"The response schema for the getInboundGuidance operation.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the getInboundGuidance operation.",
"$ref":"#/definitions/GetInboundGuidanceResult"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
}
},
"LabelDownloadURL":{
"type":"object",
"properties":{
"DownloadURL":{
"description":"URL to download the label for the package. Note: The URL will only be valid for 15 seconds",
"type":"string"
}
}
},
"BillOfLadingDownloadURL":{
"type":"object",
"properties":{
"DownloadURL":{
"description":"URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds",
"type":"string"
}
}
},
"GetLabelsResponse":{
"description":"The response schema for the getLabels operation.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the getLabels operation.",
"$ref":"#/definitions/LabelDownloadURL"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
}
},
"GetPreorderInfoResult":{
"type":"object",
"properties":{
"ShipmentContainsPreorderableItems":{
"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.",
"type":"boolean"
},
"ShipmentConfirmedForPreorder":{
"description":"Indicates whether this shipment has been confirmed for pre-order.",
"type":"boolean"
},
"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"
}
}
},
"GetPreorderInfoResponse":{
"description":"The response schema for the getPreorderInfo operation.",
"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"
}
}
},
"GetPrepInstructionsResult":{
"type":"object",
"properties":{
"SKUPrepInstructionsList":{
"$ref":"#/definitions/SKUPrepInstructionsList"
},
"InvalidSKUList":{
"$ref":"#/definitions/InvalidSKUList"
},
"ASINPrepInstructionsList":{
"$ref":"#/definitions/ASINPrepInstructionsList"
},
"InvalidASINList":{
"$ref":"#/definitions/InvalidASINList"
}
}
},
"GetPrepInstructionsResponse":{
"description":"The response schema for the getPrepInstructions operation.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the getPrepInstructions operation.",
"$ref":"#/definitions/GetPrepInstructionsResult"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
}
},
"GetTransportDetailsResult":{
"type":"object",
"properties":{
"TransportContent":{
"$ref":"#/definitions/TransportContent"
}
}
},
"GetTransportDetailsResponse":{
"description":"The response schema for the getTransportDetails operation.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the getTransportDetails operation.",
"description":"Inbound shipment information used to create and update inbound shipments.",
"type":"object",
"required":[
"DestinationFulfillmentCenterId",
"LabelPrepPreference",
"ShipFromAddress",
"ShipmentName",
"ShipmentStatus"
],
"properties":{
"ShipmentName":{
"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.",
"type":"string"
},
"ShipFromAddress":{
"description":"The return address.",
"$ref":"#/definitions/Address"
},
"DestinationFulfillmentCenterId":{
"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.",
"type":"string"
},
"AreCasesRequired":{
"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.",
"type":"boolean"
},
"ShipmentStatus":{
"$ref":"#/definitions/ShipmentStatus"
},
"LabelPrepPreference":{
"description":"The preference for label preparation for an inbound shipment.",
"$ref":"#/definitions/LabelPrepPreference"
},
"IntendedBoxContentsSource":{
"$ref":"#/definitions/IntendedBoxContentsSource"
}
}
},
"InboundShipmentInfo":{
"description":"Information about the seller's inbound shipments. Returned by the listInboundShipments operation.",
"type":"object",
"required":[
"AreCasesRequired",
"ShipFromAddress"
],
"properties":{
"ShipmentId":{
"description":"The shipment identifier submitted in the request.",
"type":"string"
},
"ShipmentName":{
"description":"The name for the inbound shipment.",
"type":"string"
},
"ShipFromAddress":{
"description":"The return address.",
"$ref":"#/definitions/Address"
},
"DestinationFulfillmentCenterId":{
"description":"An Amazon fulfillment center identifier created by Amazon.",
"type":"string"
},
"ShipmentStatus":{
"$ref":"#/definitions/ShipmentStatus"
},
"LabelPrepType":{
"$ref":"#/definitions/LabelPrepType"
},
"AreCasesRequired":{
"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.",
"type":"boolean"
},
"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"
}
}
},
"InboundShipmentItem":{
"description":"Item information for an inbound shipment. Submitted with a call to the createInboundShipment or updateInboundShipment operation.",
"type":"object",
"required":[
"QuantityShipped",
"SellerSKU"
],
"properties":{
"ShipmentId":{
"description":"A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"type":"string"
},
"SellerSKU":{
"description":"The seller SKU of the item.",
"type":"string"
},
"FulfillmentNetworkSKU":{
"description":"Amazon's fulfillment network SKU of the item.",
"type":"string"
},
"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"
}
}
},
"InboundShipmentItemList":{
"description":"A list of inbound shipment item information.",
"type":"array",
"items":{
"$ref":"#/definitions/InboundShipmentItem"
}
},
"InboundShipmentList":{
"description":"A list of inbound shipment information.",
"type":"array",
"items":{
"$ref":"#/definitions/InboundShipmentInfo"
}
},
"InboundShipmentPlan":{
"description":"Inbound shipment information used to create an inbound shipment. Returned by the createInboundShipmentPlan operation.",
"type":"object",
"required":[
"DestinationFulfillmentCenterId",
"Items",
"LabelPrepType",
"ShipToAddress",
"ShipmentId"
],
"properties":{
"ShipmentId":{
"description":"A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"type":"string"
},
"DestinationFulfillmentCenterId":{
"description":"An Amazon fulfillment center identifier created by Amazon.",
"type":"string"
},
"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.",
"description":"Item information used to create an inbound shipment. Returned by the createInboundShipmentPlan operation.",
"type":"object",
"required":[
"FulfillmentNetworkSKU",
"Quantity",
"SellerSKU"
],
"properties":{
"SellerSKU":{
"description":"The seller SKU of the item.",
"type":"string"
},
"FulfillmentNetworkSKU":{
"description":"Amazon's fulfillment network SKU of the item.",
"type":"string"
},
"Quantity":{
"description":"The item quantity that you are shipping.",
"$ref":"#/definitions/Quantity"
},
"PrepDetailsList":{
"$ref":"#/definitions/PrepDetailsList"
}
}
},
"InboundShipmentPlanItemList":{
"description":"A list of inbound shipment plan item information.",
"type":"array",
"items":{
"$ref":"#/definitions/InboundShipmentPlanItem"
}
},
"InboundShipmentPlanList":{
"description":"A list of inbound shipment plan information",
"type":"array",
"items":{
"$ref":"#/definitions/InboundShipmentPlan"
}
},
"InboundShipmentPlanRequestItem":{
"description":"Item information for creating an inbound shipment plan. Submitted with a call to the createInboundShipmentPlan operation.",
"type":"object",
"required":[
"ASIN",
"Condition",
"Quantity",
"SellerSKU"
],
"properties":{
"SellerSKU":{
"description":"The seller SKU of the item.",
"type":"string"
},
"ASIN":{
"description":"The Amazon Standard Identification Number (ASIN) of the item.",
"type":"string"
},
"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.",
"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."
"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."
"description":"A list of item information for an inbound shipment.",
"$ref":"#/definitions/InboundShipmentItemList"
},
"NextToken":{
"description":"When present and not empty, pass this string token in the next request to return the next response page.",
"type":"string"
}
}
},
"GetShipmentItemsResponse":{
"description":"The response schema for the getShipmentItems operation.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the getShipmentItems operation.",
"$ref":"#/definitions/GetShipmentItemsResult"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
}
},
"GetShipmentsResult":{
"type":"object",
"properties":{
"ShipmentData":{
"description":"Information about your inbound shipments.",
"$ref":"#/definitions/InboundShipmentList"
},
"NextToken":{
"description":"When present and not empty, pass this string token in the next request to return the next response page.",
"type":"string"
}
}
},
"GetShipmentsResponse":{
"description":"The response schema for the getShipments operation.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the getShipments operation.",
"$ref":"#/definitions/GetShipmentsResult"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
}
},
"NonPartneredLtlDataInput":{
"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.",
"type":"object",
"required":[
"CarrierName",
"ProNumber"
],
"properties":{
"CarrierName":{
"description":"The carrier that you are using for the inbound shipment.",
"type":"string"
},
"ProNumber":{
"$ref":"#/definitions/ProNumber"
}
}
},
"NonPartneredLtlDataOutput":{
"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.",
"type":"object",
"required":[
"CarrierName",
"ProNumber"
],
"properties":{
"CarrierName":{
"description":"The carrier that you are using for the inbound shipment.",
"type":"string"
},
"ProNumber":{
"$ref":"#/definitions/ProNumber"
}
}
},
"NonPartneredSmallParcelDataInput":{
"description":"Information that you provide to Amazon about a Small Parcel shipment shipped by a carrier that has not partnered with Amazon.",
"type":"object",
"required":[
"CarrierName",
"PackageList"
],
"properties":{
"CarrierName":{
"description":"The carrier that you are using for the inbound shipment.",
"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":{
"description":"Indicates whether pallets will be stacked when carrier arrives for pick-up.",
"type":"boolean"
}
}
},
"PalletList":{
"description":"A list of pallet information.",
"type":"array",
"items":{
"$ref":"#/definitions/Pallet"
}
},
"PartneredEstimate":{
"description":"The estimated shipping cost for a shipment using an Amazon-partnered carrier.",
"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"
}
}
},
"PartneredLtlDataInput":{
"description":"Information that is required by an Amazon-partnered carrier to ship a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment.",
"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 that the shipment will be ready to be picked up by the carrier.",
"$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"
}
}
},
"PartneredLtlDataOutput":{
"description":"Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by an Amazon-partnered carrier.",
"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 that the shipment will be ready to be picked up by the carrier. 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":{
"description":"A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment.",
"type":"string"
},
"IsBillOfLadingAvailable":{
"description":"Indicates whether the bill of lading for the shipment is available.",
"type":"boolean"
},
"PartneredEstimate":{
"description":"The estimated shipping cost using an Amazon-partnered carrier.",
"$ref":"#/definitions/PartneredEstimate"
},
"CarrierName":{
"description":"The carrier for the inbound shipment.",
"type":"string"
}
}
},
"PartneredSmallParcelDataInput":{
"description":"Information that is required by an Amazon-partnered carrier to ship a Small Parcel inbound shipment.",
"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."
"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.",
"description":"Indicates whether a putTransportDetails request is for an Amazon-partnered carrier.",
"type":"boolean"
},
"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"
}
}
},
"PutTransportDetailsResponse":{
"description":"Workflow status for a shipment with an Amazon-partnered carrier.",
"type":"object",
"properties":{
"payload":{
"description":"The payload for the putTransportDetails operation.",
"$ref":"#/definitions/CommonTransportResult"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
}
},
"Quantity":{
"description":"The item quantity.",
"type":"integer",
"format":"int32"
},
"SKUInboundGuidance":{
"description":"Reasons why a given seller SKU is not recommended for shipment to Amazon's fulfillment network.",
"type":"object",
"required":[
"ASIN",
"InboundGuidance",
"SellerSKU"
],
"properties":{
"SellerSKU":{
"description":"The seller SKU of the item.",
"type":"string"
},
"ASIN":{
"description":"The Amazon Standard Identification Number (ASIN) of the item.",
"type":"string"
},
"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"
}
}
},
"SKUInboundGuidanceList":{
"description":"A list of SKU inbound guidance information.",
"type":"array",
"items":{
"$ref":"#/definitions/SKUInboundGuidance"
}
},
"SKUPrepInstructions":{
"description":"Labeling requirements and item preparation instructions to help you prepare items for shipment to Amazon's fulfillment network.",
"type":"object",
"properties":{
"SellerSKU":{
"description":"The seller SKU of the item.",
"type":"string"
},
"ASIN":{
"description":"The Amazon Standard Identification Number (ASIN) of the item.",
"type":"string"
},
"BarcodeInstruction":{
"$ref":"#/definitions/BarcodeInstruction"
},
"PrepGuidance":{
"$ref":"#/definitions/PrepGuidance"
},
"PrepInstructionList":{
"$ref":"#/definitions/PrepInstructionList"
},
"AmazonPrepFeesDetailsList":{
"$ref":"#/definitions/AmazonPrepFeesDetailsList"
}
}
},
"SKUPrepInstructionsList":{
"description":"A list of SKU labeling requirements and item preparation instructions.",
"type":"array",
"items":{
"$ref":"#/definitions/SKUPrepInstructions"
}
},
"SellerFreightClass":{
"description":"The freight class of the shipment. For information about determining the freight class, contact the carrier.",
"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.",
"description":"The tracking number of the package, provided by the carrier.",
"type":"string"
},
"TransportContent":{
"description":"Inbound shipment information, including carrier details, shipment status, and the workflow status for a request for shipment with an Amazon-partnered carrier.",
"type":"object",
"required":[
"TransportDetails",
"TransportHeader",
"TransportResult"
],
"properties":{
"TransportHeader":{
"$ref":"#/definitions/TransportHeader"
},
"TransportDetails":{
"$ref":"#/definitions/TransportDetailOutput"
},
"TransportResult":{
"$ref":"#/definitions/TransportResult"
}
}
},
"TransportDetailInput":{
"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.",
"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).",
"type":"object",
"required":[
"IsPartnered",
"SellerId",
"ShipmentId",
"ShipmentType"
],
"properties":{
"SellerId":{
"description":"The Amazon seller identifier.",
"type":"string"
},
"ShipmentId":{
"description":"A shipment identifier originally returned by the createInboundShipmentPlan operation.",
"type":"string"
},
"IsPartnered":{
"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.",
"type":"boolean"
},
"ShipmentType":{
"$ref":"#/definitions/ShipmentType"
}
}
},
"TransportResult":{
"description":"The workflow status for a shipment with an Amazon-partnered carrier.",
"type":"object",
"required":[
"TransportStatus"
],
"properties":{
"TransportStatus":{
"$ref":"#/definitions/TransportStatus"
},
"ErrorCode":{
"description":"An error code that identifies the type of error that occured.",
"type":"string"
},
"ErrorDescription":{
"description":"A message that describes the error condition.",
"type":"string"
}
}
},
"TransportStatus":{
"description":"Indicates the status of the Amazon-partnered carrier shipment.",
"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."