Overview
How Store API requests are structured, and what each resource does.
Use the Store API to manage your catalogue, send stock to Bigblue warehouses, create and track orders, and handle returns. It has 30 operations.
Base URL
Each operation has its own path:
POST https://api.bigblue.co/bigblue.storeapi.v1.PublicAPI/{Method}Replace {Method} with the operation name, such as CreateProduct or
ListOrders.
Use POST for every request
Reads also use POST. A GET request returns 404 with the code bad_route.
There are no path or query parameters. Send all input in the JSON body.
Resources
Products
Create, update, get, list and delete products.
Bundles
Create, update, get, list and delete bundles.
Inbound shipments
Create, update, get, list and delete inbound shipments.
Inventory
List stock for products, bundles and sales channels.
Orders
Create, update, get, list and cancel orders, and list their support tickets.
Tracking
List the trackings for an order or a parcel.
Returns
Create, update, get and list returns.
Storefront token
Get a short-lived token for Bigblue modules in the browser.
Basics
Authentication
API keys and the Authorization header.
Conventions
Money, dates, empty values and updates.
Identifiers
ID formats and the patterns they must match.
Pagination
Page tokens and page sizes.
Errors
Error format, codes and HTTP statuses.
Rate limits
200 requests per minute per account.
OpenAPI spec
Download the OpenAPI 3 spec to import the Store API into Postman or Insomnia, or to generate a client. It has every operation, field and validation rule, with example requests and responses.
Versioning
The version is part of the path: bigblue.storeapi.v1. New optional request
fields and new response fields can be added to v1 at any time, so ignore fields
you don't recognize. Fields marked deprecated still work, but use their
replacement in new code.