GetWarehousesByQuery
Returns information about all warehouses.
Tags: GetWarehousesByQuery, GetWarehousesByQueryResponse, GetWarehousesResult, GetWarehousesInfo, WarehouseAddress, WarehouseAddressCountry, WarehouseAddressNotifyClass
Request XML
POST /xxx/Automation.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/Automation/GetWarehousesByQuery"
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetWarehousesByQuery xmlns="http://ongoingsystems.se/Automation">
<UserName>string</UserName>
<Password>string</Password>
<Query />
</GetWarehousesByQuery>
</soap:Body>
</soap:Envelope>
Request specification
| GetWarehousesByQuery |
| UserName |
string(50) |
Req. |
Your username |
| Password |
string(50) |
Req. |
Your password |
| Query |
GetWarehousesQuery |
Req. |
The query object |
Response XML
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetWarehousesByQueryResponse xmlns="http://ongoingsystems.se/Automation">
<GetWarehousesByQueryResult>
<Message>string</Message>
<Success>boolean</Success>
<Warehouses>
<GetWarehousesInfo>
<WarehouseId>int</WarehouseId>
<WarehouseName>string</WarehouseName>
<WarehouseCode>string</WarehouseCode>
<Address>
<Name>string</Name>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<Country>
<CountryCode>string</CountryCode>
<CountryStateCode>string</CountryStateCode>
</Country>
<TelePhone>string</TelePhone>
<Email>string</Email>
<MobilePhone>string</MobilePhone>
<DeliveryInstruction>string</DeliveryInstruction>
<FreeText1>string</FreeText1>
<FreeText2>string</FreeText2>
<EmailNotification>
<ToBeNotified>boolean</ToBeNotified>
<Value>string</Value>
</EmailNotification>
<TelephoneNotification>
<ToBeNotified>boolean</ToBeNotified>
<Value>string</Value>
</TelephoneNotification>
<SMSNotification>
<ToBeNotified>boolean</ToBeNotified>
<Value>string</Value>
</SMSNotification>
</Address>
</GetWarehousesInfo>
<GetWarehousesInfo>
<WarehouseId>int</WarehouseId>
<WarehouseName>string</WarehouseName>
<WarehouseCode>string</WarehouseCode>
<Address>
<Name>string</Name>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<Country>
<CountryCode>string</CountryCode>
<CountryStateCode>string</CountryStateCode>
</Country>
<TelePhone>string</TelePhone>
<Email>string</Email>
<MobilePhone>string</MobilePhone>
<DeliveryInstruction>string</DeliveryInstruction>
<FreeText1>string</FreeText1>
<FreeText2>string</FreeText2>
<EmailNotification>
<ToBeNotified>boolean</ToBeNotified>
<Value>string</Value>
</EmailNotification>
<TelephoneNotification>
<ToBeNotified>boolean</ToBeNotified>
<Value>string</Value>
</TelephoneNotification>
<SMSNotification>
<ToBeNotified>boolean</ToBeNotified>
<Value>string</Value>
</SMSNotification>
</Address>
</GetWarehousesInfo>
</Warehouses>
</GetWarehousesByQueryResult>
</GetWarehousesByQueryResponse>
</soap:Body>
</soap:Envelope>
Response specification
| GetWarehousesByQueryResponse |
| GetWarehousesByQueryResult |
GetWarehousesResult |
|
| GetWarehousesResult |
| Message |
string |
If the call failed, this field contains the error message |
| Success |
boolean |
True if the call succeeded, false otherwise |
| Warehouses |
GetWarehousesInfo[] |
A list of GetWarehousesInfo |
| GetWarehousesInfo |
| WarehouseId |
int |
Internal id for the warehouse |
| WarehouseName |
string(200) |
The name of the warehouse |
| WarehouseCode |
string(50) |
The code of the warehouse |
| Address |
WarehouseAddress |
The address to the warehouse |
| WarehouseAddress |
| Name |
string |
|
| Address |
string |
|
| Address2 |
string |
|
| Address3 |
string |
|
| PostCode |
string |
|
| City |
string |
|
| Country |
WarehouseAddressCountry |
An element of type WarehouseAddressCountry. |
| TelePhone |
string |
|
| Email |
string |
|
| MobilePhone |
string |
|
| DeliveryInstruction |
string |
|
| FreeText1 |
string |
|
| FreeText2 |
string |
|
| EmailNotification |
WarehouseAddressNotifyClass |
Contains information about email notification |
| TelephoneNotification |
WarehouseAddressNotifyClass |
Contains information about telephone notification |
| SMSNotification |
WarehouseAddressNotifyClass |
Contains information about sms notification |
| WarehouseAddressCountry |
| CountryCode |
string |
|
| CountryStateCode |
string |
|
| WarehouseAddressNotifyClass |
| ToBeNotified |
boolean |
Whether or not the consignee should be notified by the transporter when the package is in transit. |
| Value |
string |
Telephone number, mobile number or email, depending on what kind of notification it is. |