Capture 3PL Inventory Snapshot
POST/api/3pl-inventory/integration-instances/:integrationInstance/snapshots
Refresh the 3PL's inventory and capture a new comparison snapshot in the background. Returns the background job ID; poll the job, then read the summary.
inventory:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (inventory:write scope) and the integrations sync permission.
Returns 409 with the running snapshot's ID when a capture is already in progress.
Request
Responses
- 202
- 401
- 403
- 404
- 409
- 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.
Conflict
Response Headers
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.