Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *last_name;
const wchar_t *company_name;
int acquire_options;
const wchar_t *bank_account;
const wchar_t *bank_account_owner;
const wchar_t *bank_bic;
const wchar_t *bank_code;
const wchar_t *bank_iban;
const wchar_t *bank_name;
const wchar_t *birth_date;
const wchar_t *cash_allowance;
int cash_allowance_days;
const wchar_t *cash_discount;
const wchar_t *cash_discount_type;
const wchar_t *city;
const wchar_t *state;
const wchar_t *country;
const wchar_t *created_at;
const wchar_t *updated_at;
const wchar_t *delivery_title;
const wchar_t *delivery_city;
const wchar_t *delivery_state;
const wchar_t *delivery_company_name;
const wchar_t *delivery_country;
const wchar_t *delivery_first_name;
const wchar_t *delivery_last_name;
const wchar_t *delivery_personal;
int delivery_salutation;
const wchar_t *delivery_street;
const wchar_t *delivery_suffix_1;
const wchar_t *delivery_suffix_2;
const wchar_t *delivery_zip_code;
const wchar_t *display_name;
const wchar_t *fax;
const wchar_t *first_name;
const wchar_t *grace_period;
const wchar_t *due_in_days;
const wchar_t *group_id;
const wchar_t *id;
const wchar_t *info_1;
const wchar_t *info_2;
const wchar_t *internet;
const wchar_t *login_id;
const wchar_t *mobile;
const wchar_t *note;
const wchar_t *v_number;
int payment_options;
BOOL personal;
const wchar_t *phone_1;
const wchar_t *phone_2;
const wchar_t *postbox;
const wchar_t *postbox_city;
const wchar_t *postbox_state;
const wchar_t *postbox_country;
const wchar_t *postbox_zip_code;
const wchar_t *sale_price_level;
int salutation;
const wchar_t *sepa_agreement;
const wchar_t *sepa_agreement_date;
const wchar_t *sepa_mandate_reference;
const wchar_t *since_date;
const wchar_t *street;
const wchar_t *suffix_1;
const wchar_t *suffix_2;
const wchar_t *tax_number;
const wchar_t *court;
const wchar_t *court_registry_number;
const wchar_t *tax_options;
const wchar_t *title;
const wchar_t *archived;
const wchar_t *vat_identifier;
const wchar_t *zip_code;
const wchar_t *document_pdf_type;
const wchar_t *buyer_reference;
const wchar_t *foreign_supplier_number;
int j;
int count_j;
const wchar_t *strVal;
const wchar_t *page;
const wchar_t *pages;
const wchar_t *limit;
const wchar_t *total;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"limit",L"<integer>");
CkJsonObjectW_UpdateString(queryParams,L"page",L"<integer>");
CkJsonObjectW_UpdateString(queryParams,L"group_id",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"additional_group_id",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"number",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"country",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"zip_code",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"emails",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"first_name",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"last_name",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"company_name",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"created_at",L"<string>");
CkHttpW_SetRequestHeader(http,L"Authorization",L"{{apiKey}}");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.easybill.de/rest/v1/customers",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "page": "<integer>",
// "pages": "<integer>",
// "limit": "<integer>",
// "total": "<integer>",
// "items": [
// {
// "last_name": "<string>",
// "company_name": "<string>",
// "acquire_options": 7,
// "additional_groups_ids": [
// "<integer>",
// "<integer>"
// ],
// "bank_account": "<string>",
// "bank_account_owner": "<string>",
// "bank_bic": "<string>",
// "bank_code": "<string>",
// "bank_iban": "<string>",
// "bank_name": "<string>",
// "birth_date": "<date>",
// "cash_allowance": "<float>",
// "cash_allowance_days": 7,
// "cash_discount": "<float>",
// "cash_discount_type": "PERCENT",
// "city": "<string>",
// "state": "<string>",
// "country": "<string>",
// "created_at": "<date>",
// "updated_at": "<string>",
// "delivery_title": "<string>",
// "delivery_city": "<string>",
// "delivery_state": "<string>",
// "delivery_company_name": "<string>",
// "delivery_country": "<string>",
// "delivery_first_name": "<string>",
// "delivery_last_name": "<string>",
// "delivery_personal": "<boolean>",
// "delivery_salutation": 0,
// "delivery_street": "<string>",
// "delivery_suffix_1": "<string>",
// "delivery_suffix_2": "<string>",
// "delivery_zip_code": "<string>",
// "display_name": "<string>",
// "emails": [
// "<string>",
// "<string>"
// ],
// "fax": "<string>",
// "first_name": "<string>",
// "grace_period": "<integer>",
// "due_in_days": "<integer>",
// "group_id": "<integer>",
// "id": "<long>",
// "info_1": "<string>",
// "info_2": "<string>",
// "internet": "<string>",
// "login_id": "<long>",
// "mobile": "<string>",
// "note": "<string>",
// "number": "<string>",
// "payment_options": 3,
// "personal": false,
// "phone_1": "<string>",
// "phone_2": "<string>",
// "postbox": "<string>",
// "postbox_city": "<string>",
// "postbox_state": "<string>",
// "postbox_country": "<string>",
// "postbox_zip_code": "<string>",
// "sale_price_level": "SALEPRICE10",
// "salutation": 0,
// "sepa_agreement": "COR1",
// "sepa_agreement_date": "<date>",
// "sepa_mandate_reference": "<string>",
// "since_date": "<date>",
// "street": "<string>",
// "suffix_1": "<string>",
// "suffix_2": "<string>",
// "tax_number": "<string>",
// "court": "<string>",
// "court_registry_number": "<string>",
// "tax_options": "sStfr",
// "title": "<string>",
// "archived": "<boolean>",
// "vat_identifier": "<string>",
// "zip_code": "<string>",
// "document_pdf_type": "default",
// "buyer_reference": "<string>",
// "foreign_supplier_number": "<string>"
// },
// {
// "last_name": "<string>",
// "company_name": "<string>",
// "acquire_options": 7,
// "additional_groups_ids": [
// "<integer>",
// "<integer>"
// ],
// "bank_account": "<string>",
// "bank_account_owner": "<string>",
// "bank_bic": "<string>",
// "bank_code": "<string>",
// "bank_iban": "<string>",
// "bank_name": "<string>",
// "birth_date": "<date>",
// "cash_allowance": "<float>",
// "cash_allowance_days": 7,
// "cash_discount": "<float>",
// "cash_discount_type": "PERCENT",
// "city": "<string>",
// "state": "<string>",
// "country": "<string>",
// "created_at": "<date>",
// "updated_at": "<string>",
// "delivery_title": "<string>",
// "delivery_city": "<string>",
// "delivery_state": "<string>",
// "delivery_company_name": "<string>",
// "delivery_country": "<string>",
// "delivery_first_name": "<string>",
// "delivery_last_name": "<string>",
// "delivery_personal": "<boolean>",
// "delivery_salutation": 0,
// "delivery_street": "<string>",
// "delivery_suffix_1": "<string>",
// "delivery_suffix_2": "<string>",
// "delivery_zip_code": "<string>",
// "display_name": "<string>",
// "emails": [
// "<string>",
// "<string>"
// ],
// "fax": "<string>",
// "first_name": "<string>",
// "grace_period": "<integer>",
// "due_in_days": "<integer>",
// "group_id": "<integer>",
// "id": "<long>",
// "info_1": "<string>",
// "info_2": "<string>",
// "internet": "<string>",
// "login_id": "<long>",
// "mobile": "<string>",
// "note": "<string>",
// "number": "<string>",
// "payment_options": 3,
// "personal": false,
// "phone_1": "<string>",
// "phone_2": "<string>",
// "postbox": "<string>",
// "postbox_city": "<string>",
// "postbox_state": "<string>",
// "postbox_country": "<string>",
// "postbox_zip_code": "<string>",
// "sale_price_level": "SALEPRICE6",
// "salutation": 0,
// "sepa_agreement": "NULL",
// "sepa_agreement_date": "<date>",
// "sepa_mandate_reference": "<string>",
// "since_date": "<date>",
// "street": "<string>",
// "suffix_1": "<string>",
// "suffix_2": "<string>",
// "tax_number": "<string>",
// "court": "<string>",
// "court_registry_number": "<string>",
// "tax_options": "nStb",
// "title": "<string>",
// "archived": "<boolean>",
// "vat_identifier": "<string>",
// "zip_code": "<string>",
// "document_pdf_type": "default",
// "buyer_reference": "<string>",
// "foreign_supplier_number": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
page = CkJsonObjectW_stringOf(jResp,L"page");
pages = CkJsonObjectW_stringOf(jResp,L"pages");
limit = CkJsonObjectW_stringOf(jResp,L"limit");
total = CkJsonObjectW_stringOf(jResp,L"total");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"items");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
last_name = CkJsonObjectW_stringOf(jResp,L"items[i].last_name");
company_name = CkJsonObjectW_stringOf(jResp,L"items[i].company_name");
acquire_options = CkJsonObjectW_IntOf(jResp,L"items[i].acquire_options");
bank_account = CkJsonObjectW_stringOf(jResp,L"items[i].bank_account");
bank_account_owner = CkJsonObjectW_stringOf(jResp,L"items[i].bank_account_owner");
bank_bic = CkJsonObjectW_stringOf(jResp,L"items[i].bank_bic");
bank_code = CkJsonObjectW_stringOf(jResp,L"items[i].bank_code");
bank_iban = CkJsonObjectW_stringOf(jResp,L"items[i].bank_iban");
bank_name = CkJsonObjectW_stringOf(jResp,L"items[i].bank_name");
birth_date = CkJsonObjectW_stringOf(jResp,L"items[i].birth_date");
cash_allowance = CkJsonObjectW_stringOf(jResp,L"items[i].cash_allowance");
cash_allowance_days = CkJsonObjectW_IntOf(jResp,L"items[i].cash_allowance_days");
cash_discount = CkJsonObjectW_stringOf(jResp,L"items[i].cash_discount");
cash_discount_type = CkJsonObjectW_stringOf(jResp,L"items[i].cash_discount_type");
city = CkJsonObjectW_stringOf(jResp,L"items[i].city");
state = CkJsonObjectW_stringOf(jResp,L"items[i].state");
country = CkJsonObjectW_stringOf(jResp,L"items[i].country");
created_at = CkJsonObjectW_stringOf(jResp,L"items[i].created_at");
updated_at = CkJsonObjectW_stringOf(jResp,L"items[i].updated_at");
delivery_title = CkJsonObjectW_stringOf(jResp,L"items[i].delivery_title");
delivery_city = CkJsonObjectW_stringOf(jResp,L"items[i].delivery_city");
delivery_state = CkJsonObjectW_stringOf(jResp,L"items[i].delivery_state");
delivery_company_name = CkJsonObjectW_stringOf(jResp,L"items[i].delivery_company_name");
delivery_country = CkJsonObjectW_stringOf(jResp,L"items[i].delivery_country");
delivery_first_name = CkJsonObjectW_stringOf(jResp,L"items[i].delivery_first_name");
delivery_last_name = CkJsonObjectW_stringOf(jResp,L"items[i].delivery_last_name");
delivery_personal = CkJsonObjectW_stringOf(jResp,L"items[i].delivery_personal");
delivery_salutation = CkJsonObjectW_IntOf(jResp,L"items[i].delivery_salutation");
delivery_street = CkJsonObjectW_stringOf(jResp,L"items[i].delivery_street");
delivery_suffix_1 = CkJsonObjectW_stringOf(jResp,L"items[i].delivery_suffix_1");
delivery_suffix_2 = CkJsonObjectW_stringOf(jResp,L"items[i].delivery_suffix_2");
delivery_zip_code = CkJsonObjectW_stringOf(jResp,L"items[i].delivery_zip_code");
display_name = CkJsonObjectW_stringOf(jResp,L"items[i].display_name");
fax = CkJsonObjectW_stringOf(jResp,L"items[i].fax");
first_name = CkJsonObjectW_stringOf(jResp,L"items[i].first_name");
grace_period = CkJsonObjectW_stringOf(jResp,L"items[i].grace_period");
due_in_days = CkJsonObjectW_stringOf(jResp,L"items[i].due_in_days");
group_id = CkJsonObjectW_stringOf(jResp,L"items[i].group_id");
id = CkJsonObjectW_stringOf(jResp,L"items[i].id");
info_1 = CkJsonObjectW_stringOf(jResp,L"items[i].info_1");
info_2 = CkJsonObjectW_stringOf(jResp,L"items[i].info_2");
internet = CkJsonObjectW_stringOf(jResp,L"items[i].internet");
login_id = CkJsonObjectW_stringOf(jResp,L"items[i].login_id");
mobile = CkJsonObjectW_stringOf(jResp,L"items[i].mobile");
note = CkJsonObjectW_stringOf(jResp,L"items[i].note");
v_number = CkJsonObjectW_stringOf(jResp,L"items[i].number");
payment_options = CkJsonObjectW_IntOf(jResp,L"items[i].payment_options");
personal = CkJsonObjectW_BoolOf(jResp,L"items[i].personal");
phone_1 = CkJsonObjectW_stringOf(jResp,L"items[i].phone_1");
phone_2 = CkJsonObjectW_stringOf(jResp,L"items[i].phone_2");
postbox = CkJsonObjectW_stringOf(jResp,L"items[i].postbox");
postbox_city = CkJsonObjectW_stringOf(jResp,L"items[i].postbox_city");
postbox_state = CkJsonObjectW_stringOf(jResp,L"items[i].postbox_state");
postbox_country = CkJsonObjectW_stringOf(jResp,L"items[i].postbox_country");
postbox_zip_code = CkJsonObjectW_stringOf(jResp,L"items[i].postbox_zip_code");
sale_price_level = CkJsonObjectW_stringOf(jResp,L"items[i].sale_price_level");
salutation = CkJsonObjectW_IntOf(jResp,L"items[i].salutation");
sepa_agreement = CkJsonObjectW_stringOf(jResp,L"items[i].sepa_agreement");
sepa_agreement_date = CkJsonObjectW_stringOf(jResp,L"items[i].sepa_agreement_date");
sepa_mandate_reference = CkJsonObjectW_stringOf(jResp,L"items[i].sepa_mandate_reference");
since_date = CkJsonObjectW_stringOf(jResp,L"items[i].since_date");
street = CkJsonObjectW_stringOf(jResp,L"items[i].street");
suffix_1 = CkJsonObjectW_stringOf(jResp,L"items[i].suffix_1");
suffix_2 = CkJsonObjectW_stringOf(jResp,L"items[i].suffix_2");
tax_number = CkJsonObjectW_stringOf(jResp,L"items[i].tax_number");
court = CkJsonObjectW_stringOf(jResp,L"items[i].court");
court_registry_number = CkJsonObjectW_stringOf(jResp,L"items[i].court_registry_number");
tax_options = CkJsonObjectW_stringOf(jResp,L"items[i].tax_options");
title = CkJsonObjectW_stringOf(jResp,L"items[i].title");
archived = CkJsonObjectW_stringOf(jResp,L"items[i].archived");
vat_identifier = CkJsonObjectW_stringOf(jResp,L"items[i].vat_identifier");
zip_code = CkJsonObjectW_stringOf(jResp,L"items[i].zip_code");
document_pdf_type = CkJsonObjectW_stringOf(jResp,L"items[i].document_pdf_type");
buyer_reference = CkJsonObjectW_stringOf(jResp,L"items[i].buyer_reference");
foreign_supplier_number = CkJsonObjectW_stringOf(jResp,L"items[i].foreign_supplier_number");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"items[i].additional_groups_ids");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
strVal = CkJsonObjectW_stringOf(jResp,L"items[i].additional_groups_ids[j]");
j = j + 1;
}
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"items[i].emails");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
strVal = CkJsonObjectW_stringOf(jResp,L"items[i].emails[j]");
j = j + 1;
}
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -G -d "limit=%3Cinteger%3E"
-d "page=%3Cinteger%3E"
-d "group_id=%3Cstring%3E"
-d "additional_group_id=%3Cstring%3E"
-d "number=%3Cstring%3E"
-d "country=%3Cstring%3E"
-d "zip_code=%3Cstring%3E"
-d "emails=%3Cstring%3E"
-d "first_name=%3Cstring%3E"
-d "last_name=%3Cstring%3E"
-d "company_name=%3Cstring%3E"
-d "created_at=%3Cstring%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/customers
Postman Collection Item JSON
{
"name": "Fetch customers list",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/customers?limit=<integer>&page=<integer>&group_id=<string>&additional_group_id=<string>&number=<string>&country=<string>&zip_code=<string>&emails=<string>&first_name=<string>&last_name=<string>&company_name=<string>&created_at=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"customers"
],
"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": "group_id",
"value": "<string>",
"description": "Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "additional_group_id",
"value": "<string>",
"description": "Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "number",
"value": "<string>",
"description": "Filter customers by number. You can add multiple numbers separate by comma like no,no,no."
},
{
"key": "country",
"value": "<string>",
"description": "Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR."
},
{
"key": "zip_code",
"value": "<string>",
"description": "Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip."
},
{
"key": "emails",
"value": "<string>",
"description": "Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail."
},
{
"key": "first_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "last_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "company_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "created_at",
"value": "<string>",
"description": "Filter customers by created_at. You can filter one date with created_at=2014-12-10 or between like 2015-01-01,2015-12-31."
}
]
}
},
"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}}/customers?limit=<integer>&page=<integer>&group_id=<string>&additional_group_id=<string>&number=<string>&country=<string>&zip_code=<string>&emails=<string>&first_name=<string>&last_name=<string>&company_name=<string>&created_at=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"customers"
],
"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": "group_id",
"value": "<string>",
"description": "Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "additional_group_id",
"value": "<string>",
"description": "Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "number",
"value": "<string>",
"description": "Filter customers by number. You can add multiple numbers separate by comma like no,no,no."
},
{
"key": "country",
"value": "<string>",
"description": "Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR."
},
{
"key": "zip_code",
"value": "<string>",
"description": "Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip."
},
{
"key": "emails",
"value": "<string>",
"description": "Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail."
},
{
"key": "first_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "last_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "company_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "created_at",
"value": "<string>",
"description": "Filter customers by created_at. You can filter one date with created_at=2014-12-10 or between like 2015-01-01,2015-12-31."
}
]
}
},
"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 \"last_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"acquire_options\": 7,\n \"additional_groups_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"bank_account\": \"<string>\",\n \"bank_account_owner\": \"<string>\",\n \"bank_bic\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_iban\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"birth_date\": \"<date>\",\n \"cash_allowance\": \"<float>\",\n \"cash_allowance_days\": 7,\n \"cash_discount\": \"<float>\",\n \"cash_discount_type\": \"PERCENT\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"created_at\": \"<date>\",\n \"updated_at\": \"<string>\",\n \"delivery_title\": \"<string>\",\n \"delivery_city\": \"<string>\",\n \"delivery_state\": \"<string>\",\n \"delivery_company_name\": \"<string>\",\n \"delivery_country\": \"<string>\",\n \"delivery_first_name\": \"<string>\",\n \"delivery_last_name\": \"<string>\",\n \"delivery_personal\": \"<boolean>\",\n \"delivery_salutation\": 0,\n \"delivery_street\": \"<string>\",\n \"delivery_suffix_1\": \"<string>\",\n \"delivery_suffix_2\": \"<string>\",\n \"delivery_zip_code\": \"<string>\",\n \"display_name\": \"<string>\",\n \"emails\": [\n \"<string>\",\n \"<string>\"\n ],\n \"fax\": \"<string>\",\n \"first_name\": \"<string>\",\n \"grace_period\": \"<integer>\",\n \"due_in_days\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<long>\",\n \"info_1\": \"<string>\",\n \"info_2\": \"<string>\",\n \"internet\": \"<string>\",\n \"login_id\": \"<long>\",\n \"mobile\": \"<string>\",\n \"note\": \"<string>\",\n \"number\": \"<string>\",\n \"payment_options\": 3,\n \"personal\": false,\n \"phone_1\": \"<string>\",\n \"phone_2\": \"<string>\",\n \"postbox\": \"<string>\",\n \"postbox_city\": \"<string>\",\n \"postbox_state\": \"<string>\",\n \"postbox_country\": \"<string>\",\n \"postbox_zip_code\": \"<string>\",\n \"sale_price_level\": \"SALEPRICE10\",\n \"salutation\": 0,\n \"sepa_agreement\": \"COR1\",\n \"sepa_agreement_date\": \"<date>\",\n \"sepa_mandate_reference\": \"<string>\",\n \"since_date\": \"<date>\",\n \"street\": \"<string>\",\n \"suffix_1\": \"<string>\",\n \"suffix_2\": \"<string>\",\n \"tax_number\": \"<string>\",\n \"court\": \"<string>\",\n \"court_registry_number\": \"<string>\",\n \"tax_options\": \"sStfr\",\n \"title\": \"<string>\",\n \"archived\": \"<boolean>\",\n \"vat_identifier\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"document_pdf_type\": \"default\",\n \"buyer_reference\": \"<string>\",\n \"foreign_supplier_number\": \"<string>\"\n },\n {\n \"last_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"acquire_options\": 7,\n \"additional_groups_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"bank_account\": \"<string>\",\n \"bank_account_owner\": \"<string>\",\n \"bank_bic\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_iban\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"birth_date\": \"<date>\",\n \"cash_allowance\": \"<float>\",\n \"cash_allowance_days\": 7,\n \"cash_discount\": \"<float>\",\n \"cash_discount_type\": \"PERCENT\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"created_at\": \"<date>\",\n \"updated_at\": \"<string>\",\n \"delivery_title\": \"<string>\",\n \"delivery_city\": \"<string>\",\n \"delivery_state\": \"<string>\",\n \"delivery_company_name\": \"<string>\",\n \"delivery_country\": \"<string>\",\n \"delivery_first_name\": \"<string>\",\n \"delivery_last_name\": \"<string>\",\n \"delivery_personal\": \"<boolean>\",\n \"delivery_salutation\": 0,\n \"delivery_street\": \"<string>\",\n \"delivery_suffix_1\": \"<string>\",\n \"delivery_suffix_2\": \"<string>\",\n \"delivery_zip_code\": \"<string>\",\n \"display_name\": \"<string>\",\n \"emails\": [\n \"<string>\",\n \"<string>\"\n ],\n \"fax\": \"<string>\",\n \"first_name\": \"<string>\",\n \"grace_period\": \"<integer>\",\n \"due_in_days\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<long>\",\n \"info_1\": \"<string>\",\n \"info_2\": \"<string>\",\n \"internet\": \"<string>\",\n \"login_id\": \"<long>\",\n \"mobile\": \"<string>\",\n \"note\": \"<string>\",\n \"number\": \"<string>\",\n \"payment_options\": 3,\n \"personal\": false,\n \"phone_1\": \"<string>\",\n \"phone_2\": \"<string>\",\n \"postbox\": \"<string>\",\n \"postbox_city\": \"<string>\",\n \"postbox_state\": \"<string>\",\n \"postbox_country\": \"<string>\",\n \"postbox_zip_code\": \"<string>\",\n \"sale_price_level\": \"SALEPRICE6\",\n \"salutation\": 0,\n \"sepa_agreement\": \"NULL\",\n \"sepa_agreement_date\": \"<date>\",\n \"sepa_mandate_reference\": \"<string>\",\n \"since_date\": \"<date>\",\n \"street\": \"<string>\",\n \"suffix_1\": \"<string>\",\n \"suffix_2\": \"<string>\",\n \"tax_number\": \"<string>\",\n \"court\": \"<string>\",\n \"court_registry_number\": \"<string>\",\n \"tax_options\": \"nStb\",\n \"title\": \"<string>\",\n \"archived\": \"<boolean>\",\n \"vat_identifier\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"document_pdf_type\": \"default\",\n \"buyer_reference\": \"<string>\",\n \"foreign_supplier_number\": \"<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}}/customers?limit=<integer>&page=<integer>&group_id=<string>&additional_group_id=<string>&number=<string>&country=<string>&zip_code=<string>&emails=<string>&first_name=<string>&last_name=<string>&company_name=<string>&created_at=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"customers"
],
"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": "group_id",
"value": "<string>",
"description": "Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "additional_group_id",
"value": "<string>",
"description": "Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "number",
"value": "<string>",
"description": "Filter customers by number. You can add multiple numbers separate by comma like no,no,no."
},
{
"key": "country",
"value": "<string>",
"description": "Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR."
},
{
"key": "zip_code",
"value": "<string>",
"description": "Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip."
},
{
"key": "emails",
"value": "<string>",
"description": "Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail."
},
{
"key": "first_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "last_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "company_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "created_at",
"value": "<string>",
"description": "Filter customers by created_at. You can filter one date with created_at=2014-12-10 or between like 2015-01-01,2015-12-31."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
