"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Retrieves an AWD inbound shipment.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)",
"description":"Sort the response in `ASCENDING` or `DESCENDING` order.",
"enum":[
"ASCENDING",
"DESCENDING"
],
"in":"query",
"name":"sortOrder",
"type":"string",
"x-docgen-enum-table-extension":[
{
"description":"Sorts the collection in ascending order.",
"value":"ASCENDING"
},
{
"description":"Sorts the collection in descending order.",
"value":"DESCENDING"
}
],
"x-example":"ASCENDING"
},
{
"description":"Filter by inbound shipment status.",
"enum":[
"CREATED",
"SHIPPED",
"IN_TRANSIT",
"RECEIVING",
"DELIVERED",
"CLOSED",
"CANCELLED"
],
"in":"query",
"name":"shipmentStatus",
"type":"string",
"x-docgen-enum-table-extension":[
{
"description":"Shipment is created, but hasn't shipped.",
"value":"CREATED"
},
{
"description":"Shipment was picked up by the carrier or was dropped off with the carrier.",
"value":"SHIPPED"
},
{
"description":"The carrier has notified AWD that the shipment is in transit between the origin and destination nodes.",
"value":"IN_TRANSIT"
},
{
"description":"The shipment has been partially received.",
"value":"RECEIVING"
},
{
"description":"The shipment has reached the destination node and has been delivered to the facility yard. The shipment `receive` process at the warehouse will start soon.",
"value":"DELIVERED"
},
{
"description":"No more actions are required for the shipment. This is a final state.",
"value":"CLOSED"
},
{
"description":"The shipment is cancelled. This is a final state.",
"value":"CANCELLED"
}
],
"x-example":"CREATED"
},
{
"description":"List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"format":"date-time",
"in":"query",
"name":"updatedAfter",
"type":"string",
"x-example":"2023-01-12T10:00:00.000Z"
},
{
"description":"List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"format":"date-time",
"in":"query",
"name":"updatedBefore",
"type":"string",
"x-example":"2023-01-12T10:00:00.000Z"
},
{
"default":25,
"description":"Maximum number of results to return.",
"format":"int32",
"in":"query",
"maximum":200,
"minimum":1,
"name":"maxResults",
"type":"integer",
"x-example":"10"
},
{
"description":"Token to retrieve the next set of paginated results.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Lists AWD inventory associated with a merchant with the ability to apply optional filters.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Represents an AWD inbound shipment.",
"properties":{
"carrierCode":{
"description":"The shipment carrier code.",
"$ref":"#/definitions/CarrierCode"
},
"createdAt":{
"description":"Timestamp when the shipment was created. The date is returned in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"format":"date-time",
"type":"string"
},
"destinationAddress":{
"description":"Destination address for this shipment.",
"$ref":"#/definitions/Address"
},
"externalReferenceId":{
"description":"Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record.",
"type":"string",
"example":"TestReferenceId"
},
"orderId":{
"description":"The AWD inbound order ID that this inbound shipment belongs to.",
"minLength":1,
"type":"string"
},
"originAddress":{
"description":"Origin address for this shipment.",
"$ref":"#/definitions/Address"
},
"receivedQuantity":{
"description":"Quantity received (at the receiving end) as part of this shipment.",
"items":{
"$ref":"#/definitions/InventoryQuantity"
},
"type":"array"
},
"shipBy":{
"description":"Timestamp when the shipment will be shipped.",
"format":"date-time",
"type":"string"
},
"shipmentContainerQuantities":{
"description":"Packages that are part of this shipment.",
"description":"Carrier-unique tracking ID for this shipment.",
"minLength":1,
"type":"string"
},
"updatedAt":{
"description":"Timestamp when the shipment was updated. The date is returned in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"format":"date-time",
"type":"string"
},
"warehouseReferenceId":{
"description":"An AWD-provided reference ID that you can use to interact with the warehouse. For example, a carrier appointment booking.",
"description":"The shipment has reached the destination node and has been delivered to the facility yard. The shipment receive process at the warehouse will start soon.",
"description":"Optional client-provided reference ID that can be used to correlate this shipment with client resources. For example, to map this shipment to an internal bookkeeping order record.",
"description":"Unit of measurement for package dimensions.",
"$ref":"#/definitions/DimensionUnitOfMeasurement"
},
"width":{
"description":"Width of the package.",
"format":"double",
"type":"number"
}
},
"required":[
"height",
"length",
"unitOfMeasurement",
"width"
],
"type":"object"
},
"PackageVolume":{
"description":"Represents the volume of the package with a unit of measurement.",
"properties":{
"unitOfMeasurement":{
"description":"Unit of measurement for the package volume.",
"$ref":"#/definitions/VolumeUnitOfMeasurement"
},
"volume":{
"description":"The package volume value.",
"format":"double",
"type":"number"
}
},
"required":[
"unitOfMeasurement",
"volume"
],
"type":"object"
},
"PackageWeight":{
"description":"Represents the weight of the package with a unit of measurement.",
"properties":{
"unitOfMeasurement":{
"description":"Unit of measurement for the package weight.",
"$ref":"#/definitions/WeightUnitOfMeasurement"
},
"weight":{
"description":"The package weight value.",
"format":"double",
"type":"number"
}
},
"required":[
"unitOfMeasurement",
"weight"
],
"type":"object"
},
"ProductAttribute":{
"description":"Product instance attribute that is not described at the SKU level in the catalog.",
"properties":{
"name":{
"description":"Product attribute name.",
"type":"string",
"example":"TestAttribute"
},
"value":{
"description":"Product attribute value.",
"type":"string",
"example":"TestAttributeValue"
}
},
"type":"object",
"example":{
"name":"TestAttribute",
"value":"TestAttributeValue"
}
},
"ProductQuantity":{
"description":"Represents a product with the SKU details and the corresponding quantity.",
"properties":{
"attributes":{
"description":"Attributes for this instance of the product. For example, already-prepped, or other attributes that distinguish the product beyond the SKU.",
"items":{
"$ref":"#/definitions/ProductAttribute"
},
"type":"array",
"example":{
"name":"TestAttribute",
"value":"TestAttributeValue"
}
},
"quantity":{
"description":"Product quantity.",
"format":"int32",
"type":"integer"
},
"sku":{
"description":"The seller or merchant SKU.",
"type":"string"
}
},
"required":[
"quantity",
"sku"
],
"type":"object"
},
"ShipmentListing":{
"description":"A list of inbound shipment summaries filtered by the attributes specified in the request.",
"properties":{
"nextToken":{
"description":"Token to retrieve the next set of paginated results.",
"type":"string",
"example":"SampleToken"
},
"shipments":{
"description":"List of inbound shipment summaries.",
"items":{
"$ref":"#/definitions/InboundShipmentSummary"
},
"type":"array"
}
},
"type":"object"
},
"ShipmentSortableField":{
"description":"Denotes the field name on which the shipments are to be sorted.",
"enum":[
"UPDATED_AT",
"CREATED_AT"
],
"type":"string",
"x-docgen-enum-table-extension":[
{
"description":"Sort by updated at timestamp.",
"value":"UPDATED_AT"
},
{
"description":"Sort by created at timestamp.",
"value":"CREATED_AT"
}
],
"example":"CREATED_AT"
},
"SortOrder":{
"description":"Sort order for a collection of items. For example, order or shipment.",
"enum":[
"ASCENDING",
"DESCENDING"
],
"type":"string",
"x-docgen-enum-table-extension":[
{
"description":"Sorts the collection in ascending order.",
"value":"ASCENDING"
},
{
"description":"Sorts the collection in descending order.",
"value":"DESCENDING"
}
],
"example":"ASCENDING"
},
"VolumeUnitOfMeasurement":{
"description":"Unit of measurement for the package volume.",
"enum":[
"CU_IN",
"CBM",
"CC"
],
"type":"string",
"x-docgen-enum-table-extension":[
{
"description":"Denotes volume measurement in cubic inches.",
"value":"CU_IN"
},
{
"description":"Denotes volume measurement in cubic meters.",
"value":"CBM"
},
{
"description":"Denotes volume measurement in cubic centimeters.",
"value":"CC"
}
]
},
"WeightUnitOfMeasurement":{
"description":"Unit of measurement for the package weight.",
"enum":[
"POUNDS",
"KILOGRAMS"
],
"type":"string",
"x-docgen-enum-table-extension":[
{
"description":"Denotes weight measurement in pounds.",
"value":"POUNDS"
},
{
"description":"Denotes weight measurement in kilograms.",