Chilkat Online Tools

delphiAx / easybill REST API / Fetch list of position discounts

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
customer_id: WideString;
position_id: Integer;
id: WideString;
discount: Integer;
discount_type: WideString;
page: WideString;
pages: WideString;
limit: WideString;
total: WideString;
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 := TChilkatHttp.Create(Self);

queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('limit','<integer>');
queryParams.UpdateString('page','<integer>');
queryParams.UpdateString('customer_id','<string>');

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

resp := http.QuickRequestParams('GET','https://api.easybill.de/rest/v1/discounts/position',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

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

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

    Exit;
  end;

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

// {
//   "page": "<integer>",
//   "pages": "<integer>",
//   "limit": "<integer>",
//   "total": "<integer>",
//   "items": [
//     {
//       "customer_id": "<long>",
//       "position_id": -31850106,
//       "id": "<long>",
//       "discount": 0,
//       "discount_type": "PERCENT"
//     },
//     {
//       "customer_id": "<long>",
//       "position_id": 44029037,
//       "id": "<long>",
//       "discount": 0,
//       "discount_type": "PERCENT"
//     }
//   ]
// }

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

page := jResp.StringOf('page');
pages := jResp.StringOf('pages');
limit := jResp.StringOf('limit');
total := jResp.StringOf('total');
i := 0;
count_i := jResp.SizeOfArray('items');
while i < count_i do
  begin
    jResp.I := i;
    customer_id := jResp.StringOf('items[i].customer_id');
    position_id := jResp.IntOf('items[i].position_id');
    id := jResp.StringOf('items[i].id');
    discount := jResp.IntOf('items[i].discount');
    discount_type := jResp.StringOf('items[i].discount_type');
    i := i + 1;
  end;

Curl Command

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

Postman Collection Item JSON

{
  "name": "Fetch list of position discounts",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/discounts/position?limit=<integer>&page=<integer>&customer_id=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "discounts",
        "position"
      ],
      "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": "customer_id",
          "value": "<string>",
          "description": "Filter discounts by customer_id. You can add multiple customer_ids separate by comma like id,id,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}}/discounts/position?limit=<integer>&page=<integer>&customer_id=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "discounts",
            "position"
          ],
          "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": "customer_id",
              "value": "<string>",
              "description": "Filter discounts by customer_id. You can add multiple customer_ids separate by comma like id,id,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      \"customer_id\": \"<long>\",\n      \"position_id\": -31850106,\n      \"id\": \"<long>\",\n      \"discount\": 0,\n      \"discount_type\": \"PERCENT\"\n    },\n    {\n      \"customer_id\": \"<long>\",\n      \"position_id\": 44029037,\n      \"id\": \"<long>\",\n      \"discount\": 0,\n      \"discount_type\": \"PERCENT\"\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}}/discounts/position?limit=<integer>&page=<integer>&customer_id=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "discounts",
            "position"
          ],
          "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": "customer_id",
              "value": "<string>",
              "description": "Filter discounts by customer_id. You can add multiple customer_ids separate by comma like id,id,id."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}