Bulk Send Purchase Order ASNs
POST/api/purchase-orders/asn/bulk
Send the ASN for several purchase orders in the background. Each goes to its destination's warehouse system (a ShipHero purchase order) or is emailed as a spreadsheet. POs already in their warehouse system with no changes are skipped; POs with products the warehouse system doesn't have are held.
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body
ids(array of integers, 1–500, required unlessapply_to_allistrue): the purchase order ids.apply_to_all(boolean, optional):truesends every purchase order matchingfilters(object, optional; omitted = every purchase order) instead ofids.filtersis ignored unlessapply_to_allistrue, andapply_to_all: false(orfiltersalone) still requiresids.
Returns tracked_job_log_id for the background job (named Send ASNs to {destination}). When it completes, its results hold outcomes (counts of sent, linked, updated, emailed, held, skipped, failed) and one entry per purchase order with its outcome and message.
Requires permission: purchase_orders.update
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 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.
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.