API Documentation

01 1. Scope

The API guide set helps e-commerce customers connect stores, ERP accounts, or marketplace accounts to Burton WMS Ai. After onboarding, orders, products, inventory, customers, shipment status, and tracking information can sync between sales channels and warehouse operations.

These public guides do not include real API keys, customer order details, or sensitive platform screenshots. Before sharing screenshots externally, confirm they do not show tokens, secrets, customer emails, addresses, or raw order numbers.

02 2. Document Map

03 3. Onboarding Lifecycle

04 4. Recommended Ownership

05 5. Go-live Checklist

• The user account is approved and can enter the correct workspace.
• The channel is Connected or has passed the connection test.
• Three to five SKUs have been checked across channel SKU, warehouse SKU, and system SKU.
• Three to five orders have been checked for status, recipient data, line items, and fulfillment state.
• On Hand, Committed, Incoming, and Available inventory fields are understood and aligned with warehouse logic.
• Shipping confirmation fields match platform requirements, especially Carrier, Tracking, and Ship Date.
• Reports can export the required order, product, and inventory CSV files.

Integrations is the main entry point for channel connection and authorization management.

Access Control limits who can manage authorization, credentials, and admin settings.

01 1. Use Case

Customers authorize stores, ERP accounts, or marketplace accounts in Burton WMS Ai so the system can sync orders, products, inventory, shipment status, and logistics information.

After authorization, Amazon, Shopify, TikTok Shop, eBay, Wayfair, Walmart, and other channel orders can enter the system for fulfillment, inventory updates, and shipment confirmation.

02 2. Before Authorization

03 3. Sign In and Open Authorization

1. Open the Burton WMS Ai system.
2. Sign in with an approved customer account.
3. On Dashboard, confirm whether the current scope is All Channels or a specific store.
4. Open Integrations from the sidebar, or use Setup Wizard during first-time onboarding.

Customers choose the relevant platform in Integrations and open Manage or Connect to authorize it.

04 4. OAuth Channels

Shopify and TikTok Shop should use OAuth when available. After clicking Connect, the customer is redirected to the official platform authorization page. After permission approval, the page returns to Burton WMS Ai.

Key steps:

1. Confirm the browser is logged into the correct store admin account.
2. Click Connect or Manage on the matching channel card.
3. Approve the requested permission scope on the platform page.
4. Return to Burton WMS Ai and confirm the channel is Connected.
5. Open Orders or Products to check whether data starts syncing.

05 5. API Key / Token Channels

Amazon SP-API, Wayfair, Walmart, and similar channels may require API credentials. Customers should obtain the credentials from the platform admin portal and enter them in Setup Wizard or channel settings.

Setup Wizard can be used during go-live to enter channel credentials and verify connection status.

06 6. Validate After Authorization

After authorization, platform orders appear in Orders for operations and warehouse follow-up.

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.

02 2. Sync Objects and Check Pages

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.

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

04 4. Inventory Definitions

Customers should understand the operational meaning of each inventory field.

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 exports order, product, and inventory data for customer reconciliation and post-go-live review.

01 1. Troubleshooting Principle

When an API issue appears, first identify the layer: account permission, channel authorization, SKU mapping, warehouse inventory, shipment confirmation, or platform API limitation.

02 2. Quick Check Order

1. Confirm the customer account has passed Approvals.
2. Confirm the user has the correct workspace and module permissions in Access Control.
3. Open Integrations and check whether the channel is Connected.
4. Review Activity Logs for authorization failure, sync failure, or permission issues.
5. Sample-check Orders, Products, and Inventory Products.
6. For shipment issues, check Carrier, Tracking, Ship Date, and platform-required fields.

Activity Logs helps locate user actions, authorization issues, sync failures, and permission problems.

03 3. Common Questions

04 4. Error Handling Template

05 5. Permissions and Security

Admins should restrict who can operate Integrations, Setup Wizard, and Access Control. Support and operations users may review sync status, but should not manage API credentials unless explicitly approved.

Access Control manages who can view, edit, or administer sensitive features by group and workspace.