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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "marketplaceId": "officia aliqua cillum",
-- "amazonOrderId": "incididunt",
-- "packageDimensions": {
-- "length": 77584762.21559949,
-- "width": 53194956.12931797,
-- "height": 43125271.61279134,
-- "unit": "Cm",
-- "identifier": "voluptate"
-- },
-- "packageWeight": {
-- "value": 13064328.286832083,
-- "unit": "Grams"
-- }
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'marketplaceId', 'officia aliqua cillum'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'amazonOrderId', 'incididunt'
EXEC sp_OAMethod @json, 'UpdateNumber', @success OUT, 'packageDimensions.length', '77584762.21559949'
EXEC sp_OAMethod @json, 'UpdateNumber', @success OUT, 'packageDimensions.width', '53194956.12931797'
EXEC sp_OAMethod @json, 'UpdateNumber', @success OUT, 'packageDimensions.height', '43125271.61279134'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'packageDimensions.unit', 'Cm'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'packageDimensions.identifier', 'voluptate'
EXEC sp_OAMethod @json, 'UpdateNumber', @success OUT, 'packageWeight.value', '13064328.286832083'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'packageWeight.unit', 'Grams'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://sellingpartnerapi-na.amazon.com/easyShip/2022-03-23/timeSlot', 'application/json', @json
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 @json
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 @json
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)
-- {
-- "amazonOrderId": "commodo amet",
-- "timeSlots": [
-- {
-- "slotId": "dolore mollit culpa adipisicing",
-- "startTime": "2012-03-14T23:06:09.962Z",
-- "endTime": "1950-01-03T16:29:23.876Z",
-- "handoverMethod": "Dropoff"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @slotId nvarchar(4000)
DECLARE @startTime nvarchar(4000)
DECLARE @endTime nvarchar(4000)
DECLARE @handoverMethod nvarchar(4000)
DECLARE @amazonOrderId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @amazonOrderId OUT, 'amazonOrderId'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'timeSlots'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @slotId OUT, 'timeSlots[i].slotId'
EXEC sp_OAMethod @jResp, 'StringOf', @startTime OUT, 'timeSlots[i].startTime'
EXEC sp_OAMethod @jResp, 'StringOf', @endTime OUT, 'timeSlots[i].endTime'
EXEC sp_OAMethod @jResp, 'StringOf', @handoverMethod OUT, 'timeSlots[i].handoverMethod'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"marketplaceId": "officia aliqua cillum",
"amazonOrderId": "incididunt",
"packageDimensions": {
"length": 77584762.21559949,
"width": 53194956.12931797,
"height": 43125271.61279134,
"unit": "Cm",
"identifier": "voluptate"
},
"packageWeight": {
"value": 13064328.286832083,
"unit": "Grams"
}
}'
https://sellingpartnerapi-na.amazon.com/easyShip/2022-03-23/timeSlot
Postman Collection Item JSON
{
"name": "list Handover Slots",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"marketplaceId\": \"officia aliqua cillum\",\n \"amazonOrderId\": \"incididunt\",\n \"packageDimensions\": {\n \"length\": 77584762.21559949,\n \"width\": 53194956.12931797,\n \"height\": 43125271.61279134,\n \"unit\": \"Cm\",\n \"identifier\": \"voluptate\"\n },\n \"packageWeight\": {\n \"value\": 13064328.286832083,\n \"unit\": \"Grams\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/timeSlot",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"timeSlot"
]
},
"description": "Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies.\n\nThis operation is available for scheduled and unscheduled orders based on marketplace support. See **Get Time Slots** in the [Marketplace Support Table](doc:easy-ship-api-v2022-03-23-use-case-guide).\n\nThis operation can return time slots that have either pickup or drop-off handover methods - see **Supported Handover Methods** in the [Marketplace Support Table](doc:easy-ship-api-v2022-03-23-use-case-guide).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 5 |\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 than those shown here. 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": "Success.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"marketplaceId\": \"officia aliqua cillum\",\n \"amazonOrderId\": \"incididunt\",\n \"packageDimensions\": {\n \"length\": 77584762.21559949,\n \"width\": 53194956.12931797,\n \"height\": 43125271.61279134,\n \"unit\": \"Cm\",\n \"identifier\": \"voluptate\"\n },\n \"packageWeight\": {\n \"value\": 13064328.286832083,\n \"unit\": \"Grams\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/timeSlot",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"timeSlot"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "do anim",
"description": "Your rate limit (requests per second) for this operation."
},
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"amazonOrderId\": \"commodo amet\",\n \"timeSlots\": [\n {\n \"slotId\": \"dolore mollit culpa adipisicing\",\n \"startTime\": \"2012-03-14T23:06:09.962Z\",\n \"endTime\": \"1950-01-03T16:29:23.876Z\",\n \"handoverMethod\": \"Dropoff\"\n }\n ]\n}"
},
{
"name": "Request has missing or invalid parameters and cannot be parsed.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"marketplaceId\": \"officia aliqua cillum\",\n \"amazonOrderId\": \"incididunt\",\n \"packageDimensions\": {\n \"length\": 77584762.21559949,\n \"width\": 53194956.12931797,\n \"height\": 43125271.61279134,\n \"unit\": \"Cm\",\n \"identifier\": \"voluptate\"\n },\n \"packageWeight\": {\n \"value\": 13064328.286832083,\n \"unit\": \"Grams\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/timeSlot",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"timeSlot"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "do anim",
"description": "Your rate limit (requests per second) for this operation."
},
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"culpa qui dolore\",\n \"message\": \"aute\",\n \"details\": \"dolor ut\"\n },\n {\n \"code\": \"tempor\",\n \"message\": \"laboris nostrud enim magna ad\",\n \"details\": \"ullamco pariatur est\"\n }\n ]\n}"
},
{
"name": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"marketplaceId\": \"officia aliqua cillum\",\n \"amazonOrderId\": \"incididunt\",\n \"packageDimensions\": {\n \"length\": 77584762.21559949,\n \"width\": 53194956.12931797,\n \"height\": 43125271.61279134,\n \"unit\": \"Cm\",\n \"identifier\": \"voluptate\"\n },\n \"packageWeight\": {\n \"value\": 13064328.286832083,\n \"unit\": \"Grams\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/timeSlot",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"timeSlot"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "do anim",
"description": "Your rate limit (requests per second) for this operation."
},
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"marketplaceId\": \"officia aliqua cillum\",\n \"amazonOrderId\": \"incididunt\",\n \"packageDimensions\": {\n \"length\": 77584762.21559949,\n \"width\": 53194956.12931797,\n \"height\": 43125271.61279134,\n \"unit\": \"Cm\",\n \"identifier\": \"voluptate\"\n },\n \"packageWeight\": {\n \"value\": 13064328.286832083,\n \"unit\": \"Grams\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/timeSlot",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"timeSlot"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "The specified resource does not exist.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"marketplaceId\": \"officia aliqua cillum\",\n \"amazonOrderId\": \"incididunt\",\n \"packageDimensions\": {\n \"length\": 77584762.21559949,\n \"width\": 53194956.12931797,\n \"height\": 43125271.61279134,\n \"unit\": \"Cm\",\n \"identifier\": \"voluptate\"\n },\n \"packageWeight\": {\n \"value\": 13064328.286832083,\n \"unit\": \"Grams\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/timeSlot",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"timeSlot"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "do anim",
"description": "Your rate limit (requests per second) for this operation."
},
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "The request payload is in an unsupported format.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"marketplaceId\": \"officia aliqua cillum\",\n \"amazonOrderId\": \"incididunt\",\n \"packageDimensions\": {\n \"length\": 77584762.21559949,\n \"width\": 53194956.12931797,\n \"height\": 43125271.61279134,\n \"unit\": \"Cm\",\n \"identifier\": \"voluptate\"\n },\n \"packageWeight\": {\n \"value\": 13064328.286832083,\n \"unit\": \"Grams\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/timeSlot",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"timeSlot"
]
}
},
"status": "Unsupported Media Type",
"code": 415,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "The frequency of requests was greater than allowed.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"marketplaceId\": \"officia aliqua cillum\",\n \"amazonOrderId\": \"incididunt\",\n \"packageDimensions\": {\n \"length\": 77584762.21559949,\n \"width\": 53194956.12931797,\n \"height\": 43125271.61279134,\n \"unit\": \"Cm\",\n \"identifier\": \"voluptate\"\n },\n \"packageWeight\": {\n \"value\": 13064328.286832083,\n \"unit\": \"Grams\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/timeSlot",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"timeSlot"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"marketplaceId\": \"officia aliqua cillum\",\n \"amazonOrderId\": \"incididunt\",\n \"packageDimensions\": {\n \"length\": 77584762.21559949,\n \"width\": 53194956.12931797,\n \"height\": 43125271.61279134,\n \"unit\": \"Cm\",\n \"identifier\": \"voluptate\"\n },\n \"packageWeight\": {\n \"value\": 13064328.286832083,\n \"unit\": \"Grams\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/timeSlot",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"timeSlot"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "Temporary overloading or maintenance of the server.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"marketplaceId\": \"officia aliqua cillum\",\n \"amazonOrderId\": \"incididunt\",\n \"packageDimensions\": {\n \"length\": 77584762.21559949,\n \"width\": 53194956.12931797,\n \"height\": 43125271.61279134,\n \"unit\": \"Cm\",\n \"identifier\": \"voluptate\"\n },\n \"packageWeight\": {\n \"value\": 13064328.286832083,\n \"unit\": \"Grams\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/timeSlot",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"timeSlot"
]
}
},
"status": "Service Unavailable",
"code": 503,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
}
]
}
