POST api/Order

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

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

URI параметры

Нет.

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

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

CreateOrderViewModel

Имя	Описание	Тип	Дополнительная информация
Contact		ContactViewModel	Нет.
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
SupplierId	ID поставщика, полученный при поиске (При заказе от удаленных и локальных поставщиков)	integer	Нет.
ExpectedDelivery	Ожидаемый срок поставки (Обязателен при заказе от удаленных поставщиков)	integer	Нет.
GuaranteedDelivery	Гарантированный срок поставки (Обязателен при заказе от удаленных поставщиков)	integer	Нет.
DeliveryProbability	Вероятность поставки (Обязателен при заказе от удаленных поставщиков)	decimal number	Нет.
Comment	Коментарий (необезательно)	string	Нет.
UseBonus	Если задана 1 будут использованны бонусы. По умолчанию бонусы не используются.	integer	Нет.
Force	Если параметр задан в 1, будут игнорироваться ошибки об изменении цены, и заказ будет сформирован в любом случае (только для товаров со складов Phaeton). По умолчанию - 0.	integer	Нет.
route	Вариант доставки, если отсутствует будет задано доставка по умолчанию.	string	Нет.
Routes		Коллекция DeliveryRouteViewModel	Нет.

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

application/json, text/json

Пример:

{
  "Contact": {
    "UserGuid": "ec0bdc40-0aa7-44cf-96ce-8347a9a97236",
    "OrderType": 1,
    "Name": "sample string 2",
    "Phone": "sample string 3",
    "Email": "sample string 4"
  },
  "UserGuid": "8ff68897-7333-4b5e-ac1a-9b41dfaf4d79",
  "ContragentGuid": "d8c993aa-086e-44ea-ab12-83ee1c117b0c",
  "ApiKey": "sample string 1",
  "Brand": "sample string 2",
  "Article": "sample string 3",
  "WarehouseId": "b580423a-9a43-42a4-b5d9-348fafc6b0f1",
  "Price": 4,
  "Count": 5,
  "SupplierId": 1,
  "ExpectedDelivery": 1,
  "GuaranteedDelivery": 1,
  "DeliveryProbability": 1.1,
  "Comment": "sample string 6",
  "UseBonus": 7,
  "Force": 8,
  "route": "sample string 9",
  "Routes": [
    {
      "Number": "sample string 1",
      "Name": "sample string 2",
      "ExpressDeliveryPrice": 3.0,
      "DeliveryType": 0,
      "ExpressDeliveryUnavailable": "sample string 4"
    },
    {
      "Number": "sample string 1",
      "Name": "sample string 2",
      "ExpressDeliveryPrice": 3.0,
      "DeliveryType": 0,
      "ExpressDeliveryUnavailable": "sample string 4"
    }
  ]
}

multipart/form-data

Пример:

{"Contact":{"UserGuid":"ec0bdc40-0aa7-44cf-96ce-8347a9a97236","OrderType":1,"Name":"sample string 2","Phone":"sample string 3","Email":"sample string 4"},"UserGuid":"8ff68897-7333-4b5e-ac1a-9b41dfaf4d79","ContragentGuid":"d8c993aa-086e-44ea-ab12-83ee1c117b0c","ApiKey":"sample string 1","Brand":"sample string 2","Article":"sample string 3","WarehouseId":"b580423a-9a43-42a4-b5d9-348fafc6b0f1","Price":4,"Count":5,"SupplierId":1,"ExpectedDelivery":1,"GuaranteedDelivery":1,"DeliveryProbability":1.1,"Comment":"sample string 6","UseBonus":7,"Force":8,"route":"sample string 9","Routes":[{"Number":"sample string 1","Name":"sample string 2","ExpressDeliveryPrice":3.0,"DeliveryType":0,"ExpressDeliveryUnavailable":"sample string 4"},{"Number":"sample string 1","Name":"sample string 2","ExpressDeliveryPrice":3.0,"DeliveryType":0,"ExpressDeliveryUnavailable":"sample string 4"}]}

application/xml, text/xml

Пример:

<CreateOrderViewModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Contact>
    <UserGuid>ec0bdc40-0aa7-44cf-96ce-8347a9a97236</UserGuid>
    <OrderType>Our</OrderType>
    <Name>sample string 2</Name>
    <Phone>sample string 3</Phone>
    <Email>sample string 4</Email>
  </Contact>
  <UserGuid>8ff68897-7333-4b5e-ac1a-9b41dfaf4d79</UserGuid>
  <ContragentGuid>d8c993aa-086e-44ea-ab12-83ee1c117b0c</ContragentGuid>
  <ApiKey>sample string 1</ApiKey>
  <Brand>sample string 2</Brand>
  <Article>sample string 3</Article>
  <WarehouseId>b580423a-9a43-42a4-b5d9-348fafc6b0f1</WarehouseId>
  <Price>4</Price>
  <Count>5</Count>
  <SupplierId>1</SupplierId>
  <ExpectedDelivery>1</ExpectedDelivery>
  <GuaranteedDelivery>1</GuaranteedDelivery>
  <DeliveryProbability>1.1</DeliveryProbability>
  <Comment>sample string 6</Comment>
  <UseBonus>7</UseBonus>
  <Force>8</Force>
  <route>sample string 9</route>
  <Routes>
    <DeliveryRouteViewModel>
      <Number>sample string 1</Number>
      <Name>sample string 2</Name>
      <ExpressDeliveryPrice>3</ExpressDeliveryPrice>
      <DeliveryType>Simple</DeliveryType>
      <ExpressDeliveryUnavailable>sample string 4</ExpressDeliveryUnavailable>
    </DeliveryRouteViewModel>
    <DeliveryRouteViewModel>
      <Number>sample string 1</Number>
      <Name>sample string 2</Name>
      <ExpressDeliveryPrice>3</ExpressDeliveryPrice>
      <DeliveryType>Simple</DeliveryType>
      <ExpressDeliveryUnavailable>sample string 4</ExpressDeliveryUnavailable>
    </DeliveryRouteViewModel>
  </Routes>
</CreateOrderViewModel>

application/x-www-form-urlencoded

Пример:

Нет примера

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

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

OrderCreateResponse

Имя	Описание	Тип	Дополнительная информация
OrderItems	Список позиций заказа	Коллекция OrderItemCreateResult	Нет.
Warnings	Предупреждения. Если заказ сформирован, но есть замечания, например заказ частично сформирован, или произошли изменения по цене или количеству, но задан флаг force=true	Коллекция string	Нет.
IsError	Если задан в true, создание заказа завершено с ошибкой и заказ не сформирован. Если false значит заказ успешно сформирован.	boolean	Нет.
Errors	Список всех ошибок	Коллекция string	Нет.
OptionAddress	Адрес доставки	string	Нет.
Code	Код адреса	integer	Нет.

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

application/json, text/json

Пример:

{
  "OrderItems": [
    {
      "OrderItemId": 1,
      "OrderGuid": "7ec9fd7f-0e02-449d-a3a3-2ef3a2f9c59b",
      "OrderNumber": "sample string 2",
      "Article": "sample string 3",
      "Brand": "sample string 4",
      "WarehouseId": "60ae94ef-e71b-4a9a-9bc8-4117d54d466c",
      "NewPrice": 1.0,
      "NewCount": 1,
      "Error": "sample string 6"
    },
    {
      "OrderItemId": 1,
      "OrderGuid": "7ec9fd7f-0e02-449d-a3a3-2ef3a2f9c59b",
      "OrderNumber": "sample string 2",
      "Article": "sample string 3",
      "Brand": "sample string 4",
      "WarehouseId": "60ae94ef-e71b-4a9a-9bc8-4117d54d466c",
      "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"
  ],
  "OptionAddress": "sample string 2",
  "Code": 1
}

multipart/form-data

Пример:

{"OrderItems":[{"OrderItemId":1,"OrderGuid":"7ec9fd7f-0e02-449d-a3a3-2ef3a2f9c59b","OrderNumber":"sample string 2","Article":"sample string 3","Brand":"sample string 4","WarehouseId":"60ae94ef-e71b-4a9a-9bc8-4117d54d466c","NewPrice":1.0,"NewCount":1,"Error":"sample string 6"},{"OrderItemId":1,"OrderGuid":"7ec9fd7f-0e02-449d-a3a3-2ef3a2f9c59b","OrderNumber":"sample string 2","Article":"sample string 3","Brand":"sample string 4","WarehouseId":"60ae94ef-e71b-4a9a-9bc8-4117d54d466c","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"],"OptionAddress":"sample string 2","Code":1}

application/xml, text/xml

Пример:

<OrderCreateResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderItems>
    <OrderItemCreateResult>
      <OrderItemId>1</OrderItemId>
      <OrderGuid>7ec9fd7f-0e02-449d-a3a3-2ef3a2f9c59b</OrderGuid>
      <OrderNumber>sample string 2</OrderNumber>
      <Article>sample string 3</Article>
      <Brand>sample string 4</Brand>
      <WarehouseId>60ae94ef-e71b-4a9a-9bc8-4117d54d466c</WarehouseId>
      <NewPrice>1</NewPrice>
      <NewCount>1</NewCount>
      <Error>sample string 6</Error>
    </OrderItemCreateResult>
    <OrderItemCreateResult>
      <OrderItemId>1</OrderItemId>
      <OrderGuid>7ec9fd7f-0e02-449d-a3a3-2ef3a2f9c59b</OrderGuid>
      <OrderNumber>sample string 2</OrderNumber>
      <Article>sample string 3</Article>
      <Brand>sample string 4</Brand>
      <WarehouseId>60ae94ef-e71b-4a9a-9bc8-4117d54d466c</WarehouseId>
      <NewPrice>1</NewPrice>
      <NewCount>1</NewCount>
      <Error>sample string 6</Error>
    </OrderItemCreateResult>
  </OrderItems>
  <Warnings>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Warnings>
  <IsError>true</IsError>
  <Errors>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Errors>
  <OptionAddress>sample string 2</OptionAddress>
  <Code>1</Code>
</OrderCreateResponse>