Authenticate with HTTP Basic using the client credentials. Entries are scoped to the authenticated user’s current team.
Returns a paginated list including lines, receipts and available team/user details. Pagination keys are perPage, currentPage, lastPage and total. List records also include ISO 8601 created_at/updated_at timestamps.
Query encoding
Use bracket notation as shown in the parameters. When sorting is supplied, send both column and direction. Advanced filters require logic, column, operator and (except null operators) value. Repeat filters with indexes 0, 1, 2...
Example: ?advanced_filters[logic]=AND&advanced_filters[filters][0][column]=status&advanced_filters[filters][0][operator]=in&advanced_filters[filters][0][value]=PENDIENTE
The tracking_code filter searches both the legacy code and the tracking_codes array.
Allowed advanced filters
| Column | Allowed operators |
|---|---|
| id | in, not_in, is_null, is_not_null |
| team_id | in, not_in, is_null, is_not_null |
| user_id | in, not_in, is_null, is_not_null |
| reference | equals, not_equals, contains, not_contains, starts_with, ends_with, in, not_in, is_null, is_not_null |
| estimated_delivery_at | in, not_in, is_null, is_not_null, greater_than, less_than, greater_equal, less_equal |
| boxes_count | in, not_in, is_null, is_not_null |
| tracking_code | equals, not_equals, contains, not_contains, starts_with, ends_with, in, not_in, is_null, is_not_null |
| status | in, not_in, is_null, is_not_null |
| created_at | in, not_in, is_null, is_not_null, greater_than, less_than, greater_equal, less_equal |
Free-form metadata
The entry and its product lines may contain metadata: a free-form JSON object, array or null. For create and update requests, omitted or null metadata becomes an empty array. Responses include the saved metadata on the entry and each entry line. These dynamic values are shown in the JSON examples and intentionally left unexpanded in the visual schema.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||