SQL Server / Commercetools / SetReturnInfo
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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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.
-- {
-- "version": "{{version}}",
-- "actions": [
-- {
-- "action": "setReturnInfo",
-- "items": [
-- {
-- "items": [
-- {
-- "quantity": 1,
-- "lineItemId": "{{lineItemId}}",
-- "comment": "any comment",
-- "shipmentState": "Returned"
-- }
-- ],
-- "returnTrackingId": "returnTrackingId-example",
-- "returnDate": "2021-04-30T09:21:15.003Z"
-- }
-- ]
-- }
-- ]
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'version', '{{version}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].action', 'setReturnInfo'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'actions[0].items[0].items[0].quantity', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].items[0].items[0].lineItemId', '{{lineItemId}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].items[0].items[0].comment', 'any comment'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].items[0].items[0].shipmentState', 'Returned'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].items[0].returnTrackingId', 'returnTrackingId-example'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].items[0].returnDate', '2021-04-30T09:21:15.003Z'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'post', 'https://domain.com/{{project-key}}/in-store/key={{store-key}}/orders/{{order-id}}', @sbRequestBody, 'utf-8', 'application/json', 0, 0
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
EXEC @hr = sp_OADestroy @sbRequestBody
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
END
GO
Curl Command
curl -X post
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"version": {{order-version}},
"actions": [
{
"action" : "setReturnInfo",
"items" : [ {
"items" : [ {
"quantity" : 1,
"lineItemId" : "{{lineItemId}}",
"comment" : "any comment",
"shipmentState" : "Returned"
} ],
"returnTrackingId" : "returnTrackingId-example",
"returnDate" : "2021-04-30T09:21:15.003Z"
} ]
}
]
}'
https://domain.com/{{project-key}}/in-store/key={{store-key}}/orders/{{order-id}}
Postman Collection Item JSON
{
"name": "SetReturnInfo",
"event": [
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
"tests[\"Status code \" + responseCode.code] = responseCode.code === 200 || responseCode.code === 201;",
"var data = JSON.parse(responseBody);",
"if(data.results && data.results[0] && data.results[0].id && data.results[0].version){",
" pm.environment.set(\"order-id\", data.results[0].id); ",
" pm.environment.set(\"order-version\", data.results[0].version);",
"}",
"if(data.results && data.results[0] && data.results[0].key){",
" pm.environment.set(\"order-key\", data.results[0].key); ",
"}",
"if(data.version){",
" pm.environment.set(\"order-version\", data.version);",
"}",
"if(data.id){",
" pm.environment.set(\"order-id\", data.id); ",
"}",
"if(data.key){",
" pm.environment.set(\"order-key\", data.key);",
"}",
""
]
}
}
],
"request": {
"auth": {
"type": "oauth2",
"oauth2": {
"accessToken": "{{ctp_access_token}}",
"addTokenTo": "header",
"tokenType": "Bearer"
}
},
"method": "post",
"body": {
"mode": "raw",
"raw": "{\n \"version\": {{order-version}},\n \"actions\": [\n {\n \"action\" : \"setReturnInfo\",\n \"items\" : [ {\n \"items\" : [ {\n \"quantity\" : 1,\n \"lineItemId\" : \"{{lineItemId}}\",\n \"comment\" : \"any comment\",\n \"shipmentState\" : \"Returned\"\n } ],\n \"returnTrackingId\" : \"returnTrackingId-example\",\n \"returnDate\" : \"2021-04-30T09:21:15.003Z\"\n } ]\n }\n ]\n}"
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{host}}/{{project-key}}/in-store/key={{store-key}}/orders/{{order-id}}",
"host": [
"{{host}}"
],
"path": [
"{{project-key}}",
"in-store",
"key={{store-key}}",
"orders",
"{{order-id}}"
],
"query": [
{
"key": "expand",
"value": "",
"equals": true,
"disabled": true
}
]
},
"description": "Updates an order in the store specified by {storeKey}. The {storeKey} path parameter maps to a Store's key.\nIf the order exists in the commercetools project but does not have the store field,\nor the store field references a different store, this method returns a ResourceNotFound error.\n"
},
"response": [
]
}
