POST api/Order

Создает новый заказ. Возвращает результат формирования заказа и список позиций. ВНИМАНИЕ! Тестовых функций на данный момент нет, поэтому все сформированные заказы являются действительными. Заказы с наших складов можно отменить до отгрузки, ЗАКАЗЫ ОТ ПОСТАВЩИКОВ (все товары, у которых имеется SupplierCode) ОТМЕНИТЬ НЕВОЗМОЖНО! В некоторых случаях (аппаратные перебои или высокая нагрузка) когда службы формирования заказов недоступны, заказ может быть установлен в очередь и сформирован отложенно, поэтому в некоторых случаях GUID и номер заказа могут быть пустыми

Информация о запросе

URI параметры

Нет.

Параметры тела запроса

Модель для создания заказа

CreateOrderViewModel
ИмяОписаниеТипДополнительная информация
UserGuid

Ваш UserGuid

globally unique identifier

Обязательный

ContragentGuid

GUID контрагента Список контрагентов можно получить с помощью метода http://api.phaeton.kz/Help/Api/GET-api-Dictionary_UserGuid_ApiKey

globally unique identifier

Обязательный

ApiKey

Ваш ApiKey

string

Обязательный

Brand

Бренд

string

Обязательный

Article

Артикул

string

Обязательный

WarehouseId

Id склада (GUID)

globally unique identifier

Обязательный

Price

Цена

integer

В диапазоне от 0 до 2147483647

Count

Количество

integer

В диапазоне от 0 до 2147483647

SupplierCode

Код поставщика, полученный при поиске (При заказе от удаленных и локальных поставщиков)

string

Нет.

ExpectedDelivery

Ожидаемый срок поставки (Обязателен при заказе от удаленных поставщиков)

integer

Нет.

GuaranteedDelivery

Гарантированный срок поставки (Обязателен при заказе от удаленных поставщиков)

integer

Нет.

DeliveryProbability

Вероятность поставки (Обязателен при заказе от удаленных поставщиков)

decimal number

Нет.

Comment

Коментарий (необезательно)

string

Нет.

UseBonus

Если задана 1 будут использованны бонусы. По умолчанию бонусы не используются.

integer

Нет.

Force

Если параметр задан в 1, будут игнорироваться ошибки об изменении цены, и заказ будет сформирован в любом случае (только для товаров со складов Phaeton). По умолчанию - 0.

integer

Нет.

Формат запроса

application/json, text/json

Пример:
{
  "UserGuid": "8bf5e8db-afaa-4c52-ad4f-4bc2d1dffc08",
  "ContragentGuid": "7ff8fc31-7480-4f7e-b2a2-f229d6ab4418",
  "ApiKey": "sample string 1",
  "Brand": "sample string 2",
  "Article": "sample string 3",
  "WarehouseId": "0c564cd2-183f-4e5c-b85a-3bc92aedf327",
  "Price": 4,
  "Count": 5,
  "SupplierCode": "sample string 6",
  "ExpectedDelivery": 1,
  "GuaranteedDelivery": 1,
  "DeliveryProbability": 1.1,
  "Comment": "sample string 7",
  "UseBonus": 8,
  "Force": 9
}

application/xml, text/xml

Пример:
<CreateOrderViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PhaetonExternalApi.ViewModels">
  <ApiKey>sample string 1</ApiKey>
  <Article>sample string 3</Article>
  <Brand>sample string 2</Brand>
  <Comment>sample string 7</Comment>
  <ContragentGuid>7ff8fc31-7480-4f7e-b2a2-f229d6ab4418</ContragentGuid>
  <Count>5</Count>
  <DeliveryProbability>1.1</DeliveryProbability>
  <ExpectedDelivery>1</ExpectedDelivery>
  <Force>9</Force>
  <GuaranteedDelivery>1</GuaranteedDelivery>
  <Price>4</Price>
  <SupplierCode>sample string 6</SupplierCode>
  <UseBonus>8</UseBonus>
  <UserGuid>8bf5e8db-afaa-4c52-ad4f-4bc2d1dffc08</UserGuid>
  <WarehouseId>0c564cd2-183f-4e5c-b85a-3bc92aedf327</WarehouseId>
</CreateOrderViewModel>

application/x-www-form-urlencoded

Пример:

Нет примера

Информация об ответе

Описание ресурсов

OrderCreateResponse
ИмяОписаниеТипДополнительная информация
OrderItems

Список позиций заказа

Коллекция OrderItemCreateResult

Нет.

Warnings

Предупреждения. Если заказ сформирован, но есть замечания, например заказ частично сформирован, или произошли изменения по цене или количеству, но задан флаг force=true

Коллекция string

Нет.

IsError

Если задан в true, создание заказа завершено с ошибкой и заказ не сформирован. Если false значит заказ успешно сформирован.

boolean

Нет.

Errors

Список всех ошибок

Коллекция string

Нет.

Форматы ответа

application/json, text/json

Пример:
{
  "OrderItems": [
    {
      "OrderItemId": 1,
      "OrderGuid": "9b46ba15-4b4d-41ba-be4f-f68f5eb2730f",
      "OrderNumber": "sample string 2",
      "Article": "sample string 3",
      "Brand": "sample string 4",
      "WarehouseId": "b587ef39-71b8-4f81-b09d-c1c319153339",
      "NewPrice": 1.0,
      "NewCount": 1,
      "Error": "sample string 6"
    },
    {
      "OrderItemId": 1,
      "OrderGuid": "9b46ba15-4b4d-41ba-be4f-f68f5eb2730f",
      "OrderNumber": "sample string 2",
      "Article": "sample string 3",
      "Brand": "sample string 4",
      "WarehouseId": "b587ef39-71b8-4f81-b09d-c1c319153339",
      "NewPrice": 1.0,
      "NewCount": 1,
      "Error": "sample string 6"
    }
  ],
  "Warnings": [
    "sample string 1",
    "sample string 2"
  ],
  "IsError": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Пример:
<OrderCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PhaetonExternalApi.ViewModels">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <IsError>true</IsError>
  <OrderItems>
    <OrderItemCreateResult>
      <Article>sample string 3</Article>
      <Brand>sample string 4</Brand>
      <Error>sample string 6</Error>
      <NewCount>1</NewCount>
      <NewPrice>1</NewPrice>
      <OrderGuid>9b46ba15-4b4d-41ba-be4f-f68f5eb2730f</OrderGuid>
      <OrderItemId>1</OrderItemId>
      <OrderNumber>sample string 2</OrderNumber>
      <WarehouseId>b587ef39-71b8-4f81-b09d-c1c319153339</WarehouseId>
    </OrderItemCreateResult>
    <OrderItemCreateResult>
      <Article>sample string 3</Article>
      <Brand>sample string 4</Brand>
      <Error>sample string 6</Error>
      <NewCount>1</NewCount>
      <NewPrice>1</NewPrice>
      <OrderGuid>9b46ba15-4b4d-41ba-be4f-f68f5eb2730f</OrderGuid>
      <OrderItemId>1</OrderItemId>
      <OrderNumber>sample string 2</OrderNumber>
      <WarehouseId>b587ef39-71b8-4f81-b09d-c1c319153339</WarehouseId>
    </OrderItemCreateResult>
  </OrderItems>
  <Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Warnings>
</OrderCreateResponse>