Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sCode
String sMessage
String sDetails
String sTransportStatus
String sErrorCode
String sErrorDescription
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get ComQuickRequest Of hoHttp "POST" "https://sellingpartnerapi-na.amazon.com/fba/inbound/v0/shipments/:shipmentId/transport/void" To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "payload": {
// "TransportResult": {
// "TransportStatus": "ERROR_IN_VOIDING",
// "ErrorCode": "<string>",
// "ErrorDescription": "<string>"
// }
// },
// "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
Get ComStringOf Of hoJResp "payload.TransportResult.TransportStatus" To sTransportStatus
Get ComStringOf Of hoJResp "payload.TransportResult.ErrorCode" To sErrorCode
Get ComStringOf Of hoJResp "payload.TransportResult.ErrorDescription" To sErrorDescription
Move 0 To i
Get ComSizeOfArray Of hoJResp "errors" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "errors[i].code" To sCode
Get ComStringOf Of hoJResp "errors[i].message" To sMessage
Get ComStringOf Of hoJResp "errors[i].details" To sDetails
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X POST
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/fba/inbound/v0/shipments/:shipmentId/transport/void
Postman Collection Item JSON
{
"name": "void Transport",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/transport/void",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"transport",
"void"
],
"variable": [
{
"key": "shipmentId",
"value": "<string>"
}
]
},
"description": "Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier.\n\nTo be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation.\n\nImportant: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping cost.\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": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/transport/void",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"transport",
"void"
],
"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 \"TransportResult\": {\n \"TransportStatus\": \"ERROR_IN_VOIDING\",\n \"ErrorCode\": \"<string>\",\n \"ErrorDescription\": \"<string>\"\n }\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": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/transport/void",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"transport",
"void"
],
"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 \"TransportResult\": {\n \"TransportStatus\": \"ERROR_IN_VOIDING\",\n \"ErrorCode\": \"<string>\",\n \"ErrorDescription\": \"<string>\"\n }\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": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/transport/void",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"transport",
"void"
],
"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 \"TransportResult\": {\n \"TransportStatus\": \"ERROR_IN_VOIDING\",\n \"ErrorCode\": \"<string>\",\n \"ErrorDescription\": \"<string>\"\n }\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": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/transport/void",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"transport",
"void"
],
"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 \"TransportResult\": {\n \"TransportStatus\": \"ERROR_IN_VOIDING\",\n \"ErrorCode\": \"<string>\",\n \"ErrorDescription\": \"<string>\"\n }\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": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/transport/void",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"transport",
"void"
],
"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 \"TransportResult\": {\n \"TransportStatus\": \"ERROR_IN_VOIDING\",\n \"ErrorCode\": \"<string>\",\n \"ErrorDescription\": \"<string>\"\n }\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": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/transport/void",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"transport",
"void"
],
"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 \"TransportResult\": {\n \"TransportStatus\": \"ERROR_IN_VOIDING\",\n \"ErrorCode\": \"<string>\",\n \"ErrorDescription\": \"<string>\"\n }\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": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/transport/void",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"transport",
"void"
],
"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 \"TransportResult\": {\n \"TransportStatus\": \"ERROR_IN_VOIDING\",\n \"ErrorCode\": \"<string>\",\n \"ErrorDescription\": \"<string>\"\n }\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": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments/:shipmentId/transport/void",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments",
":shipmentId",
"transport",
"void"
],
"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 \"TransportResult\": {\n \"TransportStatus\": \"ERROR_IN_VOIDING\",\n \"ErrorCode\": \"<string>\",\n \"ErrorDescription\": \"<string>\"\n }\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}"
}
]
}
