SalesOrder (запись документа отгрузки)

Метод осуществляет запись документов отгрузки в систему 3PL.                                                  

Правила заполнения адреса для доставки через курьерскую службу
Должны быть заполнены поля "Регион", "Город", "Улица" (в поле улицы можно включить номер дома и квартиры).

Пример запроса

<Command Id="SalesOrder" Login="test" Password="test">
      <Orders>
            <Order>
                  <Document>
                        <ID>100004</ID>
                        <Date>2014-10-28</Date>
                        <Comment/>
                        <TotalSum>250</TotalSum>
                        <SumOfDelivery>200</SumOfDelivery>
                        <VATDelivery>18</VATDelivery>
                        <SumVATOfDelivery>36</SumVATOfDelivery>
                        <PaymentType/>
                        <IsPayed>false</IsPayed>
                        <DeliveryInformation>
                              <FullAddress>г. Москва, ул. Чоботовская, д. 2, кв. 200</FullAddress>
                              <Postcode>119634</Postcode>
                              <State>Москва</State>
                              <City>Москва</City>
                              <Street>ул. Чоботовская, д.2, кв. 200</Street>
                              <Building/>
                              <Room/>
                              <Phone>79161112233</Phone>
                        </DeliveryInformation>
                        <ConsumerID>100001</ConsumerID>
                  </Document>
                  <Items>
                        <Item>
                              <ID>700</ID>
                              <OptionID/>
                              <Quantity>1</Quantity>
                              <Price>50</Price>
                              <VAT>18</VAT>
                              <VatSum>9</VatSum>
                              <SumVATPrice>9</SumVATPrice>
                              <TotalWithoutVat>41</TotalWithoutVat>
                              <TotalWithVat>50</TotalWithVat>
                              <CancelItem>false</CancelItem>
                              <CommCancelItem/>
                        </Item>
                  </Items>
            </Order>
      </Orders>
</Command>

Пример ответа (успешно записан документ, статус документа - "Поступил")

<Reply>
    <IsError>false</IsError>
    <Comment/>
    <Result>
        <Documents>
            <Document>
                <ID>100004</ID>
                <Status>Поступил</Status>
                <Success>true</Success>
                <Comments/>
            </Document>
        </Documents>
    </Result>
</Reply>

Структура содержимого запроса

Тег

Тип значения

Описание

Command

Корневой тег

Атрибуты: Id (имя команды), Login, Password

Orders

 

 

Order

 

 

     Document

Группа

Обвязка шапки документа

               ID

Строка (12)

Номер документа в системе партнера.

Должен быть уникальным.

Если в ID используется кириллица, то следует учитывать, что при транслитерации некоторые кириллические буквы заменяются двумя и более латинскими (например, Э, Ю, Щ, …). Длину номера необходимо рассчитывать с учетом транслитерации

               Date

Дата

Дата документа в системе партнера

               Comment

Строка (1024)

Комментарий к заказу.

Поле общего пользования, видно операторам КЦ, курьерам и получателям отправления

               OperativeComment

Строка

Дополнительная информация для операций с заказом.

Доступна только операторам фулфилмента

               Currency

Строка (3)

Валюта, международный код (EUR, RUB, USD).

По умолчанию поддерживается только RUB, остальные валюты по отдельному согласованию.

               TypeOrder

Строка (2)

Тип отгрузки.
Возможные значения:

- B2C
- B2B

По умолчанию B2C.

               TotalSum

Число (15, 3)

Общая сумма по документу.

Должна быть равна сумме всех строк TotalWithVat + сумма доставки SumOfDelivery.

 

Если поле не указано или равно 0, проверка не производится.

               DateOfDispatch

Дата

Желаемая дата отгрузки заказа

               SumOfDelivery

Число (15, 3)

Стоимость доставки

              VATDelivery

Число (10,0)

Ставка НДС.

Возможные значения:

-1 – Без НСД 
0 – НДС 0
18 – НДС 18
118 – НДС 18/118
10 – НДС 10
110 – НДС 10/110

             SumVATOfDelivery

Число (10, 2)

Сумма НСД за доставку

               DateOfDelivery

Дата

Желаемая дата  доставки.

Заполняется в зависимости от курьерской службы

               TimeOfDelivery_b

Число

В данных полях указывается интервал доставки, в часах с начала суток.

 

Например, интервал с 9:00 до 18:00:

TimeOfDelivery_b = 9

TimeOfDelivery_e = 18

 

В зависимости от используемой курьерской службы может носить рекомендательный характер.

 

В зависимости от переданных в параметре TimeOfDelivery значениях, будет выбран максимально близкий интервал доставки из доступных.

 

Выделенные жирным интервалы доступны только для Москвы (тег City должен содержать "Москва").

               TimeOfDelivery_e

Число

               IsPayed

Булево

Флаг оплаты заказа.

По умолчанию false.

Тrue - заказ предоплачен.

 

Если не передан параметр "PaymentType", тогда в случае:

False - способ оплаты "Наличными курьеру"

True - способ оплаты "Не оплачивается"

              Disposal

Строка

Утилизация.
1 – истина

Другое – ложь

              ProcessType

Число

Описывает действия с заказом.

Если не указан, заказ не обновляется и загружается в статусе из настроек по умолчанию.

 

Доступные значения:

0 - Отмена

1 - Прозвон заказа (без отгрузки)

2 - Прозвон и доставка + отгрузка

3 - Отгрузка (по умолчанию)

4 - Отгрузка после появления товара на складе (отложенная отгрузка или кроссдокинг).

 

Заказ обновляется только в статусах "Поступил", "Перезвон", "Подтвержден"

              CancelReasonID

Строка

Код причины отмены заказа.

Список причин согласовывается заранее.

Указывается если ProcessType = 0

              FreighterID

Контрагент

Указывается контрагент-перевозчик, который осуществляет сбор отправления со склада.

По умолчанию, если не указан, используется соответствующий способу доставки

              DeliveryContract

Строка

Договор доставки (например, для возможности доставки различными продуктами выбранной службы доставки)

              PrintOrderFormNum

Число

Количество копий бланка заказа клиента.

По умолчанию 1 шт.

              PrintPackingListService

Булево

Необходимость печати упаковочного листа (печать и вложение в содержимого каждого транспортного места)

              PrintInvService

Булево

Необходимо распечатать ТОРГ-12 к заказу

              PrintInvNum

Строка

Номер документа ТОРГ-12 (для печати)

              PrintInvDate

Дата

Дата документа ТОРГ-12 (для печати)

              PrintTaxInvService

Булево

Необходимо распечатать Счет-Фактуру к заказу

              PrintTaxInvNum

Строка

Номер счет-фактуры (для печати)

              PrintTaxInvDate

Дата

Дата счет-фактуры (для печати)

              Warehouse

Строка

Идентификатор склада, с которого производится отгрузка. Уточняется отдельно

              Properties

 

Коллекция свойств заказа (свойства, специфичные для партнера)

                 Property

 

 

                    ID

Строка

ID свойства.

Доступные свойства согласовываются заранее

                    Name

Строка

Наименование свойства

                    Value

Строка

Значение свойства

              Driver

Физическое лицо

Информация по водителю (для B2B отгрузок)

                  ID

Строка (30)

ID физического лица в базе партнера

                  Name

Строка

ФИО

                  Phone1

Строка

Мобильный телефон

                  Phone2

Строка

Рабочий телефон

                  DocType

Число

Тип документа, удостоверяющего личность:

1 - Паспорт

2 - Водительское удостоверение

                  DocSer

Строка

Серия документа

                  DocNum

Строка

Номер документа

                  DocDate

Дата

Дата выдачи документа

              Vehicle

ТС

Транспортное средство

                  ID

Строка

Идентификатор транспортного средства в системе Партнера

                  BrandModel

Строка

Марка и модель транспортного средства

                  StateNum

Строка

Государственный номер транспортного средства.

Пример: н033на197

                  StateNumTrailer

Строка

Государственный номер прицепа транспортного средства

              DeliveryInformation

 

Информация об адресе доставки и контактах принимающего лица.

Если тег отсутствует или пустой, информация о доставке не записывается.

Обязательно к заполнению только при первой выгрузке заказа

                           FullAddress

Строка (500)

Если нет возможности разбить адрес по отдельным полям, можно выгружать целиком в это поле.

                           Country

Строка

Код страны по ISO 3166-1.

Требуется только для международных отправлений.

Если подходящей страны не будет найдено, заказ не будет загружен

                           Postcode

Строка

Почтовый индекс

                           State

Строка

Область (регион).

Поле обязательное, если адрес не валидирован через DaData

                           Area

Строка

Район

                           City

Строка

Город.

Поле обязательное, если адрес не валидирован через DaData

                           City2

Строка

Населенный пункт.

Поле обязательное, если адрес не валидирован через DaData

                           Street

Строка

Улица.

Поле обязательное, если адрес не валидирован через DaData

                           Building

Строка

Дом

                           Building2

Строка

Строение / Корпус

                           Room

Строка

Квартира / офис

                           Email

Строка

Контактная почта получателя

                           Phone

Строка

Мобильный телефон получателя.

Только цифры, желаемый формат «79103191360» - код страны, номер.

Если вы используете доставку СПСР, желаемый формат «89103191360»

                           Phone2

Строка

Городской телефон получателя.
Только цифры, желаемый формат «74957830001» - код страны, код города, номер

                           PostStationID

Строка

Идентификатор постамата.

Обязательно к заполнению в случае доставки через Pickpoint.

              ConsumerID

Строка

Контрагент - получатель

    Items

 

Строки с товарами

        Item

 

Строка с товаром

            ID

Строка

Идентификатор товара в системе партнера

            Barcode

Строка

Если штрихкод указан, сверяется с данными в системе 3PL, и, если расходятся, тогда генерируется ошибка

            OptionID

 

Идентификатор характеристики

            Quantity

Число (15, 3)

Количество товара в базовых единицах

            Price

Число (15, 3)

Цена.

Цена включает НДС и должна указываться с учетом всех скидок

            PriceInsurance

Число (15, 3)

Если не указано, то страховая цена идет из Цены товара

 

 

 

            VAT

Число (15, 3)

Ставка НДС:
0 - НДС 0
18 - НДС 18
118 - НДС 18/118
10 - НДС 10
110 - НДС 110
-1 - Без НСД 

            VatSum

Число (15, 3)

Сумма НДС

            SumVATPrice

Число (10, 2)

Сумма НДС за единицу товара

            TotalWithVat

Число (15, 3)

Сумма с НДС

            CancelItem

Булево

Флаг отмены товара в заказе

            CommCancelItem

Строка

Описание отмены товара в заказе (идентификатор)

            SupplyType

Число(1)

Тип обеспечения товара:

0 - со стока (по умолчанию)

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

2 - со стока, необязательный (если товар отсутствует на свободных остатках, позиция с данным товаров помечается на отмену и не отгружается)

    Stickers

 

Указывается, если требуется стикерование отгружаемых товаров

        Sticker

 

Описание стикера

            ItemID

 

Ссылка на товар

            PackingID

 

Идентификатор упаковки (если используются упаковки)

            Price

Число (15, 3)

Цена

            PriceDisc

Число (15, 3)

Цена со скидкой

            Barcode

Строка

Штрихкод

            Template

Строка

Код шаблона.
Шаблоны согласовываются заранее

            Properties

 

Дополнительные свойства стикера

                 Property

 

 

                    ID

Строка

ID свойства

                    Name

Строка

Наименование свойства

                    Value

Строка

Значение свойства

additionalDocumentsToPrint

 

 

print_form

 

 

     name

Строка

Наименование печатной формы

     url

Строка

Ссылка на печатную форму

     copies_qty

Число(10,0)

Количество экземпляров для печати

    AdAttachments

 

 

         Attachment

 

 

             Name

Строка

Наименование дополнительного вложения

             Quantity

Число

Количество

             Note

Строка

Примечание

Структура ответа

Тег

Тип значения

Описание

Reply

 

 

    IsError

Булево

Признак глобальной ошибки вызова команды

    Comment

 Строка

 

    Result

 

 

         Documents

 

 

             Document

 

 

                    ID

Строка (50)

Идентификатор документа в системе партнера

                    Success

Булево

Признак успешной записи

                    Comments

Строка (1024)

Комментарий