Luca API
Luca provides an API to push your business product and order data into our system. The API defines endpoints for each of the tables defined in the data tables section:
POST https://app.askluca.com/api/public/v1/products
POST https://app.askluca.com/api/public/v1/order-line-items
POST https://app.askluca.com/api/public/v1/orders
POST https://app.askluca.com/api/public/v1/inventory
POST https://app.askluca.com/api/public/v1/competitor-data
You can also view Swagger documentation for these endpoints here (requires a Luca account).
In addition to two more endpoints which are helping for checking your API integration is setup correctly:
GET https://app.askluca.com/api/public/v1/status
GET https://app.askluca.com/api/public/v1/auth
Authorization and Brand Identification
The API expects an API token to be present in the Authorization
header. You
will receive this token during onboarding.
headers: {
Authorization: `Bearer <api-key>`,
},
You will also need to provide a brand identifier which will identify the brand you are ingesting data for. You can also provide this as a header as follows:
headers: {
x-brand-id: <brand-uuid>,
},
Usage
Each of these endpoints accepts a list of objects which must match the data schema defined in the data tables documentation section.
A few notes about using this API:
The
products
endpoint accepts at most 1,000 products at a time. If you have more products than this, please send multiple requests. Products will be created or updated based on their unique constraint.The historical endpoints also accept at most 1,000 objects per requests. All provided objects will be created or updated using the unique constraint documented in the table schema definition.
The API currently does not have any rate limiting. If you need to backfill a lot of historical data, we recommended sending requests sequentially or with minimal parallelism (e.g. 1-5 concurrent requests) to avoid overwhelming our servers.
It’s recommended to continue submitting data on a daily basis so we have an ongoing and up to date record of your business products and orders.