The objects
The exact fields, endpoints and which of them can be written are in the API reference, which is generated from the contracts and always up to date.
Who owns what
The rule is simple: one system owns each piece of data, and the other one follows. Two systems writing the same field is where syncs go wrong.If you integrate products, prices or customers, agree with the company which system is the source of truth before you build. The pages for each system under Integrations state the rules for that system.
Sync patterns
Use all three together; none of them alone is enough.Webhooks
BrandGate tells you when something changed. Fast, but a single delivery can be missed.
Catch-up polling
Every few minutes, read what changed with
updated_since. This guarantees nothing is lost.Idempotent writes
Repeating a write is safe, so a retry after a crash never duplicates anything.
Idempotency in practice
Store BrandGate’sid for each order in your own system, with a uniqueness rule. Before you create an order, look it up by that id. If it exists, reuse it; if not, create it and then acknowledge. If you crash between those steps, the retry finds your order instead of creating a second one.