Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sBase64EncodedContent
String sDocumentFormat
String sTemp1
// 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 "x-amzn-shipping-business-id" "AmazonShipping_US"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://sellingpartnerapi-eu.amazon.com/shipping/v2/collectionForms/:collectionFormId" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
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 ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "collectionsFormDocument": {
// "base64EncodedContent": "<string>",
// "documentFormat": "<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 "collectionsFormDocument.base64EncodedContent" To sBase64EncodedContent
Get ComStringOf Of hoJResp "collectionsFormDocument.documentFormat" To sDocumentFormat
End_Procedure
Curl Command
curl -X GET
-H "x-amzn-shipping-business-id: AmazonShipping_US"
-H "Accept: application/json"
https://sellingpartnerapi-eu.amazon.com/shipping/v2/collectionForms/:collectionFormId
Postman Collection Item JSON
{
"name": "get Collection Form",
"request": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/collectionForms/:collectionFormId",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"collectionForms",
":collectionFormId"
],
"variable": [
{
"key": "collectionFormId",
"value": "<string>",
"description": "(Required) collection form Id to reprint a collection."
}
]
},
"description": "This API reprint a collection form. \n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)."
},
"response": [
{
"name": "Success.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/collectionForms/:collectionFormId",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"collectionForms",
":collectionFormId"
],
"variable": [
{
"key": "collectionFormId"
}
]
}
},
"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 \"collectionsFormDocument\": {\n \"base64EncodedContent\": \"<string>\",\n \"documentFormat\": \"<string>\"\n }\n}"
},
{
"name": "Request has missing or invalid parameters and cannot be parsed.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/collectionForms/:collectionFormId",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"collectionForms",
":collectionFormId"
],
"variable": [
{
"key": "collectionFormId"
}
]
}
},
"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 \"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": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/collectionForms/:collectionFormId",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"collectionForms",
":collectionFormId"
],
"variable": [
{
"key": "collectionFormId"
}
]
}
},
"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 \"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": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/collectionForms/:collectionFormId",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"collectionForms",
":collectionFormId"
],
"variable": [
{
"key": "collectionFormId"
}
]
}
},
"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 \"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 resource specified does not exist.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/collectionForms/:collectionFormId",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"collectionForms",
":collectionFormId"
],
"variable": [
{
"key": "collectionFormId"
}
]
}
},
"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 \"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 size exceeded the maximum accepted size.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/collectionForms/:collectionFormId",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"collectionForms",
":collectionFormId"
],
"variable": [
{
"key": "collectionFormId"
}
]
}
},
"status": "Request Entity Too Large",
"code": 413,
"_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 \"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 payload is in an unsupported format.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/collectionForms/:collectionFormId",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"collectionForms",
":collectionFormId"
],
"variable": [
{
"key": "collectionFormId"
}
]
}
},
"status": "Unsupported Media Type",
"code": 415,
"_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 \"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": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/collectionForms/:collectionFormId",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"collectionForms",
":collectionFormId"
],
"variable": [
{
"key": "collectionFormId"
}
]
}
},
"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 \"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": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/collectionForms/:collectionFormId",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"collectionForms",
":collectionFormId"
],
"variable": [
{
"key": "collectionFormId"
}
]
}
},
"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 \"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": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/collectionForms/:collectionFormId",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"collectionForms",
":collectionFormId"
],
"variable": [
{
"key": "collectionFormId"
}
]
}
},
"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 \"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}"
}
]
}
