Identifiers

The API checks ID formats before looking anything up. A malformed ID fails with invalid_argument. A well-formed ID that doesn't exist fails with not_found.

Product, bundle, order and return IDs start with your account's four-character tenant code, such as BGBL.

Products and bundles

Product IDstring

Three parts: tenant code, a six-character family code and a four-character variant code. Example: BGBL-ESPSRT-SMAL.

Pattern^[A-Za-z0-9]{4}-[A-Za-z0-9]{6}-[A-Za-z0-9]{4}$

Bundle IDstring

Same format as a product ID, with BU after the tenant code. Example: BGBLBU-KITSTA-2024.

Pattern^[A-Za-z0-9]{4}BU-[A-Za-z0-9]{6}-[A-Za-z0-9]{4}$

Fields that accept a product or a bundle, such as order line items, use the pattern ^[A-Za-z0-9]{4}(BU)?-[A-Za-z0-9]{6}-[A-Za-z0-9]{4}$.

id and sku are different

id is the Bigblue ID and must match the pattern. sku is your own reference, up to 40 characters. Lookups always use id.

Orders

Order IDstring

Twelve letters or digits, starting with your tenant code. Bigblue generates it unless you send your own. Example: BGBL0K3M9XQ2.

Pattern^[A-Za-z0-9]{12}$

external_idstring

Your own order reference. It doesn't need to be unique. GetOrder and ListOrders can't search by it. The only way to find an order by this reference is the external_order filter on ListTrackings, which returns the order's trackings.

Warehouses

Warehouse IDstring

Country code, a three-letter location code and a three-digit site number. Examples: FR-CDG-001, ES-MAD-001.

Pattern^[A-Za-z]{2}-[A-Za-z]{3}-[0-9]{3}$

No endpoint lists warehouses. Find your warehouse IDs in the Bigblue app or in inventory responses.

Inbound shipments

Inbound shipment IDstring

Thirteen letters or digits. Doesn't start with the tenant code. Bigblue generates it unless you send your own.

Pattern^[A-Za-z0-9]{13}$

Returns

Return IDstring

The order ID, then RT, then two characters. Example: BGBL0K3M9XQ2RT01. The first 12 characters are the order ID.

Pattern^[A-Za-z0-9]{12}RT[A-Za-z0-9]{2}$

Other IDs

Ticket IDstring

A support ticket.

27 characters

Shop IDstring

A sales channel connected to your account. Example: sh_1a2b3c4d. Used in allocation inventories and the external_order filter.

Pattern^[a-z0-9]{1,2}_[A-Za-z0-9]{8}$

Pickup point IDstring

The carrier's ID for the pickup point.

2–12 characters

Carrier servicestring

Bigblue's ID for a carrier service.

5–32 characters

Lot codestring

Your ID for a batch of a lot-tracked product. Order lines accept up to 64 characters, but a lot can only be created with up to 20 through an inbound shipment.

Up to 20 characters

B2B instructions templatestring

A B2B fulfillment instructions template set up in the Bigblue app.

Up to 32 characters

Sending your own IDs

You can choose the ID for orders, inbound shipments and returns. If a request is retried with the same ID, it fails with already_exists instead of creating a duplicate.

You always choose product and bundle IDs.