Chilkat Online Tools

SQL Server / Commercetools / AddItemShippingAddress

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.

    -- {
    --   "version": "{{version}}",
    --   "actions": [
    --     {
    --       "action": "addItemShippingAddress",
    --       "address": {
    --         "id": "exampleAddress",
    --         "key": "exampleKey",
    --         "title": "My Address",
    --         "salutation": "Mr.",
    --         "firstName": "Example",
    --         "lastName": "Person",
    --         "streetName": "Examplary Street",
    --         "streetNumber": "4711",
    --         "additionalStreetInfo": "Backhouse",
    --         "postalCode": "80933",
    --         "city": "Exemplary City",
    --         "region": "Exemplary Region",
    --         "state": "Exemplary State",
    --         "country": "DE",
    --         "company": "My Company Name",
    --         "department": "Sales",
    --         "building": "Hightower 1",
    --         "apartment": "247",
    --         "pOBox": "2471",
    --         "phone": "+49 89 12345678",
    --         "mobile": "+49 171 2345678",
    --         "email": "mail@mail.com",
    --         "fax": "+49 89 12345679",
    --         "additionalAddressInfo": "no additional Info",
    --         "externalId": "Information not needed"
    --       }
    --     }
    --   ]
    -- }

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'version', '{{version}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].action', 'addItemShippingAddress'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.id', 'exampleAddress'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.key', 'exampleKey'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.title', 'My Address'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.salutation', 'Mr.'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.firstName', 'Example'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.lastName', 'Person'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.streetName', 'Examplary Street'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.streetNumber', '4711'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.additionalStreetInfo', 'Backhouse'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.postalCode', '80933'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.city', 'Exemplary City'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.region', 'Exemplary Region'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.state', 'Exemplary State'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.country', 'DE'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.company', 'My Company Name'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.department', 'Sales'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.building', 'Hightower 1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.apartment', '247'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.pOBox', '2471'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.phone', '+49 89 12345678'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.mobile', '+49 171 2345678'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.email', 'mail@mail.com'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.fax', '+49 89 12345679'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.additionalAddressInfo', 'no additional Info'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'actions[0].address.externalId', 'Information not needed'

    -- 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
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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}}/carts/{{cart-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": {{cart-version}},
    "actions": [
        {
            "action" : "addItemShippingAddress",
            "address" : {
              "id" : "exampleAddress",
              "key" : "exampleKey",
              "title" : "My Address",
              "salutation" : "Mr.",
              "firstName" : "Example",
              "lastName" : "Person",
              "streetName" : "Examplary Street",
              "streetNumber" : "4711",
              "additionalStreetInfo" : "Backhouse",
              "postalCode" : "80933",
              "city" : "Exemplary City",
              "region" : "Exemplary Region",
              "state" : "Exemplary State",
              "country" : "DE",
              "company" : "My Company Name",
              "department" : "Sales",
              "building" : "Hightower 1",
              "apartment" : "247",
              "pOBox" : "2471",
              "phone" : "+49 89 12345678",
              "mobile" : "+49 171 2345678",
              "email" : "mail@mail.com",
              "fax" : "+49 89 12345679",
              "additionalAddressInfo" : "no additional Info",
              "externalId" : "Information not needed"
            }
          }
    ]
}'
https://domain.com/{{project-key}}/carts/{{cart-id}}

Postman Collection Item JSON

{
  "name": "AddItemShippingAddress",
  "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(\"cart-id\", data.results[0].id); ",
          "    pm.environment.set(\"cart-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"cart-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"cart-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"cart-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"cart-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "post",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"version\": {{cart-version}},\n    \"actions\": [\n        {\n            \"action\" : \"addItemShippingAddress\",\n            \"address\" : {\n              \"id\" : \"exampleAddress\",\n              \"key\" : \"exampleKey\",\n              \"title\" : \"My Address\",\n              \"salutation\" : \"Mr.\",\n              \"firstName\" : \"Example\",\n              \"lastName\" : \"Person\",\n              \"streetName\" : \"Examplary Street\",\n              \"streetNumber\" : \"4711\",\n              \"additionalStreetInfo\" : \"Backhouse\",\n              \"postalCode\" : \"80933\",\n              \"city\" : \"Exemplary City\",\n              \"region\" : \"Exemplary Region\",\n              \"state\" : \"Exemplary State\",\n              \"country\" : \"DE\",\n              \"company\" : \"My Company Name\",\n              \"department\" : \"Sales\",\n              \"building\" : \"Hightower 1\",\n              \"apartment\" : \"247\",\n              \"pOBox\" : \"2471\",\n              \"phone\" : \"+49 89 12345678\",\n              \"mobile\" : \"+49 171 2345678\",\n              \"email\" : \"mail@mail.com\",\n              \"fax\" : \"+49 89 12345679\",\n              \"additionalAddressInfo\" : \"no additional Info\",\n              \"externalId\" : \"Information not needed\"\n            }\n          }\n    ]\n}"
    },
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/carts/{{cart-id}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "carts",
        "{{cart-id}}"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "post Carts"
  },
  "response": [
  ]
}