Add unitOfMeasure to the vendorOrders model.

This commit is contained in:
Gibran Waldron 2024-08-14 08:15:33 -07:00
parent eab4b08309
commit e3ed9ac81a
1 changed files with 196 additions and 133 deletions

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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description": "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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have 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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"description": "Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"description": "Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"description": "Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"description": "Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 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"
@ -255,11 +255,13 @@
"isBackOrderAllowed": true,
"netCost": {
"amount": "1800",
"currencyCode": "INR"
"currencyCode": "INR",
"unitOfMeasure": "POUNDS"
},
"listPrice": {
"amount": "2000",
"currencyCode": "INR"
"currencyCode": "INR",
"unitOfMeasure": "POUNDS"
}
}
]
@ -430,11 +432,13 @@
"isBackOrderAllowed": true,
"netCost": {
"amount": "94.97",
"currencyCode": "USD"
"currencyCode": "USD",
"unitOfMeasure": "POUNDS"
},
"listPrice": {
"amount": "94.97",
"currencyCode": "USD"
"currencyCode": "USD",
"unitOfMeasure": "POUNDS"
}
}
]
@ -985,7 +989,8 @@
"isBackOrderAllowed": true,
"netCost": {
"amount": "94.97",
"currencyCode": "INR"
"currencyCode": "INR",
"unitOfMeasure": "POUNDS"
}
}
]
@ -1050,11 +1055,15 @@
}
},
"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."
@ -1083,6 +1092,10 @@
"$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."
@ -1095,6 +1108,10 @@
"$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."
@ -1107,6 +1124,10 @@
"$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,6 +1140,10 @@
"$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."
@ -1133,7 +1158,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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description": "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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have 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": [
{
@ -1419,11 +1444,15 @@
}
},
"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."
@ -1431,11 +1460,15 @@
}
},
"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."
@ -1464,6 +1497,10 @@
"$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."
@ -1476,6 +1513,10 @@
"$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."
@ -1488,6 +1529,10 @@
"$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."
@ -1500,6 +1545,10 @@
"$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."
@ -1514,60 +1563,15 @@
"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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description": "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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have 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",
"example": {
"acknowledgements": [
{
"purchaseOrderNumber": "L8266355",
"sellingParty": {
"partyId": "999US"
},
"acknowledgementDate": "2019-07-17T19:17:34.304Z",
"items": [
{
"itemSequenceNumber": "1",
"amazonProductIdentifier": "ABC123434",
"vendorProductIdentifier": "028877454078",
"orderedQuantity": {
"amount": 10,
"unitOfMeasure": "Cases"
},
"netCost": {
"currencyCode": "USD",
"amount": "18.0"
},
"listPrice": {
"currencyCode": "USD",
"amount": "22.2"
},
"discountMultiplier": "0.44",
"itemAcknowledgements": [
{
"acknowledgementCode": "Rejected",
"acknowledgedQuantity": {
"amount": 6,
"unitOfMeasure": "Cases",
"unitSize": 2
},
"scheduledShipDate": "2019-07-17T19:17:34.304Z",
"scheduledDeliveryDate": "2019-07-17T19:17:34.304Z",
"rejectionReason": "TemporarilyUnavailable"
}
]
}
]
}
]
}
"$ref": "#/definitions/SubmitAcknowledgementRequest"
}
}
],
@ -1700,11 +1704,15 @@
}
},
"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."
@ -1733,6 +1741,10 @@
"$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."
@ -1745,6 +1757,10 @@
"$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."
@ -1757,6 +1773,10 @@
"$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."
@ -1769,6 +1789,10 @@
"$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."
@ -1781,6 +1805,10 @@
"$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."
@ -1795,7 +1823,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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description": "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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have 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": [
{
@ -1839,7 +1867,7 @@
{
"name": "createdAfter",
"in": "query",
"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.",
"description": "Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.",
"required": false,
"type": "string",
"format": "date-time"
@ -1847,7 +1875,7 @@
{
"name": "createdBefore",
"in": "query",
"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.",
"description": "Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.",
"required": false,
"type": "string",
"format": "date-time"
@ -1855,7 +1883,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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> 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 ISO-8601 date/time format.",
"required": false,
"type": "string",
"format": "date-time"
@ -1863,7 +1891,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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> 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 ISO-8601 date/time format.",
"required": false,
"type": "string",
"format": "date-time"
@ -2660,11 +2688,15 @@
}
},
"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."
@ -2693,6 +2725,10 @@
"$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."
@ -2705,6 +2741,10 @@
"$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."
@ -2717,6 +2757,10 @@
"$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."
@ -2729,6 +2773,10 @@
"$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."
@ -2751,7 +2799,7 @@
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the `getPurchaseOrders` operation."
"description": "The response schema for the getPurchaseOrders operation."
},
"GetPurchaseOrderResponse": {
"type": "object",
@ -2764,7 +2812,7 @@
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the `getPurchaseOrder` operation."
"description": "The response schema for the getPurchaseOrder operation."
},
"OrderList": {
"type": "object",
@ -2776,21 +2824,18 @@
"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",
@ -2814,11 +2859,11 @@
"x-docgen-enum-table-extension": [
{
"value": "New",
"description": "The purchase order is newly created and needs to be acknowledged by the vendor."
"description": "The purchase order is newly created and needs to be acknowledged by vendor."
},
{
"value": "Acknowledged",
"description": "The purchase order has been acknowledged by the vendor."
"description": "The purchase order has been acknowledged by vendor."
},
{
"value": "Closed",
@ -2830,8 +2875,7 @@
"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",
@ -2844,17 +2888,17 @@
"purchaseOrderDate": {
"type": "string",
"format": "date-time",
"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."
"description": "The date the purchase order was placed. Must be in ISO-8601 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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> 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 ISO-8601 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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> 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 ISO-8601 date/time format."
},
"purchaseOrderType": {
"type": "string",
@ -3060,12 +3104,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": {
@ -3077,11 +3121,10 @@
},
"DateTimeInterval": {
"type": "string",
"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 (--)."
"description": "Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--)."
},
"PartyIdentification": {
"type": "object",
"description": "Name, address and tax details of a party.",
"required": [
"partyId"
],
@ -3127,7 +3170,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."
@ -3174,7 +3217,7 @@
},
"postalCode": {
"type": "string",
"description": "The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation."
"description": "The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation."
},
"countryCode": {
"type": "string",
@ -3217,15 +3260,14 @@
"description": "When true, we will accept backorder confirmations for this item."
},
"netCost": {
"description": "The price to Amazon each (cost).",
"description": "The net cost of an item per each or weight unit.",
"$ref": "#/definitions/Money"
},
"listPrice": {
"description": "The price to Amazon each (list).",
"description": "The list price of an item per each or weight unit.",
"$ref": "#/definitions/Money"
}
},
"description": "Represents an individual item in an order, including item details, quantities, pricing, and backorder information."
}
},
"Money": {
"type": "object",
@ -3237,9 +3279,37 @@
},
"amount": {
"$ref": "#/definitions/Decimal"
},
"unitOfMeasure": {
"type": "string",
"description": "The unit of measure for prices of items sold by weight. If this field is absent, the item is sold by eaches.",
"enum": [
"POUNDS",
"OUNCES",
"GRAMS",
"KILOGRAMS"
],
"x-docgen-enum-table-extension": [
{
"value": "POUNDS",
"description": "Priced per Pound."
},
{
"value": "OUNCES",
"description": "Priced per Ounce."
},
{
"value": "GRAMS",
"description": "Priced per Gram."
},
{
"value": "KILOGRAMS",
"description": "Priced per Kilogram."
}
]
}
},
"description": "An amount of money, including units in the form of currency."
"description": "An amount of money. Includes the currency code and an optional unit of measure for items priced by weight."
},
"Decimal": {
"type": "string",
@ -3249,14 +3319,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",
@ -3265,8 +3335,7 @@
"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",
@ -3282,11 +3351,10 @@
"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",
@ -3308,7 +3376,7 @@
"acknowledgementDate": {
"type": "string",
"format": "date-time",
"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."
"description": "The date and time when the purchase order is acknowledged, in ISO-8601 date/time format."
},
"items": {
"type": "array",
@ -3317,8 +3385,7 @@
"$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",
@ -3344,11 +3411,11 @@
"$ref": "#/definitions/ItemQuantity"
},
"netCost": {
"description": "The cost to Amazon, which should match the cost on the invoice. This is a required field. If this is left blank the file will reject in Amazon systems. Price information should not be zero or negative. Indicates a net unit price.",
"description": "The net cost of an item per each or weight unit that must match the cost on the invoice. This is a required field. If left blank, Amazon systems will reject the file. Price information must not be zero or negative.",
"$ref": "#/definitions/Money"
},
"listPrice": {
"description": "The list price. This is required only if a vendor sells books with a list price.",
"description": "The list price of an item per each or weight unit. Required only if a vendor sells books at list price.",
"$ref": "#/definitions/Money"
},
"discountMultiplier": {
@ -3387,7 +3454,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",
@ -3402,12 +3469,12 @@
"scheduledShipDate": {
"type": "string",
"format": "date-time",
"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."
"description": "Estimated ship date per line item. Must be in ISO-8601 date/time format."
},
"scheduledDeliveryDate": {
"type": "string",
"format": "date-time",
"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."
"description": "Estimated delivery date per line item. Must be in ISO-8601 date/time format."
},
"rejectionReason": {
"type": "string",
@ -3432,8 +3499,7 @@
}
]
}
},
"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",
@ -3478,7 +3544,7 @@
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the `getPurchaseOrdersStatus` operation."
"description": "The response schema for the getPurchaseOrdersStatus operation."
},
"OrderListStatus": {
"type": "object",
@ -3490,11 +3556,9 @@
"type": "array",
"items": {
"$ref": "#/definitions/OrderStatus"
},
"description": "Represents an order status within the `OrderListStatus`."
}
}
},
"description": "A list of order statuses."
}
},
"OrderStatus": {
"type": "object",
@ -3532,12 +3596,12 @@
"purchaseOrderDate": {
"type": "string",
"format": "date-time",
"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."
"description": "The date the purchase order was placed. Must be in ISO-8601 date/time format."
},
"lastUpdatedDate": {
"type": "string",
"format": "date-time",
"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."
"description": "The date when the purchase order was last updated. Must be in ISO-8601 date/time format."
},
"sellingParty": {
"description": "Name/Address and tax details of the selling party.",
@ -3580,11 +3644,11 @@
"description": "The vendor selected product identification of the item."
},
"netCost": {
"description": "The net cost to Amazon each (cost).",
"description": "The net cost of an item per each or weight unit.",
"$ref": "#/definitions/Money"
},
"listPrice": {
"description": "The list Price to Amazon each (list).",
"description": "The list price of an item per each or weight unit.",
"$ref": "#/definitions/Money"
},
"orderedQuantity": {
@ -3687,12 +3751,11 @@
"lastReceiveDate": {
"type": "string",
"format": "date-time",
"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": "The date when the most recent item was received at the buyer's warehouse. Must be in ISO-8601 date/time format."
}
}
}
},
"description": "Represents the current status of an order item, including acknowledgement and receiving details."
}
},
"OrderedQuantityDetails": {
"type": "object",
@ -3700,7 +3763,7 @@
"updatedDate": {
"type": "string",
"format": "date-time",
"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."
"description": "The date when the line item quantity was updated by buyer. Must be in ISO-8601 date/time format."
},
"orderedQuantity": {
"description": "Item quantity ordered.",
@ -3711,7 +3774,7 @@
"$ref": "#/definitions/ItemQuantity"
}
},
"description": "Details of the item quantity ordered."
"description": "Details of item quantity ordered"
},
"AcknowledgementStatusDetails": {
"type": "object",
@ -3719,18 +3782,18 @@
"acknowledgementDate": {
"type": "string",
"format": "date-time",
"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."
"description": "The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format."
},
"acceptedQuantity": {
"description": "Item quantity accepted by the vendor to be shipped.",
"description": "Item quantity accepted by vendor to be shipped.",
"$ref": "#/definitions/ItemQuantity"
},
"rejectedQuantity": {
"description": "Item quantity rejected by the vendor.",
"description": "Item quantity rejected by vendor.",
"$ref": "#/definitions/ItemQuantity"
}
},
"description": "Details of the item quantity ordered"
"description": "Details of item quantity ordered"
},
"Error": {
"type": "object",