Update AWD model
This commit is contained in:
lisa-delaney
parent
21de6a2044
commit
5979ca6208
|
|
@ -1,9 +1,9 @@
|
|||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "The Selling Partner API for AWD",
|
||||
"title": "The Selling Partner API for Amazon Warehousing and Distribution",
|
||||
"version": "2024-05-09",
|
||||
"description": "The Selling Partner API for Amazon Warehousing and Distribution (AWD).",
|
||||
"description": "The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory. ",
|
||||
"contact": {
|
||||
"name": "Selling Partner API Developer Support",
|
||||
"url": "https://sellercentral.amazon.com/gp/mws/contactus.html"
|
||||
|
|
@ -37,6 +37,27 @@
|
|||
"name": "shipmentId",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"description": "If equal to `SHOW`, the response includes the shipment SKU quantity details.\n\nDefaults to `HIDE`, in which case the response does not contain SKU quantities",
|
||||
"enum": [
|
||||
"SHOW",
|
||||
"HIDE"
|
||||
],
|
||||
"in": "query",
|
||||
"name": "skuQuantities",
|
||||
"type": "string",
|
||||
"x-example": "SHOW",
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"description": "Show the additional SKU quantity details.",
|
||||
"value": "SHOW"
|
||||
},
|
||||
{
|
||||
"description": "Hide the additional SKU quantity details.",
|
||||
"value": "HIDE"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
|
|
@ -127,6 +148,19 @@
|
|||
],
|
||||
"shipmentId": "TestShipmentId",
|
||||
"shipmentStatus": "CREATED",
|
||||
"shipmentSkuQuantities": [
|
||||
{
|
||||
"sku": "testPen",
|
||||
"expectedQuantity": {
|
||||
"quantity": 2,
|
||||
"unitOfMeasurement": "CASE"
|
||||
},
|
||||
"receivedQuantity": {
|
||||
"quantity": 0,
|
||||
"unitOfMeasurement": "CASE"
|
||||
}
|
||||
}
|
||||
],
|
||||
"updatedAt": "2023-06-07T12:12:09.061Z"
|
||||
}
|
||||
}
|
||||
|
|
@ -274,7 +308,7 @@
|
|||
],
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Field to sort results by. Required if `sortOrder` is provided.",
|
||||
"description": "Field to sort results by. By default, the response will be sorted by UPDATED_AT.",
|
||||
"enum": [
|
||||
"UPDATED_AT",
|
||||
"CREATED_AT"
|
||||
|
|
@ -284,17 +318,17 @@
|
|||
"type": "string",
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"description": "Sort by `Updated at`timestamp.",
|
||||
"description": "Sort by the time of update.",
|
||||
"value": "UPDATED_AT"
|
||||
},
|
||||
{
|
||||
"description": "Sort by `Created at` timestamp.",
|
||||
"description": "Sort by the time of creation.",
|
||||
"value": "CREATED_AT"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"description": "Sort the response in `ASCENDING` or `DESCENDING` order.",
|
||||
"description": "Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.",
|
||||
"enum": [
|
||||
"ASCENDING",
|
||||
"DESCENDING"
|
||||
|
|
@ -560,7 +594,7 @@
|
|||
"tags": [
|
||||
"awd"
|
||||
],
|
||||
"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": "Retrieves a summary of 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).",
|
||||
"operationId": "listInboundShipments"
|
||||
}
|
||||
},
|
||||
|
|
@ -661,6 +695,7 @@
|
|||
"inventory": [
|
||||
{
|
||||
"totalOnhandQuantity": 20,
|
||||
"totalInboundQuantity": 10,
|
||||
"sku": "100TestSKU1Pen",
|
||||
"inventoryDetails": {
|
||||
"availableDistributableQuantity": 10,
|
||||
|
|
@ -669,6 +704,7 @@
|
|||
},
|
||||
{
|
||||
"totalOnhandQuantity": 20,
|
||||
"totalInboundQuantity": 5,
|
||||
"sku": "2U-BKEX-VW4D",
|
||||
"inventoryDetails": {
|
||||
"availableDistributableQuantity": 10,
|
||||
|
|
@ -915,7 +951,7 @@
|
|||
"type": "string",
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"description": "Standard Carrier Alpha Code. Ref: https://help.cbp.gov/s/article/Article-572?language=en_US.",
|
||||
"description": "Standard Carrier Alpha Code. Refer to [What is a Standard Carrier Alpha Code](https://www.help.cbp.gov/s/article/Article-1420?language=en_US) for more information.",
|
||||
"value": "SCAC"
|
||||
}
|
||||
],
|
||||
|
|
@ -1169,6 +1205,13 @@
|
|||
"minLength": 1,
|
||||
"type": "string"
|
||||
},
|
||||
"shipmentSkuQuantities": {
|
||||
"description": "Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/SkuQuantity"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"shipmentStatus": {
|
||||
"description": "Current status of this shipment.",
|
||||
"$ref": "#/definitions/InboundShipmentStatus"
|
||||
|
|
@ -1365,6 +1408,11 @@
|
|||
"description": "The seller or merchant SKU.",
|
||||
"type": "string"
|
||||
},
|
||||
"totalInboundQuantity": {
|
||||
"description": "Total quantity that is in-transit from the seller and has not yet been received at an AWD Distribution Center",
|
||||
"format": "int64",
|
||||
"type": "integer"
|
||||
},
|
||||
"totalOnhandQuantity": {
|
||||
"description": "Total quantity that is present in AWD distribution centers.",
|
||||
"format": "int64",
|
||||
|
|
@ -1517,11 +1565,7 @@
|
|||
"items": {
|
||||
"$ref": "#/definitions/ProductAttribute"
|
||||
},
|
||||
"type": "array",
|
||||
"example": {
|
||||
"name": "TestAttribute",
|
||||
"value": "TestAttributeValue"
|
||||
}
|
||||
"type": "array"
|
||||
},
|
||||
"quantity": {
|
||||
"description": "Product quantity.",
|
||||
|
|
@ -1576,6 +1620,45 @@
|
|||
],
|
||||
"example": "CREATED_AT"
|
||||
},
|
||||
"SkuQuantitiesVisibility": {
|
||||
"description": "Enum to specify if returned shipment should include SKU quantity details",
|
||||
"enum": [
|
||||
"SHOW",
|
||||
"HIDE"
|
||||
],
|
||||
"type": "string",
|
||||
"example": "SHOW",
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"description": "Show the additional SKU quantity details",
|
||||
"value": "SHOW"
|
||||
},
|
||||
{
|
||||
"description": "Hide the additional SKU quantity details",
|
||||
"value": "HIDE"
|
||||
}
|
||||
]
|
||||
},
|
||||
"SkuQuantity": {
|
||||
"description": "Quantity details for a SKU as part of a shipment",
|
||||
"properties": {
|
||||
"expectedQuantity": {
|
||||
"$ref": "#/definitions/InventoryQuantity"
|
||||
},
|
||||
"receivedQuantity": {
|
||||
"$ref": "#/definitions/InventoryQuantity"
|
||||
},
|
||||
"sku": {
|
||||
"description": "The merchant stock keeping unit",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"expectedQuantity",
|
||||
"sku"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"SortOrder": {
|
||||
"description": "Sort order for a collection of items. For example, order or shipment.",
|
||||
"enum": [
|
||||
|
|
@ -1637,4 +1720,4 @@
|
|||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue