Skip to main content

List Ship-With-Preorder History

GET 

/api/v2/inventory-allocations/ship-with-preorder/events

Every ship-with-preorder change: reserved from a PO (deferred), released when its PO was received (released_on_receipt), dates re-checked (rechecked), moved to another PO (repointed), returned to shelf stock (returned_to_on_hand), ended and flagged (ended_flagged), switched to shelf stock by a user (manual_end), cancelled (cancelled).

Required scope: orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Every filter is accepted as filter[x] or plain x. action and warehouse_id take comma lists. date_from / date_to are calendar days in the account timezone, in m/d/Y (Y-m-d also accepted), inclusive.

Searches ID (exact), sales order number, SKU and PO number. Restrict with search_columns (comma list of id, sales_order_number, sku, purchase_order_number).

filter_groups (base64-encoded JSON tree with AND/OR groups) applies advanced conditions; each condition's column is <column>.<operator>. Columns: id, quantity (numeric); sales_order_number, sku, purchase_order_number (text — matches the from or to PO); created_at (datetime).

Allowed sorts: id, created_at, quantity, action, sales_order_number, sku (default -created_at). Paginated (default 10, max 500).

Request​

Responses​

OK

Response Headers
    Content-Type