Get all credit records

get

https://{project_url}/webservice/rest-api/{api_interface}/{version}/credits

Get a list of all credit transactions and their current values.

Credits are the monetary loyalty currency stored in a customer's wallet alongside reward points. Each credit record captures the assigned and available credit balances, credit type, currency, customer, partner, validity date, state, and note.

Use the customer_id filter to retrieve credits for a specific customer, credit_type_id to narrow results to a specific loyalty program or promotional category, the create_credit_time_from/create_credit_time_to parameters to filter by creation date, and note to search by note content.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

count

integer

≥ 1

Defaults to 100

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction

string

enum

Direction of sorting the response list.

Allowed:

customer_id

string

The unique ID of the customer. GET /customers

credit_type_id

string

The unique ID of a credit type. The filter reduces data in the response related only to the selected credit type. GET /credit-types

In case you want to filter multiple options use array syntax : credit_type_id[]=8bc8ca16f9c5039951021700a2&credit_type_id[]=82c06812c0756528660784fef

create_credit_time_from

string

Start of the time interval for filtering credit records by creation time. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.

create_credit_time_to

string

End of the time interval for filtering credit records by creation time. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.

note

string

Search record by the note or a part of the note.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

`error.error_data.invalid_params[]` array lists the parameters that caused the failure, each carrying a `reason` code. See the `BadRequestErrorBody` schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL

Loading…

Response

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

application/json

200OK

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access an unauthorized property or resource.

404The request path does not match any API route, or the addressed resource does not exist.

405The request path matches a valid route, but the endpoint does not support the HTTP method used in the request.

500Server is not working as expected.