Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("MarketplaceId","<string>")
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://sellingpartnerapi-na.amazon.com/fba/inbound/v0/shipments/:shipmentId/preorder",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "payload": {
; "ShipmentContainsPreorderableItems": "<boolean>",
; "ShipmentConfirmedForPreorder": "<boolean>",
; "NeedByDate": "<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
Local $sCode
Local $sMessage
Local $sDetails
Local $sShipmentContainsPreorderableItems = $oJResp.StringOf("payload.ShipmentContainsPreorderableItems")
Local $sShipmentConfirmedForPreorder = $oJResp.StringOf("payload.ShipmentConfirmedForPreorder")
Local $sNeedByDate = $oJResp.StringOf("payload.NeedByDate")
Local $sConfirmedFulfillableDate = $oJResp.StringOf("payload.ConfirmedFulfillableDate")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("errors")
While $i < $iCount_i
$oJResp.I = $i
$sCode = $oJResp.StringOf("errors[i].code")
$sMessage = $oJResp.StringOf("errors[i].message")
$sDetails = $oJResp.StringOf("errors[i].details")
$i = $i + 1
Wend
Curl Command
curl -G -d "MarketplaceId=%3Cstring%3E"
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/fba/inbound/v0/shipments/:shipmentId/preorder
Postman Collection Item JSON
{
"name": "get Preorder Info",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder?MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder"
],
"query": [
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace the shipment is tied to."
}
],
"variable": [
{
"key": "shipmentId",
"value": "<string>"
}
]
},
"description": "Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. \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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder?MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder"
],
"query": [
{
"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 \"ShipmentContainsPreorderableItems\": \"<boolean>\",\n \"ShipmentConfirmedForPreorder\": \"<boolean>\",\n \"NeedByDate\": \"<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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder?MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder"
],
"query": [
{
"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 \"ShipmentContainsPreorderableItems\": \"<boolean>\",\n \"ShipmentConfirmedForPreorder\": \"<boolean>\",\n \"NeedByDate\": \"<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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder?MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder"
],
"query": [
{
"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 \"ShipmentContainsPreorderableItems\": \"<boolean>\",\n \"ShipmentConfirmedForPreorder\": \"<boolean>\",\n \"NeedByDate\": \"<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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder?MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder"
],
"query": [
{
"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 \"ShipmentContainsPreorderableItems\": \"<boolean>\",\n \"ShipmentConfirmedForPreorder\": \"<boolean>\",\n \"NeedByDate\": \"<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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder?MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder"
],
"query": [
{
"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 \"ShipmentContainsPreorderableItems\": \"<boolean>\",\n \"ShipmentConfirmedForPreorder\": \"<boolean>\",\n \"NeedByDate\": \"<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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder?MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder"
],
"query": [
{
"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 \"ShipmentContainsPreorderableItems\": \"<boolean>\",\n \"ShipmentConfirmedForPreorder\": \"<boolean>\",\n \"NeedByDate\": \"<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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder?MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder"
],
"query": [
{
"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 \"ShipmentContainsPreorderableItems\": \"<boolean>\",\n \"ShipmentConfirmedForPreorder\": \"<boolean>\",\n \"NeedByDate\": \"<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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/preorder?MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"preorder"
],
"query": [
{
"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 \"ShipmentContainsPreorderableItems\": \"<boolean>\",\n \"ShipmentConfirmedForPreorder\": \"<boolean>\",\n \"NeedByDate\": \"<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}"
}
]
}
