1
2
Get a test company
Never build against live data. Request a test company and key through brandgate.dev/contact. Read the integration model to agree who owns each field.
3
Map the objects
Write down how each object matches: products and stock on
sku, customers on BrandGate id plus your own customer number, orders on BrandGate id. Keep the mapping in your system so every sync can find the pair.4
Build the sync
Follow Sync an ERP: orders into your system, an acknowledgement back, stock and other data out, a webhook for speed and a catch-up sweep for safety.
5
Test the hard cases
Run your integration against the test company: a cancelled order, an order with many lines, a retry after a crash, a stock level of zero, a rate limit, an expired token. See troubleshooting.
6
Go live
Use the checklist below, then switch to the customer’s credentials.
Go-live checklist
- Webhook signatures are verified and old timestamps are rejected.
- Events already handled are skipped (
BrandGate-Event-Id). - The catch-up sweep runs even when webhooks work.
- Orders are stored by BrandGate
idwith a uniqueness rule, so retries never duplicate. - You back off on
429and useRetry-After. - The key is in a secret manager and has only the needed scopes.
- You log the
request_idof every failing call. - You agreed with the company who owns stock, products, prices and customers.