Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'sellerId', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'marketplaceIds', '<string>,<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'productTypeVersion', 'LATEST'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'requirements', 'LISTING'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'requirementsEnforced', 'ENFORCED'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'locale', 'DEFAULT'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://sellingpartnerapi-na.amazon.com/definitions/2020-09-01/productTypes/:productType', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "locale": "<string>",
-- "marketplaceIds": [
-- "<string>",
-- "<string>"
-- ],
-- "productType": "<string>",
-- "productTypeVersion": {
-- "latest": "<boolean>",
-- "version": "<string>",
-- "releaseCandidate": "<boolean>"
-- },
-- "propertyGroups": {
-- "labore40": {
-- "title": "<string>",
-- "description": "<string>",
-- "propertyNames": [
-- "<string>",
-- "<string>"
-- ]
-- }
-- },
-- "requirements": "LISTING",
-- "requirementsEnforced": "ENFORCED",
-- "schema": {
-- "checksum": "<string>",
-- "link": {
-- "resource": "<string>",
-- "verb": "GET"
-- }
-- },
-- "metaSchema": {
-- "checksum": "<string>",
-- "link": {
-- "resource": "<string>",
-- "verb": "GET"
-- }
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @strVal nvarchar(4000)
DECLARE @locale nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @locale OUT, 'locale'
DECLARE @productType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @productType OUT, 'productType'
DECLARE @Latest nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Latest OUT, 'productTypeVersion.latest'
DECLARE @Version nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Version OUT, 'productTypeVersion.version'
DECLARE @ReleaseCandidate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ReleaseCandidate OUT, 'productTypeVersion.releaseCandidate'
DECLARE @Title nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Title OUT, 'propertyGroups.labore40.title'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'propertyGroups.labore40.description'
DECLARE @requirements nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @requirements OUT, 'requirements'
DECLARE @requirementsEnforced nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @requirementsEnforced OUT, 'requirementsEnforced'
DECLARE @Checksum nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Checksum OUT, 'schema.checksum'
DECLARE @Resource nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Resource OUT, 'schema.link.resource'
DECLARE @Verb nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Verb OUT, 'schema.link.verb'
DECLARE @metaSchemaChecksum nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @metaSchemaChecksum OUT, 'metaSchema.checksum'
DECLARE @LinkResource nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LinkResource OUT, 'metaSchema.link.resource'
DECLARE @LinkVerb nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LinkVerb OUT, 'metaSchema.link.verb'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'marketplaceIds'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'marketplaceIds[i]'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'propertyGroups.labore40.propertyNames'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'propertyGroups.labore40.propertyNames[i]'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "sellerId=%3Cstring%3E"
-d "marketplaceIds=%3Cstring%3E,%3Cstring%3E"
-d "productTypeVersion=LATEST"
-d "requirements=LISTING"
-d "requirementsEnforced=ENFORCED"
-d "locale=DEFAULT"
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/definitions/2020-09-01/productTypes/:productType
Postman Collection Item JSON
{
"name": "get Definitions Product Type",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/definitions/2020-09-01/productTypes/:productType?sellerId=<string>&marketplaceIds=<string>,<string>&productTypeVersion=LATEST&requirements=LISTING&requirementsEnforced=ENFORCED&locale=DEFAULT",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes",
":productType"
],
"query": [
{
"key": "sellerId",
"value": "<string>",
"description": "A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request.\nNote: This parameter is limited to one marketplaceId at this time."
},
{
"key": "productTypeVersion",
"value": "LATEST",
"description": "The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided."
},
{
"key": "requirements",
"value": "LISTING",
"description": "The name of the requirements set to retrieve requirements for."
},
{
"key": "requirementsEnforced",
"value": "ENFORCED",
"description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates)."
},
{
"key": "locale",
"value": "DEFAULT",
"description": "Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request."
}
],
"variable": [
{
"key": "productType",
"value": "<string>"
}
]
},
"description": "Retrieve an Amazon product type definition.\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 an Amazon product type definition.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/definitions/2020-09-01/productTypes/:productType?sellerId=<string>&marketplaceIds=<string>,<string>&productTypeVersion=LATEST&requirements=LISTING&requirementsEnforced=ENFORCED&locale=DEFAULT",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes",
":productType"
],
"query": [
{
"key": "sellerId",
"value": "<string>",
"description": "A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request.\nNote: This parameter is limited to one marketplaceId at this time."
},
{
"key": "productTypeVersion",
"value": "LATEST",
"description": "The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided."
},
{
"key": "requirements",
"value": "LISTING",
"description": "The name of the requirements set to retrieve requirements for."
},
{
"key": "requirementsEnforced",
"value": "ENFORCED",
"description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates)."
},
{
"key": "locale",
"value": "DEFAULT",
"description": "Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request."
}
],
"variable": [
{
"key": "productType"
}
]
}
},
"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 \"locale\": \"<string>\",\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ],\n \"productType\": \"<string>\",\n \"productTypeVersion\": {\n \"latest\": \"<boolean>\",\n \"version\": \"<string>\",\n \"releaseCandidate\": \"<boolean>\"\n },\n \"propertyGroups\": {\n \"labore40\": {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"propertyNames\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n },\n \"requirements\": \"LISTING\",\n \"requirementsEnforced\": \"ENFORCED\",\n \"schema\": {\n \"checksum\": \"<string>\",\n \"link\": {\n \"resource\": \"<string>\",\n \"verb\": \"GET\"\n }\n },\n \"metaSchema\": {\n \"checksum\": \"<string>\",\n \"link\": {\n \"resource\": \"<string>\",\n \"verb\": \"GET\"\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/:productType?sellerId=<string>&marketplaceIds=<string>,<string>&productTypeVersion=LATEST&requirements=LISTING&requirementsEnforced=ENFORCED&locale=DEFAULT",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes",
":productType"
],
"query": [
{
"key": "sellerId",
"value": "<string>",
"description": "A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request.\nNote: This parameter is limited to one marketplaceId at this time."
},
{
"key": "productTypeVersion",
"value": "LATEST",
"description": "The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided."
},
{
"key": "requirements",
"value": "LISTING",
"description": "The name of the requirements set to retrieve requirements for."
},
{
"key": "requirementsEnforced",
"value": "ENFORCED",
"description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates)."
},
{
"key": "locale",
"value": "DEFAULT",
"description": "Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request."
}
],
"variable": [
{
"key": "productType"
}
]
}
},
"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/:productType?sellerId=<string>&marketplaceIds=<string>,<string>&productTypeVersion=LATEST&requirements=LISTING&requirementsEnforced=ENFORCED&locale=DEFAULT",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes",
":productType"
],
"query": [
{
"key": "sellerId",
"value": "<string>",
"description": "A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request.\nNote: This parameter is limited to one marketplaceId at this time."
},
{
"key": "productTypeVersion",
"value": "LATEST",
"description": "The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided."
},
{
"key": "requirements",
"value": "LISTING",
"description": "The name of the requirements set to retrieve requirements for."
},
{
"key": "requirementsEnforced",
"value": "ENFORCED",
"description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates)."
},
{
"key": "locale",
"value": "DEFAULT",
"description": "Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request."
}
],
"variable": [
{
"key": "productType"
}
]
}
},
"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/:productType?sellerId=<string>&marketplaceIds=<string>,<string>&productTypeVersion=LATEST&requirements=LISTING&requirementsEnforced=ENFORCED&locale=DEFAULT",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes",
":productType"
],
"query": [
{
"key": "sellerId",
"value": "<string>",
"description": "A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request.\nNote: This parameter is limited to one marketplaceId at this time."
},
{
"key": "productTypeVersion",
"value": "LATEST",
"description": "The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided."
},
{
"key": "requirements",
"value": "LISTING",
"description": "The name of the requirements set to retrieve requirements for."
},
{
"key": "requirementsEnforced",
"value": "ENFORCED",
"description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates)."
},
{
"key": "locale",
"value": "DEFAULT",
"description": "Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request."
}
],
"variable": [
{
"key": "productType"
}
]
}
},
"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/:productType?sellerId=<string>&marketplaceIds=<string>,<string>&productTypeVersion=LATEST&requirements=LISTING&requirementsEnforced=ENFORCED&locale=DEFAULT",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes",
":productType"
],
"query": [
{
"key": "sellerId",
"value": "<string>",
"description": "A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request.\nNote: This parameter is limited to one marketplaceId at this time."
},
{
"key": "productTypeVersion",
"value": "LATEST",
"description": "The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided."
},
{
"key": "requirements",
"value": "LISTING",
"description": "The name of the requirements set to retrieve requirements for."
},
{
"key": "requirementsEnforced",
"value": "ENFORCED",
"description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates)."
},
{
"key": "locale",
"value": "DEFAULT",
"description": "Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request."
}
],
"variable": [
{
"key": "productType"
}
]
}
},
"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/:productType?sellerId=<string>&marketplaceIds=<string>,<string>&productTypeVersion=LATEST&requirements=LISTING&requirementsEnforced=ENFORCED&locale=DEFAULT",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes",
":productType"
],
"query": [
{
"key": "sellerId",
"value": "<string>",
"description": "A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request.\nNote: This parameter is limited to one marketplaceId at this time."
},
{
"key": "productTypeVersion",
"value": "LATEST",
"description": "The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided."
},
{
"key": "requirements",
"value": "LISTING",
"description": "The name of the requirements set to retrieve requirements for."
},
{
"key": "requirementsEnforced",
"value": "ENFORCED",
"description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates)."
},
{
"key": "locale",
"value": "DEFAULT",
"description": "Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request."
}
],
"variable": [
{
"key": "productType"
}
]
}
},
"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/:productType?sellerId=<string>&marketplaceIds=<string>,<string>&productTypeVersion=LATEST&requirements=LISTING&requirementsEnforced=ENFORCED&locale=DEFAULT",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes",
":productType"
],
"query": [
{
"key": "sellerId",
"value": "<string>",
"description": "A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request.\nNote: This parameter is limited to one marketplaceId at this time."
},
{
"key": "productTypeVersion",
"value": "LATEST",
"description": "The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided."
},
{
"key": "requirements",
"value": "LISTING",
"description": "The name of the requirements set to retrieve requirements for."
},
{
"key": "requirementsEnforced",
"value": "ENFORCED",
"description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates)."
},
{
"key": "locale",
"value": "DEFAULT",
"description": "Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request."
}
],
"variable": [
{
"key": "productType"
}
]
}
},
"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": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/definitions/2020-09-01/productTypes/:productType?sellerId=<string>&marketplaceIds=<string>,<string>&productTypeVersion=LATEST&requirements=LISTING&requirementsEnforced=ENFORCED&locale=DEFAULT",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes",
":productType"
],
"query": [
{
"key": "sellerId",
"value": "<string>",
"description": "A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request.\nNote: This parameter is limited to one marketplaceId at this time."
},
{
"key": "productTypeVersion",
"value": "LATEST",
"description": "The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided."
},
{
"key": "requirements",
"value": "LISTING",
"description": "The name of the requirements set to retrieve requirements for."
},
{
"key": "requirementsEnforced",
"value": "ENFORCED",
"description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates)."
},
{
"key": "locale",
"value": "DEFAULT",
"description": "Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request."
}
],
"variable": [
{
"key": "productType"
}
]
}
},
"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/:productType?sellerId=<string>&marketplaceIds=<string>,<string>&productTypeVersion=LATEST&requirements=LISTING&requirementsEnforced=ENFORCED&locale=DEFAULT",
"host": [
"{{baseUrl}}"
],
"path": [
"definitions",
"2020-09-01",
"productTypes",
":productType"
],
"query": [
{
"key": "sellerId",
"value": "<string>",
"description": "A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner."
},
{
"key": "marketplaceIds",
"value": "<string>,<string>",
"description": "(Required) A comma-delimited list of Amazon marketplace identifiers for the request.\nNote: This parameter is limited to one marketplaceId at this time."
},
{
"key": "productTypeVersion",
"value": "LATEST",
"description": "The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided."
},
{
"key": "requirements",
"value": "LISTING",
"description": "The name of the requirements set to retrieve requirements for."
},
{
"key": "requirementsEnforced",
"value": "ENFORCED",
"description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates)."
},
{
"key": "locale",
"value": "DEFAULT",
"description": "Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request."
}
],
"variable": [
{
"key": "productType"
}
]
}
},
"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}"
}
]
}
