diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..20dd4b7 Binary files /dev/null and b/.DS_Store differ diff --git a/models/.DS_Store b/models/.DS_Store new file mode 100644 index 0000000..cd72db9 Binary files /dev/null and b/models/.DS_Store differ diff --git a/models/fba-inventory-api-model/fbaInventory.json b/models/fba-inventory-api-model/fbaInventory.json index 4a85d63..9afb9b7 100644 --- a/models/fba-inventory-api-model/fbaInventory.json +++ b/models/fba-inventory-api-model/fbaInventory.json @@ -25,11 +25,14 @@ ], "paths": { "/fba/inventory/v1/summaries": { + "x-amzn-api-sandbox": { + "dynamic": {} + }, "get": { "tags": [ "fbaInventory" ], - "description": "Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters:\n\n- All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted.\n- When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified.\n- When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored.\n- When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`.\n\n**Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters:\n\n- All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted.\n- When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified.\n- When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored.\n- When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.\n\nNote: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding.\n\nUsage 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, see Usage Plans and Rate Limits in the Selling Partner API.", "operationId": "getInventorySummaries", "produces": [ "application/json" @@ -124,160 +127,8 @@ }, "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "description": "Unique request reference identifier." } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "details": { - "value": true - }, - "granularityType": { - "value": "Marketplace" - }, - "granularityId": { - "value": "ATVPDKIKX0DER" - }, - "marketplaceIds": { - "value": [ - "ATVPDKIKX0DER" - ] - } - } - }, - "response": { - "pagination": { - "nextToken": "seed" - }, - "payload": { - "granularity": { - "granularityType": "Marketplace", - "granularityId": "ATVPDKIKX0DER" - }, - "inventorySummaries": [ - { - "asin": "B0020MLK00", - "fnSku": "B0020MLK00", - "sellerSku": "EMTEC 1 GB", - "condition": "NewItem", - "inventoryDetails": { - "fulfillableQuantity": 0, - "inboundWorkingQuantity": 0, - "inboundShippedQuantity": 0, - "inboundReceivingQuantity": 0, - "reservedQuantity": { - "totalReservedQuantity": 0, - "pendingCustomerOrderQuantity": 0, - "pendingTransshipmentQuantity": 0, - "fcProcessingQuantity": 0 - }, - "researchingQuantity": { - "totalResearchingQuantity": 0, - "researchingQuantityBreakdown": [] - }, - "unfulfillableQuantity": { - "totalUnfulfillableQuantity": 0, - "customerDamagedQuantity": 0, - "warehouseDamagedQuantity": 0, - "distributorDamagedQuantity": 0, - "carrierDamagedQuantity": 0, - "defectiveQuantity": 0, - "expiredQuantity": 0 - } - }, - "lastUpdatedTime": "", - "productName": "EMTEC 1 GB 60x SD Flash Memory Card with USB 2.0 Card Reader", - "totalQuantity": 0 - }, - { - "asin": "B0020MLK00", - "fnSku": "B0020MLK00", - "sellerSku": "EMTEC-SdCard-reader", - "condition": "NewItem", - "inventoryDetails": { - "fulfillableQuantity": 0, - "inboundWorkingQuantity": 0, - "inboundShippedQuantity": 0, - "inboundReceivingQuantity": 0, - "reservedQuantity": { - "totalReservedQuantity": 0, - "pendingCustomerOrderQuantity": 0, - "pendingTransshipmentQuantity": 0, - "fcProcessingQuantity": 0 - }, - "researchingQuantity": { - "totalResearchingQuantity": 0, - "researchingQuantityBreakdown": [] - }, - "unfulfillableQuantity": { - "totalUnfulfillableQuantity": 0, - "customerDamagedQuantity": 0, - "warehouseDamagedQuantity": 0, - "distributorDamagedQuantity": 0, - "carrierDamagedQuantity": 0, - "defectiveQuantity": 0, - "expiredQuantity": 0 - } - }, - "lastUpdatedTime": "", - "productName": "EMTEC 1 GB 60x SD Flash Memory Card with USB 2.0 Card Reader", - "totalQuantity": 0 - }, - { - "asin": "B00T9QONN6", - "fnSku": "B00T9QONN6", - "sellerSku": "Silicon Power 32GB", - "condition": "NewItem", - "inventoryDetails": { - "fulfillableQuantity": 66, - "inboundWorkingQuantity": 21, - "inboundShippedQuantity": 0, - "inboundReceivingQuantity": 0, - "reservedQuantity": { - "totalReservedQuantity": 0, - "pendingCustomerOrderQuantity": 0, - "pendingTransshipmentQuantity": 0, - "fcProcessingQuantity": 0 - }, - "researchingQuantity": { - "totalResearchingQuantity": 0, - "researchingQuantityBreakdown": [ - { - "name": "researchingQuantityInShortTerm", - "quantity": 0 - }, - { - "name": "researchingQuantityInMidTerm", - "quantity": 0 - }, - { - "name": "researchingQuantityInLongTerm", - "quantity": 0 - } - ] - }, - "unfulfillableQuantity": { - "totalUnfulfillableQuantity": 0, - "customerDamagedQuantity": 0, - "warehouseDamagedQuantity": 0, - "distributorDamagedQuantity": 0, - "carrierDamagedQuantity": 0, - "defectiveQuantity": 0, - "expiredQuantity": 0 - } - }, - "lastUpdatedTime": "2018-03-31T23:40:39Z", - "productName": "Silicon Power 32GB up to 85MB/s MicroSDHC UHS-1 Class10, Elite Flash Memory Card with Adaptor (SP032GBSTHBU1V20SP)", - "totalQuantity": 87 - } - ] - } - } - } - ] } }, "400": { @@ -292,7 +143,7 @@ }, "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "description": "Unique request reference identifier." } } }, @@ -304,7 +155,7 @@ "headers": { "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "description": "Unique request reference identifier." } } }, @@ -320,7 +171,7 @@ }, "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "description": "Unique request reference identifier." } } }, @@ -330,13 +181,9 @@ "$ref": "#/definitions/GetInventorySummariesResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "description": "Unique request reference identifier." } } }, @@ -346,37 +193,10 @@ "$ref": "#/definitions/GetInventorySummariesResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "description": "Unique request reference identifier." } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "marketplaceIds": { - "value": [ - "1" - ] - } - } - }, - "response": { - "errors": [ - { - "message": "We encountered an internal error. Please try again.", - "code": "InternalFailure" - } - ] - } - } - ] } }, "503": { @@ -385,13 +205,360 @@ "$ref": "#/definitions/GetInventorySummariesResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "description": "Unique request reference identifier." + } + } + } + } + } + }, + "/fba/inventory/v1/items": { + "x-amzn-api-sandbox": { + "dynamic": {} + }, + "x-amzn-api-sandbox-only": true, + "post": { + "tags": [ + "fbaInventory" + ], + "description": "Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.", + "operationId": "createInventoryItem", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "createInventoryItemRequestBody", + "in": "body", + "description": "CreateInventoryItem Request Body Parameter.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateInventoryItemRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CreateInventoryItemResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/CreateInventoryItemResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.", + "schema": { + "$ref": "#/definitions/CreateInventoryItemResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The specified resource does not exist.", + "schema": { + "$ref": "#/definitions/CreateInventoryItemResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/CreateInventoryItemResponse" + }, + "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/CreateInventoryItemResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/CreateInventoryItemResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + } + } + }, + "/fba/inventory/v1/items/{sellerSku}": { + "x-amzn-api-sandbox": { + "dynamic": {} + }, + "x-amzn-api-sandbox-only": true, + "delete": { + "tags": [ + "fbaInventory" + ], + "description": "Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.", + "operationId": "deleteInventoryItem", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "sellerSku", + "in": "path", + "description": "A single seller SKU used for querying the specified seller SKU inventory summaries.", + "required": true, + "type": "string" + }, + { + "name": "marketplaceId", + "in": "query", + "description": "The marketplace ID for the marketplace for which the sellerSku is to be deleted.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeleteInventoryItemResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/DeleteInventoryItemResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.", + "schema": { + "$ref": "#/definitions/DeleteInventoryItemResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The specified resource does not exist.", + "schema": { + "$ref": "#/definitions/DeleteInventoryItemResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/DeleteInventoryItemResponse" + }, + "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/DeleteInventoryItemResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/DeleteInventoryItemResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + } + } + }, + "/fba/inventory/v1/items/inventory": { + "x-amzn-api-sandbox": { + "dynamic": {} + }, + "x-amzn-api-sandbox-only": true, + "post": { + "tags": [ + "fbaInventory" + ], + "description": "Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.", + "operationId": "addInventory", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "x-amzn-idempotency-token", + "in": "header", + "description": "A unique token/requestId provided with each call to ensure idempotency.", + "required": true, + "type": "string" + }, + { + "name": "addInventoryRequestBody", + "in": "body", + "description": "List of items to add to Sandbox inventory.", + "required": true, + "schema": { + "$ref": "#/definitions/AddInventoryRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AddInventoryResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/AddInventoryResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.", + "schema": { + "$ref": "#/definitions/AddInventoryResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The specified resource does not exist.", + "schema": { + "$ref": "#/definitions/AddInventoryResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/AddInventoryResponse" + }, + "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/AddInventoryResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/AddInventoryResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." } } } @@ -400,6 +567,90 @@ } }, "definitions": { + "CreateInventoryItemRequest": { + "description": "An item to be created in the inventory.", + "type": "object", + "properties": { + "sellerSku" : { + "description": "The seller SKU of the item.", + "type": "string" + }, + "marketplaceId" : { + "description": "The marketplaceId.", + "type": "string" + }, + "productName": { + "description": "The name of the item.", + "type": "string" + } + }, + "required": ["sellerSku", "marketplaceId", "productName"] + }, + "AddInventoryRequest": { + "description": "The object with the list of Inventory to be added", + "type": "object", + "properties": { + "inventoryItems": { + "$ref": "#/definitions/InventoryItems" + } + } + }, + "InventoryItems": { + "description": "List of Inventory to be added", + "type": "array", + "items": { + "$ref": "#/definitions/InventoryItem" + } + }, + "InventoryItem": { + "description": "An item in the list of inventory to be added.", + "type": "object", + "properties": { + "sellerSku" : { + "description": "The seller SKU of the item.", + "type": "string" + }, + "marketplaceId" : { + "description": "The marketplaceId.", + "type": "string" + }, + "quantity": { + "description": "The quantity of item to add.", + "type": "integer" + } + }, + "required": ["sellerSku", "marketplaceId", "quantity"] + }, + "CreateInventoryItemResponse": { + "type": "object", + "properties": { + "errors": { + "description": "One or more unexpected errors occurred during the CreateInventoryItem operation.", + "$ref": "#/definitions/ErrorList" + } + }, + "description": "The response schema for the CreateInventoryItem operation." + }, + "DeleteInventoryItemResponse": { + "type": "object", + "properties": { + "errors": { + "description": "One or more unexpected errors occurred during the DeleteInventoryItem operation.", + "$ref": "#/definitions/ErrorList" + } + }, + "description": "The response schema for the DeleteInventoryItem operation." + }, + "AddInventoryResponse": { + "type": "object", + "properties": { + "errors": { + "description": "One or more unexpected errors occurred during the AddInventory operation.", + "$ref": "#/definitions/ErrorList" + } + }, + "description": "The response schema for the AddInventory operation." + }, "Granularity": { "type": "object", "properties": { @@ -678,4 +929,4 @@ } } } -} \ No newline at end of file +} diff --git a/models/fulfillment-outbound-api-model/fulfillmentOutbound_2020-07-01.json b/models/fulfillment-outbound-api-model/fulfillmentOutbound_2020-07-01.json index 5559693..6eb1428 100644 --- a/models/fulfillment-outbound-api-model/fulfillmentOutbound_2020-07-01.json +++ b/models/fulfillment-outbound-api-model/fulfillmentOutbound_2020-07-01.json @@ -41,7 +41,8 @@ "required": true, "schema": { "$ref": "#/definitions/GetFulfillmentPreviewRequest" - } + }, + "description": "GetFulfillmentPreviewRequest parameter" } ], "responses": { @@ -138,10 +139,6 @@ "$ref": "#/definitions/GetFulfillmentPreviewResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -182,10 +179,6 @@ "$ref": "#/definitions/GetFulfillmentPreviewResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -198,10 +191,6 @@ "$ref": "#/definitions/GetFulfillmentPreviewResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -213,16 +202,162 @@ "schema": { "$ref": "#/definitions/GetFulfillmentPreviewResponse" }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + } + } + }, + "/fba/outbound/2020-07-01/deliveryOffers": { + "x-amzn-api-sandbox": { + "dynamic": {} + }, + "post": { + "tags": [ + "fbaOutbound" + ], + "description": "Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may 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": "deliveryOffers", + "parameters": [ + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetDeliveryOffersRequest" + }, + "description": "GetDeliveryOffersRequest parameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/GetDeliveryOffersResponse" + }, + "examples": { + "payload": { + "deliveryOffers": [{ + "expiresAt": "2023-10-11T18:00:00Z", + "dateRange": { + "earliest": "2023-10-13T10:00:00Z", + "latest": "2023-10-14T16:00:00Z" + }, + "policy": { + "messaging": { + "text": "Get it as soon as Wed, Aug 23", + "locale": "en_US" + } + } + }] + } + }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/GetDeliveryOffersResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "401": { + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", + "schema": { + "$ref": "#/definitions/GetDeliveryOffersResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/GetDeliveryOffersResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The specified resource does not exist.", + "schema": { + "$ref": "#/definitions/GetDeliveryOffersResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/GetDeliveryOffersResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/GetDeliveryOffersResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/GetDeliveryOffersResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } } } } @@ -352,10 +487,6 @@ "$ref": "#/definitions/ListAllFulfillmentOrdersResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -396,10 +527,6 @@ "$ref": "#/definitions/ListAllFulfillmentOrdersResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -412,10 +539,6 @@ "$ref": "#/definitions/ListAllFulfillmentOrdersResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -428,10 +551,6 @@ "$ref": "#/definitions/ListAllFulfillmentOrdersResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -453,7 +572,8 @@ "required": true, "schema": { "$ref": "#/definitions/CreateFulfillmentOrderRequest" - } + }, + "description": "CreateFulfillmentOrderRequest parameter" } ], "responses": { @@ -495,10 +615,6 @@ "$ref": "#/definitions/CreateFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -539,10 +655,6 @@ "$ref": "#/definitions/CreateFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -555,10 +667,6 @@ "$ref": "#/definitions/CreateFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -571,10 +679,6 @@ "$ref": "#/definitions/CreateFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -686,10 +790,6 @@ "$ref": "#/definitions/GetPackageTrackingDetailsResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -730,10 +830,6 @@ "$ref": "#/definitions/GetPackageTrackingDetailsResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -746,10 +842,6 @@ "$ref": "#/definitions/GetPackageTrackingDetailsResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -762,10 +854,6 @@ "$ref": "#/definitions/GetPackageTrackingDetailsResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -908,10 +996,6 @@ "$ref": "#/definitions/ListReturnReasonCodesResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -952,10 +1036,6 @@ "$ref": "#/definitions/ListReturnReasonCodesResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -968,10 +1048,6 @@ "$ref": "#/definitions/ListReturnReasonCodesResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -984,10 +1060,6 @@ "$ref": "#/definitions/ListReturnReasonCodesResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1014,7 +1086,8 @@ "required": true, "schema": { "$ref": "#/definitions/CreateFulfillmentReturnRequest" - } + }, + "description": "CreateFulfillmentReturnRequest parameter" }, { "name": "sellerFulfillmentOrderId", @@ -1097,10 +1170,6 @@ "$ref": "#/definitions/CreateFulfillmentReturnResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1113,10 +1182,6 @@ "$ref": "#/definitions/CreateFulfillmentReturnResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1145,10 +1210,6 @@ "$ref": "#/definitions/CreateFulfillmentReturnResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1161,10 +1222,6 @@ "$ref": "#/definitions/CreateFulfillmentReturnResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1177,10 +1234,6 @@ "$ref": "#/definitions/CreateFulfillmentReturnResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1297,7 +1350,8 @@ "sellerFulfillmentOrderItemId": "OrderItemID1", "quantity": 3, "packageNumber": 0, - "serialNumber": "" + "serialNumber": "", + "manufacturerLotCodes": ["LOT0822-1234", "LOT1030-5678"] } ] } @@ -1339,10 +1393,6 @@ "$ref": "#/definitions/GetFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1383,10 +1433,6 @@ "$ref": "#/definitions/GetFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1399,10 +1445,6 @@ "$ref": "#/definitions/GetFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1415,10 +1457,6 @@ "$ref": "#/definitions/GetFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1440,7 +1478,8 @@ "required": true, "schema": { "$ref": "#/definitions/UpdateFulfillmentOrderRequest" - } + }, + "description": "UpdateFulfillmentOrderRequest parameter" }, { "name": "sellerFulfillmentOrderId", @@ -1490,10 +1529,6 @@ "$ref": "#/definitions/UpdateFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1534,10 +1569,6 @@ "$ref": "#/definitions/UpdateFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1550,10 +1581,6 @@ "$ref": "#/definitions/UpdateFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1566,10 +1593,6 @@ "$ref": "#/definitions/UpdateFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1638,10 +1661,6 @@ "$ref": "#/definitions/CancelFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1682,10 +1701,6 @@ "$ref": "#/definitions/CancelFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1698,10 +1713,6 @@ "$ref": "#/definitions/CancelFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1714,10 +1725,6 @@ "$ref": "#/definitions/CancelFulfillmentOrderResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1753,7 +1760,8 @@ "required": true, "schema": { "$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateRequest" - } + }, + "description": "The identifier assigned to the item by the seller when the fulfillment order was created." } ], "responses": { @@ -1763,10 +1771,6 @@ "$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateResponse" }, "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." @@ -1779,10 +1783,6 @@ "$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateResponse" }, "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." @@ -1795,10 +1795,6 @@ "$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1823,10 +1819,6 @@ "$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateResponse" }, "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." @@ -1839,10 +1831,6 @@ "$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1855,10 +1843,6 @@ "$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1871,10 +1855,6 @@ "$ref": "#/definitions/SubmitFulfillmentOrderStatusUpdateResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1959,10 +1939,6 @@ "$ref": "#/definitions/GetFeaturesResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -2003,10 +1979,6 @@ "$ref": "#/definitions/GetFeaturesResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -2019,10 +1991,6 @@ "$ref": "#/definitions/GetFeaturesResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -2035,10 +2003,6 @@ "$ref": "#/definitions/GetFeaturesResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -2079,6 +2043,14 @@ "description": "A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.", "required": false, "type": "string" + }, + { + "name": "queryStartDate", + "in": "query", + "description": "A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ", + "required": false, + "type": "string", + "format": "date-time" } ], "responses": { @@ -2151,10 +2123,6 @@ "$ref": "#/definitions/GetFeatureInventoryResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -2195,10 +2163,6 @@ "$ref": "#/definitions/GetFeatureInventoryResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -2211,10 +2175,6 @@ "$ref": "#/definitions/GetFeatureInventoryResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -2227,10 +2187,6 @@ "$ref": "#/definitions/GetFeatureInventoryResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -2326,10 +2282,6 @@ "$ref": "#/definitions/GetFeatureSkuResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -2370,10 +2322,6 @@ "$ref": "#/definitions/GetFeatureSkuResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -2386,10 +2334,6 @@ "$ref": "#/definitions/GetFeatureSkuResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -2402,10 +2346,6 @@ "$ref": "#/definitions/GetFeatureSkuResponse" }, "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -2707,6 +2647,10 @@ "description": "The destination address for the fulfillment order.", "$ref": "#/definitions/Address" }, + "deliveryPreferences": { + "description": "The delivery preferences applied to the destination address. These preferences will be applied when possible and are best effort.\nThis feature is currently supported only in the JP marketplace and not applicable for other marketplaces.", + "$ref": "#/definitions/DeliveryPreferences" + }, "fulfillmentAction": { "$ref": "#/definitions/FulfillmentAction" }, @@ -2754,6 +2698,7 @@ "description": "The `createFulfillmentReturn` operation creates a fulfillment return for items that were fulfilled using the `createFulfillmentOrder` operation. For calls to `createFulfillmentReturn`, you must include `ReturnReasonCode` values returned by a previous call to the `listReturnReasonCodes` operation." }, "CreateFulfillmentReturnResult": { + "description": "The result for the createFulfillmentReturn operation.", "type": "object", "properties": { "returnItems": { @@ -2868,6 +2813,65 @@ "$ref": "#/definitions/DeliveryWindow" } }, + "DeliveryPreferences": { + "type": "object", + "properties": { + "deliveryInstructions": { + "type": "string", + "description": "Additional delivery instructions. For example, this could be instructions on how to enter a building, nearby landmark or navigation instructions, 'Beware of dogs', etc.", + "maxLength": 250 + }, + "dropOffLocation": { + "description": "The preferred location to leave packages at the destination address.", + "$ref": "#/definitions/DropOffLocation" + } + }, + "description": "The delivery preferences applied to the destination address. These preferences will be applied when possible and are best effort.\nThis feature is currently supported only in the JP marketplace and not applicable for other marketplaces." + }, + "DropOffLocation": { + "type": "object", + "required": ["type"], + "properties": { + "type": { + "type": "string", + "description": "Specifies the preferred location to leave the package at the destination address.", + "enum": ["FRONT_DOOR", "DELIVERY_BOX", "GAS_METER_BOX", "BICYCLE_BASKET", "GARAGE", "RECEPTIONIST", "FALLBACK_NEIGHBOR_DELIVERY", "DO_NOT_LEAVE_UNATTENDED"], + "x-docgen-enum-table-extension": [{ + "value": "FRONT_DOOR", + "description": "Indicates delivery preferred to front door." + }, { + "value": "DELIVERY_BOX", + "description": "Indicates delivery preferred to a delivery box." + }, { + "value": "GAS_METER_BOX", + "description": "Indicates delivery preferred to a gas meter box." + }, { + "value": "BICYCLE_BASKET", + "description": "Indicates delivery preferred to a bicycle basket." + }, { + "value": "GARAGE", + "description": "Indicates delivery preferred to a garage." + }, { + "value": "RECEPTIONIST", + "description": "Indicates delivery preferred with a receptionist." + }, { + "value": "FALLBACK_NEIGHBOR_DELIVERY", + "description": "Indicates delivery preferred with a designated neighbor if the recipient is not available at the destination address." + }, { + "value": "DO_NOT_LEAVE_UNATTENDED", + "description": "Indicates delivery preferred as attended." + }] + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Additional information about the drop-off location that can vary depending on the type of drop-off location specified in the `type` field.\nIf the `type` is set to `FALLBACK_NEIGHBOR_DELIVERY`, the `attributes` object should include the exact keys `neighborName` and `houseNumber` to provide the name and house number of the designated neighbor." + } + }, + "description": "The preferred location to leave packages at the destination address." + }, "Fee": { "type": "object", "required": [ @@ -3359,6 +3363,10 @@ "serialNumber": { "type": "string", "description": "The serial number of the shipped item." + }, + "manufacturerLotCodes": { + "description": "The manufacturer lot codes of the shipped items.", + "$ref": "#/definitions/StringList" } }, "description": "Item information for a shipment in a fulfillment order." @@ -3400,6 +3408,10 @@ "estimatedArrivalDate": { "description": "The estimated arrival date and time of the package. Must be in ISO 8601 format.", "$ref": "#/definitions/Timestamp" + }, + "lockerDetails": { + "description": "The locker details, if provided can be used to access locker delivery box.", + "$ref": "#/definitions/LockerDetails" } }, "description": "Package information for a shipment in a fulfillment order." @@ -3412,6 +3424,7 @@ } }, "GetFulfillmentOrderResult": { + "description": "The request for the getFulfillmentOrder operation.", "type": "object", "required": [ "fulfillmentOrder", @@ -3553,6 +3566,295 @@ }, "description": "The response schema for the `getFulfillmentPreview` operation." }, + "GetDeliveryOffersRequest": { + "type": "object", + "required": [ + "product", + "terms" + ], + "properties": { + "product": { + "$ref": "#/definitions/GetDeliveryOffersProduct", + "description": "The product details for the delivery offer." + }, + "terms": { + "$ref": "#/definitions/GetDeliveryOffersTerms", + "description": "The terms for the delivery offer." + } + }, + "description": "The request body schema for the getDeliveryOffers operation." + }, + "GetDeliveryOffersResponse": { + "type": "object", + "properties": { + "payload": { + "$ref": "#/definitions/GetDeliveryOffersResult", + "description": "The response payload for the getDeliveryOffers operation." + }, + "errors": { + "$ref": "#/definitions/ErrorList", + "description": "One or more unexpected errors occurred during the getDeliveryOffers operation." + } + }, + "description": "The response schema for the getDeliveryOffers operation." + }, + "GetDeliveryOffersResult": { + "type": "object", + "properties": { + "deliveryOffers": { + "$ref": "#/definitions/DeliveryOffersList", + "description": "An array of delivery offers." + } + }, + "description": "A list of delivery offers, including offer expiration, earliest and latest date and time range, and the delivery offer policy." + }, + "DeliveryOffersList": { + "type": "array", + "description": "An array of delivery offer information.", + "items": { + "$ref": "#/definitions/DeliveryOffer" + } + }, + "DeliveryOffer": { + "type": "object", + "properties": { + "expiresAt": { + "$ref": "#/definitions/Timestamp", + "description": "The timestamp at which a delivery offer expires." + }, + "dateRange": { + "$ref": "#/definitions/DateRange", + "description": "The range between which delivery is expected." + }, + "policy": { + "$ref": "#/definitions/DeliveryPolicy", + "description": "The policy for a delivery offer, including localized messaging." + } + }, + "description": "An available offer for delivery of a product." + }, + "GetDeliveryOffersProduct": { + "type": "object", + "required": [ + "productIdentifier" + ], + "properties": { + "productIdentifier": { + "$ref": "#/definitions/ProductIdentifier", + "description": "Product identifier input that locates a product for MCF." + }, + "amount": { + "$ref": "#/definitions/Amount", + "description": "The amount of the requested product." + } + }, + "description": "The product details for the delivery offer." + }, + "Amount": { + "type": "object", + "required": [ + "unitOfMeasure", + "value" + ], + "properties": { + "unitOfMeasure": { + "type": "string", + "description": "The unit of measure for the amount.", + "enum": [ + "Eaches" + ], + "x-docgen-enum-table-extension": [ + { + "value": "Eaches", + "description": "Specifies an integer count of units." + } + ] + }, + "value": { + "$ref": "#/definitions/Decimal", + "description": "The amount of a product in the associated unit of measure." + } + }, + "description": "A quantity based on unit of measure." + }, + "GetDeliveryOffersTerms": { + "type": "object", + "required": [ + "origin", + "destination" + ], + "properties": { + "origin": { + "$ref": "#/definitions/Origin", + "description": "The origin for the delivery offer." + }, + "destination": { + "$ref": "#/definitions/Destination", + "description": "The destination for the delivery offer." + } + }, + "description": "The delivery terms for the delivery offer." + }, + "IpAddress": { + "type": "string", + "format": "ip", + "description": "An IP Address." + }, + "Destination": { + "type": "object", + "properties": { + "deliveryAddress": { + "$ref": "#/definitions/VariablePrecisionAddress" + }, + "ipAddress": { + "$ref": "#/definitions/IpAddress", + "description": "The IP address of the customer." + } + }, + "description": "The destination for the delivery offer." + }, + "ProductIdentifier": { + "type": "object", + "required": [ + "merchantSku" + ], + "properties": { + "merchantSku": { + "type": "string", + "description": "The merchant SKU for the product.", + "maxLength": 50 + } + }, + "description": "Product identifier input that locates a product for MCF." + }, + "Origin": { + "type": "object", + "required": [ + "countryCode" + ], + "description": "The origin for the delivery offer.", + "properties": { + "countryCode": { + "type": "string", + "description": "The two digit country code the items should ship from. In ISO 3166-1 alpha-2 format.", + "minLength": 2, + "maxLength": 2 + } + } + }, + "VariablePrecisionAddress": { + "type": "object", + "required": [ + "countryCode", + "postalCode" + ], + "properties": { + "addressLine1": { + "type": "string", + "description": "The first line of the address." + }, + "addressLine2": { + "type": "string", + "description": "Additional address information, if required." + }, + "addressLine3": { + "type": "string", + "description": "Additional address information, if required." + }, + "city": { + "type": "string", + "description": "The city where the person, business, or institution is located. This property should not be used in Japan." + }, + "districtOrCounty": { + "type": "string", + "description": "The district or county where the person, business, or institution is located." + }, + "stateOrRegion": { + "type": "string", + "description": "The state or region where the person, business or institution is located." + }, + "postalCode": { + "type": "string", + "description": "The postal code of the address." + }, + "countryCode": { + "type": "string", + "description": "The two digit country code. In ISO 3166-1 alpha-2 format.", + "minLength": 2, + "maxLength": 2 + } + }, + "description": "A physical address with varying degrees of precision. A more precise address can provide more accurate results than country code and postal code alone." + }, + "DeliveryQuantity": { + "type": "object", + "required": [ + "unitOfMeasure", + "amount" + ], + "properties": { + "unitOfMeasure": { + "type": "string", + "description": "The unit of measure for the amount.", + "enum": [ + "Each" + ], + "x-docgen-enum-table-extension": [ + { + "value": "Each", + "description": "Specifies an integer count of units." + } + ] + }, + "amount": { + "$ref": "#/definitions/Decimal", + "description": "The amount of a product in the associated unit of measure." + } + }, + "description": "A quantity based on unit of measure." + }, + "DateRange": { + "type": "object", + "required": [ + "earliest", + "latest" + ], + "properties": { + "earliest": { + "$ref": "#/definitions/Timestamp", + "description": "The earliest point in a date range." + }, + "latest": { + "$ref": "#/definitions/Timestamp", + "description": "The latest point in a date range." + } + }, + "description": "The time range within which something (for example, a delivery) will occur." + }, + "DeliveryPolicy": { + "type": "object", + "properties": { + "message": { + "$ref": "#/definitions/DeliveryMessage", + "description": "Localized messaging for a delivery offering." + } + }, + "description": "The policy for a delivery offering." + }, + "DeliveryMessage": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The message content for a delivery offering." + }, + "locale": { + "type": "string", + "description": "The locale for the message (for example, en_US)." + } + }, + "description": "Localized messaging for a delivery offering." + }, "InvalidItemReasonCode": { "type": "string", "description": "A code for why the item is invalid for return.", @@ -3628,6 +3930,7 @@ } }, "ListAllFulfillmentOrdersResult": { + "description": "The request for the listAllFulfillmentOrders operation.", "type": "object", "properties": { "nextToken": { @@ -3658,6 +3961,7 @@ "description": "The response schema for the `listAllFulfillmentOrders` operation." }, "ListReturnReasonCodesResult": { + "description": "The request for the listReturnReasonCodes operation.", "type": "object", "properties": { "reasonCodeDetails": { @@ -3679,6 +3983,20 @@ }, "description": "The response schema for the `listReturnReasonCodes` operation." }, + "LockerDetails": { + "type": "object", + "properties": { + "lockerNumber": { + "type": "string", + "description": "Indicates the locker number" + }, + "lockerAccessCode": { + "type": "string", + "description": "Indicates the locker access code" + } + }, + "description": "The locker details, if provided can be used to access locker delivery box." + }, "NotificationEmailList": { "type": "array", "description": "A list of email addresses that the seller provides that are used by Amazon to send ship-complete notifications to recipients on behalf of the seller.", @@ -3924,6 +4242,7 @@ ] }, "PackageTrackingDetails": { + "description": "Tracking details of package", "type": "object", "required": [ "packageNumber" @@ -4214,18 +4533,21 @@ "description": "Delivery information for a scheduled delivery. This is only available in the JP marketplace." }, "ShippingSpeedCategoryList": { + "description": "ShippingSpeedCategory List", "type": "array", "items": { "$ref": "#/definitions/ShippingSpeedCategory" } }, "StringList": { + "description": "String list", "type": "array", "items": { "type": "string" } }, "Timestamp": { + "description": "Date timestamp", "type": "string", "format": "date-time" },