Skip to main content

Get Warehouse Mappings

GET 
/api/veracore/integration-instances/:integration_instance/warehouse-mappings

Every Veracore facility discovered for this integration instance alongside its SKU.io warehouse mapping.

Not yet available to API tokens

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

A 3PL fulfils from a handful of buildings, so the page count is usually one — the feed is paginated (page, per_page, default 15) and filtered server-side for consistency with every other record list, not to spare the database.

is_mapped is true once a SKU.io warehouse is behind the facility. auto_mapped marks a facility matched automatically rather than by hand. An inactive facility keeps its mapping — it simply stops mirroring — which is why inactive is its own scope rather than a third mapped/unmapped state.

Search filter[search] runs a fuzzy LIKE across veracore_warehouse_id, veracore_warehouse_name and the mapped SKU.io warehouse's name.

Filters Every filterable column takes an operator suffix, e.g. filter[sku.contains]=WID. The bare form (filter[sku]=WID-BLU-12) is equivalent to .is.

  • Text operators: is, is_not, contains, does_not_contain, 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.
  • Datetime operators: is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, plus the relative operators today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year.

Advanced filter groups Instead of flat keys, clients may send a base64-encoded filter_groups tree, nesting AND/OR groups over the same columns. Unregistered columns inside the tree are silently ignored.

  • Text columns: veracore_warehouse_id, veracore_warehouse_name, warehouse_name (the mapped SKU.io warehouse, filtered through the relationship).
  • Numeric columns: id, warehouse_id.
  • Boolean columns: is_active, auto_mapped (send 1 or 0).
  • Datetime columns: last_seen_at, created_at, updated_at.
  • filter[is_mapped] takes true or false; filter[scope] takes mapped, unmapped or inactive.

warehouse_name filters through its relationship and is not a sort column — sort by warehouse_id instead.

Sorting sort accepts id, veracore_warehouse_id, veracore_warehouse_name, warehouse_id, is_active, auto_mapped, last_seen_at, created_at, updated_at (prefix with - for descending). Default sort is veracore_warehouse_name.

Errors

  • 404 when the integration instance does not exist or is not a Veracore instance.

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type