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, 'requestToken', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'rateId', '<string>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-amzn-shipping-business-id', 'AmazonShipping_US'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://sellingpartnerapi-eu.amazon.com/shipping/v2/shipments/additionalInputs/schema', @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)
-- {
-- "payload": {
-- "minimc29": {}
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
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 "requestToken=%3Cstring%3E"
-d "rateId=%3Cstring%3E"
-H "x-amzn-shipping-business-id: AmazonShipping_US"
-H "Accept: application/json"
https://sellingpartnerapi-eu.amazon.com/shipping/v2/shipments/additionalInputs/schema
Postman Collection Item JSON
{
"name": "get Additional Inputs",
"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/shipments/additionalInputs/schema?requestToken=<string>&rateId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"shipments",
"additionalInputs",
"schema"
],
"query": [
{
"key": "requestToken",
"value": "<string>",
"description": "(Required) The request token returned in the response to the getRates operation."
},
{
"key": "rateId",
"value": "<string>",
"description": "(Required) The rate identifier for the shipping offering (rate) returned in the response to the getRates operation."
}
]
},
"description": "Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase.\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/shipments/additionalInputs/schema?requestToken=<string>&rateId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"shipments",
"additionalInputs",
"schema"
],
"query": [
{
"key": "requestToken",
"value": "<string>",
"description": "(Required) The request token returned in the response to the getRates operation."
},
{
"key": "rateId",
"value": "<string>",
"description": "(Required) The rate identifier for the shipping offering (rate) returned in the response to the getRates operation."
}
]
}
},
"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 \"minimc29\": {}\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/shipments/additionalInputs/schema?requestToken=<string>&rateId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"shipments",
"additionalInputs",
"schema"
],
"query": [
{
"key": "requestToken",
"value": "<string>",
"description": "(Required) The request token returned in the response to the getRates operation."
},
{
"key": "rateId",
"value": "<string>",
"description": "(Required) The rate identifier for the shipping offering (rate) returned in the response to the getRates operation."
}
]
}
},
"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/shipments/additionalInputs/schema?requestToken=<string>&rateId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"shipments",
"additionalInputs",
"schema"
],
"query": [
{
"key": "requestToken",
"value": "<string>",
"description": "(Required) The request token returned in the response to the getRates operation."
},
{
"key": "rateId",
"value": "<string>",
"description": "(Required) The rate identifier for the shipping offering (rate) returned in the response to the getRates operation."
}
]
}
},
"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/shipments/additionalInputs/schema?requestToken=<string>&rateId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"shipments",
"additionalInputs",
"schema"
],
"query": [
{
"key": "requestToken",
"value": "<string>",
"description": "(Required) The request token returned in the response to the getRates operation."
},
{
"key": "rateId",
"value": "<string>",
"description": "(Required) The rate identifier for the shipping offering (rate) returned in the response to the getRates operation."
}
]
}
},
"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/shipments/additionalInputs/schema?requestToken=<string>&rateId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"shipments",
"additionalInputs",
"schema"
],
"query": [
{
"key": "requestToken",
"value": "<string>",
"description": "(Required) The request token returned in the response to the getRates operation."
},
{
"key": "rateId",
"value": "<string>",
"description": "(Required) The rate identifier for the shipping offering (rate) returned in the response to the getRates operation."
}
]
}
},
"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/shipments/additionalInputs/schema?requestToken=<string>&rateId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"shipments",
"additionalInputs",
"schema"
],
"query": [
{
"key": "requestToken",
"value": "<string>",
"description": "(Required) The request token returned in the response to the getRates operation."
},
{
"key": "rateId",
"value": "<string>",
"description": "(Required) The rate identifier for the shipping offering (rate) returned in the response to the getRates operation."
}
]
}
},
"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/shipments/additionalInputs/schema?requestToken=<string>&rateId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"shipments",
"additionalInputs",
"schema"
],
"query": [
{
"key": "requestToken",
"value": "<string>",
"description": "(Required) The request token returned in the response to the getRates operation."
},
{
"key": "rateId",
"value": "<string>",
"description": "(Required) The rate identifier for the shipping offering (rate) returned in the response to the getRates operation."
}
]
}
},
"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/shipments/additionalInputs/schema?requestToken=<string>&rateId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"shipments",
"additionalInputs",
"schema"
],
"query": [
{
"key": "requestToken",
"value": "<string>",
"description": "(Required) The request token returned in the response to the getRates operation."
},
{
"key": "rateId",
"value": "<string>",
"description": "(Required) The rate identifier for the shipping offering (rate) returned in the response to the getRates operation."
}
]
}
},
"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/shipments/additionalInputs/schema?requestToken=<string>&rateId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"shipments",
"additionalInputs",
"schema"
],
"query": [
{
"key": "requestToken",
"value": "<string>",
"description": "(Required) The request token returned in the response to the getRates operation."
},
{
"key": "rateId",
"value": "<string>",
"description": "(Required) The rate identifier for the shipping offering (rate) returned in the response to the getRates operation."
}
]
}
},
"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/shipments/additionalInputs/schema?requestToken=<string>&rateId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"shipments",
"additionalInputs",
"schema"
],
"query": [
{
"key": "requestToken",
"value": "<string>",
"description": "(Required) The request token returned in the response to the getRates operation."
},
{
"key": "rateId",
"value": "<string>",
"description": "(Required) The rate identifier for the shipping offering (rate) returned in the response to the getRates operation."
}
]
}
},
"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}"
}
]
}
