Warehouse Get

GET{{api_url}}/shop/warehouse/{{warehouse_id}}

Returns one warehouse's settings: its name, identifier, address, contact details, fulfillment order, service IDs, and its zip code rules along with whether they apply.

Example

{{api_url}}/shop/warehouse/3

Response

Trimmed to the key fields documented below:

{
    "shop_warehouseid": "3",
    "warehouse_name": "Main Warehouse (Midwest)",
    "warehouse_identifier": "main",
    "contact_person": "main contact",
    "company": "main company",
    "street1": "123 Main St",
    "street2": "",
    "city": "Naperville",
    "state": "IL",
    "region": "",
    "zip": "60540",
    "country": "USA",
    "phone": "234-999-7361",
    "email": "main@email.com",
    "fulfill_ord": "3",
    "use_zip_rules": "0",
    "kehe_id": "18",
    "wayfair_castlegate_id": "wayfair1",
    "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*"}
    ]
}

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, so keep the street address and zip accurate.
`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. It can't be set through the API.
`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

Check for warehouse_zip_rules: null before looping. A warehouse with no rules returns null, not an empty array.
Values come back as strings, including fulfill_ord and use_zip_rules.
Zip code rules are read-only here. Add, change, or remove them in the OMS at Inventory > Warehouses > Add/Edit Warehouse.
In the example, warehouse 3 has rules for 1\* and 2\*, but use_zip_rules is "0", so it can still fill orders to any zip.
A warehouse with use_zip_rules set to "1" and warehouse_zip_rules of null matches no orders, so it drops out of routing.
To find a warehouse's ID from its name, use Warehouse Search.
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.

Example Request

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

Example Responses

Warehouse Get

Request

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

Response 200 OK

{
    "shop_warehouseid": "3",
    "shop_warehouse_siteareaid": "16",
    "shop_warehouse_drop_shipper_id": null,
    "warehouse_name": "Main Warehouse (Midwest)",
    "warehouse_identifier": "main",
    "contact_person": "main contact",
    "company": "main company",
    "street1": "123 Main St",
    "street2": "",
    "city": "Naperville",
    "state": "IL",
    "region": "",
    "zip": "60540",
    "country": "USA",
    "phone": "234-999-7361",
    "email": "main@email.com",
    "fulfill_ord": "3",
    "use_zip_rules": "0",
    "netsuite_id": "4",
    "netsuite_inventory_kit_custom_fields": "custitem_kit_qty_available_ny",
    "amazon_vendor_central_id": "",
    "wayfair_id": "",
    "shopify_id": "222222333333",
    "three_pl_central_id": "1",
    "shipstream_id": "4",
    "flexe_id": "238",
    "midwest_id": "07",
    "zhenhub_id": "AU Melbourne",
    "overstock_id": "over naper",
    "infiplex_fbi_id": "1,29",
    "qbo_inventory_asset_account": "0",
    "amazon_today_id": "145401bf-d4df-4435-9323-111111111",
    "magento_store_id": "2",
    "magento_stock_id": "3",
    "big_commerce_id": "2",
    "big_commerce_pickup_method_id": "1",
    "square_up_id": "AAAAA1GH9TAAAA",
    "sellercloud_id": "",
    "walmart_id": "Walmart naperville",
    "newegg_vf_id": "1",
    "dsco_id": "01",
    "sams_club_id": "828400_2",
    "teamwork_com_id": "014",
    "tiktok_id": "",
    "finale_inv_id": "100001",
    "infiplex_alerts_api_key": "zzzzzzzzOEWZ6GI48WXFYV5BWM46",
    "target_plus_id": "t++",
    "true_value_id": "1",
    "amazon_com_id": "111111-d4df-4435-9323-22222222",
    "emery_jensen_dist_id": "IL01",
    "deposco_id": "DAXDT",
    "cin7_id": "",
    "logiwa_id": "logiwa1",
    "ryder_id": "MADESCM",
    "do_it_best_id": "03",
    "keystone_id": "MidWest",
    "seawide_id": "MidWest",
    "ntp_id": "MidWest",
    "kehe_id": "18",
    "meyer_dist_id": "032",
    "dot_foods_id": "ILLINOIS",
    "zulily_id": "zuuu1",
    "bedbathbeyond_id": "BBBBBB1",
    "backyard_id": "backyard1",
    "shiphero_id": "",
    "costco_id": "",
    "veracore_id": "",
    "wayfair_castlegate_id": "wayfair1",
    "snapfulfil_id": "WAREHOUSE1",
    "ppm_fulfillment_id": "PPM_Naperville",
    "epicor_id": "",
    "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*"
        }
    ]
}

Warehouse Get

Authorization

Example Request

Example Responses

Warehouse Get

Request

Response 200 OK

Latest Posts

Useful Links

Contact Us