Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sName
Integer j
Integer iCount_j
String sStrVal
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
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "keywords" "<string>,<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "marketplaceIds" "<string>,<string>" To iSuccess
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://sellingpartnerapi-na.amazon.com/definitions/2020-09-01/productTypes" vQueryParams 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)
// {
// "productTypes": [
// {
// "marketplaceIds": [
// "<string>",
// "<string>"
// ],
// "name": "<string>"
// },
// {
// "marketplaceIds": [
// "<string>",
// "<string>"
// ],
// "name": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Move 0 To i
Get ComSizeOfArray Of hoJResp "productTypes" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "productTypes[i].name" To sName
Move 0 To j
Get ComSizeOfArray Of hoJResp "productTypes[i].marketplaceIds" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "productTypes[i].marketplaceIds[j]" To sStrVal
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -G -d "keywords=%3Cstring%3E,%3Cstring%3E"
-d "marketplaceIds=%3Cstring%3E,%3Cstring%3E"
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/definitions/2020-09-01/productTypes
Postman Collection Item JSON
{
"name": "search Definitions Product Types",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/definitions/2020-09-01/productTypes?keywords=<string>,<string>&marketplaceIds=<string>,<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes"
],
"query": [
{
"key": "keywords",
"value": "<string>,<string>",
"description": "A comma-delimited list of keywords to search product types by."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request."
}
]
},
"description": "Search for and return a list of Amazon product types that have definitions available.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api)."
},
"response": [
{
"name": "Successfully retrieved a list of Amazon product types that have definitions available.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/definitions/2020-09-01/productTypes?keywords=<string>,<string>&marketplaceIds=<string>,<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes"
],
"query": [
{
"key": "keywords",
"value": "<string>,<string>",
"description": "A comma-delimited list of keywords to search product types by."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request."
}
]
}
},
"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 \"productTypes\": [\n {\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ],\n \"name\": \"<string>\"\n },\n {\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ],\n \"name\": \"<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}}/definitions/2020-09-01/productTypes?keywords=<string>,<string>&marketplaceIds=<string>,<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes"
],
"query": [
{
"key": "keywords",
"value": "<string>,<string>",
"description": "A comma-delimited list of keywords to search product types by."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request."
}
]
}
},
"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": "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}}/definitions/2020-09-01/productTypes?keywords=<string>,<string>&marketplaceIds=<string>,<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes"
],
"query": [
{
"key": "keywords",
"value": "<string>,<string>",
"description": "A comma-delimited list of keywords to search product types by."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request."
}
]
}
},
"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": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/definitions/2020-09-01/productTypes?keywords=<string>,<string>&marketplaceIds=<string>,<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes"
],
"query": [
{
"key": "keywords",
"value": "<string>,<string>",
"description": "A comma-delimited list of keywords to search product types by."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request."
}
]
}
},
"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": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/definitions/2020-09-01/productTypes?keywords=<string>,<string>&marketplaceIds=<string>,<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes"
],
"query": [
{
"key": "keywords",
"value": "<string>,<string>",
"description": "A comma-delimited list of keywords to search product types by."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request."
}
]
}
},
"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": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/definitions/2020-09-01/productTypes?keywords=<string>,<string>&marketplaceIds=<string>,<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes"
],
"query": [
{
"key": "keywords",
"value": "<string>,<string>",
"description": "A comma-delimited list of keywords to search product types by."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request."
}
]
}
},
"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": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/definitions/2020-09-01/productTypes?keywords=<string>,<string>&marketplaceIds=<string>,<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes"
],
"query": [
{
"key": "keywords",
"value": "<string>,<string>",
"description": "A comma-delimited list of keywords to search product types by."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_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": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/definitions/2020-09-01/productTypes?keywords=<string>,<string>&marketplaceIds=<string>,<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes"
],
"query": [
{
"key": "keywords",
"value": "<string>,<string>",
"description": "A comma-delimited list of keywords to search product types by."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request."
}
]
}
},
"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": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/definitions/2020-09-01/productTypes?keywords=<string>,<string>&marketplaceIds=<string>,<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes"
],
"query": [
{
"key": "keywords",
"value": "<string>,<string>",
"description": "A comma-delimited list of keywords to search product types by."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request."
}
]
}
},
"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}"
}
]
}
