GET warehouses
Returns a list of Warehouses
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Returns a list of Warehouses
Collection of WarehouseModelName | Description | Type | Additional information |
---|---|---|---|
ShippingAddress | Shipping Address for the Warehouse | AddressModel | None. |
BillingAddress | Billing Address for the Warehouse | AddressModel | None. |
IsDefault | Indicates whether this is set as your Default Warehouse in StoreFeeder | boolean | None. |
MetaPackWarehouseCode | MetaPack warehouse code, may be added only if at least one MetaPack courier integration is assigned to the account. | string | None. |
SenderName | The name of the Sender for that Warehouse | string | None. |
CollectionPoint | The Collection point is used by some couriers when booking a pickup. For example: Front Desk, Warehouse | string | None. |
HandlingTime | The handling time (in days) that it takes to process and despatch an order from the Warehouse | integer | None. |
MaxOrderValue | Max Value of an order that can be placed on that Warehouse | decimal number | None. |
MaxOrderSubtotal | Max Subtotal of an order that can be placed on that Warehouse | decimal number | None. |
MaxOrderTotal | Max Total of an order that can be placed on that Warehouse | decimal number | None. |
ApplyTaxToShipping | Specifies whether tax should be applied to shipping costs for that warehouse | boolean | None. |
WarehouseType | The type of warehouse this has been designated as in StoreFeeder | string | None. |
WarehouseName | Name of the warehouse | string | None. |
WarehouseGuid | globally unique identifier | None. | |
WarehouseID | Id Number of the Warehouse | integer | None. |
Response Formats
application/json, text/json
Sample:
{ "Warehouse": { "ShippingAddress": { "Address1": "123 Example Street", "Address2": "Somewhere", "Address3": "Somewhere Else", "City": "Some City", "State": "Some Region", "Postcode": "AN1 1NA", "Country": "United Kingdom" }, "BillingAddress": { "Address1": "123 Example Street", "Address2": "Somewhere", "Address3": "Somewhere Else", "City": "Some City", "State": "Some Region", "Postcode": "AN1 1NA", "Country": "United Kingdom" }, "IsDefault": true, "MetaPackWarehouseCode": "META_PACK_CODE", "SenderName": "Sender", "HandlingTime": 1, "MaxOrderValue": 1234.56, "MaxOrderSubtotal": 999.95, "MaxOrderTotal": 1080.0, "ApplyTaxToShipping": true, "WarehouseType": "Fulfilment", "WarehouseName": "Warehouse 1", "WarehouseGuid": "00000000-0000-0000-0000-000000000000", "WarehouseID": 1 } }
application/xml, text/xml
Sample:
<WarehousesResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Warehouse> <WarehouseName>Warehouse 1</WarehouseName> <WarehouseGuid>00000000-0000-0000-0000-000000000000</WarehouseGuid> <WarehouseID>1</WarehouseID> <ShippingAddress> <Address1>123 Example Street</Address1> <Address2>Somewhere</Address2> <Address3>Somewhere Else</Address3> <City>Some City</City> <State>Some Region</State> <Postcode>AN1 1NA</Postcode> <Country>United Kingdom</Country> </ShippingAddress> <BillingAddress> <Address1>123 Example Street</Address1> <Address2>Somewhere</Address2> <Address3>Somewhere Else</Address3> <City>Some City</City> <State>Some Region</State> <Postcode>AN1 1NA</Postcode> <Country>United Kingdom</Country> </BillingAddress> <IsDefault>true</IsDefault> <MetaPackWarehouseCode>META_PACK_CODE</MetaPackWarehouseCode> <SenderName>Sender</SenderName> <HandlingTime>1</HandlingTime> <MaxOrderValue>1234.56</MaxOrderValue> <MaxOrderSubtotal>999.95</MaxOrderSubtotal> <MaxOrderTotal>1080.00</MaxOrderTotal> <ApplyTaxToShipping>true</ApplyTaxToShipping> <WarehouseType>Fulfilment</WarehouseType> </Warehouse> </WarehousesResponse>