GET warehousezones?WarehouseID={WarehouseID}&Name={Name}&PageSize={PageSize}&Page={Page}

Returns a list of Warehouse Zones

Request Information

URI Parameters

NameDescriptionTypeAdditional information
WarehouseID This is an optional parameter. Set it to only return Warehouse Zones for a given Warehouse. You can get a list of Warehouses from the Warehouses endpoint. integer Matching regular expression pattern: ^[1-9]\d*$
Name This is an optional parameter. This will only return Warehouse zones which contain the provided Name. string None.
PageSize This is an optional parameter. This will default to 100. The max page size is 100 integer Range: inclusive between 1 and 100
Page This is an optional parameter. It will default to page 1. integer Matching regular expression pattern: ^[1-9]\d*$

Body Parameters

None.

Response Information

Resource Description

Returns a list of Warehouse Zones

PagedResponseModelOfWarehouseZoneModel
NameDescriptionTypeAdditional information
TotalItems integer None.
PagingInfo PagingFilter None.
TotalPages integer None.
PrevUrl string None.
PextUrl string None.
Data Collection of WarehouseZoneModel None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItems": 2,
  "PagingInfo": {
    "PageSize": 1,
    "Page": 1
  },
  "TotalPages": 1,
  "Data": [
    {
      "WarehouseZoneID": 1,
      "Name": "WZ1",
      "Warehouse": {
        "WarehouseName": "My Warehouse",
        "WarehouseGuid": "613986d6-c4f0-4d3f-a19d-052eac5eac98",
        "WarehouseID": 1
      }
    },
    {
      "WarehouseZoneID": 2,
      "Name": "WZ2",
      "Warehouse": {
        "WarehouseName": "My Warehouse",
        "WarehouseGuid": "613986d6-c4f0-4d3f-a19d-052eac5eac98",
        "WarehouseID": 1
      }
    }
  ]
}

application/xml, text/xml

Sample:
<PagedWarehouseZoneModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TotalItems>2</TotalItems>
  <PagingInfo>
    <PageSize>1</PageSize>
    <Page>1</Page>
  </PagingInfo>
  <TotalPages>1</TotalPages>
  <Data>
    <WarehouseZoneModel>
      <WarehouseZoneID>1</WarehouseZoneID>
      <Name>WZ1</Name>
      <Warehouse>
        <WarehouseName>My Warehouse</WarehouseName>
        <WarehouseGuid>613986d6-c4f0-4d3f-a19d-052eac5eac98</WarehouseGuid>
        <WarehouseID>1</WarehouseID>
      </Warehouse>
    </WarehouseZoneModel>
    <WarehouseZoneModel>
      <WarehouseZoneID>2</WarehouseZoneID>
      <Name>WZ2</Name>
      <Warehouse>
        <WarehouseName>My Warehouse</WarehouseName>
        <WarehouseGuid>613986d6-c4f0-4d3f-a19d-052eac5eac98</WarehouseGuid>
        <WarehouseID>1</WarehouseID>
      </Warehouse>
    </WarehouseZoneModel>
  </Data>
</PagedWarehouseZoneModel>