The fulfillment model

Each Store API object matches a step in the warehouse.

Product

A product describes one sellable unit: its name, barcode, declared value, customs data and handling flags such as lot tracking. Creating a product doesn't create stock.

Product IDs are three-part SKUs such as BGBL-ESPSRT-SMAL. The first four characters are your account's tenant code.

A bundle groups up to 20 products so you can sell them as one item. Bundles have no stock of their own. Their availability comes from their components.

See Products and Bundles.

Inbound shipment

An inbound shipment tells a warehouse what stock is arriving: the products and quantities, how they are packed, the carrier and the expected arrival date. The warehouse uses it to book a delivery slot and to check what arrives.

After reception, the shipment shows how many units were received and how many were damaged, per line.

See Inbound shipments.

Inventory

Inventory is read-only. For each product and warehouse, Bigblue reports how many units are available to sell, in the warehouse, damaged, in quality control, expired or backordered.

Inventory changes when inbound shipments are received, orders ship and returns arrive. If a product tracks lots, inventory is also reported per lot.

See Inventory.

Order

An order asks Bigblue to ship line items to an address. You send the shipping address, the line items with prices and taxes, and optionally a pickup point or B2B instructions. Bigblue assigns a 12-character order ID.

Your API key's integration decides whether the order is fulfilled automatically, and from which warehouse by default. See Authentication.

See Orders.

Tracking

When a parcel is handed to a carrier, Bigblue records its tracking events. An order shows the tracking number of its most advanced parcel. The tracking endpoint returns every event for each parcel.

See Tracking.

Return

A return brings units back from a customer to a warehouse. It records the units expected and received, damage, the customer's reasons and how the customer was refunded. Received units go back into inventory.

See Returns.

Terms

Account

Your company on Bigblue

Identified by a four-character tenant code, such as BGBL. Product, bundle, order and return IDs start with it.

Integration

One API key and its settings

Created in the Bigblue app. Sets the primary warehouse and whether orders are fulfilled automatically. The store field on an order is the integration that created it, for example i_bgbl0001.

Shop

A sales channel

A storefront or marketplace connected to your account, such as a Shopify store. Shop IDs look like sh_1a2b3c4d.

Warehouse

A Bigblue site that stores and ships stock

Identified by IDs such as FR-CDG-001. No endpoint lists them. Find yours in the Bigblue app or in inventory responses.

Ticket

A support request about an order

Opened and answered in the Bigblue app. See List order tickets.