Sync Inventory Audit
POST/api/shiphero/integration-instances/:integration_instance/inventory-audit/sync
Queue a background job that pulls ShipHero inventory changes into the audit ledger. mode: since_latest (incremental from the latest recorded change, pass date_from), date_range (pass date_from + date_to), or all (full history). Returns the tracked job id. Returns 409 if a sync is already running for this integration. Requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 422
- 429
OK
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.