GET api/Dictionary?UserGuid={UserGuid}&ApiKey={ApiKey}&WarehouseId={WarehouseId}
Возвращает список доступных адресов доставки
Информация о запросе
URI параметры
Имя | Описание | Тип | Дополнительная информация |
---|---|---|---|
UserGuid |
Ваш UserGuid |
string |
Required |
ApiKey |
Ваш ApiKey |
string |
Required |
WarehouseId |
Код cклада, можно взять в функции поиска. Нужно указать склад своего города |
string |
Required |
Параметры тела запроса
Нет.
Информация об ответе
Описание ресурсов
ShipmentAddressesResponseИмя | Описание | Тип | Дополнительная информация |
---|---|---|---|
ShipmentAddresses |
Адреса доставки |
Коллекция ShipmentAddress |
Нет. |
IsError |
Указывает завершился ли запрос с ошибкой или нет |
boolean |
Нет. |
ErrorMessage |
Сообщение об ошибке |
string |
Нет. |
Форматы ответа
application/json, text/json
Пример:
{ "ShipmentAddresses": [ { "ShipmentAddressId": 1, "ShipmentAddressType": 2, "ShipmentAddressName": "sample string 3" }, { "ShipmentAddressId": 1, "ShipmentAddressType": 2, "ShipmentAddressName": "sample string 3" } ], "IsError": true, "ErrorMessage": "sample string 2" }
multipart/form-data
Пример:
{"ShipmentAddresses":[{"ShipmentAddressId":1,"ShipmentAddressType":2,"ShipmentAddressName":"sample string 3"},{"ShipmentAddressId":1,"ShipmentAddressType":2,"ShipmentAddressName":"sample string 3"}],"IsError":true,"ErrorMessage":"sample string 2"}
application/xml, text/xml
Пример:
<ShipmentAddressesResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <IsError>true</IsError> <ErrorMessage>sample string 2</ErrorMessage> <ShipmentAddresses> <ShipmentAddress> <ShipmentAddressId>1</ShipmentAddressId> <ShipmentAddressType>2</ShipmentAddressType> <ShipmentAddressName>sample string 3</ShipmentAddressName> </ShipmentAddress> <ShipmentAddress> <ShipmentAddressId>1</ShipmentAddressId> <ShipmentAddressType>2</ShipmentAddressType> <ShipmentAddressName>sample string 3</ShipmentAddressName> </ShipmentAddress> </ShipmentAddresses> </ShipmentAddressesResponse>