Skip to main content

Get Expected Arrivals

GET 

/api/veracore/integration-instances/:integration_instance/expected-arrivals

Paginated expected arrivals for an integration instance, soonest-arriving last.

Required scope: integrations:read

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

An expected arrival is an announcement, not a receipt: pushing one tells the warehouse what is coming, it never adds stock. Every quantity here is expected. Once Veracore marks an arrival received it can no longer be edited or cancelled through the API, which is what is_locked reflects.

Each row carries two aggregates: lines_count (how many lines were announced) and total_quantity_expected (their summed expected quantity). Both describe the announcement — neither is a received quantity.

Search — filter[search] matches the arrival reference and both purchase order numbers.

Filterable columns

  • Text: foreign_system_key, our_purchase_order, client_purchase_order, veracore_warehouse_id, owner_id, trading_partner_id, status, shipping_method, load_type
  • Numeric: id
  • Checkbox (filter[is_locked.is]=1): is_locked
  • Date: anticipated_arrival_at
  • Date/time: last_synced_at, created_at, updated_at
  • Bespoke: filter[purchase_order_id] (id or array of ids)
  • Linked: filter[linked_to_sku] — true = only arrivals linked to a SKU.io purchase order; false = only arrivals with no purchase order. Also available in filter_groups with the is / is_not operators.

Sortable columns — id, foreign_system_key, our_purchase_order, client_purchase_order, veracore_warehouse_id, owner_id, trading_partner_id, anticipated_arrival_at, shipping_method, load_type, status, is_locked, last_synced_at, created_at, updated_at. Prefix with - for descending. Defaults to -anticipated_arrival_at.

Filters use filter[column.operator]=value; the bare key filter[column]=value is an implicit is.

  • Text operators: contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty
  • Numeric operators: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty
  • Date operators: is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year, days_ago, days_from_now, past_days, next_days

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type