Update OrdersV0 model.
This commit is contained in:
Gibran Waldron
parent
1fb5f849d2
commit
c56f882471
|
|
@ -1278,222 +1278,6 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"/orders/v0/orders/{orderId}/fulfillmentInstructions": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"ordersV0"
|
||||
],
|
||||
"description": "Returns the fulfillment instructions for the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 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 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": "getOrderFulfillmentInstructions",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "orderId",
|
||||
"in": "path",
|
||||
"description": "An Amazon-defined order identifier, in 3-7-7 format.",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse"
|
||||
},
|
||||
"examples": {
|
||||
"application/json":{
|
||||
"payload": {
|
||||
"AmazonOrderId": "902-3159896-1390916",
|
||||
"FulfillmentPlans": [
|
||||
{
|
||||
"CreationDate": "2023-10-25T12:00:00Z",
|
||||
"FulfillmentPlanId" : "1",
|
||||
"FulfillmentType" : "SHIP",
|
||||
"FulfillmentPlanStatus": "ACTIVE",
|
||||
"LastStatusUpdateDate" : "2023-10-25T12:00:00Z",
|
||||
"FulfillmentPlanItems": [
|
||||
{
|
||||
"OrderItemId": "6217867064725",
|
||||
"Measurement" : {
|
||||
"Unit" : "COUNT",
|
||||
"Value" : 20
|
||||
}
|
||||
}
|
||||
],
|
||||
"ShippingInstructions": {
|
||||
"CarrierCode": "UPS",
|
||||
"ShippingMethod": "Ground",
|
||||
"ShippingConstraints" : {
|
||||
"PalletDelivery" : "MANDATORY"
|
||||
}
|
||||
},
|
||||
"FulfillmentLocation": {
|
||||
"SupplySourceId": "bb3e1352-a3b4-4b99-aeb7-b1a923837ef2"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"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."
|
||||
}
|
||||
},
|
||||
"x-amzn-api-sandbox": {
|
||||
"static": [
|
||||
{
|
||||
"request": {
|
||||
"parameters": {
|
||||
"orderId": {
|
||||
"value": "TEST_CASE_200"
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"payload": {
|
||||
"AmazonOrderId": "TEST_CASE_200",
|
||||
"FulfillmentPlans": [{
|
||||
"CreationDate": "2023-10-25T12:00:00Z",
|
||||
"FulfillmentPlanId" : "1",
|
||||
"FulfillmentType" : "SHIP",
|
||||
"FulfillmentPlanStatus": "ACTIVE",
|
||||
"LastStatusUpdateDate" : "2023-10-25T12:00:00Z",
|
||||
"FulfillmentPlanItems": [
|
||||
{
|
||||
"OrderItemId": "6217867064725",
|
||||
"Measurement" : {
|
||||
"Unit" : "COUNT",
|
||||
"Value" : 20
|
||||
}
|
||||
}
|
||||
],
|
||||
"ShippingInstructions": {
|
||||
"CarrierCode": "UPS",
|
||||
"ShippingMethod": "Ground",
|
||||
"ShippingConstraints" : {
|
||||
"PalletDelivery" : "MANDATORY"
|
||||
}
|
||||
},
|
||||
"FulfillmentLocation": {
|
||||
"SupplySourceId": "bb3e1352-a3b4-4b99-aeb7-b1a923837ef2"
|
||||
}
|
||||
}]
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Request has missing or invalid parameters and cannot be parsed.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse"
|
||||
},
|
||||
"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."
|
||||
}
|
||||
},
|
||||
"x-amzn-api-sandbox": {
|
||||
"static": [
|
||||
{
|
||||
"request": {
|
||||
"parameters": {
|
||||
"orderId": {
|
||||
"value": "TEST_CASE_400"
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"errors": [
|
||||
{
|
||||
"code": "InvalidInput",
|
||||
"message": "Invalid Input"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "The resource specified does not exist.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The frequency of requests was greater than allowed.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
}
|
||||
}
|
||||
},
|
||||
"503": {
|
||||
"description": "Temporary overloading or maintenance of the server.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/orders/v0/orders/{orderId}/orderItems": {
|
||||
"get": {
|
||||
"tags": [
|
||||
|
|
@ -3110,20 +2894,6 @@
|
|||
},
|
||||
"description": "The response schema for the `getOrderItemsBuyerInfo` operation."
|
||||
},
|
||||
"GetOrderFulfillmentInstructionsResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"payload" : {
|
||||
"description": "The payload for the `getOrderFulfillmentInstructions` operation.",
|
||||
"$ref": "#/definitions/FulfillmentInstructions"
|
||||
},
|
||||
"errors": {
|
||||
"description": "One or more unexpected errors occurred during the `getOrderFulfillmentInstructions` operation.",
|
||||
"$ref": "#/definitions/ErrorList"
|
||||
}
|
||||
},
|
||||
"description": "The response schema for the `getOrderFulfillmentInstructions` operation."
|
||||
},
|
||||
"OrdersList": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
|
|
@ -4699,146 +4469,6 @@
|
|||
},
|
||||
"description": "Contains the instructions about the fulfillment like where should it be fulfilled from."
|
||||
},
|
||||
"FulfillmentInstructions": {
|
||||
"type": "object",
|
||||
"description": "Contains all fulfillment plans for the order",
|
||||
"required": [
|
||||
"AmazonOrderId"
|
||||
],
|
||||
"properties": {
|
||||
"FulfillmentPlans": {
|
||||
"type": "array",
|
||||
"description": "List of all fulfillment plans for the given order id",
|
||||
"items": {
|
||||
"$ref": "#/definitions/FulfillmentPlan"
|
||||
}
|
||||
},
|
||||
"AmazonOrderId": {
|
||||
"type": "string",
|
||||
"description": "An Amazon-defined order identifier, in 3-7-7 format."
|
||||
}
|
||||
}
|
||||
},
|
||||
"FulfillmentPlan": {
|
||||
"type": "object",
|
||||
"description": "A collection of order items that are to be fulfilled from the same location with the same shipping, pickup, and service instructions",
|
||||
"required": [
|
||||
"FulfillmentPlanId",
|
||||
"CreationDate",
|
||||
"FulfillmentType",
|
||||
"FulfillmentPlanStatus",
|
||||
"LastStatusUpdateDate",
|
||||
"FulfillmentPlanItems"
|
||||
],
|
||||
"properties": {
|
||||
"FulfillmentPlanId": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier of a fulfillment plan"
|
||||
},
|
||||
"CreationDate": {
|
||||
"type": "string",
|
||||
"description": "Time when the fulfillment plan was created in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format"
|
||||
},
|
||||
"FulfillmentType": {
|
||||
"type": "string",
|
||||
"description": "Type of fulfillment",
|
||||
"enum": [
|
||||
"INSTORE_PICKUP",
|
||||
"SERVICE",
|
||||
"SHIP"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "INSTORE_PICKUP",
|
||||
"description": "Buyer picks up items in plan from store"
|
||||
},
|
||||
{
|
||||
"value": "SERVICE",
|
||||
"description": "Services that are performed for the buyer, such as assembly"
|
||||
},
|
||||
{
|
||||
"value": "SHIP",
|
||||
"description": "Shipped by seller through detailed ship method"
|
||||
}
|
||||
]
|
||||
},
|
||||
"FulfillmentPlanStatus": {
|
||||
"type": "string",
|
||||
"description": "Status of the fulfillment plan",
|
||||
"enum": [
|
||||
"ACTIVE",
|
||||
"ABORTED",
|
||||
"COMPLETED",
|
||||
"PARTIALLY_FULFILLED"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "ACTIVE",
|
||||
"description": "The plan is ready to be fulfilled"
|
||||
},
|
||||
{
|
||||
"value": "ABORTED",
|
||||
"description": "Plan was canceled, either through order canceling or replanning of shipment."
|
||||
},
|
||||
{
|
||||
"value": "COMPLETED",
|
||||
"description": "Plan has been fulfilled and completed"
|
||||
},
|
||||
{
|
||||
"value": "PARTIALLY_FULFILLED",
|
||||
"description": "Plan has been partially fulfilled"
|
||||
}
|
||||
]
|
||||
},
|
||||
"LastStatusUpdateDate": {
|
||||
"type": "string",
|
||||
"description": "Time when the fulfillment plan's status was last updated in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> Format"
|
||||
},
|
||||
"FulfillmentLocation": {
|
||||
"description": "Represents a location from which the plan is to be fulfilled",
|
||||
"$ref": "#/definitions/FulfillmentLocation"
|
||||
},
|
||||
"ShippingInstructions": {
|
||||
"description": "Represents shipping related information of a delivery",
|
||||
"$ref": "#/definitions/ShippingInstructions"
|
||||
},
|
||||
"FulfillmentPlanItems": {
|
||||
"description": "Represents the details of order items that are included in the fulfillment plan",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/FulfillmentPlanItem"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"FulfillmentLocation": {
|
||||
"type": "object",
|
||||
"description": "Represents a location from which the plan is to be fulfilled",
|
||||
"properties": {
|
||||
"SupplySourceId": {
|
||||
"type": "string",
|
||||
"description": "The fulfillment location identifier"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ShippingInstructions": {
|
||||
"type": "object",
|
||||
"description": "Represents shipping related information of a delivery",
|
||||
"properties": {
|
||||
"CarrierCode": {
|
||||
"description": "Carrier Name that will deliver the package.",
|
||||
"type": "string"
|
||||
},
|
||||
"ShippingMethod": {
|
||||
"description": "Ship method to be used for shipping the order",
|
||||
"type": "string"
|
||||
},
|
||||
"ShippingConstraints": {
|
||||
"description": "Models constraints around shipping",
|
||||
"$ref": "#/definitions/FulfillmentPlanShippingConstraints"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ShippingConstraints": {
|
||||
"type": "object",
|
||||
"description": "Delivery constraints applicable to this order.",
|
||||
|
|
@ -4862,56 +4492,6 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
"FulfillmentPlanShippingConstraints": {
|
||||
"type": "object",
|
||||
"description" :"Delivery constraints applicable to this order.",
|
||||
"properties" : {
|
||||
"PalletDelivery": {
|
||||
"description": "Indicates if the line item needs to be delivered by pallet",
|
||||
"$ref": "#/definitions/FulfillmentPlanConstraintType"
|
||||
},
|
||||
"SignatureConfirmation": {
|
||||
"description": "Indicates if the line item needs to be shipped with delivery confirmation services",
|
||||
"$ref": "#/definitions/FulfillmentPlanConstraintType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"FulfillmentPlanConstraintType": {
|
||||
"type": "string",
|
||||
"description" :"Details the importance of the constraint present on the item",
|
||||
"enum": [
|
||||
"MANDATORY",
|
||||
"RECOMMENDED"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "MANDATORY",
|
||||
"description": "Item must follow the constraint to ensure order is met with buyer's delivery requirements."
|
||||
},
|
||||
{
|
||||
"value": "RECOMMENDED",
|
||||
"description": "Item is recommended to follow the constraint to ensure order is met with buyer's delivery requirements."
|
||||
}
|
||||
]
|
||||
},
|
||||
"FulfillmentPlanItem": {
|
||||
"type": "object",
|
||||
"description": "The order items associated with this fulfillment plan",
|
||||
"required": [
|
||||
"OrderItemId",
|
||||
"Measurement"
|
||||
],
|
||||
"properties": {
|
||||
"OrderItemId": {
|
||||
"type": "string",
|
||||
"description": "An Amazon-defined associated order item's order item identifier."
|
||||
},
|
||||
"Measurement": {
|
||||
"description": "Measurement information for the order item.",
|
||||
"$ref": "#/definitions/Measurement"
|
||||
}
|
||||
}
|
||||
},
|
||||
"BuyerInfo": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
|
|||
Loading…
Reference in New Issue