Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("limit","<integer>")
loQueryParams.UpdateString("page","<integer>")
loQueryParams.UpdateString("group_id","<string>")
loQueryParams.UpdateString("additional_group_id","<string>")
loQueryParams.UpdateString("number","<string>")
loQueryParams.UpdateString("country","<string>")
loQueryParams.UpdateString("zip_code","<string>")
loQueryParams.UpdateString("emails","<string>")
loQueryParams.UpdateString("first_name","<string>")
loQueryParams.UpdateString("last_name","<string>")
loQueryParams.UpdateString("company_name","<string>")
loQueryParams.UpdateString("created_at","<string>")
loHttp.SetRequestHeader("Authorization","{{apiKey}}")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api.easybill.de/rest/v1/customers",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
lcPage = loJResp.StringOf("page")
lcPages = loJResp.StringOf("pages")
lcLimit = loJResp.StringOf("limit")
lcTotal = loJResp.StringOf("total")
i = 0
lnCount_i = loJResp.SizeOfArray("items")
do while i < lnCount_i
loJResp.I = i
lcLast_name = loJResp.StringOf("items[i].last_name")
lcCompany_name = loJResp.StringOf("items[i].company_name")
lnAcquire_options = loJResp.IntOf("items[i].acquire_options")
lcBank_account = loJResp.StringOf("items[i].bank_account")
lcBank_account_owner = loJResp.StringOf("items[i].bank_account_owner")
lcBank_bic = loJResp.StringOf("items[i].bank_bic")
lcBank_code = loJResp.StringOf("items[i].bank_code")
lcBank_iban = loJResp.StringOf("items[i].bank_iban")
lcBank_name = loJResp.StringOf("items[i].bank_name")
lcBirth_date = loJResp.StringOf("items[i].birth_date")
lcCash_allowance = loJResp.StringOf("items[i].cash_allowance")
lnCash_allowance_days = loJResp.IntOf("items[i].cash_allowance_days")
lcCash_discount = loJResp.StringOf("items[i].cash_discount")
lcCash_discount_type = loJResp.StringOf("items[i].cash_discount_type")
lcCity = loJResp.StringOf("items[i].city")
lcState = loJResp.StringOf("items[i].state")
lcCountry = loJResp.StringOf("items[i].country")
lcCreated_at = loJResp.StringOf("items[i].created_at")
lcUpdated_at = loJResp.StringOf("items[i].updated_at")
lcDelivery_title = loJResp.StringOf("items[i].delivery_title")
lcDelivery_city = loJResp.StringOf("items[i].delivery_city")
lcDelivery_state = loJResp.StringOf("items[i].delivery_state")
lcDelivery_company_name = loJResp.StringOf("items[i].delivery_company_name")
lcDelivery_country = loJResp.StringOf("items[i].delivery_country")
lcDelivery_first_name = loJResp.StringOf("items[i].delivery_first_name")
lcDelivery_last_name = loJResp.StringOf("items[i].delivery_last_name")
lcDelivery_personal = loJResp.StringOf("items[i].delivery_personal")
lnDelivery_salutation = loJResp.IntOf("items[i].delivery_salutation")
lcDelivery_street = loJResp.StringOf("items[i].delivery_street")
lcDelivery_suffix_1 = loJResp.StringOf("items[i].delivery_suffix_1")
lcDelivery_suffix_2 = loJResp.StringOf("items[i].delivery_suffix_2")
lcDelivery_zip_code = loJResp.StringOf("items[i].delivery_zip_code")
lcDisplay_name = loJResp.StringOf("items[i].display_name")
lcFax = loJResp.StringOf("items[i].fax")
lcFirst_name = loJResp.StringOf("items[i].first_name")
lcGrace_period = loJResp.StringOf("items[i].grace_period")
lcDue_in_days = loJResp.StringOf("items[i].due_in_days")
lcGroup_id = loJResp.StringOf("items[i].group_id")
lcId = loJResp.StringOf("items[i].id")
lcInfo_1 = loJResp.StringOf("items[i].info_1")
lcInfo_2 = loJResp.StringOf("items[i].info_2")
lcInternet = loJResp.StringOf("items[i].internet")
lcLogin_id = loJResp.StringOf("items[i].login_id")
lcMobile = loJResp.StringOf("items[i].mobile")
lcNote = loJResp.StringOf("items[i].note")
lcV_number = loJResp.StringOf("items[i].number")
lnPayment_options = loJResp.IntOf("items[i].payment_options")
llPersonal = loJResp.BoolOf("items[i].personal")
lcPhone_1 = loJResp.StringOf("items[i].phone_1")
lcPhone_2 = loJResp.StringOf("items[i].phone_2")
lcPostbox = loJResp.StringOf("items[i].postbox")
lcPostbox_city = loJResp.StringOf("items[i].postbox_city")
lcPostbox_state = loJResp.StringOf("items[i].postbox_state")
lcPostbox_country = loJResp.StringOf("items[i].postbox_country")
lcPostbox_zip_code = loJResp.StringOf("items[i].postbox_zip_code")
lcSale_price_level = loJResp.StringOf("items[i].sale_price_level")
lnSalutation = loJResp.IntOf("items[i].salutation")
lcSepa_agreement = loJResp.StringOf("items[i].sepa_agreement")
lcSepa_agreement_date = loJResp.StringOf("items[i].sepa_agreement_date")
lcSepa_mandate_reference = loJResp.StringOf("items[i].sepa_mandate_reference")
lcSince_date = loJResp.StringOf("items[i].since_date")
lcStreet = loJResp.StringOf("items[i].street")
lcSuffix_1 = loJResp.StringOf("items[i].suffix_1")
lcSuffix_2 = loJResp.StringOf("items[i].suffix_2")
lcTax_number = loJResp.StringOf("items[i].tax_number")
lcCourt = loJResp.StringOf("items[i].court")
lcCourt_registry_number = loJResp.StringOf("items[i].court_registry_number")
lcTax_options = loJResp.StringOf("items[i].tax_options")
lcTitle = loJResp.StringOf("items[i].title")
lcArchived = loJResp.StringOf("items[i].archived")
lcVat_identifier = loJResp.StringOf("items[i].vat_identifier")
lcZip_code = loJResp.StringOf("items[i].zip_code")
lcDocument_pdf_type = loJResp.StringOf("items[i].document_pdf_type")
lcBuyer_reference = loJResp.StringOf("items[i].buyer_reference")
lcForeign_supplier_number = loJResp.StringOf("items[i].foreign_supplier_number")
j = 0
lnCount_j = loJResp.SizeOfArray("items[i].additional_groups_ids")
do while j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("items[i].additional_groups_ids[j]")
j = j + 1
enddo
j = 0
lnCount_j = loJResp.SizeOfArray("items[i].emails")
do while j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("items[i].emails[j]")
j = j + 1
enddo
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
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": ""
}
]
}
