Skip to main content

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.

Required scope: integrations:write

Grant 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​

OK

Response Headers
    Content-Type