Skip to main content

List Inbound Shipments

GET 
/api/walmart/:integrationInstance/wfs/inbound-shipments

Paginated list of WFS inbound shipments for an integration instance (Spatie QueryBuilder).

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Authentication: Requires Bearer token.

Filters (query string, all optional):

  • filter[search]: global fuzzy search over shipment_id, inbound_order_id, ship_node.
  • Text filters (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; bare key = implicit 'is'): shipment_id, inbound_order_id, status, ship_node, carrier_name.
  • Numeric filters (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): id, shipment_units, received_units.
  • Datetime filters (is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, tomorrow, past_week/month/year, next_week/month/year, days_ago, days_from_now, past_days, next_days): expected_delivery_date, walmart_created_at, created_at. Operator syntax: filter[<column>.<operator>]=value (e.g. filter[shipment_id.contains]=9012).

Sorts (sort=<field>, prefix - for descending): id, shipment_id, inbound_order_id, status, ship_node, shipment_units, received_units, line_count, expected_delivery_date, updated_expected_delivery_date, walmart_created_at, created_at. Default sort: -created_at.

Pagination: page, per_page (default 10).

Request​

Responses​

OK

Response Headers
    Content-Type