Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCode
LOCAL lcMessage
LOCAL lcDetails
LOCAL lcConfirmedNeedByDate
LOCAL lcConfirmedFulfillableDate
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequest("PUT","https://sellingpartnerapi-na.amazon.com/fba/inbound/v0/shipments/:shipmentId/preorder/confirm?NeedByDate=<date>&MarketplaceId=<string>")
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "payload": {
* "ConfirmedNeedByDate": "<date>",
* "ConfirmedFulfillableDate": "<date>"
* },
* "errors": [
* {
* "code": "<string>",
* "message": "<string>",
* "details": "<string>"
* },
* {
* "code": "<string>",
* "message": "<string>",
* "details": "<string>"
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcConfirmedNeedByDate = loJResp.StringOf("payload.ConfirmedNeedByDate")
lcConfirmedFulfillableDate = loJResp.StringOf("payload.ConfirmedFulfillableDate")
i = 0
lnCount_i = loJResp.SizeOfArray("errors")
DO WHILE i < lnCount_i
loJResp.I = i
lcCode = loJResp.StringOf("errors[i].code")
lcMessage = loJResp.StringOf("errors[i].message")
lcDetails = loJResp.StringOf("errors[i].details")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X PUT
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/fba/inbound/v0/shipments/:shipmentId/preorder/confirm?NeedByDate=<date>&MarketplaceId=<string>
Postman Collection Item JSON
{
"name": "confirm Preorder",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder/confirm?NeedByDate=<date>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder",
"confirm"
],
"query": [
{
"key": "NeedByDate",
"value": "<date>",
"description": "(Required) Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace the shipment is tied to."
}
],
"variable": [
{
"key": "shipmentId",
"value": "<string>"
}
]
},
"description": "Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)."
},
"response": [
{
"name": "Success.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder/confirm?NeedByDate=<date>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder",
"confirm"
],
"query": [
{
"key": "NeedByDate",
"value": "<date>",
"description": "(Required) Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace the shipment is tied to."
}
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ConfirmedNeedByDate\": \"<date>\",\n \"ConfirmedFulfillableDate\": \"<date>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Request has missing or invalid parameters and cannot be parsed.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder/confirm?NeedByDate=<date>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder",
"confirm"
],
"query": [
{
"key": "NeedByDate",
"value": "<date>",
"description": "(Required) Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace the shipment is tied to."
}
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ConfirmedNeedByDate\": \"<date>\",\n \"ConfirmedFulfillableDate\": \"<date>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder/confirm?NeedByDate=<date>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder",
"confirm"
],
"query": [
{
"key": "NeedByDate",
"value": "<date>",
"description": "(Required) Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace the shipment is tied to."
}
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "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": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ConfirmedNeedByDate\": \"<date>\",\n \"ConfirmedFulfillableDate\": \"<date>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder/confirm?NeedByDate=<date>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder",
"confirm"
],
"query": [
{
"key": "NeedByDate",
"value": "<date>",
"description": "(Required) Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace the shipment is tied to."
}
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ConfirmedNeedByDate\": \"<date>\",\n \"ConfirmedFulfillableDate\": \"<date>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The specified resource does not exist.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder/confirm?NeedByDate=<date>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder",
"confirm"
],
"query": [
{
"key": "NeedByDate",
"value": "<date>",
"description": "(Required) Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace the shipment is tied to."
}
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ConfirmedNeedByDate\": \"<date>\",\n \"ConfirmedFulfillableDate\": \"<date>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The frequency of requests was greater than allowed.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder/confirm?NeedByDate=<date>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder",
"confirm"
],
"query": [
{
"key": "NeedByDate",
"value": "<date>",
"description": "(Required) Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace the shipment is tied to."
}
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "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": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ConfirmedNeedByDate\": \"<date>\",\n \"ConfirmedFulfillableDate\": \"<date>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder/confirm?NeedByDate=<date>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder",
"confirm"
],
"query": [
{
"key": "NeedByDate",
"value": "<date>",
"description": "(Required) Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace the shipment is tied to."
}
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "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": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ConfirmedNeedByDate\": \"<date>\",\n \"ConfirmedFulfillableDate\": \"<date>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Temporary overloading or maintenance of the server.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder/confirm?NeedByDate=<date>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder",
"confirm"
],
"query": [
{
"key": "NeedByDate",
"value": "<date>",
"description": "(Required) Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace the shipment is tied to."
}
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"status": "Service Unavailable",
"code": 503,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "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": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ConfirmedNeedByDate\": \"<date>\",\n \"ConfirmedFulfillableDate\": \"<date>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
}
]
}
