Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Function orders/get (<http://<DOMAIN>>/api/orders/get/)

Block customer_details in Getting order list only for b2b projects

dropshipping_details block and new ownTTNPicked parameter in the delivery_data array in the order list only for b2b projects

Параметры:

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

  • from — показать заказы от указанной даты (включительно). Необязательный параметр.
    Формат даты:

    • YYYY-MM-DD

    • DD.MM.YYYY

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

    • YYYY-MM-DD HH:mm:ss

    • DD.MM.YYYY HH:mm:ss

  • to — показать заказы до указанной даты (включительно). Необязательный параметр.
    Формат даты:

    • YYYY-MM-DD

    • DD.MM.YYYY

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

    • YYYY-MM-DD HH:mm:ss

    • DD.MM.YYYY HH:mm:ss

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

  • status — показать заказы с выбранными статусами (выгрузить все статусы можно через функцию orders/get_available_statuses). Необязательный параметр. Параметр можно передавать как массив или переменную (status=1 или status[]=1&status[]=2, {status:1}, {status:[1, 2]}). Возможные значения:

    • 1 — новый

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

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

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

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

  • additionalData — boolean значение (true или false). Позволяет выгрузить дополнительную информацию о заказе, например, данные о ТТН Новой Почты, складе получателя и отправителя.

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

  • offset — смешение относительно начала выборки пользователей (работает только в паре с параметром limit)

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


Ответ:

  • status

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

    • EMPTY — заказы не найдены

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

    • response.orders[i]

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

      • user — идентификатор пользователя в системе (уникален для каждого пользователя)

      • delivery_name — ФИО получателя

      • delivery_email — email (уникален для каждого пользователя внутри системы, дублирование невозможно)

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

      • delivery_city — город

      • delivery_address — адрес доставки (при выборе варианта доставки УкрПочтой поля разбиваются символом @)

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

        • delivery_type.id — идентификатор доставки в API. Получить информацию о вариантах доставки можно через функции: delivery/export и delivery/exportTypes.

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

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

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

          • и т. д. (на каждом проекте идентификаторы вариантов доставки могут отличаться)

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

      • delivery_price — стоимость доставки ("delivery_price": -1 — означает, что стоимость доставки рассчитывается по тарифам перевозчика)

      • comment — комментарий покупателя к заказу

      • payment_type — тип оплаты. Получить информацию о вариантах оплаты можно через функции: payment/export и payment/exportMethods.

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

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

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

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

          • 14 — Онлайн-оплата кредитной картой

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

          • и т. д.

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

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

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

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

      • total_sum — итоговая стоимость (с учетом всех скидок, но без учета стоимости доставки)

      • total_quantity — общее количество товаров в заказе

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

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

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

      • coupon_percent — относительная скидка купона

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

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

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

        • 1 — сертификат на сумму

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

      • stat_status — статус заказа. Получить информацию о всех статусах заказов можно через функцию orders/get_available_statuses (доступно начиная с версии 4.0).

        • 1 — новый

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

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

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

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

      • currency — валюта в которой был оформлен заказ (в формате ISO, например: UAH — гривна, USD — доллар, EUR — евро и т. д.). Получить информацию о всех валютах можно через функцию currency/export.

      • order_without_callback — boolean значение (true или false). Нужно ли перезванивать покупателю (добавлено в версии 3.32).

      • manager_id - id менеджера который обрабатывал заказ

      • manager_comment - комментарий менеджера

      • manager_discount - скидка от менеджера

      • manager_discount_title - название скидки от менеджера

      • delivery_country - страна доставки (если включена функция выбора стран на странице оформления заказа)

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

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

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

        • price — стоимость единицы товара для пользователя

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

        • total_price — итоговая стоимость товара с учетом заказанного количества

        • discount_marker — маркер использованной скидки на товар

          • PRICE_OLD — старая цена / относительная скидка на товар

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

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

          • DISCOUNT_NONE — отсутствие скидки (при условиях акций и т. д.)

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

        • type — данный параметр появился в v4.7.0 и может содержать такие значения (как определить какой товар относиться к комплекту, или к какому товару относится подарок можно на примере этого скриншота):

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

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

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

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

        • storage_id — уникальный идентификатор, который в последствии передаётся в следующий параметр parent_storage_id, для указания связи между товарами на уровни комплектов / подарков

        • parent_storage_id — если значение null — значит, что к товару был добавлен подарок или товары в комплект (на данном скриншоте показан пример связи между товарами).

      • additional_data — дополнительная информация о заказе (отображается только в том случае, если в теле запроса передать ключ "additionalData": true)

        • np_ref — идентификатор электронной накладной (далее ЭН) для API Новой Почты v.2

        • np_number — номер ЭН

        • sender_warehouse_ref — идентификатор склада отправителя в API Новой Почты

        • recipient_warehouse_ref — идентификатор склада получателя в API Новой Почты для способа доставки “Новая почта” (на отделение)

        • recipient_address — данные об адресе получателя для способа доставки “Курьером Новой почты”(адресная доставка):

          • recipient_address.street_id –– идетнификатор улицы получателя в API Новой Почты

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

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

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

Response:

status

OK - orders successfully found

EMPTY - no orders 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 in the system, duplication is impossible)

delivery_phone - phone number

delivery_city - city

delivery_address - delivery address (if you choose UkrPochta delivery option, fields are broken by @ symbol)

delivery_type - delivery type

delivery_type.id - delivery identifier in API. You can get information about delivery options through the functions: delivery/export and delivery/exportTypes.

3 - New Post

8 - Self-delivery

9 - Ukrposhta

etc. (on each project identifiers of delivery options may differ)

delivery_type.title - name of the delivery option

delivery_price - delivery cost ("delivery_price": -1 - means that the delivery cost is calculated according to the carrier's tariffs)

comment - buyer's comment to the order

payment_type - payment type. You can get information about payment options through the functions: payment/export and payment/exportMethods.

payment_type.id - payment identifier in API

11 - Payment to courier

12 - Cashless payment

13 - Cash

14 - Online payment by credit card

15 - Payment on receipt (cash on delivery)

etc.

payment_type.title - name of payment option

payment_price - commission for payment

paid - 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 coupon discount

coupon_discount_value - coupon discount amount

coupon_type - coupon type

0 - no coupon

1 - certificate for amount

2 - reusable discount coupon

stat_status - order status. You can get information about all order statuses through 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 - 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 buyer should be called back (added in version 3.32).

manager_id - id of manager who processed the order

manager_comment - manager's comment

manager_discount - discount from manager

manager_discount_title - title of manager's discount

delivery_country - delivery country (if the function of selecting countries on the checkout page is enabled)

products[i] - products in the order

title - product name

article - product article

price - cost per unit for the user

quantity - number of ordered units

total_price - total cost of the product taking into account the ordered quantity

discount_marker - marker of used discount on the product

PRICE_OLD - old price / relative discount for the product

PAGE_DISCOUNT - section discount

DISCOUNT_CARD - accumulative 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 which product belongs to a gift can be seen on the example of this screenshot):

gift_parent - the item to which the gift was added

gift - the gift itself

set_main - the item to which the set was added

set_item - the item included in the set

storage_id - unique identifier, which is then passed to the next parameter parent_storage_id, to indicate the connection between the goods on the levels of sets/gifts.

parent_storage_id - if the value is null - it means that a gift or goods in a set were added to the product (this screenshot shows an example of a link between goods).

additional_data - additional information about the order (it is displayed only if the "additionalData" key is passed in the body of the request: true).

np_ref - electronic invoice identifier (hereinafter referred to as EN) for Novaya Pochta API v.2.

np_number - EN number

sender_warehouse_ref - sender's warehouse identifier in Novaya Pochta API

recipient_warehouse_ref - recipient's warehouse identifier in Novaya Pochta API for "New Mail" delivery method (to a branch)

recipient_address - recipient's address data for "New Post Courier" delivery method (address delivery):

recipient_address.street_id -- recipient's street identifier in New Post API

recipient_address.street_name -- street name

recipient_address.building_number -- house number

recipient_address.flat -- apartment number

  • delivery_data - массив данных о способе доставки

    • deliveryOperatorType- тип оператора доставки. Возможные значения: nova_poshta, ukrposhta

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

    • tnNumber — номер ЭН

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

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

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

    • departure

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

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

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

        • contactPerson — массив данных по контактному лицу (передается только для deliveryOperatorType= **nova_poshta)

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

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

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

        • type — тип отправителя (ключ передается только для deliveryOperatorType= **ukrposhta) . Возможные значения:

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

          • PRIVATE_ENTREPRENEUR — ФЛП

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

        • phone — телефон отправителя (ключ передается только для deliveryOperatorType= **ukrposhta)

    • address

      • type — тип адреса отправителя. Возможные значения: 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)

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

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

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

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

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

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

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

  • delivery_data - array of data about delivery method

    • deliveryOperatorType - type of delivery operator. Possible values: nova_poshta, ukrposht

    • tnID - 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

      • 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 - 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 - 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 - 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 - 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 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": "Киев",
        "delivery_address": "Отделение №13 (до 30 кг на одно место): ул. Оранжерейная, 3 (метро Дорогожичи)",
        "delivery_type": {
          "id": 3,
          "title": "Новой почтой"
        },
        "delivery_price": -1,
        "comment": "Комментарий к заказу",
        "payment_type": {
          "id": 13,
          "title": "Наличными"
        },
        "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": "Товар 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": "Товар 13",
            "article": "10000013",
            "price": 0,
            "quantity": 1,
            "discount_marker": "DISCOUNT_NONE",
            "type": "gift",
            "storage_id": 42,
            "parent_storage_id": 41,
            "total_price": 0
          },
          {
            "title": "Тестовый комплект",
            "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": "Товар 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": "Товар 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": "Товар 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": "Создан",
    "tnTrackingUpdateDate": null,
    "estimatedDeliveryDate": "2021-12-24",
    "departure": {
        "sender": {
            "id": "60cd854f-580c-11eb-8513-b88303659df5",
            "title": "Приватна особа",
            "contactPerson": {
                "id": "9bc4f232-580c-11eb-8513-b88303659df5",
                "name": "Александр Анатолиевич Коваль (380915554433)",
                "phone": "380915554433"
            }
        },
        "address": {
            "type": "warehouse",
            "geoObject": {
                "id": "db5c88e0-391c-11dd-90d9-001a92567626",
                "name": "Харьков"
            },
            "warehouse": {
                "id": "169227f4-e1c2-11e3-8c4a-0050568002cf",
                "name": "Отделение №1: ул. Полевая, 67"
            }
        }
    },
    "destination": {
        "recipient": {
            "name": "Наталья",
            "surname": "Ткаченко",
            "patronymic": null,
            "phone": "380914443322"
        },
        "address": {
            "type": "warehouse",
            "geoObject": {
                "id": "f706237a-4078-11de-b509-001d92f78698",
                "name": "Яворов"
            },
            "warehouse": {
                "id": "16922828-e1c2-11e3-8c4a-0050568002cf",
                "name": "Отделение №1: ул. А. Маковея, 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": "Яворов"
      },
     "street" : {
          "id"   : "16922828-e1c2-11e3-8c4a-0050568002cf", 
          "name" : "ул. А. Маковея, 62" 
      },
      "houseNumber"   : "22/12", 
      "flatNumber"    : "16Б"
}

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": "Не зарегистрирован в отделении",
    "tnTrackingUpdateDate": null,
    "estimatedDeliveryDate": "2022-02-15",
    "departure": {
        "sender": {
            "type": "INDIVIDUAL",
            "id": "a4018a6e-8e86-40c4-8637-3eb71669d8ae",
            "title": "Петров Иван Генадиевич",
            "phone": "380636511066"
        },
        "address": {
            "type": "warehouse",
            "geoObject": {
                "id": "10754",
                "name": "Львов"
            },
            "warehouse": {
                "id": "79000",
                "name": "79000 Львів, вул. Словацького, 1"
            }
        }
    },
    "destination": {
        "recipient": {
            "name": "Тамара",
            "surname": "Перепеличко",
            "patronymic": "Анатольевна",
            "phone": "380636511023"
        },
        "address": {
            "type": "doors",
            "geoObject": {
                "id": "10754",
                "name": "Львов"
            },
            "street": {
                "id": "490046",
                "name": "вул. Банаха"
            },
            "buildingNumber": "2",
            "flatNumber": "3"
        }
    },
    "payment": {
        "payer": "Recipient"
    },
    "redelivery": {
        "cost": "43998",
        "payer": "Recipient"
    }
}

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
}

  • No labels