Common data formats

Resource IDs

Most resource IDs are prefixed strings followed by a UUID:

Prefix	Resource
order-	Order
identifiedCustomer-	Customer
reservation-	Reservation
shipment-	Shipment
webhook-	Webhook
product-	Product
orderLine-	Order line

When creating a customer, the response returns identifiedCustomerId. In other responses the same value is exposed as customerId.

Customer address and external references

Customer detail and list responses expose address as an object with fields such as lineOne, lineTwo, city, country, zipCode, and phoneNumber. External identifiers are returned in externalReferenceIds, a map keyed by provider name (for example publicApi or Farmad).

When creating or updating a customer, send externalReferenceId (singular) in the request body. Orders and other resources may also expose a single externalReferenceId field.

When creating or updating a customer, you can still send flat address fields (address, zipCode, city, country) in the request body.

Pagination

List endpoints support pagination through query parameters:

• pagination[page] — page number (default: 1)
• pagination[size] — page size (default: 10, maximum: 1000)

List responses include a total count, an items array, and pagination metadata.

Sorting

Some list endpoints support sorting:

• sorting[field] — field to sort on (varies per endpoint; see the endpoint docs)
• sorting[direction] — ascending or descending

For customers, sort query parameters use createdOn and updatedOn, while response timestamps are named createdAt and updatedAt.

Timestamp field names

Most resources expose createdAt and updatedAt. Webhook resources use createdOn and updatedOn instead.

Filters

Some list endpoints support filters through filters[...] query parameters:

• Orders and reservations: filters[customerId]
• Reservations: filters[orderId]
• Reservations: filters[reservationStatuses][] — repeat for multiple statuses, for example filters[reservationStatuses][]=complete&filters[reservationStatuses][]=incomplete

Product codes

Product codes identify products across integrations. Each code has a type and a value. Supported types include CNK, EAN, and other codes configured for your branch.

When importing stock or prices, unresolved product codes are returned in unresolvedProductCodes.

Prices

Prices are expressed in cents (amountInCents) with a currency code. In detail responses, currency is enriched with a name and symbol. All prices are considered tax included.

Dates and times

The API uses two UTC datetime formats:

• ISO 8601 — used for customers and reservations, for example 2020-02-25T10:20:30+00:00
• Y-m-d H:i:s — used for orders, shipments, and webhooks, for example 2020-02-25 10:20:30

Webhook event payloads use a space-separated datetime in the on field. See Webhooks for an example.