Connect orders, inventory, and warehouses with the Boostmyshop API

The Boostmyshop REST API opens your ecommerce operations to your ERP, your BI, and your in-house tools: orders, inventory, picking, purchasing, and shipping, with read and write access.

In Boostmyshoporders, inventory, warehouses

Your codecalls the REST API

Boostmyshop Sales Orders

Orders

Orders to ship in Boostmyshop
OrderChannelCustomerStatus
1064APIMargaux F.New
1060AmazonMarc T.In stock
1058ManoManoLéa M.On hold
1053CdiscountPaul D.Unallocated
1051ShopifyInès L.Label error
1047PrestaShopHugo B.Out of stock
1042AmazonCamille R.Partial

7 orders

Request

POST/api/v2/sales/orders

Authorization: Bearer $TOKEN
Content-Type: application/json
{
  "integration_id": 4,
  "store_id": 1,
  "reference": "1064",
  "status": "processing",
  "payment_method": "card",
  "customer": { "firstname": "Margaux", "lastname": "F.", … },
  "billing_address": { … },
  "shipping_address": { … },
  "shipping": { "method": "colissimo_home" },
  "items": [{ "product_id": 214, "qty": 1, … }]
}

Response201 Created

{
  "id": 1064,
  "reference": "1064",
  "status": "processing",
  "created_at": "2026-11-17T10:42:00+01:00",
  "items": [
    { "sku": "SWEAT-GRY-L", "qty": 1, "qty_to_ship": 1 }
  ],
  …
}

The essentials

A REST API with complete OpenAPI documentation.

What your developer looks for first, taken from the API documentation.

Format
REST and JSON
Documentation
Complete, in OpenAPI 3.0.3 format
Operations
164
Rate limit
300 calls per minute

Reviewed on

What the API covers

An ecommerce operations API: 164 operations, from sales orders to purchasing.

Order management API, warehouse management API, inventory, purchasing: every Boostmyshop module exposes its read and write operations.

Orders and returns

Create and update orders, put them on hold or cancel them, read shipments, invoices, and credit memos, and process returns.

42 operations

18 read24 write

Show the paths
  • POST/api/v2/sales/orders
  • POST/api/v2/sales/orders/{id}/hold
  • GET/api/v2/sales/shipments
  • POST/api/sales/order/{orderReference}/ship
  • GET/api/sales/invoices
  • POST/api/v2/returns/{id}/return_label

Inventory and warehouses

Read and adjust stock by SKU and warehouse, track stock movements, and manage locations, transfers, and picking missions.

25 operations

12 read13 write

Show the paths
  • GET/api/advanced-stock/product/{sku}/stocks
  • PUT/api/advanced-stock/product/{sku}/warehouse/{warehouse_id}
  • PUT/api/advanced-stock/warehouse/{warehouse_id}/items
  • GET/api/v2/stock-movements
  • POST/api/v2/transfers
  • POST/api/v2/picking-missions/{id}/scan

Picking and packing

List each warehouse’s ready, partial, and backordered orders, start picking, pack orders, and assign bins.

18 operations

9 read9 write

Show the paths
  • GET/api/v2/order-preparation/{warehouseId}/instock
  • POST/api/v2/in-progress
  • GET/api/v2/in-progress/picking
  • POST/api/v2/in-progress/{id}/pick
  • POST/api/v2/in-progress/{id}/pack
  • POST/api/v2/in-progress/{id}/bin/{binId}

Purchasing and receiving

Read replenishment needs, create purchase orders and receipts, and keep suppliers and supplier SKUs up to date.

34 operations

17 read17 write

Show the paths
  • GET/api/v2/supply-needs/warehouse/{warehouseId}
  • POST/api/v2/purchase-orders
  • POST/api/v2/purchase-orders/{id}/receive
  • GET/api/v2/suppliers
  • POST/api/v2/supplier-items
  • POST/api/v2/free-receptions/{id}/scan

Shipping

Read your configured carriers and shipping methods, and the rates available for an order.

2 operations

2 read0 write

Show the paths
  • GET/api/tms/carrier
  • GET/api/v2/tms/orders/{order_id}/rates

Catalog and manufacturing

Create and update products, kits, and lots, and manage bills of materials and manufacturing orders.

22 operations

8 read14 write

Show the paths
  • POST/api/v2/products
  • GET/api/v2/products/search/{queryString}
  • POST/api/v2/kits/{productId}
  • POST/api/v2/products/{product_id}/sources
  • POST/api/v2/manufacturing
  • POST/api/v2/manufacturing/{id}/confirm

Integrations and reporting

Monitor your integrations and their sync errors, rerun a feed, read sales by product and warehouse, and create tasks and notes.

21 operations

14 read7 write

Show the paths
  • GET/api/v2/integrations/{integration_id}/errors
  • POST/api/v2/integrations/{id}/feed/{feed_code}/schedule
  • GET/api/v2/statistics/sales/warehouse/{warehouseId}
  • POST/api/v2/organizer
  • GET/api/v2/account/stores
  • GET/api/auth/permissions

Complete OpenAPI documentation details all 164 operations, their parameters, and their responses.

Integration examples

Your ERP, your BI, your in-house tools: connected to Boostmyshop.

Four common integrations, call by call.

Your ERP receives the goods, and Boostmyshop has the right stock levels.

In BoostmyshopInventory › Products

Your ERPrecords the receipt

Boostmyshop Inventory Products

HOODIE-BLK-M

Stock by warehouse

HOODIE-BLK-M stock by warehouse in Boostmyshop
WarehouseOn handReservedLocation
Lyon00—
Nantes170A-01

Latest movements

The latest HOODIE-BLK-M stock movements
DateWarehouseQuantityReason
Today 10:15 a.m.Nantes+12Adjustment · ERP receipt 4471

Total on hand: 17

Request

POST/api/v2/stock-movements

Authorization: Bearer $TOKEN
Content-Type: application/json
{
  "product_id": 131,
  "to_warehouse_id": 2,
  "qty": 12,
  "category": "adjustment",
  "comments": "ERP receipt 4471"
}

Response201 Created

{
  "id": 58213,
  "sku": "HOODIE-BLK-M",
  "to_warehouse_name": "Nantes",
  "new_qty": 17,
  "created_at": "2026-11-17T10:15:00+01:00",
  …
}

Your ERP stays the inventory master, and Boostmyshop picks and ships from the ERP’s numbers.

The tracking number for order 1064 goes back to your channel.

In BoostmyshopSales › Shipments

Your connectorreads the shipment

Boostmyshop Sales Shipments

Shipments

Warehouse: Lyon

Lyon shipments in Boostmyshop
OrderCarrierTrackingStatus
1064Colissimo6A10640000017Shipped
1060GLS—Ready to pick
1051DHL—Label error

Shipment for order 1064

Shipping method
Colissimo Domicile
Tracking number
6A10640000017
Contents
1 × SWEAT-GRY-L

Request

GET/api/v2/sales/shipments?filters[order_reference]=1064

Authorization: Bearer $TOKEN

Response200 OK

{
  "data": [
    {
      "order_reference": "1064",
      "method_description": "Colissimo Domicile",
      "trackings": [{ "number": "6A10640000017", … }],
      "warehouse_id": 1,
      "items": [{ "sku": "SWEAT-GRY-L", "qty": 1 }]
    }
  ],
  "meta": { "total": 1 }
}

Your customer tracks the package where they ordered, and nobody retypes anything.

The purchase order for Confection A, created by your purchasing tool.

In BoostmyshopPurchasing › Purchase orders

Your purchasing toolcreates the order

Boostmyshop Purchasing Purchase orders

Purchase orders

Warehouse: Lyon

Lyon purchase orders in Boostmyshop
ReferenceSupplierExpected
PO-20261117-0021Confection AThu, Nov 26
PO-20261015-0003Atelier BThu, Nov 19

Order PO-20261117-0021

Supplier
Confection A
Warehouse
Lyon
Products
6
Total
€1,840.00

Request

POST/api/v2/purchase-orders

Authorization: Bearer $TOKEN
Content-Type: application/json
{
  "supplier_id": 7,
  "warehouse_id": 1,
  "eta": "2026-11-26",
  "items": [{ "product_id": 131, "qty": 12, "price": "21.00" }, …]
}

Response201 Created

{
  "id": 88,
  "reference": "PO-20261117-0021",
  "supplier_name": "Confection A",
  "warehouse_name": "Lyon",
  "eta": "2026-11-26",
  "grandtotal": "1840.00",
  …
}

The order lands in Boostmyshop, ready to be received in Lyon.

Sales by product and warehouse, in your dashboard.

Your dashboardLyon sales

Your codereads the statistics

Your dashboard Sales by warehouse

Lyon

Units sold

Lyon sales by product in your dashboard
SKU30 days15 days5 days
TSHIRT-RED-M41228
SWEAT-GRY-L27124

From Boostmyshop

Products sold
38
Periods
30, 15, and 5 days

Request

GET/api/v2/statistics/sales/warehouse/1?limit=2

Authorization: Bearer $TOKEN

Response200 OK

{
  "periods": { "1": 30, "2": 15, "3": 5 },
  "data": [
    { "sku": "TSHIRT-RED-M", "sales_period_1": 41, … },
    { "sku": "SWEAT-GRY-L", "sales_period_1": 27, … }
  ],
  "meta": { "total": 38 }
}

The three periods configured in Boostmyshop, ready for your charts.

No code to write? Your sales channels and carriers connect through our integrations, and your AI assistant through the MCP server.

Example call

Your open orders, in one call.

cURL

export BMS_URL="https://…"  # your Boostmyshop account’s address
export BMS_TOKEN="…"  # your access token

curl -g "$BMS_URL/api/v2/sales/orders?limit=10&filters[status]=processing" \
  -H "Authorization: Bearer $BMS_TOKEN" \
  | jq '.meta.total, [.data[].reference]'  # the total, then the order numbers

JavaScript

const base = process.env.BMS_URL; // your Boostmyshop account’s address
const token = process.env.BMS_TOKEN; // your access token

const orders = await fetch(`${base}/api/v2/sales/orders?limit=10&filters[status]=processing`, {
  headers: { Authorization: `Bearer ${token}` },
}).then((response) => response.json());

console.log(orders.meta.total, orders.data.map((order) => order.reference)); // the total, then the order numbers

Python

import os, requests

base = os.environ["BMS_URL"]  # your Boostmyshop account’s address
token = os.environ["BMS_TOKEN"]  # your access token

orders = requests.get(
    f"{base}/api/v2/sales/orders",
    params={"limit": 10, "filters[status]": "processing"},
    headers={"Authorization": f"Bearer {token}"},
).json()

print(orders["meta"]["total"], [order["reference"] for order in orders["data"]])  # the total, then the order numbers

PHP

<?php
$base = getenv('BMS_URL'); // your Boostmyshop account’s address
$token = getenv('BMS_TOKEN'); // your access token

$ch = curl_init("$base/api/v2/sales/orders?" . http_build_query(['limit' => 10, 'filters' => ['status' => 'processing']]));
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
    CURLOPT_RETURNTRANSFER => true,
]);
$orders = json_decode(curl_exec($ch), true);

echo $orders['meta']['total'], ' ', implode(', ', array_column($orders['data'], 'reference')), PHP_EOL; // the total, then the order numbers

The complete OpenAPI documentation covers authentication, schemas, and every operation.

Frequently asked questions

Ecommerce operations API: your questions.

Updated

Your operations already run in Boostmyshop.

Orders, inventory, picking, and purchasing, connected to your sales channels and carriers.

Plug your systems in.