ADM-BUYING-POLICY-550 - List active or scheduled credit holds

get

https://example.com/v1/buying-policies/credit-control/holds

Returns the list of credit holds configured for Customer Accounts.
A credit hold prevents the associated account from placing orders during
the specified period.

Filter behaviour

If customerAccountIds[] contains both valid and invalid IDs, the valid IDs are applied and the invalid ones are silently ignored.

Default sorting
By createdAt:desc (most recent first).
When sorting by endDate, null values are always placed last.
Invalid or malformed sort entries are ignored.

⚠️ This endpoint is only accessible when the dj-client header is set to OPERATOR.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

size

int32

sort

array of strings

Sorting expressed as field:direction.

Allowed fields: createdAt, updatedAt, startDate, endDate, accountId, accountName
Allowed directions: asc, desc
Multiple sorts are supported by repeating the parameter: ?sort=createdAt:desc&sort=accountId:asc
Default sorting: createdAt:desc
For endDate, null values are always placed last.
Invalid or malformed sort entries are silently ignored.

Format: property:direction (recommended) or property,direction (kept for backward compatibility).

sort

customerAccountIds

string

External IDs of Customer Accounts to filter on.

Example: customerAccountIds=ACCID1234&customerAccountIds=ACCID5678

startDateFrom

date-time

Include entries with startDate ≥ this timestamp.

startDateTo

date-time

Include entries with startDate ≤ this timestamp.

endDateFrom

date-time

Include entries with endDate ≥ this timestamp.

endDateTo

date-time

Include entries with endDate ≤ this timestamp.

customerAccountName

string

Filter by Customer Account display name (case-insensitive, contains).

If the value is empty or only whitespace, the filter is ignored.

Example: customerAccountName=Compte

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.

Responses

400

Invalid request parameters.

This error occurs when:

startDateFrom > startDateTo
endDateFrom > endDateTo
Invalid date-time format (must be ISO 8601: YYYY-MM-DDTHH:MM:SSZ)

401

Authentication required.

403

Access forbidden.

500

Internal server error.

Language

Credentials

Bearer

JWT

Loading…

Response

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

*/*

200List of current or upcoming credit holds.