POST api/orders
Метод для создания "Заказа"
Полный URL-адрес запроса: https://sfa-api.ddapp.biz/api/orders
Для этого метода требуется авторизация
Информация о запросе
URL параметры
Нет
Тело запроса
"Заказ"
CreateOrderModel| Название | Описание | Тип данных | Дополнительная информация |
|---|---|---|---|
| VendorId | string |
Длина: от 1 до 100 Соответствует регулярному выражению: ^[a-zA-Zа-яА-Я0-9_-]+$ |
|
| Number | string |
Длина: от 1 до 100 |
|
| StatusId | globally unique identifier |
Обязательное поле |
|
| CustomerId | string |
Обязательное поле Длина: от 1 до 100 |
|
| RelationshipId | string |
Обязательное поле Длина: от 1 до 100 |
|
| TradeOutletId | string |
Обязательное поле Длина: от 1 до 100 |
|
| WarehouseId | string |
Обязательное поле Длина: от 1 до 100 |
|
| PaymentTypeId | string |
Обязательное поле Длина: от 1 до 100 |
|
| DeliveryTypeId | string |
Длина: от 1 до 100 |
|
| PaymentForm | integer |
Обязательное поле Интервал: с 1 по 2 |
|
| DeliveryDate | date |
Обязательное поле |
|
| DeliveryTimeFrom | time interval |
Нет |
|
| DeliveryTimeTill | time interval |
Нет |
|
| Sums | Collection of CreateMultiCurrencySumModel |
Обязательное поле |
|
| Notes | string |
Длина: от 0 до 1024 |
|
| StatusDescription | string |
Длина: от 0 до 1500 |
|
| Positions | Collection of CreateOrderPositionModel |
Обязательное поле |
|
| Properties | Collection of CreateEntityPropertyValueModel |
Нет |
|
| DocumentDate | date |
Нет |
|
| UserId | string |
Нет |
|
| IsExchange | boolean |
Нет |
Форматы запросов
{
"vendorId": "sample string 1",
"number": "sample string 2",
"statusId": "667e3422-290d-43fc-b856-94f02c42d15b",
"customerId": "sample string 4",
"relationshipId": "sample string 5",
"tradeOutletId": "sample string 6",
"warehouseId": "sample string 7",
"paymentTypeId": "sample string 8",
"deliveryTypeId": "sample string 9",
"paymentForm": 10,
"deliveryDate": "2025-11-03T21:57:05.021496Z",
"deliveryTimeFrom": "00:00:00.1234567",
"deliveryTimeTill": "00:00:00.1234567",
"sums": [
{
"currencyId": "sample string 1",
"sum": 2.0
},
{
"currencyId": "sample string 1",
"sum": 2.0
}
],
"notes": "sample string 12",
"statusDescription": "sample string 13",
"positions": [
{
"productId": "sample string 1",
"currencyId": "sample string 2",
"priceCategoryId": "sample string 3",
"quantity": 4.1,
"price": 5.0,
"sum": 6.0,
"discountPercent": 1.1,
"promoOfferId": "dce0fc97-aaf6-423b-a75d-8c178f6ef20c",
"isGift": true,
"originalPrice": 1.0,
"isApproved": true,
"packagingId": "sample string 7"
},
{
"productId": "sample string 1",
"currencyId": "sample string 2",
"priceCategoryId": "sample string 3",
"quantity": 4.1,
"price": 5.0,
"sum": 6.0,
"discountPercent": 1.1,
"promoOfferId": "dce0fc97-aaf6-423b-a75d-8c178f6ef20c",
"isGift": true,
"originalPrice": 1.0,
"isApproved": true,
"packagingId": "sample string 7"
}
],
"properties": [
{
"propertyId": "sample string 1",
"value": "sample string 2"
},
{
"propertyId": "sample string 1",
"value": "sample string 2"
}
],
"documentDate": "2025-11-03T21:57:05.021496Z",
"userId": "sample string 14",
"isExchange": true,
"mobileId": "cc2d4ae1-954c-4d6d-b78f-105b29cb0f4b"
}
<CreateOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Orders">
<CustomerId>sample string 4</CustomerId>
<DeliveryDate>2025-11-03T21:57:05.021496+00:00</DeliveryDate>
<DeliveryTimeFrom>PT0.1234567S</DeliveryTimeFrom>
<DeliveryTimeTill>PT0.1234567S</DeliveryTimeTill>
<DeliveryTypeId>sample string 9</DeliveryTypeId>
<DocumentDate>2025-11-03T21:57:05.021496+00:00</DocumentDate>
<IsExchange>true</IsExchange>
<MobileId>cc2d4ae1-954c-4d6d-b78f-105b29cb0f4b</MobileId>
<Notes>sample string 12</Notes>
<Number>sample string 2</Number>
<PaymentForm>10</PaymentForm>
<PaymentTypeId>sample string 8</PaymentTypeId>
<Positions xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Orders.Positions">
<d2p1:CreateOrderPositionModel>
<d2p1:CurrencyId>sample string 2</d2p1:CurrencyId>
<d2p1:DiscountPercent>1.1</d2p1:DiscountPercent>
<d2p1:IsApproved>true</d2p1:IsApproved>
<d2p1:IsGift>true</d2p1:IsGift>
<d2p1:OriginalPrice>1</d2p1:OriginalPrice>
<d2p1:PackagingId>sample string 7</d2p1:PackagingId>
<d2p1:Price>5</d2p1:Price>
<d2p1:PriceCategoryId>sample string 3</d2p1:PriceCategoryId>
<d2p1:ProductId>sample string 1</d2p1:ProductId>
<d2p1:PromoOfferId>dce0fc97-aaf6-423b-a75d-8c178f6ef20c</d2p1:PromoOfferId>
<d2p1:Quantity>4.1</d2p1:Quantity>
<d2p1:Sum>6</d2p1:Sum>
</d2p1:CreateOrderPositionModel>
<d2p1:CreateOrderPositionModel>
<d2p1:CurrencyId>sample string 2</d2p1:CurrencyId>
<d2p1:DiscountPercent>1.1</d2p1:DiscountPercent>
<d2p1:IsApproved>true</d2p1:IsApproved>
<d2p1:IsGift>true</d2p1:IsGift>
<d2p1:OriginalPrice>1</d2p1:OriginalPrice>
<d2p1:PackagingId>sample string 7</d2p1:PackagingId>
<d2p1:Price>5</d2p1:Price>
<d2p1:PriceCategoryId>sample string 3</d2p1:PriceCategoryId>
<d2p1:ProductId>sample string 1</d2p1:ProductId>
<d2p1:PromoOfferId>dce0fc97-aaf6-423b-a75d-8c178f6ef20c</d2p1:PromoOfferId>
<d2p1:Quantity>4.1</d2p1:Quantity>
<d2p1:Sum>6</d2p1:Sum>
</d2p1:CreateOrderPositionModel>
</Positions>
<Properties xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.EntityProperties.Values">
<d2p1:CreateEntityPropertyValueModel>
<d2p1:PropertyId>sample string 1</d2p1:PropertyId>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:CreateEntityPropertyValueModel>
<d2p1:CreateEntityPropertyValueModel>
<d2p1:PropertyId>sample string 1</d2p1:PropertyId>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:CreateEntityPropertyValueModel>
</Properties>
<RelationshipId>sample string 5</RelationshipId>
<StatusDescription>sample string 13</StatusDescription>
<StatusId>667e3422-290d-43fc-b856-94f02c42d15b</StatusId>
<Sums xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Miscellaneous.MultiCurrency">
<d2p1:CreateMultiCurrencySumModel>
<d2p1:CurrencyId>sample string 1</d2p1:CurrencyId>
<d2p1:Sum>2</d2p1:Sum>
</d2p1:CreateMultiCurrencySumModel>
<d2p1:CreateMultiCurrencySumModel>
<d2p1:CurrencyId>sample string 1</d2p1:CurrencyId>
<d2p1:Sum>2</d2p1:Sum>
</d2p1:CreateMultiCurrencySumModel>
</Sums>
<TradeOutletId>sample string 6</TradeOutletId>
<UserId>sample string 14</UserId>
<VendorId>sample string 1</VendorId>
<WarehouseId>sample string 7</WarehouseId>
</CreateOrderModel>
Sample not available.
Информация об ответе
ResourceIdModel
| Название | Описание | Тип данных | Дополнительная информация |
|---|---|---|---|
| Id | globally unique identifier |
Нет |
Форматы ответа
{
"id": "e2960b83-2205-4f1c-b6e2-7c962ffe07b7"
}
<ResourceIdModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Alt.Api.Models.Response"> <Id>e2960b83-2205-4f1c-b6e2-7c962ffe07b7</Id> </ResourceIdModel>