Documentation
Public API Documentation
Use this documentation as an introduction to the public API surface. It gives external developers a starting point for understanding which endpoints are available, how requests and responses are structured, and where to look for implementation details and usage examples.
What You Can Build
The Public API is the client-facing integration surface for external systems that need to create and manage fulfilment workflows programmatically. Use it when an e-commerce platform, middleware service, ERP, customer service tool, or custom client application needs API access to operational data.
Common use cases include:
- Creating, updating, approving, cancelling, deleting, and bulk-editing orders.
- Creating return orders and managing return items, return item conditions, restock, quarantine, forwarding, and disposal workflows.
- Creating and updating products, SKUs, item groups, stock views, packaging information, and customs data.
- Creating ASNs, updating ASN items, and triggering ASN actions.
- Retrieving tracking details, tracking events, courier options, courier groups, countries, warehouses, rates, and shipping options.
- Generating labels, exporting orders, generating pallet documents, and checking async task progress.
- Registering webhooks for order, ASN, product, return order, return item, and tracking events.
- Managing addresses, exporter addresses, importer addresses, client location addresses, and customs broker addresses.
Authentication and Request Patterns
Public API requests use client-scoped authentication tokens. The token controls which client data the caller can access. Most integrations send requests with JSON payloads and receive JSON responses with validation details, pagination metadata, and resource objects.
Important search terms for this API include client token, authorization header, rate limits, concurrency limits, pagination, webhook signature, HMAC SHA256, sandbox credentials, production credentials, and API throttling.
Endpoint Reference
The generated reference includes detailed request and response schemas for these endpoint groups:
| Group | Common Endpoints |
|---|---|
| Orders | /orders/, /orders/{id}/, /orders/action/, /orders/{id}/action/{action_name}/, /orders/label/, /orders/export/ |
| Returns | /orders/returns/, /orders/returns/{id}/, /return_items/, /return_items/{id}/, /return_items/action/, /return_items/return-item-conditions/ |
| Products and inventory | /products/, /products/{id}/, /products/stocks/, /item_groups/, /item_groups/{id}/ |
| ASN | /asn/, /asn/{id}/, /asn/{id}/action/{action_name}/ |
| Tracking | /track/, /track/{tracking_number}/, /fic_track/{tracking_number}/ |
| Shipping and rates | /shipping_option/, /shipping_option/{id}/, /couriers/, /couriers/groups/, /countries/, /rates/, /warehouses/ |
| Webhooks | /webhooks/, /webhooks/{id}/ |
| Addresses | /address/, /address/{id}/, /address/exporter_address/, /address/importer_address/, /address/client_location_address/, /address/customs_broker_address/ |
| Embedded workflows | /embedded/context/, /embedded/orders/, /embedded/tracking/, /embedded/create_rma_order/, /embedded/labels/{floship_so_number}/ |
| Async tasks and documents | /tasks/{task_id}/, /tasks/{task_id}/progress/, /tasks/{task_id}/stop/, /documents/pallets/ |