Refresh Single Order
POST/api/big-commerce/:integrationInstance/orders/refresh-order
Refresh a single BigCommerce order by its unique identifier (BigCommerce order ID). Fetches the latest data from BigCommerce API and returns the updated order resource.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Fields:
- uniqueId (required, string): The BigCommerce order unique ID (e.g., 'BC-10001')
Requires the integrations.sync permission.
Request
Responses
- 200
- 401
- 403
- 404
- 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
Response Headers
Not Found
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.