Skip to main content

Команда Shipments (отправления)

Метод возвращает данные по отгрузкам.

Метод :  /resources/shipments

Тип вызова: GET

Параметры запроса: ?fields=field1,…fieldN&param1=param1_value& … paramN_paramN_value&tables=table1,…tableN

Описание полей в ответе

  • guid – уникальный идентификатор документа
  • date – дата документа
  • state – статус отправления
    • entered – поступил
    • call_center – перезвон
    • approved – подтвержден
    • await_goods – подтвержден, ожидает поступления товара
    • on_packaging – на сборке
    • packed – собран
    • ready_for_shipment – готов к отгрузке
    • shipped_out – передан службе доставки
    • on_delivery – на доставке
    • on_delivery_city – на руках у курьера
    • at_takeout_point – в пункте самовывоза
    • delivered – доставлен
    • cancelled – не доставлен
    • on_return – на возврате
  • external_id – идентификатор отправления в системе клиента
  • updated_at – дата обновления отправления
  • cancel_reason – причина отмены
  • goods_reserved – отправление держит резерв товаров
  • customer – контрагент
  • customer_name – наименование контрагента
  • comment – комментарий к заказу
  • delivery_date_planned – планируемая дата доставки
  • delivery_time_from – период доставки с
  • delivery_time_to – период доставки по
  • is_payed – признак оплаты заказа
  • delivery_method – способ доставки
  • delivery_contract_external_id – внешний id договора доставки

Данные адреса доставки:

  • c_country – страна
  • postal_code – индекс
  • c_region – регион
  • c_area – область
  • c_city – город
  • c_city2 –населенный пункт
  • c_street – улица
  • c_house – дом
  • c_building – строение
  • c_flat – квартира
  • c_phone – контактный телефон
  • c_phone2 – контактный телефон
  • c_email – электронная почта
  • delivery_date_fact – фактическая дата доставки
  • doc_total_sum – сумма документа
  • client_order_num – номер заказа по данным клиента
  • client_order_date – дата заказа по данным клиента
  • courierNum – номер заказа в курьерской службе

Табличные части (tables):

goods (товары):

  • n – номер строки товарной части заказа
  • item_external_id – внешний ключ номенклатуры
  • variant_external_id – внешний ключ варианта номенклатуры
  • item_vendor_code – артикул
  • quantity – количество упаковок
  • quantity_pce – количество единиц товара
  • price – цена единицы
  • insurance_price – страховая стоимость
  • sum – сумма
  • vat_sum – сумма ндс
  • vat_rate – процент ндс
  • cancelled – признак отменены позиции
  • cancel_reason – причина отмены
  • is_service – признак сервиса, услуги
  • sum_manual_discounts – размер ручной скидки

delivery_packages (упаковки в заказе):

  • seat_num – номер места
  • barcode – штрихкод места
  • weight – вес места
  • sum – сумма
  • height – высота
  • width – ширина
  • depth – глубина

returns (возвраты):

  • item_external_id – внешний ключ номенклатуры
  • variant_external_id – внешний ключ варианта номенклатуры
  • item_vendor_code – артикул
  • quantity – количество
  • overage – излишек
  • expired – просрочено
  • blocked – брак
  • reclamation – рекламация
  • barcode – штрихкод
  • return – номер возврата
  • date – дата возврата
  • incoming_doc_num – номер входящего документа