GET api/v2/products/GetWarehouseList
Get list of warehouses
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of WarehouseName | Description | Type | Additional information |
---|---|---|---|
WarehouseCode | string |
None. |
|
Name | string |
None. |
|
Address1 | string |
None. |
|
Address2 | string |
None. |
|
City | string |
None. |
|
State | string |
None. |
|
Zip | string |
None. |
|
Phone | string |
None. |
|
Fax | string |
None. |
Item Type Definitions
Items - These are standalone products packaged in a single box.
- Examples include a dining chair, a complete nightstand, or even a dining set where all components are packaged together in one box.
- The contents may represent a single product or multiple pieces bundled as a complete set.
Kit Items - Products requiring multiple boxes for complete assembly or functionality.
- Examples include a dining table where the tabletop and legs are boxed separately.
- While the complete product is sold as one SKU, its components are shipped in multiple packages.
Supplement Items - Products that depend on a primary item to function, often enhancing or complementing another product.
- Examples: A dresser mirror (requires a dresser for use) or a trundle (designed to pair with a daybed).
- While sellable individually, they lack standalone utility without the corresponding main product.
Components - Single-box parts of a larger Kit Item, typically not sold or listed independently.
- Examples include the tabletop or legs of a Kit Item dining table.
- Unlike Supplement Items, Components are integral parts of a single product, not optional add-ons.
Combo Sets - Bundles of individually sellable Items curated for convenience or a cohesive design.
- Examples: A dining set combining a Kit Item table with four matching dining chairs (each chair being an Item).
- These sets simplify purchasing and ensure compatibility among the pieces.
Sellable Components - Functionally part of a larger Kit Item but capable of being sold or used on their own.
- Examples: A headboard from a multi-box bed or a standalone glass tabletop for a dining table.
- Unlike Components, Sellable Components retain functional value independently and are offered individually.
Response Formats
application/json, text/json
Sample:
[ { "WarehouseCode": "sample string 1", "Name": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "Zip": "sample string 7", "Phone": "sample string 8", "Fax": "sample string 9" }, { "WarehouseCode": "sample string 1", "Name": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "Zip": "sample string 7", "Phone": "sample string 8", "Fax": "sample string 9" } ]
application/xml, text/xml
Sample:
<ArrayOfWarehouse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CoasterAPI.Warehouses"> <Warehouse> <Address1>sample string 3</Address1> <Address2>sample string 4</Address2> <City>sample string 5</City> <Fax>sample string 9</Fax> <Name>sample string 2</Name> <Phone>sample string 8</Phone> <State>sample string 6</State> <WarehouseCode>sample string 1</WarehouseCode> <Zip>sample string 7</Zip> </Warehouse> <Warehouse> <Address1>sample string 3</Address1> <Address2>sample string 4</Address2> <City>sample string 5</City> <Fax>sample string 9</Fax> <Name>sample string 2</Name> <Phone>sample string 8</Phone> <State>sample string 6</State> <WarehouseCode>sample string 1</WarehouseCode> <Zip>sample string 7</Zip> </Warehouse> </ArrayOfWarehouse>