Refresh Single Shipment
POST/api/shipstation/integration-instances/:integrationInstance/shipments/refresh-shipment
Download (or update) a single label shipment live from ShipStation and persist it to the local cache. Backs the per-result Download/Update buttons on the shipments refresh modal's search tab.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
ShipStation V1 has no GET /shipments/{id} endpoint, so the lookup needs the shipment's order id or tracking number alongside its id — the shipment is found by listing shipments filtered by orderId (preferred) or exact trackingNumber and matching on the shipment id.
Request body:
uniqueId(string, required) — the ShipStation shipment id (shipstation_shipment_idfrom a search result).order_id(integer, optional, nullable) — the ShipStation order id (shipstation_order_idfrom a search result). Preferred lookup key.tracking_number(string, optional, nullable, max 255) — fallback lookup key when the shipment has no order id.
At least one of order_id or tracking_number is required (400 otherwise). Returns 404 if ShipStation no longer returns the shipment, 502 if the ShipStation API call fails.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 429
- 502
OK
Response Headers
Bad Request
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.
Bad Gateway