Record Shipment Carrier Pickup
PUT/api/spscommerce/fulfillments/:salesOrderFulfillment/packing/carrier-pickup
Record when the carrier picked a shipment up, or clear it by sending null. A retailer with the after_carrier_pickup document rule takes the 856 only after this is set, because a shipment being marked shipped does not mean the carrier has it. Recording it on a shipped shipment sends the ship notice it was holding, dated the pickup day, unless another rule still holds it.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body fields:
- carrier_picked_up_at (ISO 8601 date-time or null, required): when the carrier took the shipment. It can't be in the future.
Returns 422 once the shipment's 856 exists.
Authentication: Requires Bearer token. Available for shipments of SPS Commerce EDI orders; other shipments return 404. Requires the sales_orders.update 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 — 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.
Unprocessable Entity
Response Headers
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.