GET api/relationships/{id}
Метод для получения информации о "Взаимоотношении" между Клиентом и Дистрибьютором (aka Договор)
Полный URL-адрес запроса: https://sfa-api.ddapp.biz/api/relationships/{id}?api-version=2.0
Для этого метода требуется авторизация
Информация о запросе
URL параметры
Название | Описание | Тип данных | Дополнительная информация |
---|---|---|---|
id |
Уникальный идентфикатор "Взаимоотношения" |
string |
Required |
fields |
Список дополнительных полей, которые необходимо вернуть |
string |
Нет |
Тело запроса
Нет параметров в теле запроса
Информация об ответе
RelationshipModel2
Название | Описание | Тип данных | Дополнительная информация |
---|---|---|---|
Id | globally unique identifier |
Нет |
|
VendorId | string |
Нет |
|
Name | string |
Нет |
|
Customer | CustomerModel |
Дополнительное поле |
|
PriceCategory | PriceCategoryModel |
Дополнительное поле |
|
PriceTiers | Collection of PriceCategoryModel |
Дополнительное поле |
|
Currency | CurrencyModel |
Дополнительное поле |
|
PaymentTypes | Collection of PaymentTypeModel |
Дополнительное поле |
|
PaymentForms | Collection of integer |
Дополнительное поле |
|
Deferment | integer |
Нет |
|
Limit | decimal number |
Нет |
|
MinOrder | decimal number |
Нет |
|
Debts | Collection of MultiCurrencySumModel |
Дополнительное поле |
|
OverdueDebts | Collection of MultiCurrencySumModel |
Дополнительное поле |
|
Properties | Collection of EntityPropertyValueModel |
Дополнительное поле |
|
Discounts | Collection of RelationshipDiscountModel |
Дополнительное поле |
|
Active | boolean |
Нет |
|
DateFrom | date |
Нет |
|
DateTill | date |
Нет |
|
OrderIndex | integer |
Нет |
|
IsFixedPriceCategory | boolean |
Нет |
|
DeliveryTypes | Collection of DeliveryTypeModel |
Дополнительное поле |
|
BrandPriceCategories | Collection of RelationshipBrandPriceCategoryModel |
Дополнительное поле |
|
GroupPriceCategories | Collection of RelationshipGroupPriceCategoryModel |
Дополнительное поле |
Форматы ответа
{ "id": "a71aaacd-5ba2-4780-a3fd-d7076561636f", "vendorId": "sample string 2", "name": "sample string 3", "customer": { "id": "0367610c-7275-4658-a997-e7ccc3824b87", "vendorId": "sample string 2", "name": "sample string 3", "taxNumber": "sample string 4", "location": { "country": { "id": "90bba67a-b73d-46f3-9400-a03dce3e421b", "isoCode": "sample string 2", "name": "sample string 3" }, "province": { "id": "8319a895-5a09-41d9-b001-a3243d4d2864", "name": "sample string 2" }, "settlement": "sample string 1", "addressLine": "sample string 2", "geoCoordinate": { "latitude": 1.1, "longitude": 1.1 } }, "tradeNetwork": { "id": "365b79cd-7d89-4547-860c-8f28f75a5b00", "vendorId": "sample string 2", "name": "sample string 3", "properties": [ { "entityProperty": { "id": "3b0914b1-f757-4e3c-ac0a-bacbc9a3e7fa", "vendorId": "sample string 2", "name": "sample string 3", "entityDataType": "string", "valueLookup": "contacts", "required": true }, "value": "sample string 1" }, { "entityProperty": { "id": "3b0914b1-f757-4e3c-ac0a-bacbc9a3e7fa", "vendorId": "sample string 2", "name": "sample string 3", "entityDataType": "string", "valueLookup": "contacts", "required": true }, "value": "sample string 1" } ] }, "office": { "id": "27d7ad9b-4115-4227-9cdb-a1cfde2b7f53", "vendorId": "sample string 2", "name": "sample string 3", "responsible": { "id": "c6951b33-e36e-4248-b1b7-48edfdb24d92", "vendorId": "sample string 2", "firstName": "sample string 3", "lastName": "sample string 4", "middleName": "sample string 5", "fullName": "sample string 6", "imageUrl": "sample string 7", "email": "sample string 8", "emailConfirmed": true, "phoneNumber": "sample string 10", "phoneNumberConfirmed": true, "twoFactorEnabled": true, "lockoutEndDateUtc": "2024-10-06T19:23:17.2173706Z", "lockoutEnabled": true, "roles": [ "sample string 1", "sample string 2" ] }, "location": { "country": { "id": "90bba67a-b73d-46f3-9400-a03dce3e421b", "isoCode": "sample string 2", "name": "sample string 3" }, "province": { "id": "8319a895-5a09-41d9-b001-a3243d4d2864", "name": "sample string 2" }, "settlement": "sample string 1", "addressLine": "sample string 2", "geoCoordinate": { "latitude": 1.1, "longitude": 1.1 } }, "timeZoneId": "sample string 4" }, "properties": [ { "entityProperty": { "id": "3b0914b1-f757-4e3c-ac0a-bacbc9a3e7fa", "vendorId": "sample string 2", "name": "sample string 3", "entityDataType": "string", "valueLookup": "contacts", "required": true }, "value": "sample string 1" }, { "entityProperty": { "id": "3b0914b1-f757-4e3c-ac0a-bacbc9a3e7fa", "vendorId": "sample string 2", "name": "sample string 3", "entityDataType": "string", "valueLookup": "contacts", "required": true }, "value": "sample string 1" } ] }, "priceCategory": { "id": "8c6f9e17-5a5e-4d5d-a445-51922a5a461c", "vendorId": "sample string 2", "name": "sample string 3", "orderIndex": 1 }, "priceTiers": [ { "id": "8c6f9e17-5a5e-4d5d-a445-51922a5a461c", "vendorId": "sample string 2", "name": "sample string 3", "orderIndex": 1 }, { "id": "8c6f9e17-5a5e-4d5d-a445-51922a5a461c", "vendorId": "sample string 2", "name": "sample string 3", "orderIndex": 1 } ], "currency": { "id": "863e23d8-2b92-45db-993f-4d365e45a7d0", "isoCode": "sample string 2", "isoNumber3": "sample string 3", "name": "sample string 4", "shortName": "sample string 5", "symbol": "sample string 6" }, "paymentTypes": [ { "id": "2ed84f7d-bd91-4813-9284-8ca3109c41d1", "vendorId": "sample string 2", "name": "sample string 3", "orderIndex": 1 }, { "id": "2ed84f7d-bd91-4813-9284-8ca3109c41d1", "vendorId": "sample string 2", "name": "sample string 3", "orderIndex": 1 } ], "paymentForms": [ 1, 2 ], "deferment": 1, "limit": 1.0, "minOrder": 1.0, "debts": [ { "currency": { "id": "863e23d8-2b92-45db-993f-4d365e45a7d0", "isoCode": "sample string 2", "isoNumber3": "sample string 3", "name": "sample string 4", "shortName": "sample string 5", "symbol": "sample string 6" }, "sum": 1.0 }, { "currency": { "id": "863e23d8-2b92-45db-993f-4d365e45a7d0", "isoCode": "sample string 2", "isoNumber3": "sample string 3", "name": "sample string 4", "shortName": "sample string 5", "symbol": "sample string 6" }, "sum": 1.0 } ], "overdueDebts": [ { "currency": { "id": "863e23d8-2b92-45db-993f-4d365e45a7d0", "isoCode": "sample string 2", "isoNumber3": "sample string 3", "name": "sample string 4", "shortName": "sample string 5", "symbol": "sample string 6" }, "sum": 1.0 }, { "currency": { "id": "863e23d8-2b92-45db-993f-4d365e45a7d0", "isoCode": "sample string 2", "isoNumber3": "sample string 3", "name": "sample string 4", "shortName": "sample string 5", "symbol": "sample string 6" }, "sum": 1.0 } ], "properties": [ { "entityProperty": { "id": "3b0914b1-f757-4e3c-ac0a-bacbc9a3e7fa", "vendorId": "sample string 2", "name": "sample string 3", "entityDataType": "string", "valueLookup": "contacts", "required": true }, "value": "sample string 1" }, { "entityProperty": { "id": "3b0914b1-f757-4e3c-ac0a-bacbc9a3e7fa", "vendorId": "sample string 2", "name": "sample string 3", "entityDataType": "string", "valueLookup": "contacts", "required": true }, "value": "sample string 1" } ], "discounts": [ { "id": "a7e5c091-18ce-4eea-9c27-919b002cffef", "group": { "id": "5c71a84b-56e3-46c7-9f11-df3b7bf5d6bb", "vendorId": "sample string 2", "name": "sample string 3", "hierarchy": { "level": 1, "path": "sample string 2" } }, "brand": { "id": "b3013412-dad1-43b1-bad0-1d0c0141da24", "vendorId": "sample string 2", "name": "sample string 3" }, "percent": 2.1 }, { "id": "a7e5c091-18ce-4eea-9c27-919b002cffef", "group": { "id": "5c71a84b-56e3-46c7-9f11-df3b7bf5d6bb", "vendorId": "sample string 2", "name": "sample string 3", "hierarchy": { "level": 1, "path": "sample string 2" } }, "brand": { "id": "b3013412-dad1-43b1-bad0-1d0c0141da24", "vendorId": "sample string 2", "name": "sample string 3" }, "percent": 2.1 } ], "active": true, "dateFrom": "2024-10-06T19:23:17.2173706Z", "dateTill": "2024-10-06T19:23:17.2173706Z", "orderIndex": 1, "isFixedPriceCategory": true, "deliveryTypes": [ { "id": "419840c2-8d41-4482-a14a-1ae9b48fed8d", "vendorId": "sample string 2", "name": "sample string 3", "orderIndex": 1 }, { "id": "419840c2-8d41-4482-a14a-1ae9b48fed8d", "vendorId": "sample string 2", "name": "sample string 3", "orderIndex": 1 } ], "brandPriceCategories": [ { "brand": { "id": "b3013412-dad1-43b1-bad0-1d0c0141da24", "vendorId": "sample string 2", "name": "sample string 3" }, "priceCategory": { "id": "8c6f9e17-5a5e-4d5d-a445-51922a5a461c", "vendorId": "sample string 2", "name": "sample string 3", "orderIndex": 1 } }, { "brand": { "id": "b3013412-dad1-43b1-bad0-1d0c0141da24", "vendorId": "sample string 2", "name": "sample string 3" }, "priceCategory": { "id": "8c6f9e17-5a5e-4d5d-a445-51922a5a461c", "vendorId": "sample string 2", "name": "sample string 3", "orderIndex": 1 } } ], "groupPriceCategories": [ { "group": { "id": "5c71a84b-56e3-46c7-9f11-df3b7bf5d6bb", "vendorId": "sample string 2", "name": "sample string 3", "hierarchy": { "level": 1, "path": "sample string 2" } }, "priceCategory": { "id": "8c6f9e17-5a5e-4d5d-a445-51922a5a461c", "vendorId": "sample string 2", "name": "sample string 3", "orderIndex": 1 } }, { "group": { "id": "5c71a84b-56e3-46c7-9f11-df3b7bf5d6bb", "vendorId": "sample string 2", "name": "sample string 3", "hierarchy": { "level": 1, "path": "sample string 2" } }, "priceCategory": { "id": "8c6f9e17-5a5e-4d5d-a445-51922a5a461c", "vendorId": "sample string 2", "name": "sample string 3", "orderIndex": 1 } } ] }
Sample not available.
Sample not available.