Sync Companies From Shopify
POST/api/shopify/b2b/:integrationInstance/companies/sync
Queues a read-only pull of the store's B2B companies and locations, then auto-matches unmapped locations to SKU.io customers.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
This never writes to Shopify. Exact matches on external id, billing email, or company plus location name are applied automatically; a fuzzy name match is recorded as a candidate for review and is never applied on its own.
Returns the tracked job id so progress can be followed.
Authentication: requires a Bearer token.
Request
Responses
- 202
- 401
- 403
- 404
- 422
- 429
Accepted
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.