API

API Authorization Guide: Connect Stores and Platform Accounts

How customers authorize channels in Burton AI WMS through OAuth, API keys, or tokens, then verify that the connection works.

Burton AI WMS API E-commerce customers / Operations / Implementation / Admin 10 min Configuration Required Version 2026.08 Updated 2026-05-16 Owner: Burton Product Documentation Quarterly review
3assets 2026-05-16Updated on

01 Use Case

Customers authorize stores, ERP accounts, or marketplace accounts in Burton AI WMS so an enabled and validated connector can synchronize orders, products, inventory, shipment status, and logistics information within the authorized scope.

After authorization, configuration, and integration testing, orders from enabled channels can enter the system within the approved project scope for fulfillment, inventory updates, and shipment confirmation.

02 Pre-Go-Live Capability Status

A connector shown in the interface, a screenshot, or this documentation is not necessarily enabled for the current customer environment. Confirm one of these statuses before rollout:

StatusQualificationCustomer Action
StandardGenerally available in the applicable release and verified environment.Confirm license, account permissions, and business scope.
Configuration RequiredThe connector or workflow exists but requires authorization, mapping, or environment setup.Complete authorization, mapping, testing, and rollout approval.
Custom AssessmentA new adapter, transformation, or customer-specific workflow is required.Approve requirements, pricing, schedule, and acceptance criteria.
RoadmapA direction available for assessment without a delivery commitment.Do not use it as a contractual, production-planning, or rollout dependency.

Platform availability, fields, synchronization frequency, and confirmation behavior follow the current environment and mutually approved documents.

03 Before Authorization

ItemDescription
Customer accountThe customer needs an approved Burton AI WMS account.
Store permissionsThe customer must have admin or API authorization permission for the channel.
API credentialsAPI connections may require Seller ID, Client ID, Client Secret, Refresh Token, Marketplace ID, or similar values.
SKU rulesStore SKU, warehouse SKU, and system SKU should be aligned before go-live.
Logistics rulesConfirm default warehouse, shipping method, carrier name, and confirmation rules.

Do not place Client Secret, Refresh Token, or Access Token in chat history or public screenshots. If credentials must be shared temporarily, use a controlled channel and rotate them when required by the customer's security policy.

04 Sign In and Open Authorization

  1. Open the Burton AI WMS 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.

Integrations authorization entry

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

05 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 AI WMS.

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 AI WMS and confirm the channel is Connected.
  5. Open Orders or Products to check whether data starts syncing.

06 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.

FieldPurpose
Seller ID / Merchant IDIdentifies the seller or merchant account.
Marketplace IDIdentifies the marketplace region, such as US, UK, or DE.
Client IDClient identifier for the API app or connector.
Client SecretAPI app secret; customers should store it securely.
Refresh TokenAllows the system to keep syncing orders, inventory, and shipment status.
Warehouse / CarrierUsed for inventory, fulfillment, and logistics mapping.

Setup Wizard API authorization

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

07 Validate After Authorization

PageWhat to Check
OrdersPlatform orders, order status, recipient information, and fulfillment status.
ProductsProduct title, SKU, price, weight, and status.
Inventory ProductsOn Hand, Committed, Incoming, and Available stock.
Activity LogsAuthorization failure, sync failure, or permission issues.

Orders after authorization

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