Retrieve paginated customer account from djust

get

https://example.com/v1/customer-accounts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

supplierId

string

customerAccountIds

array of strings

customerAccountIds

customerTagIds

array of strings

customerTagIds

status

array of objects

status

Allowed:

customFields

array of strings, unique

Filter on the account custom field values, as customFieldId|value pairs. Repeat the parameter to add a criterion. Only the first pipe separates the identifier: the value may contain pipes and commas.

The custom field is targeted by its DJUST or its external identifier, whatever idType.
A value matches when the stored value contains it, ignoring case and accents.
Values asked on a same custom field combine with an OR, criteria on different custom fields with an AND.
MEDIA custom fields are ignored.
An account without a value for the custom field is never returned.

customFields

creationDateFrom

date-time

Filter customer accounts created at or after this timestamp (inclusive).

creationDateTo

date-time

Filter customer accounts created at or before this timestamp (inclusive).

updateDateFrom

date-time

Filter customer accounts updated at or after this timestamp (inclusive). The update date is the one of the account itself: attaching a customer user does not change it.

updateDateTo

date-time

Filter customer accounts updated at or before this timestamp (inclusive). The update date is the one of the account itself: attaching a customer user does not change it.

idType

string

Defaults to DJUST_ID

The idType query parameter enforces the following rules:

idType=DJUST_ID: The customerAccountId, supplierId and customerTagId refer to business IDs.
idType=EXTERNAL_ID: The customerAccountId, supplierId and customerTagId refer to an external IDs.

pageable

object

required

Headers

dj-client

string

enum

required

Specifies the client type making the request.

OPERATOR: Platform operator user.
ACCOUNT: Customer account user.
SUPPLIER: Supplier managing orders.

Allowed:

dj-api-key

string

required

API key required for authentication. Must be valid and linked to the requesting user.

dj-store

string

(Optional) Store ID in multi-store environments.

dj-store-view

string

(Optional) Store view ID in multi-store environments.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200OK