Remove shipmentConfirmation (beta) content and republish Orders V0 model and reference
This commit is contained in:
Gibran Waldron
parent
53763b8ab2
commit
b04225f1fb
|
|
@ -1403,7 +1403,9 @@
|
||||||
"IsBuyerRequestedCancel": true,
|
"IsBuyerRequestedCancel": true,
|
||||||
"BuyerCancelReason": "Found cheaper somewhere else."
|
"BuyerCancelReason": "Found cheaper somewhere else."
|
||||||
},
|
},
|
||||||
"SerialNumbers": ["854"]
|
"SerialNumbers": [
|
||||||
|
"854"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"ASIN": "BCTU1104UEFB",
|
"ASIN": "BCTU1104UEFB",
|
||||||
|
|
@ -2998,238 +3000,6 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"/orders/v0/orders/{orderId}/shipmentConfirmation": {
|
|
||||||
"post": {
|
|
||||||
"tags": [
|
|
||||||
"ordersV0"
|
|
||||||
],
|
|
||||||
"description": "Updates the shipment confirmation status for a specified order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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).",
|
|
||||||
"operationId": "confirmShipment",
|
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"name": "orderId",
|
|
||||||
"in": "path",
|
|
||||||
"description": "An Amazon-defined order identifier, in 3-7-7 format.",
|
|
||||||
"required": true,
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "payload",
|
|
||||||
"in": "body",
|
|
||||||
"description": "Request body of confirmShipment.",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/definitions/ConfirmShipmentRequest"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"responses": {
|
|
||||||
"204": {
|
|
||||||
"description": "Success.",
|
|
||||||
"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": "902-1106328-1059050"
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"value": {
|
|
||||||
"marketplaceId": "ATVPDKIKX0DER",
|
|
||||||
"packageDetail": {
|
|
||||||
"packageReferenceId": "1",
|
|
||||||
"carrierCode": "FedEx",
|
|
||||||
"carrierName": "FedEx",
|
|
||||||
"shippingMethod": "FedEx Ground",
|
|
||||||
"trackingNumber": "112345678",
|
|
||||||
"shipDate": "2022-02-11T01:00:00.000Z",
|
|
||||||
"shipFromSupplySourceId": "057d3fcc-b750-419f-bbcd-4d340c60c430",
|
|
||||||
"orderItems":[
|
|
||||||
{
|
|
||||||
"orderItemId": "79039765272157",
|
|
||||||
"quantity": 1,
|
|
||||||
"transparencyCodes": [
|
|
||||||
"09876543211234567890"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"response": {
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"400": {
|
|
||||||
"description": "Request has missing or invalid parameters and cannot be parsed.",
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/definitions/ConfirmShipmentErrorResponse"
|
|
||||||
},
|
|
||||||
"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": "902-1106328-1059050"
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"value": {
|
|
||||||
"marketplaceId": "ATVPDKIKX0DER",
|
|
||||||
"packageDetail": {
|
|
||||||
"packageReferenceId": "1",
|
|
||||||
"carrierCode": "FedEx",
|
|
||||||
"carrierName": "FedEx",
|
|
||||||
"shippingMethod": "FedEx Ground",
|
|
||||||
"trackingNumber": "112345678",
|
|
||||||
"shipDate": "02/21/2022",
|
|
||||||
"shipFromSupplySourceId": "057d3fcc-b750-419f-bbcd-4d340c60c430",
|
|
||||||
"orderItems":[
|
|
||||||
{
|
|
||||||
"orderItemId": "79039765272157",
|
|
||||||
"quantity": 1,
|
|
||||||
"transparencyCodes": [
|
|
||||||
"09876543211234567890"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"response": {
|
|
||||||
"errors": [
|
|
||||||
{
|
|
||||||
"code": "Invalid Input",
|
|
||||||
"message": "Invalid Input"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"401": {
|
|
||||||
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/definitions/ConfirmShipmentErrorResponse"
|
|
||||||
},
|
|
||||||
"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": {
|
|
||||||
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/definitions/ConfirmShipmentErrorResponse"
|
|
||||||
},
|
|
||||||
"headers": {
|
|
||||||
"x-amzn-RequestId": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Unique request reference identifier."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"404": {
|
|
||||||
"description": "The specified resource does not exist.",
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/definitions/ConfirmShipmentErrorResponse"
|
|
||||||
},
|
|
||||||
"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/ConfirmShipmentErrorResponse"
|
|
||||||
},
|
|
||||||
"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."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"500": {
|
|
||||||
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/definitions/ConfirmShipmentErrorResponse"
|
|
||||||
},
|
|
||||||
"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."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"503": {
|
|
||||||
"description": "Temporary overloading or maintenance of the server.",
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/definitions/ConfirmShipmentErrorResponse"
|
|
||||||
},
|
|
||||||
"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."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"definitions": {
|
"definitions": {
|
||||||
|
|
@ -5147,126 +4917,6 @@
|
||||||
},
|
},
|
||||||
"description": "The error response schema for the updateOrderItemsApprovals operation."
|
"description": "The error response schema for the updateOrderItemsApprovals operation."
|
||||||
},
|
},
|
||||||
"ConfirmShipmentRequest": {
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"marketplaceId",
|
|
||||||
"packageDetail"
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"packageDetail": {
|
|
||||||
"$ref": "#/definitions/PackageDetail"
|
|
||||||
},
|
|
||||||
"codCollectionMethod": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The cod collection method, support in JP only. ",
|
|
||||||
"enum":["DirectPayment"]
|
|
||||||
},
|
|
||||||
"marketplaceId": {
|
|
||||||
"$ref": "#/definitions/MarketplaceId"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"description": "The request schema for an shipment confirmation."
|
|
||||||
},
|
|
||||||
"ConfirmShipmentErrorResponse": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "The error response schema for an shipment confirmation.",
|
|
||||||
"properties": {
|
|
||||||
"errors": {
|
|
||||||
"description": "One or more unexpected errors occurred during the confirmShipment operation.",
|
|
||||||
"$ref": "#/definitions/ErrorList"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"PackageDetail": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "Properties of packages",
|
|
||||||
"required": [
|
|
||||||
"packageReferenceId",
|
|
||||||
"carrierCode",
|
|
||||||
"trackingNumber",
|
|
||||||
"shipDate",
|
|
||||||
"orderItems"
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"packageReferenceId": {
|
|
||||||
"$ref": "#/definitions/PackageReferenceId"
|
|
||||||
},
|
|
||||||
"carrierCode": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Identifies the carrier that will deliver the package. This field is required for all marketplaces, see [reference](https://developer-docs.amazon.com/sp-api/changelog/carriercode-value-required-in-shipment-confirmations-for-br-mx-ca-sg-au-in-jp-marketplaces)."
|
|
||||||
},
|
|
||||||
"carrierName": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Carrier Name that will deliver the package. Required when carrierCode is \"Others\" "
|
|
||||||
},
|
|
||||||
"shippingMethod": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Ship method to be used for shipping the order."
|
|
||||||
},
|
|
||||||
"trackingNumber": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The tracking number used to obtain tracking and delivery information."
|
|
||||||
},
|
|
||||||
"shipDate": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The shipping date for the package. Must be in ISO-8601 date/time format.",
|
|
||||||
"format": "date-time"
|
|
||||||
},
|
|
||||||
"shipFromSupplySourceId": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The unique identifier of the supply source."
|
|
||||||
},
|
|
||||||
"orderItems": {
|
|
||||||
"description": "The list of order items and quantities to be updated.",
|
|
||||||
"$ref": "#/definitions/ConfirmShipmentOrderItemsList"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"ConfirmShipmentOrderItemsList": {
|
|
||||||
"type": "array",
|
|
||||||
"description": "A list of order items.",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/definitions/ConfirmShipmentOrderItem"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"ConfirmShipmentOrderItem": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "A single order item.",
|
|
||||||
"required": [
|
|
||||||
"orderItemId",
|
|
||||||
"quantity"
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"orderItemId": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The unique identifier of the order item."
|
|
||||||
},
|
|
||||||
"quantity": {
|
|
||||||
"type": "integer",
|
|
||||||
"description": "The quantity of the item."
|
|
||||||
},
|
|
||||||
"transparencyCodes": {
|
|
||||||
"description": "The list of transparency codes.",
|
|
||||||
"$ref": "#/definitions/TransparencyCodeList"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"TransparencyCodeList": {
|
|
||||||
"type": "array",
|
|
||||||
"description": "A list of order items.",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/definitions/TransparencyCode"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"TransparencyCode": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The Transparency code associated with the item."
|
|
||||||
},
|
|
||||||
"PackageReferenceId": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "A seller-supplied identifier that uniquely identifies a package within the scope of an order."
|
|
||||||
},
|
|
||||||
"ErrorList": {
|
"ErrorList": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"description": "A list of error responses returned when a request is unsuccessful.",
|
"description": "A list of error responses returned when a request is unsuccessful.",
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue