API

API Sync Rules: Orders, Products, Inventory, and Shipment Confirmation

How orders, products, inventory, and shipment confirmation sync after authorization, and which field rules should be aligned before go-live.

Burton WMS Ai API Customer operations / Warehouse team / Customer success / Implementation 9 min
4assets 2026-05-16Updated on
Export Module

01 1. Sync Scope

After authorization, the system can sync orders, products, customers, inventory, shipment status, and tracking information depending on channel capability. Exact fields depend on platform API permissions and the customer's authorization scope.

Do not stop at connection success. Before go-live, confirm that order sync, product sync, inventory sync, and shipment confirmation can all be explained and validated.

02 2. Sync Objects and Check Pages

Sync ObjectPageKey Fields
OrdersOrdersOrder ID, Channel, Status, Recipient, Items, Fulfillment Status.
ProductsProductsSKU, Title, Status, Price, Weight, Category, Image.
InventoryInventory ProductsWarehouse, Bin, On Hand, Committed, Incoming, Available.
CustomersCustomersName, Email, Channel, Orders, Last Order.
Shipment confirmationOrders / Activity LogsCarrier, Tracking, Ship Date, Confirmation Status, API Result.

Orders sync check

Orders helps verify whether platform orders have entered the system and whether fulfillment status is correct.

03 3. SKU and Product Mapping

SKU mapping is critical for stable order sync, inventory sync, and shipment confirmation. Customers should align store SKU, warehouse SKU, and system SKU before go-live.

ScenarioRecommended Handling
All SKU values matchUse automatic matching and sample-check the result.
Channel SKU differs from warehouse SKUCreate a mapping before validating orders and inventory.
Case or spacing differsClean the SKU values before deciding whether they represent the same product.
Bundle or kit itemConfirm whether it should split into multiple warehouse SKUs.
New product syncCheck Products first, then Inventory Products.

Products catalog

Products shows title, SKU, status, price, weight, and image completeness.

04 4. Inventory Definitions

Customers should understand the operational meaning of each inventory field.

FieldSuggested Definition
On HandPhysical stock currently in the warehouse.
CommittedStock allocated to orders but not fully shipped.
IncomingStock in receiving plans or inbound transit.
AvailableSellable or allocatable stock after committed quantities are considered.
StatusStock health such as In Stock, Low Stock, or Out of Stock.

Inventory Products sync check

Inventory Products helps verify SKU, warehouse, bin, and available stock.

05 5. Shipment Confirmation Rules

After fulfillment, the system sends Tracking, Carrier, Ship Date, Fulfillment Status, ASN, or shipment confirmation back to the platform when required.

Before go-live, confirm:

  1. Carrier names match platform requirements.
  2. The customer allows automatic shipment confirmation.
  3. Platform label, ASN, or service code requirements are known.
  4. Someone owns retry and customer notification when confirmation fails.

06 6. Reconciliation

After authorization and sync are stable, customers can export order, product, and inventory CSV files from Reports. Run at least one post-go-live review across orders, inventory, and logistics.

Reports export

Reports exports order, product, and inventory data for customer reconciliation and post-go-live review.