PureBasic / easybill REST API / Fetch customers list
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"limit","<integer>")
CkJsonObject::ckUpdateString(queryParams,"page","<integer>")
CkJsonObject::ckUpdateString(queryParams,"group_id","<string>")
CkJsonObject::ckUpdateString(queryParams,"additional_group_id","<string>")
CkJsonObject::ckUpdateString(queryParams,"number","<string>")
CkJsonObject::ckUpdateString(queryParams,"country","<string>")
CkJsonObject::ckUpdateString(queryParams,"zip_code","<string>")
CkJsonObject::ckUpdateString(queryParams,"emails","<string>")
CkJsonObject::ckUpdateString(queryParams,"first_name","<string>")
CkJsonObject::ckUpdateString(queryParams,"last_name","<string>")
CkJsonObject::ckUpdateString(queryParams,"company_name","<string>")
CkJsonObject::ckUpdateString(queryParams,"created_at","<string>")
CkHttp::ckSetRequestHeader(http,"Authorization","{{apiKey}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.easybill.de/rest/v1/customers",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
last_name.s
company_name.s
acquire_options.i
bank_account.s
bank_account_owner.s
bank_bic.s
bank_code.s
bank_iban.s
bank_name.s
birth_date.s
cash_allowance.s
cash_allowance_days.i
cash_discount.s
cash_discount_type.s
city.s
state.s
country.s
created_at.s
updated_at.s
delivery_title.s
delivery_city.s
delivery_state.s
delivery_company_name.s
delivery_country.s
delivery_first_name.s
delivery_last_name.s
delivery_personal.s
delivery_salutation.i
delivery_street.s
delivery_suffix_1.s
delivery_suffix_2.s
delivery_zip_code.s
display_name.s
fax.s
first_name.s
grace_period.s
due_in_days.s
group_id.s
id.s
info_1.s
info_2.s
internet.s
login_id.s
mobile.s
note.s
v_number.s
payment_options.i
personal.i
phone_1.s
phone_2.s
postbox.s
postbox_city.s
postbox_state.s
postbox_country.s
postbox_zip_code.s
sale_price_level.s
salutation.i
sepa_agreement.s
sepa_agreement_date.s
sepa_mandate_reference.s
since_date.s
street.s
suffix_1.s
suffix_2.s
tax_number.s
court.s
court_registry_number.s
tax_options.s
title.s
archived.s
vat_identifier.s
zip_code.s
document_pdf_type.s
buyer_reference.s
foreign_supplier_number.s
j.i
count_j.i
strVal.s
page.s = CkJsonObject::ckStringOf(jResp,"page")
pages.s = CkJsonObject::ckStringOf(jResp,"pages")
limit.s = CkJsonObject::ckStringOf(jResp,"limit")
total.s = CkJsonObject::ckStringOf(jResp,"total")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"items")
While i < count_i
CkJsonObject::setCkI(jResp, i)
last_name = CkJsonObject::ckStringOf(jResp,"items[i].last_name")
company_name = CkJsonObject::ckStringOf(jResp,"items[i].company_name")
acquire_options = CkJsonObject::ckIntOf(jResp,"items[i].acquire_options")
bank_account = CkJsonObject::ckStringOf(jResp,"items[i].bank_account")
bank_account_owner = CkJsonObject::ckStringOf(jResp,"items[i].bank_account_owner")
bank_bic = CkJsonObject::ckStringOf(jResp,"items[i].bank_bic")
bank_code = CkJsonObject::ckStringOf(jResp,"items[i].bank_code")
bank_iban = CkJsonObject::ckStringOf(jResp,"items[i].bank_iban")
bank_name = CkJsonObject::ckStringOf(jResp,"items[i].bank_name")
birth_date = CkJsonObject::ckStringOf(jResp,"items[i].birth_date")
cash_allowance = CkJsonObject::ckStringOf(jResp,"items[i].cash_allowance")
cash_allowance_days = CkJsonObject::ckIntOf(jResp,"items[i].cash_allowance_days")
cash_discount = CkJsonObject::ckStringOf(jResp,"items[i].cash_discount")
cash_discount_type = CkJsonObject::ckStringOf(jResp,"items[i].cash_discount_type")
city = CkJsonObject::ckStringOf(jResp,"items[i].city")
state = CkJsonObject::ckStringOf(jResp,"items[i].state")
country = CkJsonObject::ckStringOf(jResp,"items[i].country")
created_at = CkJsonObject::ckStringOf(jResp,"items[i].created_at")
updated_at = CkJsonObject::ckStringOf(jResp,"items[i].updated_at")
delivery_title = CkJsonObject::ckStringOf(jResp,"items[i].delivery_title")
delivery_city = CkJsonObject::ckStringOf(jResp,"items[i].delivery_city")
delivery_state = CkJsonObject::ckStringOf(jResp,"items[i].delivery_state")
delivery_company_name = CkJsonObject::ckStringOf(jResp,"items[i].delivery_company_name")
delivery_country = CkJsonObject::ckStringOf(jResp,"items[i].delivery_country")
delivery_first_name = CkJsonObject::ckStringOf(jResp,"items[i].delivery_first_name")
delivery_last_name = CkJsonObject::ckStringOf(jResp,"items[i].delivery_last_name")
delivery_personal = CkJsonObject::ckStringOf(jResp,"items[i].delivery_personal")
delivery_salutation = CkJsonObject::ckIntOf(jResp,"items[i].delivery_salutation")
delivery_street = CkJsonObject::ckStringOf(jResp,"items[i].delivery_street")
delivery_suffix_1 = CkJsonObject::ckStringOf(jResp,"items[i].delivery_suffix_1")
delivery_suffix_2 = CkJsonObject::ckStringOf(jResp,"items[i].delivery_suffix_2")
delivery_zip_code = CkJsonObject::ckStringOf(jResp,"items[i].delivery_zip_code")
display_name = CkJsonObject::ckStringOf(jResp,"items[i].display_name")
fax = CkJsonObject::ckStringOf(jResp,"items[i].fax")
first_name = CkJsonObject::ckStringOf(jResp,"items[i].first_name")
grace_period = CkJsonObject::ckStringOf(jResp,"items[i].grace_period")
due_in_days = CkJsonObject::ckStringOf(jResp,"items[i].due_in_days")
group_id = CkJsonObject::ckStringOf(jResp,"items[i].group_id")
id = CkJsonObject::ckStringOf(jResp,"items[i].id")
info_1 = CkJsonObject::ckStringOf(jResp,"items[i].info_1")
info_2 = CkJsonObject::ckStringOf(jResp,"items[i].info_2")
internet = CkJsonObject::ckStringOf(jResp,"items[i].internet")
login_id = CkJsonObject::ckStringOf(jResp,"items[i].login_id")
mobile = CkJsonObject::ckStringOf(jResp,"items[i].mobile")
note = CkJsonObject::ckStringOf(jResp,"items[i].note")
v_number = CkJsonObject::ckStringOf(jResp,"items[i].number")
payment_options = CkJsonObject::ckIntOf(jResp,"items[i].payment_options")
personal = CkJsonObject::ckBoolOf(jResp,"items[i].personal")
phone_1 = CkJsonObject::ckStringOf(jResp,"items[i].phone_1")
phone_2 = CkJsonObject::ckStringOf(jResp,"items[i].phone_2")
postbox = CkJsonObject::ckStringOf(jResp,"items[i].postbox")
postbox_city = CkJsonObject::ckStringOf(jResp,"items[i].postbox_city")
postbox_state = CkJsonObject::ckStringOf(jResp,"items[i].postbox_state")
postbox_country = CkJsonObject::ckStringOf(jResp,"items[i].postbox_country")
postbox_zip_code = CkJsonObject::ckStringOf(jResp,"items[i].postbox_zip_code")
sale_price_level = CkJsonObject::ckStringOf(jResp,"items[i].sale_price_level")
salutation = CkJsonObject::ckIntOf(jResp,"items[i].salutation")
sepa_agreement = CkJsonObject::ckStringOf(jResp,"items[i].sepa_agreement")
sepa_agreement_date = CkJsonObject::ckStringOf(jResp,"items[i].sepa_agreement_date")
sepa_mandate_reference = CkJsonObject::ckStringOf(jResp,"items[i].sepa_mandate_reference")
since_date = CkJsonObject::ckStringOf(jResp,"items[i].since_date")
street = CkJsonObject::ckStringOf(jResp,"items[i].street")
suffix_1 = CkJsonObject::ckStringOf(jResp,"items[i].suffix_1")
suffix_2 = CkJsonObject::ckStringOf(jResp,"items[i].suffix_2")
tax_number = CkJsonObject::ckStringOf(jResp,"items[i].tax_number")
court = CkJsonObject::ckStringOf(jResp,"items[i].court")
court_registry_number = CkJsonObject::ckStringOf(jResp,"items[i].court_registry_number")
tax_options = CkJsonObject::ckStringOf(jResp,"items[i].tax_options")
title = CkJsonObject::ckStringOf(jResp,"items[i].title")
archived = CkJsonObject::ckStringOf(jResp,"items[i].archived")
vat_identifier = CkJsonObject::ckStringOf(jResp,"items[i].vat_identifier")
zip_code = CkJsonObject::ckStringOf(jResp,"items[i].zip_code")
document_pdf_type = CkJsonObject::ckStringOf(jResp,"items[i].document_pdf_type")
buyer_reference = CkJsonObject::ckStringOf(jResp,"items[i].buyer_reference")
foreign_supplier_number = CkJsonObject::ckStringOf(jResp,"items[i].foreign_supplier_number")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"items[i].additional_groups_ids")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"items[i].additional_groups_ids[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"items[i].emails")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"items[i].emails[j]")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
