Content Comparison

Функция Function orders/get (http<http://<DOMAIN><DOMAIN>>/api/orders/get/)

...

...

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

...

token — ключ авторизации полученный через функцию auth.

...

Parameters:

• token — authorization key obtained through the auth function.

• from — show orders from the specified date (inclusive). Optional parameter.
  Date format:

  • YYYY-MM-DD

  • DD.MM.YYYY

  • Начиная с версии Starting with version 3.30

  • YYYY-MM-DD HH:mm:ss

  • DD.MM.YYYY HH:mm:ss

• to — показать заказы до указанной даты (включительно). Необязательный параметр.
  Формат датыshow orders up to the specified date (inclusive). Optional parameter.
  Date Format:

  • YYYY-MM-DD

  • DD.MM.YYYY

  • Начиная с версии Starting with version 3.30

  • YYYY-MM-DD HH:mm:ss

  • DD.MM.YYYY HH:mm:ss

• ids[] — номера заказов для отображенияorder numbers for display

• status — показать заказы с выбранными статусами (выгрузить все статусы можно через функцию show orders with selected statuses (all statuses can be downloaded via the orders/get_available_statuses function). Необязательный параметр. Параметр можно передавать как массив или переменную Optional parameter. The parameter can be passed as an array or variable (status=1 или or status[]=1&status[]=2, {status:1}, {status:[1, 2]}). Возможные значенияPossible values:

  • 1 — новый- new

  • 2 — в обработке- in process

  • 3 — доставлен- delivered

  • 4 — не доставлен- not delivered

  • 6 — доставляется- delivering

• additionalData — boolean значение value (true или or false). Позволяет выгрузить дополнительную информацию о заказе, например, данные о ТТН Новой Почты, складе получателя и отправителя.Начиная с версии Allows to upload additional information about the order, for example, tracking number, recipient's and sender's warehouse.

• Starting with version 3.30

• offset — смешение относительно начала выборки пользователей (работает только в паре с параметром limitoffset of user selection relative to the start (works only in combination with the limit parameter)

• limit — количество выводимых заказов

...

• number of orders displayed

Response:

• status

  • OK — заказы успешно найденыorders found successfully

  • EMPTY — заказы не найденыorders not found

• response.orders — массив, содержащий заказыarray containing orders

  • response.orders[i]

    • order_id — номер заказаorder number

    • user — идентификатор пользователя в системе (уникален для каждого пользователяuser ID in the system (unique for each user)

    • delivery_name — ФИО получателяrecipient's full name

    • delivery_email — email (уникален для каждого пользователя внутри системы, дублирование невозможноunique for each user within the system, duplication is not possible)

    • delivery_phone — номер телефонаphone number

    • delivery_city — городcity

    • delivery_address — адрес доставки (при выборе варианта доставки УкрПочтой поля разбиваются символом @delivery address (if UkrPoshta delivery option is selected, fields are separated by @ symbol)

    • delivery_type — тип доставкиdelivery type

      • delivery_type.id — идентификатор доставки в API. Получить информацию о вариантах доставки можно через функции: delivery type identifier in the API. You can get information about delivery options through the functions delivery/export и and delivery/exportTypes..

        • 3 — Новой почтойNova Post

        • 8 — СамовывозLocal pickup

        • 9 — УкрпочтойUkrPoshta

        • и тetc. д. (на каждом проекте идентификаторы вариантов доставки могут отличаться(delivery option identifiers may differ on each project)

      • delivery_type.title — название варианта доставкиdelivery type name

    • delivery_price — стоимость доставки delivery cost ("delivery_price": -1 — означает, что стоимость доставки рассчитывается по тарифам перевозчикаmeans that the cost of delivery is calculated at the carrier's rates)

    • comment — комментарий покупателя к заказуcustomer comments on the order

    • payment_type — тип оплаты. Получить информацию о вариантах оплаты можно через функции: payment type. You can get information about payment options through the payment/export и and payment/exportMethods functions.

      • payment_type.id — идентификатор оплаты в payment type identifier in API

        • 11 — Оплата курьеруCash on delivery

        • 12 — Безналичный расчетCashless payment

        • 13 — НаличнымиIn cash

        • 14 — Онлайн-оплата кредитной картойOnline payment (Stripe)

        • 15 — Оплата при получении (наложенный платеж)и т. д.PayPal

        • etc.

      • payment_type.title — название варианта оплатыpayment type name

    • payment_price — комиссия за оплатуpayment fee

    • payed — оплачено paid (1 — даyes; 0 — нетno)

    • total_default — стоимость товаров (без учета скидокcost of goods (excluding discounts)

    • total_sum — итоговая стоимость (с учетом всех скидок, но без учета стоимости доставкиtotal cost (including all discounts, but excluding shipping costs)

    • total_quantity — общее количество товаров в заказеtotal number of items in the order

    • discount_percent — относительная скидкаrelative discount

    • discount_value — сумма скидкиdiscount amount

    • coupon_code — код купона на скидкуdiscount coupon code

    • coupon_percent — относительная скидка купонаrelative discount of the coupon

    • coupon_discount_value — сумма скидки по купонуcoupon discount amount

    • coupon_type — тип купона coupon type

      • 0 — без купонаwithout coupon

      • 1 — сертификат на суммуcertificate for certain amount

      • 2 — многоразовый купон на скидкуreusable discount coupon

    • stat_status — статус заказа. Получить информацию о всех статусах заказов можно через функцию order status. You can get information about all order statuses via the orders/get_available_statuses (доступно начиная с версии function (available since version 4.0).

      • 1 — новыйnew

      • 2 — в обработкеin processing

      • 3 — доставленdelivered

      • 4 — не доставленnot delivered

    • stat_created — дата и время оформления заказа (примерdate and time of order placement (example: 2021-04-09 12:09:01)

    • currency — валюта в которой был оформлен заказ (в формате ISO, напримерcurrency in which the order was placed (in ISO format, for example: UAH — гривнаhryvnia, USD — долларdollar, EUR — евро и т. д.). Получить информацию о всех валютах можно через функцию euro, etc.). You can get information about all currencies through the currency/export function.

    • order_without_callback — boolean значение value (true или or false). Нужно ли перезванивать покупателю (добавлено в версии Whether the customer should be called back (added in version 3.32).

    • manager_id - id менеджера который обрабатывал заказ — id of the manager who processed the order

    • manager_comment - комментарий менеджера — manager's comment

    • manager_discount - скидка от менеджераdiscount — manager's discount

    • manager_discount_title - название скидки от менеджера — manager's discount name

    • delivery_country - страна доставки (если включена функция выбора стран на странице оформления заказа — country of delivery (if country selection is enabled on the checkout page)

    • products[i] — товары в заказеproducts in an order

      • title — название товараproduct name

      • article — артикул товараproduct SKU

      • price — стоимость единицы товара для пользователяproduct unit cost to the user

      • quantity — количество заказанных единиц товараnumber of product units ordered

      • total_price — итоговая стоимость товара с учетом заказанного количестваthe total cost of goods, taking into account the quantity ordered

      • discount_marker — маркер использованной скидки на товарmarker for used discount on the product

        • PRICE_OLD — старая цена / относительная скидка на товарold price / relative discount on the product

        • PAGE_DISCOUNT — скидка на разделcategory discount

        • DISCOUNT_CARD — накопительная скидкаcumulative discount

        • DISCOUNT_NONE — отсутствие скидки (при условиях акций и т. д.no discount (under conditions of promotions, etc.)

        • NONE — без скидкиno discount

      • type — данный параметр появился в — this parameter appeared in v4.7.0 и может содержать такие значения (как определить какой товар относиться к комплекту, или к какому товару относится подарок можно на примере этого скриншотаand can contain such values (how to determine which product belongs to a set, or to which products belongs a gift can be seen on the example of this screenshot):

        • gift_parent — товар, к которому был добавлен подарок

        • gift — сам подарок

        • set_main — товар, к которому был добавлен комплектthe product to which the gift was added

        • gift — gift itself

        • set_main — product to which the set has been added

        • set_item — товар, входящий в комплектproduct belonging to a set

      • storage_id — уникальный идентификатор, который в последствии передаётся в следующий параметр A unique identifier that is subsequently passed to the following parameter parent_storage_id, для указания связи между товарами на уровни комплектов / подарковto indicate the relationship between items at the set/gift levels

      • parent_storage_id — если значение null — значит, что к товару был добавлен подарок или товары в комплект (на данном скриншоте показан пример связи между товарамиIf the value is null, it means that a gift or bundled items have been added to the product (this screenshot shows an example of a relation between items).

    • additional_data — дополнительная информация о заказе (отображается только в том случае, если в теле запроса передать ключ additional order information (only displayed if you pass the "additionalData": true key in the body of the query)

      • np_ref — идентификатор электронной накладной (далее ЭН) для API Новой Почты electronic invoice (hereinafter referred to as EI) ID for Nova Poshta v.2 API

      • np_number — номер ЭНEI number

      • sender_warehouse_ref — идентификатор склада отправителя в API Новой Почтыsender's warehouse ID in Nova Poshta API

      • recipient_warehouse_ref — идентификатор склада получателя в API Новой Почты для способа доставки “Новая почта” (на отделение)recipient_address — данные об адресе получателя для способа доставки “Курьером Новой почты”(адресная доставка)recipient's warehouse ID in Nova Poshta API for the "Nova Poshta Branch" delivery method

      • recipient_address — data on the recipient's address for the “Nova Poshta Courier” delivery method:

        • recipient_address.street_id –– идетнификатор улицы получателя в API Новой Почтыthe recipient's street ID in Nova Poshta API

        • recipient_address.street_name –– название улицыstreet name

        • recipient_address.building_number –– номер домаbuilding number

        • recipient_address.flat –– номер квартирыapartment number

• delivery_data - массив данных о способе доставкиarray of data about delivery method

  • deliveryOperatorType - тип оператора доставки. Возможные значенияtype of delivery operator. Possible values: nova_poshta, ukrposhtaukrposht

  • tnID — уникальный идентификатор ЭН

  • tnNumber — номер ЭН

  • tnStatusName — текст статуса накладной у оператора

  • tnTrackingUpdateDate — время последнего изменения статуса у оператора

  • estimatedDeliveryDate — предполагаемая дата доставки

  • departure

    sender — массив данных по отправителю

  • id — уникальный идентификатор отправителя в базе оператора доставки

  • title — название отправителя

  contactPerson — массив данных по контактному лицу (передается только для

  - unique identifier of electronic shipping note

  • tnNumber - number of electronic shipping note

  • tnStatusName - text of delivery note status with operator

  • tnTrackingUpdateDate - time of last status change at the operator

  • estimatedDeliveryDate - estimated delivery date

  • departure

    payment — данные об оплате услуг за доставку

    • sender - sender data array

    • id - unique identifier of sender in the delivery operator's database

    • title - sender's name

    • contactPerson - data array by contact person (it is passed only for deliveryOperatorType= **nova_poshta)

    • id

      — уникальный идентификатор контактного лица в базе оператора доставки

    • name — имя контактного лица

    • phone — телефон контактного лица

    type — тип отправителя (ключ передается только для

    - unique identifier of the contact person in the delivery operator's database

    • name - contact person's name

    • phone - phone number of the contact person

    • type - type of sender (the key is passed only for deliveryOperatorType= **ukrposhta) .

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

      Possible values:

      • COMPANY

        — Юридическое лицо

        - Legal entity

      • PRIVATE_ENTREPRENEUR

        — ФЛП

        - PRIVATE COMPANY

      • INDIVIDUAL

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

        phone — телефон отправителя (ключ передается только для - Physical person

    • phone - sender's phone number (the key is passed only for deliveryOperatorType= **ukrposhta)

    • address

      • type

      — тип адреса отправителя. Возможные значения

      • - type of sender's address. Possible values: warehouse

      • geoObject

      — массив данных о складе отправителя

      • id — уникальный идентификатор города отправителя в базе оператора доставки

      • name — город отправителя

    • warehouse (передается для type = warehouse)

      • id — идентификатор склада отправителя в базе оператора доставки

      • name — склад отправителя

  • destination

    • recipient — массив данных о получателе

      • name— имя получателя

      • surname— фамилия получателя

      • patronymic— отчество получателя

      • phone — телефон получателя

    • address — массив данных об адресе получателя

      • type — тип адреса отправителя. Возможные значения: warehouse / doors

      • geoObject — данные о городе

        • id — уникальный идентификатор города в базе оператора доставки

        • name — город получателя

      • warehouse — данные о складе (передается для type = warehouse)

        • id — уникальный идентификатор склада получателя в базе оператора доставки

        • name — склад получателя

      • street — данные о адресе для курьерской доставки (передается для type = doors)

        • id — уникальный идентификатор улицы в базе оператора доставки

        • name — название улицы

      • buildingNumber — номер дома получателя (передается для type = doors)

      • flatNumber — номер квартиры получателя (передается для type = doors)

  • • type — тип оплаты услуг доставки (ключ передается только при

      • - array of data about the sender's warehouse

      • id - unique identifier of the sender's city in the delivery operator's database

      • name - sender's city

• warehouse (passed for type = warehouse)

• id - identifier of the sender's warehouse in the delivery operator's database

• name - sender's warehouse

• destination

  • recipient - data array about recipient

  • recipient name

• surname - recipient's last name

• patronymic - patronymic of the recipient

• phone - recipient's phone number

• address - array of data about the recipient's address

• type - type of sender's address. Possible values: warehouse / doors

• geoObject - city data

• id - unique identifier of the city in the delivery operator's database

• name - recipient's city

• warehouse - warehouse data (transmitted for type = warehouse)

• id - unique identifier of the recipient's warehouse in the delivery operator's database

• name - recipient's warehouse

• street - address data for courier delivery (passed for type = doors)

• id - unique street identifier in the delivery operator's database

• name - street name

• buildingNumber - recipient's house number (passed for type = doors)

• flatNumber - number of the recipient's apartment (transmitted for type = doors)

• payment - data on payment for delivery services

• type - type of payment for delivery services (the key is transmitted only when ****deliveryOperatorType= ****nova_poshta)

• payer

  — плательщик за услуги доставки

• redelivery — данные об обратной доставке

  • cost — сумма обратной доставки

  • payer — плательщик за обратную доставку

Примечание: передача информации о заказе осуществляется на языке той версии сайта, на которой он был сделан.

• analytics — массив данных источнике заказа (utm-метки) и покупателе

  • utm_source — идентификатор источника трафик;

  • utm_medium — конкретного маркетингового канала;

  • utm_campaign — идентификатор рекламной кампании;

  • utm_term — идентификатор ключевого слова;

  • utm_content — идентификатор конткертного объявления;

  • google_client_id — уникальный идентификатор пользователя.

В Получение списка заказов добавляем дополнительные данные о покупателе - группу, к которой он относится и тип цены, назначенной этой группе.

• customer_details — массив дополнительных данных о покупателе для b2b-проектов

  group

• id - id группы покупателей, к которой принадлежит покупатель

title - название группы покупателей, к которой принадлежит покупатель

- payer for delivery services

• redelivery - data on return delivery

• cost - amount of return delivery

• payer - payer for return delivery

Note: transfer of information about the order is carried out in the language of the version of the site on which it was made.

Block in analytics response - array of data about order source and client_id

• analytics - data array of the order source (utm-tags) and the customer

  • utm_source - traffic source identifier;

  • utm_medium - specific marketing channel;

  • utm_campaign - identifier of the advertising campaign;

  • utm_term - keyword identifier;

  • utm_content - the identifier of the counter ad;

  • google_client_id - unique user identifier.

customer_details block - only for b2b projects

 In the Order List we add additional data about the customer - the group he belongs to and the type of price assigned to this group.

• customer_details - an array of additional customer data for b2b projects

  • group

    • id - id of the buyer group the buyer belongs to

    • title - name of the buyer group to which the buyer belongs

• price_level

  • id - id

    типа цены для группы покупателя

  • title - название типа цены для группы покупателя

...

• • of price type for buyer group

  • title - name of the price type for the buyer group

PUT query example

{
    "token": "c5bc0cd25647e701bc6427f3629b27b4",
    "from": "01.04.2021",
    "to": "03.04.2021",
    "additionalData": true
}

Пример ответа на запросResponse example

{
  "status": "OK",
  "response": {
    "orders": [
      {
        "order_id": 7,
        "user": 6,
        "delivery_name": "John Doe",
        "delivery_email": "john.doe@gmail.com",
        "delivery_phone": "+38 (055) 555-55-55",
        "delivery_city": "КиевKyiv",
        "delivery_address": "ОтделениеBranch №13 (до 30 кг на одно место): ул.Dorohozhytska ОранжерейнаяSt, 3 (метро Дорогожичи)4",
        "delivery_type": {
          "id": 3,
          "title": "НовойNova Poshta почтойBranch"
        },
        "delivery_price": -1,
        "comment": "КомментарийOrder к заказуcomment",
        "payment_type": {
          "id": 13,
          "title": "НаличнымиIn cash"
        },
        "payment_price": 0,
        "payed": 0,
        "total_default": 3413,
        "total_sum": 3413,
        "total_quantity": 2,
        "discount_percent": 0,
        "discount_value": 0,
        "coupon_code": "",
        "coupon_percent": 0,
        "coupon_discount_value": 0,
        "coupon_type": 0,
        "stat_status": 2,
        "stat_created": "2021-04-09 12:09:01",
        "currency": "UAH",
        "order_without_callback": false,
        "products": [
          {
            "title": "ТоварProduct 1",
            "article": "10000001",
            "price": 1001,
            "quantity": 1,
            "discount_marker": "PRICE_OLD",
            "type": "gift_parent",
            "storage_id": 41,
            "parent_storage_id": null,
            "total_price": 1001
          },
          {
            "title": "ТоварProduct 13",
            "article": "10000013",
            "price": 0,
            "quantity": 1,
            "discount_marker": "DISCOUNT_NONE",
            "type": "gift",
            "storage_id": 42,
            "parent_storage_id": 41,
            "total_price": 0
          },
          {
            "title": "ТестовыйTest комплектset",
            "article": "test_set_123",
            "price": 2412,
            "quantity": 1,
            "discount_marker": "PRODUCTS_SET",
            "type": "set_main",
            "storage_id": 43,
            "parent_storage_id": null,
            "total_price": 2412
          },
          {
            "title": "ТоварProduct 1",
            "article": "10000001",
            "price": 1001,
            "quantity": 1,
            "discount_marker": "PRICE_OLD",
            "type": "set_item",
            "storage_id": 44,
            "parent_storage_id": 43,
            "total_price": 1001
          },
          {
            "title": "ТоварProduct 5",
            "article": "10000005",
            "price": 1005,
            "quantity": 1,
            "discount_marker": "PRICE_OLD",
            "type": "set_item",
            "storage_id": 45,
            "parent_storage_id": 43,
            "total_price": 1005
          },
          {
            "title": "ТоварProduct 9",
            "article": "10000009",
            "price": 1009,
            "quantity": 1,
            "discount_marker": "PRICE_OLD",
            "type": "set_item",
            "storage_id": 46,
            "parent_storage_id": 43,
            "total_price": 1009
          }
        ],
        "additional_data": {
          "np_ref": "8d8ecd29-9913-11eb-8513-b88303659df5",
          "np_number": 12345678912345,
          "sender_warehouse_ref": "0d545f63-e1c2-11e3-8c4a-0050568002cf",
          "recipient_warehouse_ref": "39931b8c-e1c2-11e3-8c4a-0050568002cf"
        }
         "analytics": {
          "utm_source": "google",
          "utm_medium": "google_cpc",
          "utm_campaign": "brand_1",
          "utm_term": (none),
          "utm_content": "banner_3",
          "google_client_id": "GA1.3.391577864.1662575866"
        }
      }
    ]
  }
}

Пример блока ответа с новыми данным доставкиExample of a response block with new delivery data

"delivery_data": 
{
    "deliveryOperatorType": "nova_poshta",
    "tnId": "a3a24ec9-632e-11ec-8513-b88303659df5",
    "tnNumber": "20450492106170",
    "tnStatusName": "СозданCreated",
    "tnTrackingUpdateDate": null,
    "estimatedDeliveryDate": "2021-12-24",
    "departure": {
        "sender": {
            "id": "60cd854f-580c-11eb-8513-b88303659df5",
            "title": "ПриватнаPrivate особаperson",
            "contactPerson": {
                "id": "9bc4f232-580c-11eb-8513-b88303659df5",
                "name": "АлександрAlex АнатолиевичJ. КовальSmith (380915554433)",
                "phone": "380915554433"
            }
        },
        "address": {
            "type": "warehouse",
            "geoObject": {
                "id": "db5c88e0-391c-11dd-90d9-001a92567626",
                "name": "ХарьковKharkiv"
            },
            "warehouse": {
                "id": "169227f4-e1c2-11e3-8c4a-0050568002cf",
                "name": "ОтделениеBranch №1: ул. ПолеваяPol'ova St, 67"
            }
        }
    },
    "destination": {
        "recipient": {
            "name": "НатальяNatalie",
            "surname": "ТкаченкоTaylor",
            "patronymic": null,
            "phone": "380914443322"
        },
        "address": {
            "type": "warehouse",
            "geoObject": {
                "id": "f706237a-4078-11de-b509-001d92f78698",
                "name": "ЯворовYavoriv"
            },
            "warehouse": {
                "id": "16922828-e1c2-11e3-8c4a-0050568002cf",
                "name": "ОтделениеBranch №1: улO. А.Makoveya МаковеяSt, 62"
            }
        }
    },
    "payment": {
        "type": "Cash",
        "payer": "Sender"
    },
    "redelivery": {
        "cost": "54000",
        "payer": "Sender"
    }
}

Пример адреса отправителя для Example of sender address for type = doors

"address": 
{
    "type:" "doors",
    "geoObject": {
          "id": "f706237a-4078-11de-b509-001d92f78698",
          "name": "ЯворовYavoriv"
      },
     "street" : {
          "id"   : "16922828-e1c2-11e3-8c4a-0050568002cf", 
          "name" : "улO. А.Makoveya МаковеяSt, 62" 
      },
      "houseNumber"   : "22/12", 
      "flatNumber"    : "16Б16B"
}

Пример ответа при доставке Укрпочтой с типом склад-двериExample of response for Ukrposhta delivery with warehouse-doors type

deliveryOperatorType=ukrposhta, departure.address=warehouse и and destination.address=doors

{
    "deliveryOperatorType": "ukrposhta",
    "tnId": "d07d4f9a-444a-4da9-968f-349c50e028c0",
    "tnNumber": "0000003391590",
    "tnStatusName": "НеNot registred зарегистрированat вthe отделенииdepot",
    "tnTrackingUpdateDate": null,
    "estimatedDeliveryDate": "2022-02-15",
    "departure": {
        "sender": {
            "type": "INDIVIDUAL",
            "id": "a4018a6e-8e86-40c4-8637-3eb71669d8ae",
            "title": "ПетровPetrov ИванIvan ГенадиевичGennadyovich",
            "phone": "380636511066"
        },
        "address": {
            "type": "warehouse",
            "geoObject": {
                "id": "10754",
                "name": "ЛьвовLviv"
            },
            "warehouse": {
                "id": "79000",
                "name": "79000 ЛьвівLviv, вул. СловацькогоSlovats'koro St, 1"
            }
        }
    },
    "destination": {
        "recipient": {
            "name": "ТамараTamara",
            "surname": "ПерепеличкоPerepelychko",
            "patronymic": "АнатольевнаAnatoliivna",
            "phone": "380636511023"
        },
        "address": {
            "type": "doors",
            "geoObject": {
                "id": "10754",
                "name": "ЛьвовLviv"
            },
            "street": {
                "id": "490046",
                "name": "вул.Banakha БанахаSt"
            },
            "buildingNumber": "2",
            "flatNumber": "3"
        }
    },
    "payment": {
        "payer": "Recipient"
    },
    "redelivery": {
        "cost": "43998",
        "payer": "Recipient"
    }
}

Пример ответа с блоком

...

Пример тела запроса с использованием offset и Example of a query body using offset and limit

{
    "token": "c5bc0cd25647e701bc6427f3629b27b4",
    "offset": 0,
    "limit": 2,
    "additionalData": true
}

Пример тела запроса для экспорта отдельных заказовExample of a query body for exporting individual orders

{
    "token": "c5bc0cd25647e701bc6427f3629b27b4",
    "ids": [
        5, 6
    ],
    "additionalData": true
}

Пример тела запроса для экспорта заказов по статусуExample of a query body for exporting orders by status

{
    "token": "c5bc0cd25647e701bc6427f3629b27b4",
    "status": [
        2
    ],
    "additionalData": true
}

...