Chilkat Online Tools

SQL Server / Commercetools / AddParcelToDelivery

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": "addParcelToDelivery",
    --       "deliveryId": "{{deliveryId}}",
    --       "measurements": {
    --         "heightInMillimeter": 11,
    --         "widthInMillimeter": 11
    --       },
    --       "trackingData": {
    --         "trackingId": "{{trackingId}}",
    --         "carrier": "TNT",
    --         "provider": "providerName",
    --         "providerTransaction": "{{transactionId}}",
    --         "isReturn": false
    --       },
    --       "items": {
    --         "id": "{{lineItemId}}",
    --         "quantity": 2
    --       }
    --     }
    --   ]
    -- }

    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', 'addParcelToDelivery'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].deliveryId', '{{deliveryId}}'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'actions[0].measurements.heightInMillimeter', 11
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'actions[0].measurements.widthInMillimeter', 11
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].trackingData.trackingId', '{{trackingId}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].trackingData.carrier', 'TNT'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].trackingData.provider', 'providerName'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].trackingData.providerTransaction', '{{transactionId}}'
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'actions[0].trackingData.isReturn', 0
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].items.id', '{{lineItemId}}'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'actions[0].items.quantity', 2

    -- 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}}/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" : "addParcelToDelivery",
            "deliveryId" : "{{deliveryId}}",
            "measurements" : {
              "heightInMillimeter" : 11,
              "widthInMillimeter" : 11
            },
            "trackingData" : {
              "trackingId" : "{{trackingId}}",
              "carrier" : "TNT",
              "provider" : "providerName",
              "providerTransaction" : "{{transactionId}}",
              "isReturn" : false
            },
            "items" : {
              "id" : "{{lineItemId}}",
              "quantity" : 2
            }
          }
    ]
}'
https://domain.com/{{project-key}}/orders/{{order-id}}

Postman Collection Item JSON

{
  "name": "AddParcelToDelivery",
  "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\" : \"addParcelToDelivery\",\n            \"deliveryId\" : \"{{deliveryId}}\",\n            \"measurements\" : {\n              \"heightInMillimeter\" : 11,\n              \"widthInMillimeter\" : 11\n            },\n            \"trackingData\" : {\n              \"trackingId\" : \"{{trackingId}}\",\n              \"carrier\" : \"TNT\",\n              \"provider\" : \"providerName\",\n              \"providerTransaction\" : \"{{transactionId}}\",\n              \"isReturn\" : false\n            },\n            \"items\" : {\n              \"id\" : \"{{lineItemId}}\",\n              \"quantity\" : 2\n            }\n          }\n    ]\n}"
    },
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/orders/{{order-id}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "orders",
        "{{order-id}}"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "post Orders"
  },
  "response": [
  ]
}