Qodex.ai

Get all customers

GET https://api.ecartapi.com/api/v2/customers

FILTERS

FilterDescription
idsFilter cutomers by Id's provided
limitLimit size of the search
pagePagination number.
sinceIdFilter customers since the Id given
createdAt[from]Filter customers by date created from. When used createdAt[to]Required
createdAt[to]Filter customers by date created to. When used createdAt[from]Required
updatedAt[from]Filter customers by date updated from. When used updatedAt[to]Required
updatedAt[to]Filter customers by date updated to. When used updatedAt[from]Required
nameFilter categories by name
searchSearch by string
emailSearch customers by email
offsetLower limit of the results block. Modifies the range of the results provided range goes from offset to limit

Request Params

KeyDatatypeRequiredDescription
limitstringDefault 50. Quantity of documents to be returned in the response.
pagestringAllows iteration through the results.
idsstringReturns the items inside of a list of ids separated by comas
sinceIdstringFilter results to be returned only after certain ID.
createdAt[from]stringFilter results by date of creation.
createdAt[to]stringFilter results between their creation date range. createdAt[from]Required
updatedAt[from]stringFilter results by date last update.
updatedAt[to]stringFilter results between a date range. updatedAt[from]Required
namestringFilter results based of the customers name.
searchstringGeneral search on the resource.
emailstringSearch based of email information.

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Authorizationstring

RESPONSES

status: OK

{"success":true,"customers":[{"id":"6116894245041","email":"fake@ecartapi.com","firstName":"Daniela","lastName":"Zapata","status":{"id":null,"status":"disabled"},"note":null,"phone":null,"currency":"MXN","addresses":[{"id":"7425587544241","firstName":"Daniela","lastName":"Zapata","address1":"Belisario Dominguez, Obispado","address2":"Obispado","country":{"code":"MX","name":"Mexico","codeIso2":"MX","codeIso3":"MEX"},"state":{"code":"NL","name":"Nuevo León","codeIso2":null,"codeIso3":null},"city":"Monterrey","postalCode":"64060","phone":null,"company":null,"references":null,"defaultBilling":null,"defaultShipping":null},{"id":"7435537252529","firstName":"Daniela","lastName":"Zapata","address1":"MIGUEL SAENZ 905, Zacatecas, col. Santa Cecilia, Zacatecas, col. Santa Cecilia, Zacatecas, col. Santa Cecilia","address2":"Zacatecas, col. Santa Cecilia","country":{"code":"MX","name":"Mexico","codeIso2":"MX","codeIso3":"MEX"},"state":{"code":"COAH","name":"Coahuila","codeIso2":null,"codeIso3":null},"city":"Mexico","postalCode":"25720","phone":null,"company":null,"references":null,"defaultBilling":null,"defaultShipping":null},{"id":"7435550949553","firstName":"JUST","lastName":"checking out","address1":"Avenida Carrera","address2":null,"country":{"code":"CO","name":"Colombia","codeIso2":"CO","codeIso3":"COL"},"state":{"code":"DC","name":"Bogotá, D.C.","codeIso2":null,"codeIso3":null},"city":"cundinamarca","postalCode":"66C30","phone":null,"company":null,"references":null,"defaultBilling":null,"defaultShipping":null}],"dates":{"createdAt":"2022-07-22T13:48:42-04:00","updatedAt":"2022-08-09T12:14:54-04:00"}},{"id":"6007834706097","email":"fake@email.com","firstName":"JUST","lastName":"checking out","status":{"id":null,"status":"disabled"},"note":null,"phone":null,"currency":"MXN","addresses":[{"id":"7283996033201","firstName":"Daniela","lastName":"Zapata","address1":"MIGUEL SAENZ 905","address2":" Zacatecas, col. Santa Cecilia","country":{"code":"MX","name":"Mexico","codeIso2":"MX","codeIso3":"MEX"},"state":{"code":"COAH","name":"Coahuila","codeIso2":null,"codeIso3":null},"city":"Monclova","postalCode":"25720","phone":null,"company":null,"references":null,"defaultBilling":null,"defaultShipping":null},{"id":"7284113932465","firstName":"JUST","lastName":"checking out","address1":"Belisario Dominguez 2471","address2":null,"country":{"code":"MX","name":"Mexico","codeIso2":"MX","codeIso3":"MEX"},"state":{"code":"NL","name":"Nuevo León","codeIso2":null,"codeIso3":null},"city":"Monterrey","postalCode":"64060","phone":null,"company":null,"references":null,"defaultBilling":null,"defaultShipping":null}],"dates":{"createdAt":"2022-04-29T11:40:13-04:00","updatedAt":"2022-06-03T19:06:25-04:00"}},{"id":"5984488161457","email":"admin@fake.com","firstName":"Daniela","lastName":"Zapata","status":{"id":null,"status":"disabled"},"note":null,"phone":null,"currency":"MXN","addresses":[{"id":"7252376453297","firstName":"Daniela","lastName":"Zapata","address1":"2423 Nambusunhwan-ro, Seocho 3(sam)-dong","address2":null,"country":{"code":"KR","name":"South Korea","codeIso2":"KR","codeIso3":"KOR"},"state":{"code":"KR-11","name":"Seoul","codeIso2":null,"codeIso3":null},"city":"Seocho-gu","postalCode":"06073","phone":null,"company":null,"references":null,"defaultBilling":null,"defaultShipping":null}],"dates":{"createdAt":"2022-04-11T19:21:23-04:00","updatedAt":"2022-07-13T19:06:52-04:00"}},{"id":"4630009348273","email":null,"firstName":"Marcelo","lastName":"Gomez","status":{"id":null,"status":"disabled"},"note":null,"phone":null,"currency":"MXN","addresses":[{"id":"5634184478897","firstName":"Marcelo","lastName":"Gomez","address1":"Rio Tigris 1039","address2":"Dpto 103D","country":{"code":"MX","name":"Mexico","codeIso2":"MX","codeIso3":"MEX"},"state":{"code":"NL","name":"Nuevo León","codeIso2":null,"codeIso3":null},"city":"San Pedro Garza Garc","postalCode":"66250","phone":"8180161135","company":null,"references":null,"defaultBilling":null,"defaultShipping":null}],"dates":{"createdAt":"2021-02-02T13:34:51-05:00","updatedAt":"2022-03-31T13:04:42-04:00"}},{"id":"4312034246833","email":"marcelo@envia.com","firstName":"Marcelo","lastName":"Gomez","status":{"id":null,"status":"disabled"},"note":null,"phone":null,"currency":"MXN","addresses":[{"id":"5281001341105","firstName":"Marcelo","lastName":"Gomez","address1":"California","address2":"123","country":{"code":"US","name":"United States","codeIso2":"US","codeIso3":"USA"},"state":{"code":"TX","name":"Texas","codeIso2":null,"codeIso3":null},"city":"Los Angeles","postalCode":"90017","phone":"8181201982","company":"Hola","references":null,"defaultBilling":null,"defaultShipping":null}],"dates":{"createdAt":"2020-10-19T12:16:11-04:00","updatedAt":"2021-08-25T20:44:59-04:00"}}],"page":{"next":null,"previous":null}}