Update Shipment Ship Notice Structure
PUT/api/spscommerce/fulfillments/:salesOrderFulfillment/packing/asn-structure
Choose the 856 advance ship notice structure for this one shipment, overriding its trading partner's structure — for retailers whose routing varies per shipment (e.g. Split by DC for an LTL load to a distribution center, Small Package for parcel). Send asn_structure as one of order_item, pick_and_pack, store_order_item, store_pick_and_pack, or null to go back to the trading partner's structure.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Pick-and-pack structures report every carton with its SSCC-18 and wait for packing to be finalized; store structures send one order level per store of a multi-store purchase order, so each carton must hold a single store's items. When a shipped shipment moves to a structure without cartons (or its packing is already finalized), its ship notice is sent. 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.