API Reference

Get all purchases for a credit

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

Get all purchases associated with a specific credit record.

Credits can be earned through customer purchases. This endpoint returns the purchases linked to a specific credit record, allowing you to trace which purchase transaction originated the credit. Supports filtering by store, customer, purchase type, and payment date range.

Use the purchase_items_extension parameter to include individual line items in the response. To retrieve all purchases for a customer, use GET /customers/{customer_id}/purchases.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique ID of the credit record.

Query Params
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.

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.

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.

string
enum

Direction of sorting the response list.

Allowed:
string

The unique ID of the store in CareCloud.

string

The unique ID of the customer.

string

Purchase type

string

Start of the time interval for filtering purchases by payment 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.

string

End of the time interval for filtering purchases by payment 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.

boolean
enum
Defaults to false

If true, resource returns extended response with purchase items. If false, the resource won't be extended. If the parameter is not set, the default value is false.

Allowed:
Headers
string
Defaults to cs, en-gb;q=0.8

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

Responses

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.

Updated 12 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago