Refresh Sales Order Address Snapshots
POST/api/sales-orders/:salesOrder/refresh-address-snapshots
Re-copies the current contents of the order's shipping and billing address records into the order's own inline address snapshot columns. Use this after editing an address record's content (same address ID, different data) so the order's stored snapshot — which is what documents and the order detail display — reflects the corrected address.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Only addresses linked by ID are refreshed; orders whose snapshot has no backing address record are left unchanged.
Authentication: Requires Bearer token.
No request body.
Path parameters:
- salesOrder (required): Sales order ID.
Requires permission: sales_orders.update
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 — 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
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.