Chilkat Online Tools

delphiDll / easybill REST API / Fetch a list of stock entries for positions

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
stock_count: PWideChar;
position_id: PWideChar;
id: PWideChar;
note: PWideChar;
document_id: PWideChar;
document_position_id: PWideChar;
stored_at: PWideChar;
created_at: PWideChar;
updated_at: PWideChar;
page: PWideChar;
pages: PWideChar;
limit: PWideChar;
total: PWideChar;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'limit','<integer>');
CkJsonObject_UpdateString(queryParams,'page','<integer>');
CkJsonObject_UpdateString(queryParams,'position_id','<string>');
CkJsonObject_UpdateString(queryParams,'document_id','<string>');

CkHttp_SetRequestHeader(http,'Authorization','{{apiKey}}');
CkHttp_SetRequestHeader(http,'Accept','application/json');

resp := CkHttp_QuickRequestParams(http,'GET','https://api.easybill.de/rest/v1/stocks',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "page": "<integer>",
//   "pages": "<integer>",
//   "limit": "<integer>",
//   "total": "<integer>",
//   "items": [
//     {
//       "stock_count": "<long>",
//       "position_id": "<long>",
//       "id": "<long>",
//       "note": "<string>",
//       "document_id": "<long>",
//       "document_position_id": "<long>",
//       "stored_at": "<string>",
//       "created_at": "<string>",
//       "updated_at": "<string>"
//     },
//     {
//       "stock_count": "<long>",
//       "position_id": "<long>",
//       "id": "<long>",
//       "note": "<string>",
//       "document_id": "<long>",
//       "document_position_id": "<long>",
//       "stored_at": "<string>",
//       "created_at": "<string>",
//       "updated_at": "<string>"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

page := CkJsonObject__stringOf(jResp,'page');
pages := CkJsonObject__stringOf(jResp,'pages');
limit := CkJsonObject__stringOf(jResp,'limit');
total := CkJsonObject__stringOf(jResp,'total');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'items');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    stock_count := CkJsonObject__stringOf(jResp,'items[i].stock_count');
    position_id := CkJsonObject__stringOf(jResp,'items[i].position_id');
    id := CkJsonObject__stringOf(jResp,'items[i].id');
    note := CkJsonObject__stringOf(jResp,'items[i].note');
    document_id := CkJsonObject__stringOf(jResp,'items[i].document_id');
    document_position_id := CkJsonObject__stringOf(jResp,'items[i].document_position_id');
    stored_at := CkJsonObject__stringOf(jResp,'items[i].stored_at');
    created_at := CkJsonObject__stringOf(jResp,'items[i].created_at');
    updated_at := CkJsonObject__stringOf(jResp,'items[i].updated_at');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

curl -G -d "limit=%3Cinteger%3E"
	-d "page=%3Cinteger%3E"
	-d "position_id=%3Cstring%3E"
	-d "document_id=%3Cstring%3E"
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/stocks

Postman Collection Item JSON

{
  "name": "Fetch a list of stock entries for positions",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/stocks?limit=<integer>&page=<integer>&position_id=<string>&document_id=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "stocks"
      ],
      "query": [
        {
          "key": "limit",
          "value": "<integer>",
          "description": "Limited the result. Default is 100. Maximum can be 1000."
        },
        {
          "key": "page",
          "value": "<integer>",
          "description": "Set current Page. Default is 1."
        },
        {
          "key": "position_id",
          "value": "<string>",
          "description": "Filter stock entries by position id."
        },
        {
          "key": "document_id",
          "value": "<string>",
          "description": "Filter stock entries by document id."
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/stocks?limit=<integer>&page=<integer>&position_id=<string>&document_id=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "stocks"
          ],
          "query": [
            {
              "key": "limit",
              "value": "<integer>",
              "description": "Limited the result. Default is 100. Maximum can be 1000."
            },
            {
              "key": "page",
              "value": "<integer>",
              "description": "Set current Page. Default is 1."
            },
            {
              "key": "position_id",
              "value": "<string>",
              "description": "Filter stock entries by position id."
            },
            {
              "key": "document_id",
              "value": "<string>",
              "description": "Filter stock entries by document id."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"page\": \"<integer>\",\n  \"pages\": \"<integer>\",\n  \"limit\": \"<integer>\",\n  \"total\": \"<integer>\",\n  \"items\": [\n    {\n      \"stock_count\": \"<long>\",\n      \"position_id\": \"<long>\",\n      \"id\": \"<long>\",\n      \"note\": \"<string>\",\n      \"document_id\": \"<long>\",\n      \"document_position_id\": \"<long>\",\n      \"stored_at\": \"<string>\",\n      \"created_at\": \"<string>\",\n      \"updated_at\": \"<string>\"\n    },\n    {\n      \"stock_count\": \"<long>\",\n      \"position_id\": \"<long>\",\n      \"id\": \"<long>\",\n      \"note\": \"<string>\",\n      \"document_id\": \"<long>\",\n      \"document_position_id\": \"<long>\",\n      \"stored_at\": \"<string>\",\n      \"created_at\": \"<string>\",\n      \"updated_at\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/stocks?limit=<integer>&page=<integer>&position_id=<string>&document_id=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "stocks"
          ],
          "query": [
            {
              "key": "limit",
              "value": "<integer>",
              "description": "Limited the result. Default is 100. Maximum can be 1000."
            },
            {
              "key": "page",
              "value": "<integer>",
              "description": "Set current Page. Default is 1."
            },
            {
              "key": "position_id",
              "value": "<string>",
              "description": "Filter stock entries by position id."
            },
            {
              "key": "document_id",
              "value": "<string>",
              "description": "Filter stock entries by document id."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}