Warehouse Search

GET{{api_url}}/shop/warehouse/search

Returns the warehouses on your account, with each warehouse's name, identifier, address, contact details, fulfillment order, service IDs, and zip code rules. Search by text and page through results with limit and limit_start. Results are always sorted by warehouse name, A to Z.

Use it to find a warehouse's warehouse_id from its name, which the inventory, bin location, and warehouse endpoints need, or to see which warehouse covers which zips. For one known warehouse, use Warehouse Get.

Query parameters

Parameter	Type	Description
`search_term`	string	Partial match against the warehouse's name, identifier, address (street, city, state, region, zip, country), contact person, company, phone, and email. `Naperville` returns every warehouse with Naperville in any of those fields.
`limit`	integer	Number of warehouses to return. Default and maximum: 100.
`limit_start`	integer	Number of warehouses to skip before returning results. Use it with `limit` to page: `limit=25&limit_start=25` returns warehouses 26 through 50.
`just_count`	integer	Set to `1` to return only `total_warehouses`, the number of matching warehouses, instead of the warehouses themselves.

Examples

Every warehouse, up to 100:

{{api_url}}/shop/warehouse/search

Find a warehouse by name:

{{api_url}}/shop/warehouse/search?search_term=Main

Warehouses in one city:

{{api_url}}/shop/warehouse/search?search_term=Naperville

How many warehouses match, without the warehouses:

{{api_url}}/shop/warehouse/search?just_count=1

Response

Sorted by warehouse name, and trimmed to the key fields documented below:

{
    "warehouses": [
        {
            "shop_warehouseid": "7", "warehouse_name": "Canada", "warehouse_identifier": "canada",
            "city": "Brant and Norfolk (Waterford)", "zip": "N0E", "country": "CAN",
            "fulfill_ord": "7", "use_zip_rules": "0",
            "warehouse_zip_rules": [
                {"shop_warehouse_zip_rule_id": "6", "shop_warehouse_zip_rule_warehouse_id": "7", "zip_rule": "0*"}
            ]
        },
        {
            "shop_warehouseid": "3", "warehouse_name": "Main Warehouse (Midwest)", "warehouse_identifier": "main",
            "street1": "123 Main St", "city": "Naperville", "state": "IL", "zip": "60540", "country": "USA",
            "fulfill_ord": "3", "use_zip_rules": "0",
            "warehouse_zip_rules": [
                {"shop_warehouse_zip_rule_id": "4", "shop_warehouse_zip_rule_warehouse_id": "3", "zip_rule": "1*"},
                {"shop_warehouse_zip_rule_id": "5", "shop_warehouse_zip_rule_warehouse_id": "3", "zip_rule": "2*"}
            ]
        },
        {
            "shop_warehouseid": "4", "warehouse_name": "Secondary Warehouse (West)", "warehouse_identifier": "secondary",
            "zip": "12345",
            "fulfill_ord": "4", "use_zip_rules": "0",
            "warehouse_zip_rules": [
                {"shop_warehouse_zip_rule_id": "2", "shop_warehouse_zip_rule_warehouse_id": "4", "zip_rule": "9*"},
                {"shop_warehouse_zip_rule_id": "3", "shop_warehouse_zip_rule_warehouse_id": "4", "zip_rule": "8*"}
            ]
        }
    ],
    "total_warehouses": "4"
}

Field	Description
`warehouses`	The matching warehouses, sorted by warehouse name, A to Z. `null` when nothing matches.
`total_warehouses`	The number of warehouses matching your search across all pages, not just this page.

Warehouse fields

Field	Description
`shop_warehouseid`	The warehouse ID. This is the `warehouse_id` the inventory, bin location, and order endpoints take.
`warehouse_name`	The warehouse's display name.
`warehouse_identifier`	The warehouse's short code, for example `main`. The same value appears in `warehouse_identifier` on order lines and in routing records.
`street1`, `street2`, `city`, `state`, `region`, `zip`, `country`	The warehouse address. Zip Code Distance routing measures from this address.
`contact_person`, `company`, `phone`, `email`	The warehouse's contact details.
`fulfill_ord`	The warehouse's position in the Manual Sort priority list, used when `warehouse_fulfill_order_method` is set to Manual Sort. InfiPlex assigns it.
`use_zip_rules`	`1` when the warehouse only fills orders whose ship-to zip matches one of its zip code rules. `0` when it is eligible for every order.
`kehe_id`, `wayfair_castlegate_id`, `three_pl_central_id`, `shopify_id`, and the other `\*_id` fields	The warehouse's ID on a connected 3PL, fulfillment service, marketplace, or ERP. A fulfillment service ID is what routes the warehouse's orders to that service. Empty when the warehouse isn't tied to that service. Set these in the OMS at Inventory > Warehouses.
`warehouse_zip_rules`	The warehouse's zip code rules, one entry per rule. `null` when the warehouse has no rules. They are listed whether or not `use_zip_rules` is on, but they only limit which orders the warehouse can fill when `use_zip_rules` is `1`.

Zip rule fields (warehouse_zip_rules)

Field	Description
`shop_warehouse_zip_rule_id`	The rule's ID.
`shop_warehouse_zip_rule_warehouse_id`	The warehouse the rule belongs to.
`zip_rule`	The rule: a zip prefix ending in the `\` wildcard. `9\` matches every zip starting with 9, and `713\*` matches every zip starting with 713, five-digit or ZIP+4. A rule without the wildcard, such as `60540`, matches only that exact zip and misses `60540-1234`.

Before you build

search_term matches anywhere in any of its fields, so a short term can return more than you expect. IL matches warehouses in Illinois and also any name, street, or email containing "il". To pin down one warehouse, search by its name or identifier.
search_term doesn't search zip rules. To find the warehouse that covers a zip, read warehouse_zip_rules on each warehouse that has use_zip_rules set to "1".
Check for null before looping, both on warehouses and on each warehouse's warehouse_zip_rules. A search with no matches, and a warehouse with no rules, both return null, not an empty array.
The sort order is by name, not by fulfill_ord. To see the Manual Sort priority, order the results by fulfill_ord yourself.
Values come back as strings, including total_warehouses, fulfill_ord, and use_zip_rules.
A call returns at most 100 warehouses. On accounts with more, page with limit=100, adding 100 to limit_start each time, until you've read total_warehouses warehouses or a page returns fewer than 100.
Your API key needs Warehouse read permission. A key without it gets 403 Forbidden.

Related guides:

Authorization

Bearer token, sent in the Authorization header. Inherited from the collection.

Query Parameters

Key	Value	Description
`just_count` optional		Set to 1 if you want a count of warehouses found
`limit` optional		If this is set, then only this number of results will be returned
`limit_start` optional		If 100 results are returned and this is set to 25, the first 25 results will be omitted
`search_term` optional

Example Request

curl --location --request GET '{{api_url}}/shop/warehouse/search' \
--header 'Authorization: Bearer {{auth_token}}'

Example Responses