Skip to main content

Bulk Re-process Shipments

POST 

/api/shiprush/instances/:integration_instance/shipments/bulk-re-process

Re-process several shipments at once: clears the writeback error on every selected shipment whose writeback failed. Shipments without a writeback error are skipped.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Body fields:

  • ids (array of integers, required unless apply_to_all is true): the shipment ids to act on. Ids belonging to another integration instance are ignored.
  • apply_to_all (boolean, optional): when true, act on every shipment matching filters instead of ids.
  • filters (object, optional): the same filter keys the List Shipments endpoint accepts (e.g. writeback_status.is, carrier_code.is), plus filter_groups for grouped conditions. Only used with apply_to_all.

Returns counts: processed (acted on), skipped (the action does not apply to the row's state), failed (the action errored), and errors keyed by row id. Returns 422 when neither ids nor apply_to_all is sent.

Authentication: Requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type