Chilkat Online Tools

SQL Server / Coupa Postman Collection - OAuth - Master / Retrieve goods receipts by ID

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

    DECLARE @queryParams int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT

    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'fields', '["id","status","price","quantity","total","transaction_date","type","match_reference","original_transaction_id","voided_value","exported",{"account": ["id","name","code","active","segment_1","segment_2", "segment_3", "segment_4", "account_type_id"]},{"account_allocations": ["id","name","code","active","segment_1","segment_2", "segment_3", "segment_4", "account_type_id"]},{"order_line": ["id","order_header_id","order_header_number"]},{"item": ["id","name","item_number"]},{"uom": ["name","code"]},{"created_by": ["id","login","email"]},{"updated_by": ["id","login","email"]}]'

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/receiving_transactions/:id', @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

    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 @queryParams


END
GO

Curl Command

curl -G -d "fields=%5B%22id%22,%22status%22,%22price%22,%22quantity%22,%22total%22,%22transaction_date%22,%22type%22,%22match_reference%22,%22original_transaction_id%22,%22voided_value%22,%22exported%22,%7B%22account%22%3A%20%5B%22id%22,%22name%22,%22code%22,%22active%22,%22segment_1%22,%22segment_2%22,%20%22segment_3%22,%20%22segment_4%22,%20%22account_type_id%22%5D%7D,%7B%22account_allocations%22%3A%20%5B%22id%22,%22name%22,%22code%22,%22active%22,%22segment_1%22,%22segment_2%22,%20%22segment_3%22,%20%22segment_4%22,%20%22account_type_id%22%5D%7D,%7B%22order_line%22%3A%20%5B%22id%22,%22order_header_id%22,%22order_header_number%22%5D%7D,%7B%22item%22%3A%20%5B%22id%22,%22name%22,%22item_number%22%5D%7D,%7B%22uom%22%3A%20%5B%22name%22,%22code%22%5D%7D,%7B%22created_by%22%3A%20%5B%22id%22,%22login%22,%22email%22%5D%7D,%7B%22updated_by%22%3A%20%5B%22id%22,%22login%22,%22email%22%5D%7D%5D"
	-H "Authorization: Bearer <access_token>"
https://domain.com/receiving_transactions/:id

Postman Collection Item JSON

{
  "name": "Retrieve goods receipts by ID",
  "protocolProfileBehavior": {
    "disabledSystemHeaders": {}
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{URL}}/receiving_transactions/:id?fields=[\"id\",\"status\",\"price\",\"quantity\",\"total\",\"transaction_date\",\"type\",\"match_reference\",\"original_transaction_id\",\"voided_value\",\"exported\",{\"account\": [\"id\",\"name\",\"code\",\"active\",\"segment_1\",\"segment_2\", \"segment_3\", \"segment_4\", \"account_type_id\"]},{\"account_allocations\": [\"id\",\"name\",\"code\",\"active\",\"segment_1\",\"segment_2\", \"segment_3\", \"segment_4\", \"account_type_id\"]},{\"order_line\": [\"id\",\"order_header_id\",\"order_header_number\"]},{\"item\": [\"id\",\"name\",\"item_number\"]},{\"uom\": [\"name\",\"code\"]},{\"created_by\": [\"id\",\"login\",\"email\"]},{\"updated_by\": [\"id\",\"login\",\"email\"]}]",
      "host": [
        "{{URL}}"
      ],
      "path": [
        "receiving_transactions",
        ":id"
      ],
      "query": [
        {
          "key": "fields",
          "value": "[\"id\",\"status\",\"price\",\"quantity\",\"total\",\"transaction_date\",\"type\",\"match_reference\",\"original_transaction_id\",\"voided_value\",\"exported\",{\"account\": [\"id\",\"name\",\"code\",\"active\",\"segment_1\",\"segment_2\", \"segment_3\", \"segment_4\", \"account_type_id\"]},{\"account_allocations\": [\"id\",\"name\",\"code\",\"active\",\"segment_1\",\"segment_2\", \"segment_3\", \"segment_4\", \"account_type_id\"]},{\"order_line\": [\"id\",\"order_header_id\",\"order_header_number\"]},{\"item\": [\"id\",\"name\",\"item_number\"]},{\"uom\": [\"name\",\"code\"]},{\"created_by\": [\"id\",\"login\",\"email\"]},{\"updated_by\": [\"id\",\"login\",\"email\"]}]"
        }
      ],
      "variable": [
        {
          "key": "id",
          "value": "5033",
          "description": "Coupa Internal Id for a Goods Receipt"
        }
      ]
    }
  },
  "response": [
  ]
}