Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcName
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal
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')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("keywords","<string>,<string>")
loQueryParams.UpdateString("marketplaceIds","<string>,<string>")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://sellingpartnerapi-na.amazon.com/definitions/2020-09-01/productTypes",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
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 loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
i = 0
lnCount_i = loJResp.SizeOfArray("productTypes")
DO WHILE i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("productTypes[i].name")
j = 0
lnCount_j = loJResp.SizeOfArray("productTypes[i].marketplaceIds")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("productTypes[i].marketplaceIds[j]")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
