API Reference

Get all customer purchases

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

Get information about all customer account purchases.

Returns all purchase transactions recorded on the customer's account. Each purchase record includes the total value, payment time, store, and purchase type. Use purchase_items_extension=true to include individual line items in the response.

Filter by store, purchase type, and payment date range to narrow results. To retrieve purchases across all customers, use GET /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 customer.

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. GET /stores

string

The unique ID of the purchase type. GET /purchase-types

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:
string

ID of the purchase from external (e-shop, POS) system. This ID should have unique value.

Headers
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.

Updated 3 months 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 3 months ago