Retrieve an order

get
https://api.clakta.com/v1/orders/{orderId}

Retrieve a single order. `orderId` is your own order ID, the value sent as `orderId` when the order was created, and the owning project is passed as the `projectId` query parameter. Requires an API key with `orders.read`.

`totalPrice` and each product `price` are returned in the smallest unit of the order currency (`1040` for $10.40). The `customer` object carries the name, email, phone, gender, date of birth and address of the customer record the order is attached to. Fields are null when unknown, and the shopper's IP and User-Agent are never returned.

Authentication

Send your API key as a bearer token in the Authorization header.

See Authentication for how to create and scope an API key.

Path parameters

orderIdstringrequired

The order ID in your own system.

Query parameters

projectIdstringrequired

The project ID (e.g. proj_xxx) or slug that owns the order.

Response

The requested order

dataobjectrequired