Merchants API Overview
The Merchants API allows store owners to securely manage product listings and retrieve transaction data.
All merchant actions require a valid API key and are scoped to the store’s domain.
Endpoints Overview
Endpoint | Description |
---|---|
/{domain}/merchants/product | Add, update, list, and delete products in your store. |
/{domain}/merchants/transaction | Retrieve order and payment transaction history securely. |
Key Concepts
- Domain validation – Merchant routes are always prefixed with
{domain}
and validated before execution. - API key authentication – All merchant requests must include a valid
x-api-key
header. - Scoped access – Actions are tied to the merchant’s
store_id
, preventing cross-store access. - Encrypted data – Sensitive order details (e.g., shipping info) are encrypted at rest and in transit.
Example Flow
- Authenticate using your
x-api-key
. - Add or update products using
/{domain}/merchants/product/add
or/{domain}/merchants/product/edit/{id}
. - List products with filtering and pagination using
/{domain}/merchants/product/list
. - Retrieve transactions using
/{domain}/merchants/transaction
.