wezone
/
selling-partner-api-models
mirror of https://github.com/amzn/selling-partner-api-models.git
10
0
Fork 0
Code Issues Projects Releases Wiki Activity

Vendor df models update.

This commit is contained in:
Gibran Waldron 2024-06-27 08:07:14 -07:00
parent 20de4e71e0
commit 773915d0a6
12 changed files with 1063 additions and 1780 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
models/vendor-direct-fulfillment-inventory-api-model/vendorDirectFulfillmentInventoryV1.json
View File

@ -29,7 +29,7 @@
"tags": [
"updateInventory"
],
"description": "Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the 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 *SP-API*](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "submitInventoryUpdate",
"parameters": [
{
@ -38,7 +38,8 @@
"required": true,
"schema": {
"$ref": "#/definitions/SubmitInventoryUpdateRequest"
}
},
"description": "The request body that contains the inventory update data to submit."
},
{
"name": "warehouseId",
@ -203,10 +204,6 @@
"$ref": "#/definitions/SubmitInventoryUpdateResponse"
},
"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."
@ -219,10 +216,6 @@
"$ref": "#/definitions/SubmitInventoryUpdateResponse"
},
"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."
@ -235,10 +228,6 @@
"$ref": "#/definitions/SubmitInventoryUpdateResponse"
},
"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."
@ -251,10 +240,6 @@
"$ref": "#/definitions/SubmitInventoryUpdateResponse"
},
"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."
@ -267,10 +252,6 @@
"$ref": "#/definitions/SubmitInventoryUpdateResponse"
},
"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."
@ -291,9 +272,10 @@
"$ref": "#/definitions/InventoryUpdate"
}
},
"description": "The request body for the submitInventoryUpdate operation."
"description": "The request body for the `submitInventoryUpdate` operation."
},
"InventoryUpdate": {
"description": "Inventory details required to update some or all items for the requested warehouse.",
"type": "object",
"required": [
"isFullUpdate",
@ -302,12 +284,12 @@
],
"properties": {
"sellingParty": {
"description": "ID of the selling party or vendor.",
"description": "The ID for the selling party or vendor.",
"$ref": "#/definitions/PartyIdentification"
},
"isFullUpdate": {
"type": "boolean",
"description": "When true, this request contains a full feed. Otherwise, this request contains a partial feed. When sending a full feed, you must send information about all items in the warehouse. Any items not in the full feed are updated as not available. When sending a partial feed, only include the items that need an update to inventory. The status of other items will remain unchanged."
"description": "When `true`, this request contains a full feed. When `false`, this request contains a partial feed. When sending a full feed, you must send information about all items in the warehouse. Any items not in the full feed are updated as not available. When sending a partial feed, only include the items that need an inventory update. The status of other items will remain unchanged."
},
"items": {
"type": "array",
@ -326,11 +308,11 @@
"properties": {
"buyerProductIdentifier": {
"type": "string",
"description": "The buyer selected product identification of the item. Either buyerProductIdentifier or vendorProductIdentifier should be submitted."
"description": "The buyer-selected product identification for the item. Either `buyerProductIdentifier` or `vendorProductIdentifier` must be submitted."
},
"vendorProductIdentifier": {
"type": "string",
"description": "The vendor selected product identification of the item. Either buyerProductIdentifier or vendorProductIdentifier should be submitted."
"description": "The vendor selected product identification for the item. Either `buyerProductIdentifier` or `vendorProductIdentifier` must be submitted."
},
"availableQuantity": {
"description": "Total item quantity available in the warehouse.",
@ -338,12 +320,13 @@
},
"isObsolete": {
"type": "boolean",
"description": "When true, the item is permanently unavailable."
"description": "When `true`, the item is permanently unavailable."
}
},
"description": "Updated inventory details for an item."
},
"PartyIdentification": {
"description": "Name, address and tax details for a group.",
"type": "object",
"required": [
"partyId"
@ -370,20 +353,20 @@
"description": "Unit of measure for the available quantity."
}
},
"description": "Details of item quantity."
"description": "Details about item quantity."
},
"SubmitInventoryUpdateResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The response payload for the submitInventoryUpdate operation.",
"description": "The response payload for the `submitInventoryUpdate` operation.",
"$ref": "#/definitions/TransactionReference"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the submitInventoryUpdate operation."
"description": "The response schema for the `submitInventoryUpdate` operation."
},
"TransactionReference": {
"type": "object",
@ -392,7 +375,8 @@
"type": "string",
"description": "GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction."
}
}
},
"description": "A response that contains the transaction ID."
},
"ErrorList": {
"type": "array",

341
models/vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrdersV1.json
View File

@ -691,251 +691,6 @@
}
}
},
{
"request": {
"parameters": {
"createdBefore": {
"value": "2020-02-20T00:00:00-08:00"
},
"createdAfter": {
"value": "2020-02-15T14:00:00-08:00"
},
"includeDetails": {
"value": "true"
},
"limit": {
"value": 2
},
"sortOrder": {
"value": "DESC"
},
"nextToken": {
"value": "MDAwMDAwMDAwMQ=="
}
}
},
"response": {
"payload": {
"orders": [
{
"purchaseOrderNumber": "2JK3S9VCD",
"orderDetails": {
"customerOrderNumber": "123-ABC",
"orderDate": "2020-02-20T13:51:00Z",
"orderStatus": "NEW",
"shipmentDetails": {
"isPriorityShipment": false,
"isScheduledDeliveryShipment": false,
"isPslipRequired": true,
"isGift": false,
"shipMethod": "UPS_2ND",
"shipmentDates": {
"requiredShipDate": "2020-02-21T00:00:00Z",
"promisedDeliveryDate": "2020-02-24T00:00:00Z"
},
"messageToCustomer": "This shipment completes your order. You can always check the status of your orders from the \"Your Account\" link at the top of each page of our site.Thank you for shopping at Amazon.com"
},
"taxTotal": {
"taxLineItem": [
{
"taxAmount": {
"currencyCode": "USD",
"amount": "190"
},
"type": "TOTAL"
}
]
},
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"shipToParty": {
"name": "ABCD",
"attention": "ABCD",
"addressLine1": "123 XYZ Street",
"addressLine2": "Apt 5",
"city": "San Jose",
"stateOrRegion": "CA",
"postalCode": "94086",
"countryCode": "USA"
},
"billToParty": {
"partyId": "ABCD"
},
"items": [
{
"itemSequenceNumber": "00001",
"buyerProductIdentifier": "B07DFVDRAB",
"vendorProductIdentifier": "8806098286500",
"title": "LG 8 kg Inverter Wi-Fi Fully-Automatic Front Loading Washing Machine (FHT1408SWS, STS-VCM, Inbuilt Heater)",
"orderedQuantity": {
"amount": 1,
"unitOfMeasure": "EACH"
},
"netPrice": {
"currencyCode": "USD",
"amount": "500"
},
"taxDetails": {
"taxLineItem": [
{
"taxRate": "0.1",
"taxAmount": {
"currencyCode": "USD",
"amount": "50"
},
"type": "TOTAL"
}
]
}
},
{
"itemSequenceNumber": "00002",
"buyerProductIdentifier": "B07DFYF5AB",
"vendorProductIdentifier": "8806098286123",
"title": "LG 6.5 kg Inverter Fully-Automatic Front Loading Washing Machine (FHT1065SNW, Blue and White, Inbuilt Heater)",
"orderedQuantity": {
"amount": 2,
"unitOfMeasure": "EACH"
},
"netPrice": {
"currencyCode": "USD",
"amount": "700"
},
"taxDetails": {
"taxLineItem": [
{
"taxRate": "0.1",
"taxAmount": {
"currencyCode": "USD",
"amount": "140"
},
"type": "TOTAL"
}
]
}
}
]
}
},
{
"purchaseOrderNumber": "3TRD2IABC",
"orderDetails": {
"customerOrderNumber": "456-ABC",
"orderDate": "2020-02-18T11:47:00Z",
"orderStatus": "NEW",
"shipmentDetails": {
"isPriorityShipment": false,
"isScheduledDeliveryShipment": false,
"isPslipRequired": true,
"isGift": false,
"shipMethod": "UPS_2ND",
"shipmentDates": {
"requiredShipDate": "2020-02-20T00:00:00Z",
"promisedDeliveryDate": "2020-02-22T00:00:00Z"
},
"messageToCustomer": "This shipment completes your order. You can always check the status of your orders from the \"Your Account\" link at the top of each page of our site.Thank you for shopping at Amazon.com"
},
"taxTotal": {
"taxLineItem": [
{
"taxRate": "0.1",
"taxAmount": {
"currencyCode": "USD",
"amount": "2"
},
"type": "TOTAL"
}
]
},
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"shipToParty": {
"name": "XYZ",
"attention": "XYZ",
"addressLine1": "456 ABC Street",
"city": "Seattle",
"stateOrRegion": "WA",
"postalCode": "98007",
"countryCode": "USA"
},
"billToParty": {
"partyId": "ABCD"
},
"items": [
{
"itemSequenceNumber": "00001",
"buyerProductIdentifier": "B01LNRIIAB",
"vendorProductIdentifier": "8806098286501",
"title": "Baby Dove Baby Wipes Rich Moisture (50 Pieces)",
"orderedQuantity": {
"amount": 1,
"unitOfMeasure": "EACH"
},
"netPrice": {
"currencyCode": "USD",
"amount": "20"
},
"taxDetails": {
"taxLineItem": [
{
"taxRate": "0.1",
"taxAmount": {
"currencyCode": "USD",
"amount": "2"
},
"type": "TOTAL"
}
]
}
}
]
}
}
]
}
}
},
{
"request": {
"parameters": {
"createdBefore": {
"value": "2019-08-21T00:00:00-08:00"
},
"createdAfter": {
"value": "2019-08-20T14:00:00-08:00"
},
"includeDetails": {
"value": "false"
},
"sortOrder": {
"value": "DESC"
}
}
},
"response": {
"payload": {
"pagination": {
"nextToken": "MDAwMDAwMDAwMQ=="
},
"orders": [
{
"purchaseOrderNumber": "2JK3S9VC"
},
{
"purchaseOrderNumber": "3TRD2IAB"
}
]
}
}
},
{
"request": {
"parameters": {
@ -1273,10 +1028,6 @@
"$ref": "#/definitions/GetOrdersResponse"
},
"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."
@ -1289,10 +1040,6 @@
"$ref": "#/definitions/GetOrdersResponse"
},
"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."
@ -1305,10 +1052,6 @@
"$ref": "#/definitions/GetOrdersResponse"
},
"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."
@ -1321,10 +1064,6 @@
"$ref": "#/definitions/GetOrdersResponse"
},
"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."
@ -1750,10 +1489,6 @@
"$ref": "#/definitions/GetOrderResponse"
},
"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."
@ -1794,10 +1529,6 @@
"$ref": "#/definitions/GetOrderResponse"
},
"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."
@ -1810,10 +1541,6 @@
"$ref": "#/definitions/GetOrderResponse"
},
"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."
@ -1826,10 +1553,6 @@
"$ref": "#/definitions/GetOrderResponse"
},
"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."
@ -1842,10 +1565,6 @@
"$ref": "#/definitions/GetOrderResponse"
},
"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."
@ -1869,7 +1588,8 @@
"required": true,
"schema": {
"$ref": "#/definitions/SubmitAcknowledgementRequest"
}
},
"description": "The request body that contains the order acknowledgement."
}
],
"responses": {
@ -2027,10 +1747,6 @@
"$ref": "#/definitions/SubmitAcknowledgementResponse"
},
"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."
@ -2043,10 +1759,6 @@
"$ref": "#/definitions/SubmitAcknowledgementResponse"
},
"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."
@ -2059,10 +1771,6 @@
"$ref": "#/definitions/SubmitAcknowledgementResponse"
},
"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."
@ -2075,10 +1783,6 @@
"$ref": "#/definitions/SubmitAcknowledgementResponse"
},
"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."
@ -2091,10 +1795,6 @@
"$ref": "#/definitions/SubmitAcknowledgementResponse"
},
"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."
@ -2136,15 +1836,18 @@
"type": "object",
"properties": {
"pagination": {
"$ref": "#/definitions/Pagination"
"$ref": "#/definitions/Pagination",
"description": "The pagination elements required to retrieve the remaining data."
},
"orders": {
"type": "array",
"items": {
"$ref": "#/definitions/Order"
},
"description": "Represents a purchase order within the `OrderList`."
}
}
}
},
"description": "A purchase orders list returned as a response."
},
"Pagination": {
"type": "object",
@ -2153,9 +1856,11 @@
"type": "string",
"description": "A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return."
}
}
},
"description": "The pagination elements required to retrieve the remaining data."
},
"Order": {
"description": "Represents a purchase order.",
"type": "object",
"required": [
"purchaseOrderNumber"
@ -2226,6 +1931,7 @@
},
"taxTotal": {
"type": "object",
"description": "The total tax object within the shipment that relates to the order.",
"properties": {
"taxLineItem": {
"description": "Tax details.",
@ -2260,6 +1966,7 @@
"description": "Details of an order."
},
"PartyIdentification": {
"description": "Name, address, and tax details of a party.",
"type": "object",
"required": [
"partyId"
@ -2329,7 +2036,7 @@
"properties": {
"name": {
"type": "string",
"description": "The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
"description": "The name of the person, business, or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
},
"attention": {
"type": "string",
@ -2349,15 +2056,15 @@
},
"city": {
"type": "string",
"description": "The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
"description": "The city where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
},
"county": {
"type": "string",
"description": "The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
"description": "The county where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
},
"district": {
"type": "string",
"description": "The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
"description": "The district where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
},
"stateOrRegion": {
"type": "string",
@ -2373,7 +2080,7 @@
},
"phone": {
"type": "string",
"description": "The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
"description": "The phone number of the person, business, or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
}
},
"description": "Address of the party."
@ -2432,7 +2139,8 @@
"description": "The price to Amazon each (cost).",
"$ref": "#/definitions/Money"
}
}
},
"description": "An order item."
},
"Money": {
"type": "object",
@ -2471,7 +2179,8 @@
"type": "string",
"description": "GUID assigned by Amazon to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction."
}
}
},
"description": "Response that contains the transaction ID."
},
"ErrorList": {
"type": "array",
@ -2563,7 +2272,8 @@
"description": "Details of quantity acknowledged with the above acknowledgement code.",
"$ref": "#/definitions/ItemQuantity"
}
}
},
"description": "Individual item details within the acknowledged order."
},
"ItemQuantity": {
"type": "object",
@ -2653,7 +2363,8 @@
}
]
}
}
},
"description": "The order's tax details."
},
"AcknowledgementStatus": {
"type": "object",

91
models/vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrders_2021-12-28.json
View File

@ -316,10 +316,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -332,10 +328,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -348,10 +340,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -364,10 +352,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -544,10 +528,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -588,10 +568,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -604,10 +580,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -620,10 +592,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -636,10 +604,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -666,7 +630,8 @@
"required": true,
"schema": {
"$ref": "#/definitions/SubmitAcknowledgementRequest"
}
},
"description": "The request body containing the acknowledgement to an order"
}
],
"responses": {
@ -736,10 +701,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -752,10 +713,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -768,10 +725,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -784,10 +737,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -800,10 +749,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -822,15 +767,18 @@
"type": "object",
"properties": {
"pagination": {
"$ref": "#/definitions/Pagination"
"$ref": "#/definitions/Pagination",
"description": "The pagination elements required to retrieve the remaining data."
},
"orders": {
"type": "array",
"items": {
"$ref": "#/definitions/Order"
},
"description": "Represents a purchase order within the OrderList."
}
}
}
},
"description": "A list of purchase orders."
},
"Pagination": {
"type": "object",
@ -839,9 +787,11 @@
"type": "string",
"description": "A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return."
}
}
},
"description": "The pagination elements required to retrieve the remaining data."
},
"Order": {
"description": "Represents a purchase order.",
"type": "object",
"required": [
"purchaseOrderNumber"
@ -941,6 +891,7 @@
},
"PartyIdentification": {
"type": "object",
"description": "Name, address and tax details of a party.",
"required": [
"partyId"
],
@ -1110,7 +1061,8 @@
"description": "The buyer information for products the vendor has configured as customizable, specifying the types of customizations or configurations along with types and ranges for their product. This provides the ability for buyers to customize multiple aspects of the products according to what the vendor allows.",
"$ref": "#/definitions/buyerCustomizedInfoDetail"
}
}
},
"description": "An item within an order"
},
"Money": {
"type": "object",
@ -1132,7 +1084,8 @@
"type": "string",
"description": "A [Base 64](https://datatracker.ietf.org/doc/html/rfc4648#section-4) encoded URL using the UTF-8 character set. The URL provides the location of the zip file that specifies the types of customizations or configurations allowed by the vendor, along with types and ranges for the attributes of their products."
}
}
},
"description": "The details of the products the vendor has configured as customizable."
},
"Decimal": {
"type": "string",
@ -1158,7 +1111,8 @@
"type": "string",
"description": "GUID assigned by Amazon to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction."
}
}
},
"description": "Response containing the transaction ID."
},
"ErrorList": {
"type": "object",
@ -1171,7 +1125,8 @@
"type": "array",
"items": {
"$ref": "#/definitions/Error"
}
},
"description": "An array of Error objects representing individual errors encountered during the request."
}
}
},
@ -1258,7 +1213,8 @@
"description": "Details of quantity acknowledged with the above acknowledgement code.",
"$ref": "#/definitions/ItemQuantity"
}
}
},
"description": "Details of an individual item within the order being acknowledged."
},
"ItemQuantity": {
"type": "object",
@ -1348,7 +1304,8 @@
}
]
}
}
},
"description": "The tax details related to the order."
},
"AcknowledgementStatus": {
"type": "object",

38
models/vendor-direct-fulfillment-payments-api-model/vendorDirectFulfillmentPaymentsV1.json
View File

@ -29,12 +29,13 @@
"tags": [
"vendorInvoice"
],
"description": "Submits one or more invoices for a vendor's direct fulfillment orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Submits one or more invoices for a vendor's direct fulfillment orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table 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": "submitInvoice",
"parameters": [
{
"in": "body",
"name": "body",
"description": "The request body that contains one or more invoices for vendor orders.",
"required": true,
"schema": {
"$ref": "#/definitions/SubmitInvoiceRequest"
@ -287,10 +288,6 @@
"$ref": "#/definitions/SubmitInvoiceResponse"
},
"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."
@ -303,10 +300,6 @@
"$ref": "#/definitions/SubmitInvoiceResponse"
},
"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."
@ -319,10 +312,6 @@
"$ref": "#/definitions/SubmitInvoiceResponse"
},
"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."
@ -335,10 +324,6 @@
"$ref": "#/definitions/SubmitInvoiceResponse"
},
"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."
@ -351,10 +336,6 @@
"$ref": "#/definitions/SubmitInvoiceResponse"
},
"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."
@ -372,6 +353,7 @@
"properties": {
"invoices": {
"type": "array",
"description": "An array of invoice details you want to submit.",
"items": {
"$ref": "#/definitions/InvoiceDetail"
}
@ -455,7 +437,8 @@
"$ref": "#/definitions/InvoiceItem"
}
}
}
},
"description": "Represents the invoice details, including the invoice number, date, parties involved, payment terms, totals, taxes, charges, and line items."
},
"InvoiceItem": {
"type": "object",
@ -512,10 +495,12 @@
"$ref": "#/definitions/ChargeDetails"
}
}
}
},
"description": "Details of the invoice items."
},
"PartyIdentification": {
"type": "object",
"description": "Name, address, and tax details of a party.",
"required": [
"partyId"
],
@ -563,7 +548,7 @@
},
"taxRegistrationNumber": {
"type": "string",
"description": "Tax registration number for the entity. For example, VAT ID, Consumption Tax ID."
"description": "Tax registration number for the entity. For example, VAT ID or Consumption Tax ID."
},
"taxRegistrationAddress": {
"description": "Address associated with the tax registration number.",
@ -852,7 +837,7 @@
"description": "The language code of the additional information detail."
}
},
"description": "A field where the selling party can provide additional information for tax-related or any other purposes."
"description": "A field where the selling party provides additional information."
},
"ItemQuantity": {
"type": "object",
@ -892,7 +877,8 @@
"type": "string",
"description": "GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction."
}
}
},
"description": "Response that contains the transaction ID."
},
"ErrorList": {
"type": "array",

80
models/vendor-direct-fulfillment-sandbox-test-data-api-model/vendorDirectFulfillmentSandboxData_2021-10-28.json
View File

@ -36,6 +36,7 @@
"in": "body",
"name": "body",
"required": true,
"description": "The request payload that contain parameters to generate test order data scenarios.",
"schema": {
"$ref": "#/definitions/GenerateOrderScenarioRequest"
}
@ -48,10 +49,6 @@
"$ref": "#/definitions/TransactionReference"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
@ -64,10 +61,6 @@
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
@ -92,10 +85,6 @@
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
@ -174,16 +163,12 @@
"tags": [
"vendorDFSandboxtransactionstatus"
],
"description": "Returns the status of the transaction indicated by the specified transactionId. If the transaction was successful, also returns the requested test order data.",
"description": "Retrieves the transaction status identified by the specified `transactionId`, and returns the requested test order data if the transaction is successful.",
"operationId": "getOrderScenarios",
"responses": {
"200": {
"description": "Success.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
@ -230,10 +215,6 @@
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
@ -244,12 +225,8 @@
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"description": "The request's authorization header is not formatted correctly or does not contain a valid token.",
"headers": {
"x-amzn-RateLimit-Limit": {
"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.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
@ -274,10 +251,6 @@
"404": {
"description": "The resource specified does not exist.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
@ -290,10 +263,6 @@
"415": {
"description": "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RateLimit-Limit": {
"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.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
@ -306,10 +275,6 @@
"429": {
"description": "The frequency of requests was greater than allowed.",
"headers": {
"x-amzn-RateLimit-Limit": {
"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.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
@ -322,10 +287,6 @@
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"headers": {
"x-amzn-RateLimit-Limit": {
"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.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
@ -338,10 +299,6 @@
"503": {
"description": "Temporary overloading or maintenance of the server.",
"headers": {
"x-amzn-RateLimit-Limit": {
"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.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
@ -356,7 +313,7 @@
{
"name": "transactionId",
"in": "path",
"description": "The transaction identifier returned in the response to the generateOrderScenarios operation.",
"description": "The transaction identifier returned in the response for the `generateOrderScenarios` operation.",
"required": true,
"type": "string"
}
@ -370,7 +327,7 @@
},
"definitions": {
"GenerateOrderScenarioRequest": {
"description": "The request body for the generateOrderScenarios operation.",
"description": "The `generateOrderScenarios` request body.",
"type": "object",
"properties": {
"orders": {
@ -391,17 +348,17 @@
],
"properties": {
"sellingParty": {
"description": "The identifier of the selling party or vendor.",
"description": "The identifier for the selling party or vendor.",
"$ref": "#/definitions/PartyIdentification"
},
"shipFromParty": {
"description": "The warehouse code of the vendor.",
"description": "The warehouse code for the vendor.",
"$ref": "#/definitions/PartyIdentification"
}
}
},
"PartyIdentification": {
"description": "The identification object for the party information. For example, warehouse code or vendor code. Please refer to specific party for more details.",
"description": "The identification object for the party information. For example, warehouse code or vendor code.",
"type": "object",
"required": [
"partyId"
@ -409,16 +366,17 @@
"properties": {
"partyId": {
"type": "string",
"description": "Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details."
"description": "Assigned identification for the party. For example, warehouse code or vendor code."
}
}
},
"Pagination": {
"description": "A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return.",
"description": "A generated string used to pass information to your next request. If `NextToken` is returned, pass the value of `NextToken` to the next request. If `NextToken` is not returned, there are no more order items to return.",
"type": "object",
"properties": {
"nextToken": {
"type": "string"
"type": "string",
"description": "A generated token that retrieves the next set of results. This token is specified in the next request."
}
}
},
@ -427,12 +385,13 @@
"type": "object",
"properties": {
"transactionId": {
"type": "string"
"type": "string",
"description": "A GUID (Globally Unique Identifier) assigned by Amazon to uniquely identify the transaction."
}
}
},
"TransactionStatus": {
"description": "The payload for the getOrderScenarios operation.",
"description": "The payload for `getOrderScenarios`.",
"type": "object",
"properties": {
"transactionStatus": {
@ -441,11 +400,11 @@
}
},
"Transaction": {
"description": "The transaction details including the status. If the transaction was successful, also includes the requested test order data.",
"description": "The transaction details that include the status. If the transaction is successful, also includes the requested test order data.",
"type": "object",
"properties": {
"transactionId": {
"description": "The unique identifier returned in the response to the generateOrderScenarios request.",
"description": "The unique identifier returned in the response for the `generateOrderScenarios` request.",
"type": "string"
},
"status": {
@ -472,7 +431,7 @@
]
},
"testCaseData": {
"description": "Test case data for the transaction. Only available when the transaction status is SUCCESS.",
"description": "Test case data for the transaction. Only available when the transaction status is `SUCCESS`.",
"$ref": "#/definitions/TestCaseData"
}
},
@ -534,6 +493,7 @@
"properties": {
"errors": {
"type": "array",
"description": "An array of individual error objects that contain error details.",
"items": {
"$ref": "#/definitions/Error"
}
@ -552,7 +512,7 @@
"properties": {
"code": {
"type": "string",
"description": "An error code that identifies the type of error that occured."
"description": "An error code that identifies the type of error that occurred."
},
"message": {
"type": "string",

346
models/vendor-direct-fulfillment-shipping-api-model/vendorDirectFulfillmentShippingV1.json
View File

@ -29,13 +29,13 @@
"tags": [
"vendorShippingLabels"
],
"description": "Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the `createdAfter` and `createdBefore` parameters. You must use both of these parameters. The date range to search must not be more than 7 days.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "getShippingLabels",
"parameters": [
{
"name": "shipFromPartyId",
"in": "query",
"description": "The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.",
"description": "The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses.",
"required": false,
"type": "string"
},
@ -51,7 +51,7 @@
{
"name": "createdAfter",
"in": "query",
"description": "Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Shipping labels that became available after this date and time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": true,
"type": "string",
"format": "date-time"
@ -59,7 +59,7 @@
{
"name": "createdBefore",
"in": "query",
"description": "Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Shipping labels that became available before this date and time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": true,
"type": "string",
"format": "date-time"
@ -355,10 +355,6 @@
"$ref": "#/definitions/GetShippingLabelListResponse"
},
"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."
@ -371,10 +367,6 @@
"$ref": "#/definitions/GetShippingLabelListResponse"
},
"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."
@ -387,10 +379,6 @@
"$ref": "#/definitions/GetShippingLabelListResponse"
},
"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."
@ -403,10 +391,6 @@
"$ref": "#/definitions/GetShippingLabelListResponse"
},
"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."
@ -419,7 +403,7 @@
"tags": [
"vendorShippingLabels"
],
"description": "Creates a shipping label for a purchase order and returns a transactionId for reference.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Creates a shipping label for a purchase order and returns a `transactionId` for reference.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "submitShippingLabelRequest",
"parameters": [
{
@ -428,7 +412,8 @@
"required": true,
"schema": {
"$ref": "#/definitions/SubmitShippingLabelsRequest"
}
},
"description": "Request body containing one or more shipping labels data."
}
],
"responses": {
@ -702,10 +687,6 @@
"$ref": "#/definitions/SubmitShippingLabelsResponse"
},
"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."
@ -718,10 +699,6 @@
"$ref": "#/definitions/SubmitShippingLabelsResponse"
},
"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."
@ -734,10 +711,6 @@
"$ref": "#/definitions/SubmitShippingLabelsResponse"
},
"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."
@ -750,10 +723,6 @@
"$ref": "#/definitions/SubmitShippingLabelsResponse"
},
"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."
@ -766,10 +735,6 @@
"$ref": "#/definitions/SubmitShippingLabelsResponse"
},
"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."
@ -784,13 +749,13 @@
"tags": [
"vendorShippingLabels"
],
"description": "Returns a shipping label for the purchaseOrderNumber that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Returns a shipping label for the `purchaseOrderNumber` that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "getShippingLabel",
"parameters": [
{
"name": "purchaseOrderNumber",
"in": "path",
"description": "The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.",
"description": "The purchase order number for which you want to return the shipping label. It should be the same `purchaseOrderNumber` as received in the order.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
@ -935,15 +900,11 @@
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"description": "The request's authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetShippingLabelResponse"
},
"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 +945,6 @@
"$ref": "#/definitions/GetShippingLabelResponse"
},
"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."
@ -1000,10 +957,6 @@
"$ref": "#/definitions/GetShippingLabelResponse"
},
"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."
@ -1016,10 +969,6 @@
"$ref": "#/definitions/GetShippingLabelResponse"
},
"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."
@ -1032,10 +981,6 @@
"$ref": "#/definitions/GetShippingLabelResponse"
},
"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."
@ -1050,7 +995,7 @@
"tags": [
"vendorShipping"
],
"description": "Submits one or more shipment confirmations for vendor orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Submits one or more shipment confirmations for vendor orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "submitShipmentConfirmations",
"parameters": [
{
@ -1059,7 +1004,8 @@
"required": true,
"schema": {
"$ref": "#/definitions/SubmitShipmentConfirmationsRequest"
}
},
"description": "Request body containing the shipment confirmations data."
}
],
"responses": {
@ -1357,10 +1303,6 @@
"$ref": "#/definitions/SubmitShipmentConfirmationsResponse"
},
"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."
@ -1373,10 +1315,6 @@
"$ref": "#/definitions/SubmitShipmentConfirmationsResponse"
},
"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."
@ -1389,10 +1327,6 @@
"$ref": "#/definitions/SubmitShipmentConfirmationsResponse"
},
"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."
@ -1405,10 +1339,6 @@
"$ref": "#/definitions/SubmitShipmentConfirmationsResponse"
},
"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."
@ -1421,10 +1351,6 @@
"$ref": "#/definitions/SubmitShipmentConfirmationsResponse"
},
"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."
@ -1439,7 +1365,7 @@
"tags": [
"vendorShipping"
],
"description": "This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "submitShipmentStatusUpdates",
"parameters": [
{
@ -1448,7 +1374,8 @@
"required": true,
"schema": {
"$ref": "#/definitions/SubmitShipmentStatusUpdatesRequest"
}
},
"description": "Request body containing the shipment status update data."
}
],
"responses": {
@ -1605,10 +1532,6 @@
"$ref": "#/definitions/SubmitShipmentStatusUpdatesResponse"
},
"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."
@ -1621,10 +1544,6 @@
"$ref": "#/definitions/SubmitShipmentStatusUpdatesResponse"
},
"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."
@ -1637,10 +1556,6 @@
"$ref": "#/definitions/SubmitShipmentStatusUpdatesResponse"
},
"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."
@ -1653,10 +1568,6 @@
"$ref": "#/definitions/SubmitShipmentStatusUpdatesResponse"
},
"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."
@ -1669,10 +1580,6 @@
"$ref": "#/definitions/SubmitShipmentStatusUpdatesResponse"
},
"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."
@ -1687,13 +1594,13 @@
"tags": [
"customerInvoices"
],
"description": "Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the `createdAfter` and `createdBefore` parameters. You must use both of these parameters. The date range to search must be no more than 7 days.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "getCustomerInvoices",
"parameters": [
{
"name": "shipFromPartyId",
"in": "query",
"description": "The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.",
"description": "The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses.",
"required": false,
"type": "string"
},
@ -1709,7 +1616,7 @@
{
"name": "createdAfter",
"in": "query",
"description": "Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Orders that became available after this date and time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": true,
"type": "string",
"format": "date-time"
@ -1717,7 +1624,7 @@
{
"name": "createdBefore",
"in": "query",
"description": "Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Orders that became available before this date and time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": true,
"type": "string",
"format": "date-time"
@ -1941,10 +1848,6 @@
"$ref": "#/definitions/GetCustomerInvoiceResponse"
},
"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."
@ -1957,10 +1860,6 @@
"$ref": "#/definitions/GetCustomerInvoiceResponse"
},
"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."
@ -1973,10 +1872,6 @@
"$ref": "#/definitions/GetCustomerInvoiceResponse"
},
"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."
@ -1989,10 +1884,6 @@
"$ref": "#/definitions/GetCustomerInvoiceResponse"
},
"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."
@ -2007,7 +1898,7 @@
"tags": [
"customerInvoices"
],
"description": "Returns a customer invoice based on the purchaseOrderNumber that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Returns a customer invoice based on the `purchaseOrderNumber` that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "getCustomerInvoice",
"parameters": [
{
@ -2113,15 +2004,11 @@
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"description": "The request's authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetCustomerInvoiceResponse"
},
"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."
@ -2162,10 +2049,6 @@
"$ref": "#/definitions/GetCustomerInvoiceResponse"
},
"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."
@ -2178,10 +2061,6 @@
"$ref": "#/definitions/GetCustomerInvoiceResponse"
},
"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."
@ -2194,10 +2073,6 @@
"$ref": "#/definitions/GetCustomerInvoiceResponse"
},
"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."
@ -2210,10 +2085,6 @@
"$ref": "#/definitions/GetCustomerInvoiceResponse"
},
"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."
@ -2228,13 +2099,13 @@
"tags": [
"vendorShipping"
],
"description": "Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "getPackingSlips",
"parameters": [
{
"name": "shipFromPartyId",
"in": "query",
"description": "The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.",
"description": "The vendor `warehouseId` for order fulfillment. If not specified the result will contain orders for all warehouses.",
"required": false,
"type": "string"
},
@ -2250,7 +2121,7 @@
{
"name": "createdAfter",
"in": "query",
"description": "Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Packing slips that became available after this date and time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": true,
"type": "string",
"format": "date-time"
@ -2258,7 +2129,7 @@
{
"name": "createdBefore",
"in": "query",
"description": "Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Packing slips that became available before this date and time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": true,
"type": "string",
"format": "date-time"
@ -2453,10 +2324,6 @@
"$ref": "#/definitions/GetPackingSlipListResponse"
},
"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."
@ -2497,10 +2364,6 @@
"$ref": "#/definitions/GetPackingSlipListResponse"
},
"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."
@ -2513,10 +2376,6 @@
"$ref": "#/definitions/GetPackingSlipListResponse"
},
"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."
@ -2529,10 +2388,6 @@
"$ref": "#/definitions/GetPackingSlipListResponse"
},
"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."
@ -2545,10 +2400,6 @@
"$ref": "#/definitions/GetPackingSlipListResponse"
},
"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."
@ -2563,13 +2414,13 @@
"tags": [
"vendorShipping"
],
"description": "Returns a packing slip based on the purchaseOrderNumber that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Returns a packing slip based on the `purchaseOrderNumber` that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "getPackingSlip",
"parameters": [
{
"name": "purchaseOrderNumber",
"in": "path",
"description": "The purchaseOrderNumber for the packing slip you want.",
"description": "The `purchaseOrderNumber` for the packing slip you want.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
@ -2672,15 +2523,11 @@
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"description": "The request's authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetPackingSlipResponse"
},
"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."
@ -2721,10 +2568,6 @@
"$ref": "#/definitions/GetPackingSlipResponse"
},
"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."
@ -2737,10 +2580,6 @@
"$ref": "#/definitions/GetPackingSlipResponse"
},
"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."
@ -2753,10 +2592,6 @@
"$ref": "#/definitions/GetPackingSlipResponse"
},
"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."
@ -2769,10 +2604,6 @@
"$ref": "#/definitions/GetPackingSlipResponse"
},
"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."
@ -2820,13 +2651,15 @@
"type": "object",
"properties": {
"pagination": {
"$ref": "#/definitions/Pagination"
"$ref": "#/definitions/Pagination",
"description": "The pagination elements required to retrieve the remaining data."
},
"packingSlips": {
"type": "array",
"items": {
"$ref": "#/definitions/PackingSlip"
}
},
"description": "An array of packing slip objects."
}
},
"description": "A list of packing slips."
@ -2840,7 +2673,8 @@
"errors": {
"$ref": "#/definitions/ErrorList"
}
}
},
"description": "Response payload with the list of packing slips."
},
"GetPackingSlipResponse": {
"type": "object",
@ -2851,7 +2685,8 @@
"errors": {
"$ref": "#/definitions/ErrorList"
}
}
},
"description": "Response payload with packing slip."
},
"SubmitShippingLabelsRequest": {
"type": "object",
@ -2860,9 +2695,11 @@
"type": "array",
"items": {
"$ref": "#/definitions/ShippingLabelRequest"
},
"description": "An array of shipping label requests to be processed."
}
}
}
},
"description": "The request schema for the `submitShippingLabelRequest` operation."
},
"ShippingLabelRequest": {
"type": "object",
@ -2892,7 +2729,8 @@
"$ref": "#/definitions/Container"
}
}
}
},
"description": "Represents the request payload for creating a shipping label, containing the purchase order number, selling party, ship from party, and a list of containers or packages in the shipment."
},
"Item": {
"type": "object",
@ -2907,7 +2745,7 @@
},
"buyerProductIdentifier": {
"type": "string",
"description": "Buyer's Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required."
"description": "Buyer's Standard Identification Number (ASIN) of an item. Either `buyerProductIdentifier` or `vendorProductIdentifier` is required."
},
"vendorProductIdentifier": {
"type": "string",
@ -2933,7 +2771,7 @@
},
"buyerProductIdentifier": {
"type": "string",
"description": "Buyer's Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required."
"description": "Buyer's Standard Identification Number (ASIN) of an item. Either `buyerProductIdentifier` or `vendorProductIdentifier` is required."
},
"vendorProductIdentifier": {
"type": "string",
@ -2943,9 +2781,11 @@
"description": "Total item quantity packed in the container.",
"$ref": "#/definitions/ItemQuantity"
}
}
},
"description": "Represents an item that has been packed into a container for shipping."
},
"PartyIdentification": {
"description": "Name, address and tax details of a party.",
"type": "object",
"required": [
"partyId"
@ -3026,20 +2866,20 @@
"properties": {
"trackingNumber": {
"type": "string",
"description": "This is required to be provided for every package and should match with the trackingNumber sent for the shipment confirmation."
"description": "This is required to be provided for every package and should match with the `trackingNumber` sent for the shipment confirmation."
},
"statusCode": {
"type": "string",
"description": "Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation)."
"description": "Indicates the shipment status code for the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation)."
},
"reasonCode": {
"type": "string",
"description": "Provides a reason code for the status of the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation)."
"description": "Provides a reason code for the status for the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation)."
},
"statusDateTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the shipment status was updated. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00."
"description": "The date and time when the shipment status was updated. This field is expected to be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`."
},
"statusLocationAddress": {
"$ref": "#/definitions/Address"
@ -3050,19 +2890,20 @@
"estimatedDeliveryDateTime": {
"type": "string",
"format": "date-time",
"description": "Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00."
"description": "Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`."
},
"apptWindowStartDateTime": {
"type": "string",
"format": "date-time",
"description": "This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00."
"description": "This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`."
},
"apptWindowEndDateTime": {
"type": "string",
"format": "date-time",
"description": "This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00."
}
"description": "This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`."
}
},
"description": "Details for the scheduled delivery timeline for a shipment, including the estimated delivery date and time, as well as the start and end times of the appointment window for delivery."
}
},
"description": "Details for the shipment status update given by the vendor for the specific package."
@ -3261,27 +3102,27 @@
"type": "object",
"properties": {
"payload": {
"description": "The response payload for the submitShipmentConfirmations operation.",
"description": "The response payload for the `submitShipmentConfirmations` operation.",
"$ref": "#/definitions/TransactionReference"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the submitShipmentConfirmations operation."
"description": "The response schema for the `submitShipmentConfirmations` operation."
},
"SubmitShipmentStatusUpdatesResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The response payload for the submitShipmentStatusUpdates operation.",
"description": "The response payload for the `submitShipmentStatusUpdates` operation.",
"$ref": "#/definitions/TransactionReference"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the submitShipmentStatusUpdates operation."
"description": "The response schema for the `submitShipmentStatusUpdates` operation."
},
"GetShippingLabelListResponse": {
"type": "object",
@ -3294,20 +3135,20 @@
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getShippingLabels operation."
"description": "The response schema for the `getShippingLabels` operation."
},
"GetShippingLabelResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getShippingLabel operation.",
"description": "The payload for the `getShippingLabel` operation.",
"$ref": "#/definitions/ShippingLabel"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getShippingLabel operation."
"description": "The response schema for the `getShippingLabel` operation."
},
"ShippingLabelList": {
"type": "object",
@ -3319,9 +3160,11 @@
"type": "array",
"items": {
"$ref": "#/definitions/ShippingLabel"
},
"description": "An array containing the details of the generated shipping labels."
}
}
}
},
"description": "Response payload with the list of shipping labels"
},
"LabelData": {
"type": "object",
@ -3339,7 +3182,7 @@
},
"shipMethod": {
"type": "string",
"description": "Ship method to be used for shipping the order. Amazon defines Ship Method Codes indicating shipping carrier and shipment service level. Ship Method Codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the Ship Method Codes are vendor specific and will be provided to each vendor during the implementation."
"description": "Ship method to be used for shipping the order. Amazon defines ship method codes indicating shipping carrier and shipment service level. Ship method codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the ship method codes are vendor specific and will be provided to each vendor during the implementation."
},
"shipMethodName": {
"type": "string",
@ -3400,20 +3243,21 @@
"$ref": "#/definitions/LabelData"
}
}
}
},
"description": "Shipping label information for an order, including the purchase order number, selling party, ship from party, label format, and package details."
},
"SubmitShippingLabelsResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The response payload for the submitShippingLabelRequest operation.",
"description": "The response payload for the `submitShippingLabelRequest` operation.",
"$ref": "#/definitions/TransactionReference"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the submitShippingLabelRequest operation."
"description": "The response schema for the `submitShippingLabelRequest` operation."
},
"SubmitShipmentConfirmationsRequest": {
"type": "object",
@ -3422,9 +3266,11 @@
"type": "array",
"items": {
"$ref": "#/definitions/ShipmentConfirmation"
},
"description": "Array of `ShipmentConfirmation` objects, each representing confirmation details for a specific shipment."
}
}
}
},
"description": "The request schema for the `submitShipmentConfirmations` operation."
},
"ShipmentConfirmation": {
"type": "object",
@ -3467,7 +3313,8 @@
"$ref": "#/definitions/Container"
}
}
}
},
"description": "Represents the confirmation details of a shipment, including the purchase order number and other shipment details."
},
"SubmitShipmentStatusUpdatesRequest": {
"type": "object",
@ -3477,10 +3324,12 @@
"items": {
"$ref": "#/definitions/ShipmentStatusUpdate"
},
"minItems": 1
}
"minItems": 1,
"description": "Contains a list of one or more `ShipmentStatusUpdate` objects, each representing an update to the status of a specific shipment."
}
},
"description": "Represents the request payload for submitting updates to the status of shipments, containing an array of one or more `ShipmentStatusUpdate` objects."
},
"ShipmentStatusUpdate": {
"type": "object",
"required": [
@ -3507,7 +3356,8 @@
"description": "Provide the details about the status of the shipment at that particular point of time.",
"$ref": "#/definitions/StatusUpdateDetails"
}
}
},
"description": "Represents an update to the status of a shipment."
},
"GetCustomerInvoicesResponse": {
"type": "object",
@ -3520,20 +3370,20 @@
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getCustomerInvoices operation."
"description": "The response schema for the `getCustomerInvoices` operation."
},
"GetCustomerInvoiceResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getCustomerInvoice operation.",
"description": "The payload for the `getCustomerInvoice` operation.",
"$ref": "#/definitions/CustomerInvoice"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getCustomerInvoice operation."
"description": "The response schema for the `getCustomerInvoice` operation."
},
"CustomerInvoiceList": {
"type": "object",
@ -3543,21 +3393,24 @@
},
"customerInvoices": {
"type": "array",
"description": "Represents a customer invoice within the `CustomerInvoiceList`.",
"items": {
"$ref": "#/definitions/CustomerInvoice"
}
}
}
},
"description": "Represents a list of customer invoices, potentially paginated."
},
"Pagination": {
"type": "object",
"properties": {
"nextToken": {
"type": "string",
"description": "A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return."
}
"description": "A generated string used to pass information to your next request. If `NextToken` is returned, pass the value of `NextToken` to the next request. If `NextToken` is not returned, there are no more order items to return."
}
},
"description": "The pagination elements required to retrieve the remaining data."
},
"CustomerInvoice": {
"type": "object",
"required": [
@ -3572,10 +3425,11 @@
},
"content": {
"type": "string",
"description": "The Base64encoded customer invoice."
}
"description": "The `Base64encoded` customer invoice."
}
},
"description": "Represents a customer invoice associated with a purchase order."
},
"TransactionReference": {
"type": "object",
"properties": {
@ -3583,7 +3437,8 @@
"type": "string",
"description": "GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction."
}
}
},
"description": "Response containing the transaction ID."
},
"ErrorList": {
"type": "array",
@ -3686,7 +3541,8 @@
"$ref": "#/definitions/PackedItem"
}
}
}
},
"description": "A container used for shipping and packing items."
}
}
}

140
models/vendor-direct-fulfillment-shipping-api-model/vendorDirectFulfillmentShipping_2021-12-28.json
View File

@ -216,10 +216,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -232,10 +228,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -248,10 +240,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -264,10 +252,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -292,7 +276,8 @@
"required": true,
"schema": {
"$ref": "#/definitions/SubmitShippingLabelsRequest"
}
},
"description": "Request body that contains the shipping labels data."
}
],
"responses": {
@ -362,10 +347,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -378,10 +359,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -394,10 +371,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -410,10 +383,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -426,10 +395,6 @@
"$ref": "#/definitions/ErrorList"
},
"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 +418,7 @@
{
"name": "purchaseOrderNumber",
"in": "path",
"description": "The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.",
"description": "The purchase order number for which you want to return the shipping label. Should be the same `purchaseOrderNumber` as received in the order.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
@ -519,10 +484,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -563,10 +524,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -579,10 +536,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -595,10 +548,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -611,10 +560,6 @@
"$ref": "#/definitions/ErrorList"
},
"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."
@ -645,6 +590,7 @@
"in": "body",
"name": "body",
"required": true,
"description": "The request payload that contains parameters for creating shipping labels.",
"schema": {
"$ref": "#/definitions/CreateShippingLabelsRequest"
}
@ -803,7 +749,8 @@
"required": true,
"schema": {
"$ref": "#/definitions/SubmitShipmentConfirmationsRequest"
}
},
"description": "Request body containing the shipment confirmations data."
}
],
"responses": {
@ -947,7 +894,8 @@
"required": true,
"schema": {
"$ref": "#/definitions/SubmitShipmentStatusUpdatesRequest"
}
},
"description": "Request body that contains the shipment status update data."
}
],
"responses": {
@ -1849,13 +1797,15 @@
"type": "object",
"properties": {
"pagination": {
"$ref": "#/definitions/Pagination"
"$ref": "#/definitions/Pagination",
"description": "The pagination elements required to retrieve the remaining data."
},
"packingSlips": {
"type": "array",
"items": {
"$ref": "#/definitions/PackingSlip"
}
},
"description": "An array of packing slip objects."
}
},
"description": "A list of packing slips."
@ -1892,9 +1842,11 @@
"type": "array",
"items": {
"$ref": "#/definitions/ShippingLabelRequest"
},
"description": "An array of shipping label requests you want to process."
}
}
}
},
"description": "The request schema for the `submitShippingLabelRequest` operation."
},
"ShippingLabelRequest": {
"type": "object",
@ -1924,7 +1876,8 @@
"$ref": "#/definitions/Container"
}
}
}
},
"description": "Represents the request payload to create a shipping label. Contains the purchase order number, selling party, ship from party, and a list of containers or packages in the shipment."
},
"Item": {
"type": "object",
@ -1979,9 +1932,11 @@
"description": "Total item quantity packed in the container.",
"$ref": "#/definitions/ItemQuantity"
}
}
},
"description": "Represents an item packed into a container for shipping."
},
"PartyIdentification": {
"description": "Name, address, and tax details for a party.",
"type": "object",
"required": [
"partyId"
@ -2066,11 +2021,11 @@
},
"statusCode": {
"type": "string",
"description": "Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation)."
"description": "The shipment status code for the package that provides transportation information for Amazon tracking systems and the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation)."
},
"reasonCode": {
"type": "string",
"description": "Provides a reason code for the status of the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation)."
"description": "Provides a reason code for the package status that provides additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation)."
},
"statusDateTime": {
"type": "string",
@ -2307,9 +2262,11 @@
"type": "array",
"items": {
"$ref": "#/definitions/ShippingLabel"
},
"description": "An array that contains the details of the generated shipping labels."
}
}
}
},
"description": "Response payload with the shipping labels list."
},
"LabelData": {
"type": "object",
@ -2388,7 +2345,8 @@
"$ref": "#/definitions/LabelData"
}
}
}
},
"description": "Shipping label information for an order. Includes the purchase order number, selling party, ship from party, label format, and package details."
},
"SubmitShipmentConfirmationsRequest": {
"type": "object",
@ -2397,9 +2355,11 @@
"type": "array",
"items": {
"$ref": "#/definitions/ShipmentConfirmation"
},
"description": "An array of `ShipmentConfirmation` objects, each represents confirmation details for a specific shipment."
}
}
}
},
"description": "The `submitShipmentConfirmations` request schema."
},
"ShipmentConfirmation": {
"type": "object",
@ -2442,7 +2402,8 @@
"$ref": "#/definitions/Container"
}
}
}
},
"description": "Represents the confirmation details of a shipment. Includes the purchase order number and other shipment details."
},
"SubmitShipmentStatusUpdatesRequest": {
"type": "object",
@ -2452,10 +2413,12 @@
"items": {
"$ref": "#/definitions/ShipmentStatusUpdate"
},
"minItems": 1
}
"minItems": 1,
"description": "Contains a list of one or more `ShipmentStatusUpdate` objects, each represents a status update of a specific shipment."
}
},
"description": "The `submitShipmentStatusUpdates` request schema."
},
"ShipmentStatusUpdate": {
"type": "object",
"required": [
@ -2482,21 +2445,25 @@
"description": "Provide the details about the status of the shipment at that particular point of time.",
"$ref": "#/definitions/StatusUpdateDetails"
}
}
},
"description": "Represents a shipment status update."
},
"CustomerInvoiceList": {
"type": "object",
"properties": {
"pagination": {
"$ref": "#/definitions/Pagination"
"$ref": "#/definitions/Pagination",
"description": "The pagination elements required to retrieve the remaining data."
},
"customerInvoices": {
"type": "array",
"description": "Represents a customer invoice within the `CustomerInvoiceList`.",
"items": {
"$ref": "#/definitions/CustomerInvoice"
}
}
}
},
"description": "Represents a list of customer invoices, potentially paginated."
},
"Pagination": {
"type": "object",
@ -2505,7 +2472,8 @@
"type": "string",
"description": "A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return."
}
}
},
"description": "The pagination elements required to retrieve the remaining data."
},
"CustomerInvoice": {
"type": "object",
@ -2523,7 +2491,8 @@
"type": "string",
"description": "The Base64encoded customer invoice."
}
}
},
"description": "Represents a customer invoice associated with a purchase order."
},
"TransactionReference": {
"type": "object",
@ -2532,7 +2501,8 @@
"type": "string",
"description": "GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction."
}
}
},
"description": "Response that contains the transaction ID."
},
"ErrorList": {
"type": "object",
@ -2545,7 +2515,8 @@
"type": "array",
"items": {
"$ref": "#/definitions/Error"
}
},
"description": "An array of error objects that represents individual errors encountered during the request."
}
}
},
@ -2643,7 +2614,8 @@
"$ref": "#/definitions/PackedItem"
}
}
}
},
"description": "A container for shipping and packing items."
}
}
}

26
models/vendor-direct-fulfillment-transactions-api-model/vendorDirectFulfillmentTransactionsV1.json
View File

@ -29,7 +29,7 @@
"tags": [
"vendorTransaction"
],
"description": "Returns the status of the transaction indicated by the specified transactionId.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Returns the status of the transaction indicated by the specified `transactionId`.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the operation, when available. The preceding table 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 SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getTransactionStatus",
"parameters": [
{
@ -168,10 +168,6 @@
"$ref": "#/definitions/GetTransactionResponse"
},
"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."
@ -212,10 +208,6 @@
"$ref": "#/definitions/GetTransactionResponse"
},
"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."
@ -228,10 +220,6 @@
"$ref": "#/definitions/GetTransactionResponse"
},
"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."
@ -244,10 +232,6 @@
"$ref": "#/definitions/GetTransactionResponse"
},
"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."
@ -260,10 +244,6 @@
"$ref": "#/definitions/GetTransactionResponse"
},
"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."
@ -286,7 +266,7 @@
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getTransactionStatus operation."
"description": "The response schema for the `getTransactionStatus` operation."
},
"TransactionStatus": {
"type": "object",
@ -295,7 +275,7 @@
"$ref": "#/definitions/Transaction"
}
},
"description": "The payload for the getTransactionStatus operation."
"description": "The payload for the `getTransactionStatus` operation."
},
"Transaction": {
"type": "object",

27
models/vendor-direct-fulfillment-transactions-api-model/vendorDirectFulfillmentTransactions_2021-12-28.json
View File

@ -29,7 +29,7 @@
"tags": [
"vendorTransaction"
],
"description": "Returns the status of the transaction indicated by the specified transactionId.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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 then 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 the status of the transaction indicated by the specified `transactionId`.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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 then 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": "getTransactionStatus",
"parameters": [
{
@ -82,15 +82,11 @@
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"description": "The request's authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/Error"
},
"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."
@ -131,10 +127,6 @@
"$ref": "#/definitions/Error"
},
"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."
@ -147,10 +139,6 @@
"$ref": "#/definitions/Error"
},
"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."
@ -163,10 +151,6 @@
"$ref": "#/definitions/Error"
},
"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."
@ -179,10 +163,6 @@
"$ref": "#/definitions/Error"
},
"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."
@ -205,7 +185,7 @@
"$ref": "#/definitions/Transaction"
}
},
"description": "The payload for the getTransactionStatus operation."
"description": "The payload for the `getTransactionStatus` operation."
},
"Transaction": {
"type": "object",
@ -257,6 +237,7 @@
"properties": {
"errors": {
"type": "array",
"description": "An array of individual error objects containing error details.",
"items": {
"$ref": "#/definitions/Error"
}

91
models/vendor-invoices-api-model/vendorInvoices.json
View File

@ -29,7 +29,7 @@
"tags": [
"vendorPayments"
],
"description": "Submit new invoices to Amazon.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Submit new invoices to Amazon.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "submitInvoices",
"parameters": [
{
@ -280,7 +280,8 @@
]
}
}
}
},
"description": "The request body containing the invoice data to submit."
}
],
"responses": {
@ -303,7 +304,7 @@
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier. "
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
@ -416,7 +417,7 @@
},
"x-amzn-RequestId": {
"type": "string",
"description": "unique request reference identifier."
"description": "Unique request reference identifier."
}
}
},
@ -426,10 +427,6 @@
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"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."
@ -442,10 +439,6 @@
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"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."
@ -458,10 +451,6 @@
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"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."
@ -474,10 +463,6 @@
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"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."
@ -490,10 +475,6 @@
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"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."
@ -509,14 +490,14 @@
"type": "object",
"properties": {
"payload": {
"description": "The response payload for the submitInvoices operation.",
"description": "The response payload for the `submitInvoices` operation.",
"$ref": "#/definitions/TransactionId"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the submitInvoices operation."
"description": "The response schema for the `submitInvoices` operation."
},
"TransactionId": {
"type": "object",
@ -525,7 +506,8 @@
"type": "string",
"description": "GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction."
}
}
},
"description": "Response containing the transaction ID."
},
"ErrorList": {
"type": "array",
@ -563,10 +545,11 @@
"type": "array",
"items": {
"$ref": "#/definitions/Invoice"
}
},
"description": "An array of Invoice objects representing the invoices or credit notes to be submitted."
}
},
"description": "The request schema for the submitInvoices operation."
"description": "The request schema for the `submitInvoices` operation."
},
"Invoice": {
"type": "object",
@ -609,19 +592,19 @@
"$ref": "#/definitions/DateTime"
},
"remitToParty": {
"description": "Name, address and tax details of the party receiving the payment of this invoice.",
"description": "Name, address, and tax details of the party receiving the payment of this invoice.",
"$ref": "#/definitions/PartyIdentification"
},
"shipToParty": {
"description": "Name, address and tax details of the party receiving a shipment of products.",
"description": "Name, address, and tax details of the party receiving a shipment of products.",
"$ref": "#/definitions/PartyIdentification"
},
"shipFromParty": {
"description": "Name, address and tax details of the party sending a shipment of products.",
"description": "Name, address, and tax details of the party sending a shipment of products.",
"$ref": "#/definitions/PartyIdentification"
},
"billToParty": {
"description": "Name, address and tax details of the party to whom this invoice is issued.",
"description": "Name, address, and tax details of the party to whom this invoice is issued.",
"$ref": "#/definitions/PartyIdentification"
},
"paymentTerms": {
@ -667,9 +650,11 @@
"$ref": "#/definitions/InvoiceItem"
}
}
}
},
"description": "Represents an invoice or credit note document with details about the transaction, parties involved, and line items."
},
"PartyIdentification": {
"description": "Name, address, and tax details of a party.",
"type": "object",
"required": [
"partyId"
@ -750,23 +735,23 @@
},
"city": {
"type": "string",
"description": "The city where the person, business or institution is located."
"description": "The city where the person, business, or institution is located."
},
"county": {
"type": "string",
"description": "The county where person, business or institution is located."
"description": "The county where person, business, or institution is located."
},
"district": {
"type": "string",
"description": "The district where person, business or institution is located."
"description": "The district where person, business, or institution is located."
},
"stateOrRegion": {
"type": "string",
"description": "The state or region where person, business or institution is located."
"description": "The state or region where person, business, or institution is located."
},
"postalOrZipCode": {
"type": "string",
"description": "The postal or zip code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation."
"description": "The postal or zip code of that address. It contains a series of letters, digits, or both, sometimes including spaces or punctuation."
},
"countryCode": {
"type": "string",
@ -810,14 +795,14 @@
},
"purchaseOrderNumber": {
"type": "string",
"description": "The Amazon purchase order number for this invoiced line item. Formatting Notes: 8-character alpha-numeric code. This value is mandatory only when invoiceType is Invoice, and is not required when invoiceType is CreditNote."
"description": "The Amazon purchase order number for this invoiced line item. Formatting Notes: 8-character alpha-numeric code. This value is mandatory only when `invoiceType` is `Invoice`, and is not required when `invoiceType` is `CreditNote`."
},
"hsnCode": {
"type": "string",
"description": "HSN Tax code. The HSN number cannot contain alphabets."
"description": "The HSN Tax code. The HSN number cannot contain alphabets."
},
"creditNoteDetails": {
"description": "Details required in order to process a credit note. This information is required only if invoiceType is CreditNote.",
"description": "Details required in order to process a credit note. This information is required only if `invoiceType` is `CreditNote`.",
"$ref": "#/definitions/CreditNoteDetails"
},
"taxDetails": {
@ -930,11 +915,11 @@
]
},
"taxRate": {
"description": "Tax percentage applied. Percentage must be expressed in decimal.",
"description": "Tax percentage applied. Percentage must be expressed in decimal format.",
"$ref": "#/definitions/Decimal"
},
"taxAmount": {
"description": "Total tax amount applied on invoice total or an item total.",
"description": "Total tax amount applied on an invoice total or item total.",
"$ref": "#/definitions/Money"
},
"taxableAmount": {
@ -1196,7 +1181,7 @@
},
"discountDueDays": {
"type": "number",
"description": "The number of calendar days from the Base date (Invoice date) until the discount is no longer valid."
"description": "The number of calendar days from the base date (Invoice date) until the discount is no longer valid."
},
"netDueDays": {
"type": "number",
@ -1210,18 +1195,18 @@
"properties": {
"referenceInvoiceNumber": {
"type": "string",
"description": "Original Invoice Number when sending a credit note relating to an existing invoice. One Invoice only to be processed per Credit Note. This is mandatory for AP Credit Notes."
"description": "Original invoice number when sending a credit note relating to an existing invoice. One invoice only to be processed per credit note. This is mandatory for AP credit notes."
},
"debitNoteNumber": {
"type": "string",
"description": "Debit Note Number as generated by Amazon. Recommended for Returns and COOP Credit Notes."
"description": "Debit note number as generated by Amazon. Recommended for returns and COOP credit notes."
},
"returnsReferenceNumber": {
"type": "string",
"description": "Identifies the Returns Notice Number. Mandatory for all Returns Credit Notes."
"description": "Identifies the returns notice number. Mandatory for all returns credit notes."
},
"goodsReturnDate": {
"description": "Date that a return is received by the vendor. It is mandatory for Returns Credit Note.",
"description": "Date that a return is received by the vendor. It is mandatory for the returns credit note.",
"$ref": "#/definitions/DateTime"
},
"rmaId": {
@ -1230,14 +1215,14 @@
},
"coopReferenceNumber": {
"type": "string",
"description": "Identifies the COOP reference used for COOP agreement. Failure to provide the COOP reference number or the Debit Note number may lead to a rejection of the Credit Note."
"description": "Identifies the COOP reference used for COOP agreement. Failure to provide the COOP reference number or the debit note number may lead to a rejection of the credit note."
},
"consignorsReferenceNumber": {
"type": "string",
"description": "Identifies the consignor reference number (VRET number), if generated by Amazon."
}
},
"description": "References required in order to process a credit note. This information is required only if InvoiceType is CreditNote."
"description": "References required in order to process a credit note. This information is required only if `InvoiceType` is `CreditNote`."
},
"ItemQuantity": {
"type": "object",
@ -1270,7 +1255,7 @@
},
"unitSize": {
"type": "integer",
"description": "The case size, if the unit of measure value is Cases."
"description": "The case size, if the unit of measure value is `Cases`."
}
},
"description": "Details of quantity."
@ -1282,7 +1267,7 @@
"DateTime": {
"type": "string",
"format": "date-time",
"description": "Defines a date and time according to ISO8601."
"description": "Defines a date and time according to <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a>."
}
}
}

226
models/vendor-orders-api-model/vendorOrders.json
View File

@ -29,7 +29,7 @@
"tags": [
"vendorOrders"
],
"description": "Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "getPurchaseOrders",
"parameters": [
{
@ -45,7 +45,7 @@
{
"name": "createdAfter",
"in": "query",
"description": "Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Purchase orders that became available after this time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": false,
"type": "string",
"format": "date-time"
@ -53,7 +53,7 @@
{
"name": "createdBefore",
"in": "query",
"description": "Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Purchase orders that became available before this time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": false,
"type": "string",
"format": "date-time"
@ -89,7 +89,7 @@
{
"name": "includeDetails",
"in": "query",
"description": "When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.",
"description": "When `true`, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is `true`.",
"required": false,
"type": "string",
"format": "boolean"
@ -97,7 +97,7 @@
{
"name": "changedAfter",
"in": "query",
"description": "Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Purchase orders that changed after this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": false,
"type": "string",
"format": "date-time"
@ -105,7 +105,7 @@
{
"name": "changedBefore",
"in": "query",
"description": "Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Purchase orders that changed before this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": false,
"type": "string",
"format": "date-time"
@ -113,7 +113,7 @@
{
"name": "poItemState",
"in": "query",
"description": "Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.",
"description": "Current state of the purchase order item. If this value is `Cancelled`, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.",
"required": false,
"type": "string",
"enum": [
@ -129,7 +129,7 @@
{
"name": "isPOChanged",
"in": "query",
"description": "When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.",
"description": "When `true`, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is `false`.",
"required": false,
"type": "string",
"format": "boolean"
@ -1050,15 +1050,11 @@
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description": "Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized`, `Expired Token`, or `Invalid Signature`.",
"schema": {
"$ref": "#/definitions/GetPurchaseOrdersResponse"
},
"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."
@ -1087,10 +1083,6 @@
"$ref": "#/definitions/GetPurchaseOrdersResponse"
},
"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."
@ -1103,10 +1095,6 @@
"$ref": "#/definitions/GetPurchaseOrdersResponse"
},
"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."
@ -1119,10 +1107,6 @@
"$ref": "#/definitions/GetPurchaseOrdersResponse"
},
"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."
@ -1135,10 +1119,6 @@
"$ref": "#/definitions/GetPurchaseOrdersResponse"
},
"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."
@ -1153,7 +1133,7 @@
"tags": [
"vendorOrders"
],
"description": "Returns a purchase order based on the purchaseOrderNumber value that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Returns a purchase order based on the `purchaseOrderNumber` value that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "getPurchaseOrder",
"parameters": [
{
@ -1439,15 +1419,11 @@
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"description": "The request's authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/GetPurchaseOrderResponse"
},
"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."
@ -1455,15 +1431,11 @@
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description": "Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized`, `Expired Token`, or `Invalid Signature`.",
"schema": {
"$ref": "#/definitions/GetPurchaseOrderResponse"
},
"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."
@ -1492,10 +1464,6 @@
"$ref": "#/definitions/GetPurchaseOrderResponse"
},
"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."
@ -1508,10 +1476,6 @@
"$ref": "#/definitions/GetPurchaseOrderResponse"
},
"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."
@ -1524,10 +1488,6 @@
"$ref": "#/definitions/GetPurchaseOrderResponse"
},
"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."
@ -1540,10 +1500,6 @@
"$ref": "#/definitions/GetPurchaseOrderResponse"
},
"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."
@ -1558,12 +1514,13 @@
"tags": [
"vendorOrders"
],
"description": "Submits acknowledgements for one or more purchase orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Submits acknowledgements for one or more purchase orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "submitAcknowledgement",
"parameters": [
{
"in": "body",
"name": "body",
"description": "Submits acknowledgements for one or more purchase orders from a vendor.",
"required": true,
"schema": {
"$ref": "#/definitions/SubmitAcknowledgementRequest",
@ -1743,15 +1700,11 @@
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description": "Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized,` `Expired Token`, or `Invalid Signature`.",
"schema": {
"$ref": "#/definitions/SubmitAcknowledgementResponse"
},
"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."
@ -1780,10 +1733,6 @@
"$ref": "#/definitions/SubmitAcknowledgementResponse"
},
"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."
@ -1796,10 +1745,6 @@
"$ref": "#/definitions/SubmitAcknowledgementResponse"
},
"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."
@ -1812,10 +1757,6 @@
"$ref": "#/definitions/SubmitAcknowledgementResponse"
},
"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."
@ -1828,10 +1769,6 @@
"$ref": "#/definitions/SubmitAcknowledgementResponse"
},
"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."
@ -1844,10 +1781,6 @@
"$ref": "#/definitions/SubmitAcknowledgementResponse"
},
"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."
@ -1862,7 +1795,7 @@
"tags": [
"vendorOrders"
],
"description": "Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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).",
"description": "Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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": "getPurchaseOrdersStatus",
"parameters": [
{
@ -1906,7 +1839,7 @@
{
"name": "createdAfter",
"in": "query",
"description": "Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Purchase orders that became available after this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": false,
"type": "string",
"format": "date-time"
@ -1914,7 +1847,7 @@
{
"name": "createdBefore",
"in": "query",
"description": "Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Purchase orders that became available before this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": false,
"type": "string",
"format": "date-time"
@ -1922,7 +1855,7 @@
{
"name": "updatedAfter",
"in": "query",
"description": "Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": false,
"type": "string",
"format": "date-time"
@ -1930,7 +1863,7 @@
{
"name": "updatedBefore",
"in": "query",
"description": "Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.",
"description": "Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"required": false,
"type": "string",
"format": "date-time"
@ -2727,15 +2660,11 @@
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description": "Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized`, `Expired Token`, or `Invalid Signature`.",
"schema": {
"$ref": "#/definitions/GetPurchaseOrdersStatusResponse"
},
"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."
@ -2764,10 +2693,6 @@
"$ref": "#/definitions/GetPurchaseOrdersStatusResponse"
},
"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."
@ -2780,10 +2705,6 @@
"$ref": "#/definitions/GetPurchaseOrdersStatusResponse"
},
"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."
@ -2796,10 +2717,6 @@
"$ref": "#/definitions/GetPurchaseOrdersStatusResponse"
},
"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."
@ -2812,10 +2729,6 @@
"$ref": "#/definitions/GetPurchaseOrdersStatusResponse"
},
"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."
@ -2838,7 +2751,7 @@
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getPurchaseOrders operation."
"description": "The response schema for the `getPurchaseOrders` operation."
},
"GetPurchaseOrderResponse": {
"type": "object",
@ -2851,7 +2764,7 @@
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getPurchaseOrder operation."
"description": "The response schema for the `getPurchaseOrder` operation."
},
"OrderList": {
"type": "object",
@ -2863,19 +2776,22 @@
"type": "array",
"items": {
"$ref": "#/definitions/Order"
},
"description": "Represents an individual order within the `OrderList`."
}
}
}
},
"description": "A list of orders returned as response."
},
"Pagination": {
"type": "object",
"properties": {
"nextToken": {
"type": "string",
"description": "A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more purchase order items to return."
}
"description": "A generated string used to pass information to your next request. If `NextToken` is returned, pass the value of `NextToken` to the next request. If `NextToken` is not returned, there are no more purchase order items to return."
}
},
"description": "The pagination elements required to retrieve the remaining data."
},
"Order": {
"type": "object",
"required": [
@ -2898,11 +2814,11 @@
"x-docgen-enum-table-extension": [
{
"value": "New",
"description": "The purchase order is newly created and needs to be acknowledged by vendor."
"description": "The purchase order is newly created and needs to be acknowledged by the vendor."
},
{
"value": "Acknowledged",
"description": "The purchase order has been acknowledged by vendor."
"description": "The purchase order has been acknowledged by the vendor."
},
{
"value": "Closed",
@ -2914,7 +2830,8 @@
"description": "Details of an order.",
"$ref": "#/definitions/OrderDetails"
}
}
},
"description": "Represents an order placed by Amazon, including the purchase order number, current state, and order details."
},
"OrderDetails": {
"type": "object",
@ -2927,17 +2844,17 @@
"purchaseOrderDate": {
"type": "string",
"format": "date-time",
"description": "The date the purchase order was placed. Must be in ISO-8601 date/time format."
"description": "The date the purchase order was placed. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
},
"purchaseOrderChangedDate": {
"type": "string",
"format": "date-time",
"description": "The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than 'purchaseOrderDate'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO-8601 date/time format."
"description": "The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than 'purchaseOrderDate'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
},
"purchaseOrderStateChangedDate": {
"type": "string",
"format": "date-time",
"description": "The date when current purchase order state was changed. Current purchase order state is available in the field 'purchaseOrderState'. Must be in ISO-8601 date/time format."
"description": "The date when current purchase order state was changed. Current purchase order state is available in the field 'purchaseOrderState'. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
},
"purchaseOrderType": {
"type": "string",
@ -3143,12 +3060,12 @@
},
"portOfDelivery": {
"type": "string",
"description": "The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the internationalCommercialTerms is FOB.",
"description": "The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the `internationalCommercialTerms` is `FOB`.",
"maxLength": 64
},
"importContainers": {
"type": "string",
"description": "Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: $NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE. The list of values for the container type is: 40'(40-foot container), 40'HC (40-foot high-capacity container), 45', 45'HC, 30', 30'HC, 20', 20'HC.",
"description": "Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: `$NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE`. The list of values for the container type is: `40'`(40-foot container), `40'HC` (40-foot high-capacity container), `45'`, `45'HC`, `30'`, `30'HC`, `20'`, `20'HC`.",
"maxLength": 64
},
"shippingInstructions": {
@ -3160,10 +3077,11 @@
},
"DateTimeInterval": {
"type": "string",
"description": "Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--)."
"description": "Defines a date time interval according to <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a>. Interval is separated by double hyphen (--)."
},
"PartyIdentification": {
"type": "object",
"description": "Name, address and tax details of a party.",
"required": [
"partyId"
],
@ -3209,7 +3127,7 @@
},
"taxRegistrationNumber": {
"type": "string",
"description": "Tax registration number for the entity. For example, VAT ID."
"description": "Tax registration number for the entity. For example, `VAT ID`."
}
},
"description": "Tax registration details of the entity."
@ -3256,7 +3174,7 @@
},
"postalCode": {
"type": "string",
"description": "The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation."
"description": "The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation."
},
"countryCode": {
"type": "string",
@ -3306,7 +3224,8 @@
"description": "The price to Amazon each (list).",
"$ref": "#/definitions/Money"
}
}
},
"description": "Represents an individual item in an order, including item details, quantities, pricing, and backorder information."
},
"Money": {
"type": "object",
@ -3330,14 +3249,14 @@
"type": "object",
"properties": {
"payload": {
"description": "The payload for the submitAcknowledgement operation.",
"description": "The payload for the `submitAcknowledgement` operation.",
"$ref": "#/definitions/TransactionId"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the submitAcknowledgement operation"
"description": "The response schema for the `submitAcknowledgement` operation"
},
"TransactionId": {
"type": "object",
@ -3346,7 +3265,8 @@
"type": "string",
"description": "GUID assigned by Amazon to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction."
}
}
},
"description": "Response containing the transaction ID."
},
"ErrorList": {
"type": "array",
@ -3362,10 +3282,11 @@
"type": "array",
"items": {
"$ref": "#/definitions/OrderAcknowledgement"
}
},
"description": "An array of order acknowledgements to be submitted."
}
},
"description": "The request schema for the submitAcknowledgment operation."
"description": "The request schema for the `submitAcknowledgment` operation."
},
"OrderAcknowledgement": {
"type": "object",
@ -3387,7 +3308,7 @@
"acknowledgementDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the purchase order is acknowledged, in ISO-8601 date/time format."
"description": "The date and time when the purchase order is acknowledged, in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
},
"items": {
"type": "array",
@ -3396,7 +3317,8 @@
"$ref": "#/definitions/OrderAcknowledgementItem"
}
}
}
},
"description": "Represents an acknowledgement for an order, including the purchase order number, selling party details, acknowledgement date, and a list of acknowledged items."
},
"OrderAcknowledgementItem": {
"type": "object",
@ -3465,7 +3387,7 @@
},
{
"value": "Backordered",
"description": "Vendor placed a backorder to fulfill the original order and provides a scheduledShipDate or scheduledDeliveryDate which is different than the expectedShipDate or expectedDeliveryDate provided in the purchase order."
"description": "Vendor placed a backorder to fulfill the original order and provides a `scheduledShipDate` or `scheduledDeliveryDate` which is different than the `expectedShipDate` or `expectedDeliveryDate` provided in the purchase order."
},
{
"value": "Rejected",
@ -3480,12 +3402,12 @@
"scheduledShipDate": {
"type": "string",
"format": "date-time",
"description": "Estimated ship date per line item. Must be in ISO-8601 date/time format."
"description": "Estimated ship date per line item. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
},
"scheduledDeliveryDate": {
"type": "string",
"format": "date-time",
"description": "Estimated delivery date per line item. Must be in ISO-8601 date/time format."
"description": "Estimated delivery date per line item. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
},
"rejectionReason": {
"type": "string",
@ -3510,7 +3432,8 @@
}
]
}
}
},
"description": "Represents the acknowledgement details for an individual order item, including the acknowledgement code, acknowledged quantity, scheduled ship and delivery dates, and rejection reason (if applicable)."
},
"ItemQuantity": {
"type": "object",
@ -3555,7 +3478,7 @@
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getPurchaseOrdersStatus operation."
"description": "The response schema for the `getPurchaseOrdersStatus` operation."
},
"OrderListStatus": {
"type": "object",
@ -3567,9 +3490,11 @@
"type": "array",
"items": {
"$ref": "#/definitions/OrderStatus"
},
"description": "Represents an order status within the `OrderListStatus`."
}
}
}
},
"description": "A list of order statuses."
},
"OrderStatus": {
"type": "object",
@ -3607,12 +3532,12 @@
"purchaseOrderDate": {
"type": "string",
"format": "date-time",
"description": "The date the purchase order was placed. Must be in ISO-8601 date/time format."
"description": "The date the purchase order was placed. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
},
"lastUpdatedDate": {
"type": "string",
"format": "date-time",
"description": "The date when the purchase order was last updated. Must be in ISO-8601 date/time format."
"description": "The date when the purchase order was last updated. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
},
"sellingParty": {
"description": "Name/Address and tax details of the selling party.",
@ -3762,19 +3687,20 @@
"lastReceiveDate": {
"type": "string",
"format": "date-time",
"description": "The date when the most recent item was received at the buyer's warehouse. Must be in ISO-8601 date/time format."
}
"description": "The date when the most recent item was received at the buyer's warehouse. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
}
}
}
},
"description": "Represents the current status of an order item, including acknowledgement and receiving details."
},
"OrderedQuantityDetails": {
"type": "object",
"properties": {
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date when the line item quantity was updated by buyer. Must be in ISO-8601 date/time format."
"description": "The date when the line item quantity was updated by the buyer. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
},
"orderedQuantity": {
"description": "Item quantity ordered.",
@ -3785,7 +3711,7 @@
"$ref": "#/definitions/ItemQuantity"
}
},
"description": "Details of item quantity ordered"
"description": "Details of the item quantity ordered."
},
"AcknowledgementStatusDetails": {
"type": "object",
@ -3793,18 +3719,18 @@
"acknowledgementDate": {
"type": "string",
"format": "date-time",
"description": "The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format."
"description": "The date when the line item was confirmed by the vendor. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
},
"acceptedQuantity": {
"description": "Item quantity accepted by vendor to be shipped.",
"description": "Item quantity accepted by the vendor to be shipped.",
"$ref": "#/definitions/ItemQuantity"
},
"rejectedQuantity": {
"description": "Item quantity rejected by vendor.",
"description": "Item quantity rejected by the vendor.",
"$ref": "#/definitions/ItemQuantity"
}
},
"description": "Details of item quantity ordered"
"description": "Details of the item quantity ordered"
},
"Error": {
"type": "object",

37
models/vendor-transaction-status-api-model/vendorTransactionStatus.json
View File

@ -21,7 +21,7 @@
"/vendor/transactions/v1/transactions/{transactionId}" : {
"get" : {
"tags" : [ "vendorTransaction" ],
"description" : "Returns the status of the transaction that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 20 |\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).",
"description" : "Returns the status of the transaction that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 20 |\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" : "getTransaction",
"parameters" : [ {
"name" : "transactionId",
@ -107,7 +107,7 @@
} ]
},
"400" : {
"description" : "Request has missing or invalid parameters and cannot be parsed.",
"description" : "Request has missing or not valid parameters and cannot be parsed.",
"schema" : {
"$ref" : "#/definitions/GetTransactionResponse"
},
@ -139,15 +139,11 @@
} ]
},
"401" : {
"description" : "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"description" : "The request's authorization header is not formatted correctly or does not contain a valid token.",
"schema" : {
"$ref" : "#/definitions/GetTransactionResponse"
},
"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."
@ -167,11 +163,15 @@
}
},
"404" : {
"description" : "The resource specified does not exist.",
"description" : "The specified resource does not exist.",
"schema" : {
"$ref" : "#/definitions/GetTransactionResponse"
},
"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."
@ -184,10 +184,6 @@
"$ref" : "#/definitions/GetTransactionResponse"
},
"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."
@ -200,10 +196,6 @@
"$ref" : "#/definitions/GetTransactionResponse"
},
"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."
@ -216,10 +208,6 @@
"$ref" : "#/definitions/GetTransactionResponse"
},
"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."
@ -232,10 +220,6 @@
"$ref" : "#/definitions/GetTransactionResponse"
},
"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."
@ -252,17 +236,18 @@
"type" : "object",
"properties" : {
"payload" : {
"description" : "The response payload for the getTransaction operation.",
"description" : "The response payload for the `getTransaction` operation.",
"$ref" : "#/definitions/TransactionStatus"
},
"errors" : {
"$ref" : "#/definitions/ErrorList"
}
},
"description" : "The response schema for the getTransaction operation."
"description" : "The response schema for the `getTransaction` operation."
},
"TransactionStatus" : {
"type" : "object",
"description" : "Represents the status of a transaction.",
"properties" : {
"transactionStatus" : {
"$ref" : "#/definitions/Transaction"