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

Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п.

Раньше генерация детальной информации по заказам называлась Отчет по заказам. Сейчас это новый отчет. Подробнее об отчете

В одном запросе можно получить информацию не более чем по 200 заказам.

⚙️ Лимит: 1 000 000 запросов в час

Request

POST

https://api.partner.market.yandex.ru/campaigns/{campaignId}/stats/orders

Path parameters

Name

Type

Description

campaignId*

integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Query parameters

Name

Type

Description

page_token

string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается самая старая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token, параметры offset, page_number и page_size игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

limit

integer<int32>

Количество товаров на одной странице.
Example: 20

Body

application/json
{
    "dateFrom": "string",
    "dateTo": "string",
    "updateFrom": "string",
    "updateTo": "string",
    "orders": [
        0
    ],
    "statuses": [
        "CANCELLED_BEFORE_PROCESSING"
    ],
    "hasCis": false
}

Name

Type

Description

dateFrom

string<date>

Начальная дата, когда заказ был сформирован.

Формат даты: ГГГГ‑ММ‑ДД.

Нельзя использовать вместе с параметрами updateFrom и updateTo.

dateTo

string<date>

Конечная дата, когда заказ был сформирован. Формат даты: ГГГГ‑ММ‑ДД. Нельзя использовать вместе с параметрами updateFrom и updateTo.

updateFrom

string<date>

Начальная дата периода, за который были изменения статуса заказа. Формат даты: ГГГГ‑ММ‑ДД. Нельзя использовать вместе с параметрами dateFrom и dateTo.

updateTo

string<date>

Конечная дата периода, за который были изменения статуса заказа. Формат даты: ГГГГ‑ММ‑ДД. Нельзя использовать вместе с параметрами dateFrom и dateTo.

orders

integer<int64>[]

Список идентификаторов заказов.
Список товаров в заказе после возможных изменений.

В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.

  • Если из заказа удалены все единицы товара, его не будет в списке items — только в списке initialItems.

  • Если в заказе осталась хотя бы одна единица товара, он будет и в списке items (с уменьшенным количеством единиц count), и в списке initialItems (с первоначальным количеством единиц initialCount).

statuses

OrderStatsStatusType[]

Список статусов заказов.
Текущий статус заказа:

  • CANCELLED_BEFORE_PROCESSING — заказ отменен до начала его обработки.

  • CANCELLED_IN_DELIVERY — заказ отменен во время его доставки.

  • CANCELLED_IN_PROCESSING — заказ отменен во время его обработки.

  • DELIVERY — заказ передан службе доставки.

  • DELIVERED — заказ доставлен.

  • PARTIALLY_DELIVERED — заказ частично доставлен.

  • PARTIALLY_RETURNED — заказ частично возвращен покупателем.

  • PENDING — заказ ожидает подтверждения.

  • PICKUP — заказ доставлен в пункт выдачи.

  • PROCESSING — заказ в обработке.

  • RESERVED — товар зарезервирован на складе.

  • RETURNED — заказ полностью возвращен покупателем.

  • UNKNOWN — неизвестный статус заказа.

  • UNPAID — заказ от юридического лица ожидает оплаты.

  • LOST — заказ утерян.


Enum: CANCELLED_BEFORE_PROCESSING, CANCELLED_IN_DELIVERY, CANCELLED_IN_PROCESSING, DELIVERY, DELIVERED, PARTIALLY_DELIVERED, PARTIALLY_RETURNED, PENDING, PICKUP, PROCESSING, RESERVED, RETURNED, UNKNOWN, UNPAID, LOST

hasCis

boolean

Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:

  • true — да.
  • false — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.

OrderStatsStatusType

Текущий статус заказа:

  • CANCELLED_BEFORE_PROCESSING — заказ отменен до начала его обработки.

  • CANCELLED_IN_DELIVERY — заказ отменен во время его доставки.

  • CANCELLED_IN_PROCESSING — заказ отменен во время его обработки.

  • DELIVERY — заказ передан службе доставки.

  • DELIVERED — заказ доставлен.

  • PARTIALLY_DELIVERED — заказ частично доставлен.

  • PARTIALLY_RETURNED — заказ частично возвращен покупателем.

  • PENDING — заказ ожидает подтверждения.

  • PICKUP — заказ доставлен в пункт выдачи.

  • PROCESSING — заказ в обработке.

  • RESERVED — товар зарезервирован на складе.

  • RETURNED — заказ полностью возвращен покупателем.

  • UNKNOWN — неизвестный статус заказа.

  • UNPAID — заказ от юридического лица ожидает оплаты.

  • LOST — заказ утерян.

Type

Description

OrderStatsStatusType

Enum: CANCELLED_BEFORE_PROCESSING, CANCELLED_IN_DELIVERY, CANCELLED_IN_PROCESSING, DELIVERY, DELIVERED, PARTIALLY_DELIVERED, PARTIALLY_RETURNED, PENDING, PICKUP, PROCESSING, RESERVED, RETURNED, UNKNOWN, UNPAID, LOST

Responses

200 OK

Информация по заказам.

Body

application/json
{
    "status": "OK",
    "result": {
        "orders": [
            {
                "id": 0,
                "creationDate": "string",
                "statusUpdateDate": "2022-12-29T18:02:01Z",
                "status": "CANCELLED_BEFORE_PROCESSING",
                "partnerOrderId": "string",
                "paymentType": "CREDIT",
                "fake": false,
                "deliveryRegion": {
                    "id": 0,
                    "name": "string"
                },
                "items": [
                    {
                        "offerName": "string",
                        "marketSku": 0,
                        "shopSku": "string",
                        "count": 0,
                        "prices": [
                            {
                                "type": "BUYER",
                                "costPerItem": 0,
                                "total": 0
                            }
                        ],
                        "warehouse": {
                            "id": 0,
                            "name": "string"
                        },
                        "details": [
                            {
                                "itemStatus": "REJECTED",
                                "itemCount": 0,
                                "updateDate": "string",
                                "stockType": "FIT"
                            }
                        ],
                        "cisList": [
                            "string"
                        ],
                        "initialCount": 0,
                        "bidFee": 570,
                        "cofinanceThreshold": 0,
                        "cofinanceValue": 0
                    }
                ],
                "initialItems": [
                    {
                        "offerName": "string",
                        "marketSku": 0,
                        "shopSku": "string",
                        "count": 0,
                        "prices": [
                            {
                                "type": "BUYER",
                                "costPerItem": 0,
                                "total": 0
                            }
                        ],
                        "warehouse": {
                            "id": 0,
                            "name": "string"
                        },
                        "details": [
                            {
                                "itemStatus": "REJECTED",
                                "itemCount": 0,
                                "updateDate": "string",
                                "stockType": "FIT"
                            }
                        ],
                        "cisList": [
                            "string"
                        ],
                        "initialCount": 0,
                        "bidFee": 570,
                        "cofinanceThreshold": 0,
                        "cofinanceValue": 0
                    }
                ],
                "payments": [
                    {
                        "id": "string",
                        "date": "string",
                        "type": "PAYMENT",
                        "source": "BUYER",
                        "total": 0,
                        "paymentOrder": {
                            "id": "string",
                            "date": "string"
                        }
                    }
                ],
                "commissions": [
                    {
                        "type": "FEE",
                        "actual": 0
                    }
                ]
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

result

OrdersStatsDTO

Информация по заказам.

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

OrdersStatsDTO

Информация по заказам.

Name

Type

Description

orders

OrdersStatsOrderDTO[]

Список заказов.
Информация о заказе.

paging

ForwardScrollingPagerDTO

Ссылка на следующую страницу.

OrdersStatsOrderDTO

Информация о заказе.

Name

Type

Description

id

integer<int64>

Идентификатор заказа.

creationDate

string<date>

Дата создания заказа. Формат даты: ГГГГ-ММ-ДД.

statusUpdateDate

string<date-time>

Дата и время, когда статус заказа был изменен в последний раз. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва).

status

OrderStatsStatusType

Текущий статус заказа:

  • CANCELLED_BEFORE_PROCESSING — заказ отменен до начала его обработки.

  • CANCELLED_IN_DELIVERY — заказ отменен во время его доставки.

  • CANCELLED_IN_PROCESSING — заказ отменен во время его обработки.

  • DELIVERY — заказ передан службе доставки.

  • DELIVERED — заказ доставлен.

  • PARTIALLY_DELIVERED — заказ частично доставлен.

  • PARTIALLY_RETURNED — заказ частично возвращен покупателем.

  • PENDING — заказ ожидает подтверждения.

  • PICKUP — заказ доставлен в пункт выдачи.

  • PROCESSING — заказ в обработке.

  • RESERVED — товар зарезервирован на складе.

  • RETURNED — заказ полностью возвращен покупателем.

  • UNKNOWN — неизвестный статус заказа.

  • UNPAID — заказ от юридического лица ожидает оплаты.

  • LOST — заказ утерян.


Enum: CANCELLED_BEFORE_PROCESSING, CANCELLED_IN_DELIVERY, CANCELLED_IN_PROCESSING, DELIVERY, DELIVERED, PARTIALLY_DELIVERED, PARTIALLY_RETURNED, PENDING, PICKUP, PROCESSING, RESERVED, RETURNED, UNKNOWN, UNPAID, LOST

partnerOrderId

string

Идентификатор заказа в информационной системе магазина.

paymentType

OrdersStatsOrderPaymentType

Тип оплаты заказа.
Enum: CREDIT, POSTPAID, PREPAID, TINKOFF_CREDIT

fake

boolean

Тип заказа:

  • false — настоящий заказ покупателя.

  • true — тестовый заказ Маркета.

deliveryRegion

OrdersStatsDeliveryRegionDTO

Информация о регионе доставки.

items

OrdersStatsItemDTO[]

Список товаров в заказе после возможных изменений.
Список товаров в заказе после возможных изменений.

В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.

  • Если из заказа удалены все единицы товара, его не будет в списке items — только в списке initialItems.

  • Если в заказе осталась хотя бы одна единица товара, он будет и в списке items (с уменьшенным количеством единиц count), и в списке initialItems (с первоначальным количеством единиц initialCount).

initialItems

OrdersStatsItemDTO[]

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

В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.

  • Если из заказа удалены все единицы товара, его не будет в списке items — только в списке initialItems.

  • Если в заказе осталась хотя бы одна единица товара, он будет и в списке items (с уменьшенным количеством единиц count), и в списке initialItems (с первоначальным количеством единиц initialCount).

payments

OrdersStatsPaymentDTO[]

Информация о денежных переводах по заказу.
Информация о денежных переводах по заказу.

commissions

OrdersStatsCommissionDTO[]

Информация о комиссиях за заказ.
Информация о стоимости услуг.

ForwardScrollingPagerDTO

Ссылка на следующую страницу.

Name

Type

Description

nextPageToken

string

Идентификатор следующей страницы результатов.

OrdersStatsOrderPaymentType

Тип оплаты заказа:

  • CREDIT — заказ оформлен в кредит.
  • POSTPAID — заказ оплачен после того, как был получен.
  • PREPAID — заказ оплачен до того, как был получен.

Type

Description

OrdersStatsOrderPaymentType

Enum: CREDIT, POSTPAID, PREPAID, TINKOFF_CREDIT

OrdersStatsDeliveryRegionDTO

Информация о регионе доставки.

Name

Type

Description

id

integer<int64>

Идентификатор региона доставки.

name

string

Название региона доставки.

OrdersStatsItemDTO

Список товаров в заказе после возможных изменений.

В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.

  • Если из заказа удалены все единицы товара, его не будет в списке items — только в списке initialItems.

  • Если в заказе осталась хотя бы одна единица товара, он будет и в списке items (с уменьшенным количеством единиц count), и в списке initialItems (с первоначальным количеством единиц initialCount).

Name

Type

Description

offerName

string

Название товара.

marketSku

integer<int64>

SKU на Маркете.

shopSku

string

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы . , / \ ( ) [ ] - = _

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать


Min length: 1
Max length: 80

count

integer<int32>

Количество единиц товара с учетом удаленных единиц.

Если из заказа удалены все единицы товара, он попадет только в список initialItems.

prices

OrdersStatsPriceDTO[]

Цена или скидки на товар.
Цена или скидки на товар.

warehouse

OrdersStatsWarehouseDTO

Информация о складе, на котором хранится товар.

details

OrdersStatsDetailsDTO[]

Информация об удалении товара из заказа.
Информация об удалении товара из заказа.

cisList

string[]

Список кодов идентификации товара в системе «Честный ЗНАК».

initialCount

integer<int32>

Первоначальное количество единиц товара.

bidFee

integer<int32>

Списанная ставка ближайшего конкурента.

Указывается в процентах от стоимости товара и умножается на 100. Например, ставка 5% обозначается как 500.


Example: 570

cofinanceThreshold

number

Порог для скидок с Маркетом на момент оформления заказа. Что это такое?

Указан в рублях. Точность — два знака после запятой.

cofinanceValue

number

Скидка с Маркетом. Что это такое?

Указана в рублях. Точность — два знака после запятой.

OrdersStatsPaymentDTO

Информация о денежных переводах по заказу.

Name

Type

Description

id

string

Идентификатор денежного перевода.

date

string<date>

Дата денежного перевода. Формат даты: ГГГГ-ММ-ДД.

type

OrdersStatsPaymentType

Тип денежного перевода.
Enum: PAYMENT, REFUND, UNKNOWN

source

OrdersStatsPaymentSourceType

Способ денежного перевода.
Enum: BUYER, CASHBACK, MARKETPLACE, SPASIBO, SPLIT

total

number

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

paymentOrder

OrdersStatsPaymentOrderDTO

Информация о платежном получении.

OrdersStatsCommissionDTO

Информация о стоимости услуг.

Name

Type

Description

type

OrdersStatsCommissionType

Услуга.
Enum: FEE, FULFILLMENT, LOYALTY_PARTICIPATION_FEE, AUCTION_PROMOTION, INSTALLMENT, DELIVERY_TO_CUSTOMER, EXPRESS_DELIVERY_TO_CUSTOMER, AGENCY, PAYMENT_TRANSFER, RETURNED_ORDERS_STORAGE, SORTING, INTAKE_SORTING, RETURN_PROCESSING, ILLIQUID_GOODS_SALE

actual

number

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

OrdersStatsPriceDTO

Цена или скидки на товар.

Name

Type

Description

type

OrdersStatsPriceType

Тип скидки или цена на товар.
Enum: BUYER, CASHBACK, MARKETPLACE, SPASIBO

costPerItem

number

Цена или скидка на единицу товара в заказе. Указана в рублях. Точность — два знака после запятой.

total

number

Суммарная цена или скидка на все единицы товара в заказе. Указана в рублях. Точность — два знака после запятой.

OrdersStatsWarehouseDTO

Информация о складе, на котором хранится товар.

Name

Type

Description

id

integer<int64>

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

name

string

Название склада.

OrdersStatsDetailsDTO

Информация об удалении товара из заказа.

Name

Type

Description

itemStatus

OrdersStatsItemStatusType

Статус товара.
Enum: REJECTED, RETURNED

itemCount

integer<int64>

Количество товара со статусом, указанном в параметре itemStatus.

updateDate

string<date>

Дата, когда товар получил статус, указанный в параметре itemStatus.

Формат даты: ГГГГ-ММ-ДД.

stockType

OrdersStatsStockType

Тип товара.
Enum: FIT, FREEZE, AVAILABLE, QUARANTINE, UTILIZATION, DEFECT, EXPIRED

OrdersStatsPaymentType

Тип денежного перевода:

  • PAYMENT — оплата.
  • REFUND — возврат.

Type

Description

OrdersStatsPaymentType

Enum: PAYMENT, REFUND, UNKNOWN

OrdersStatsPaymentSourceType

Способ денежного перевода:

  • BUYER — оплата или возврат деньгами.
  • CASHBACK — оплата или возврат баллами Плюса.
  • MARKETPLACE — оплата или возврат купонами.
  • SPASIBO — оплата или возврат бонусами СберСпасибо.
  • SPLIT — оплата картой по частям (Сплит).

Type

Description

OrdersStatsPaymentSourceType

Enum: BUYER, CASHBACK, MARKETPLACE, SPASIBO, SPLIT

OrdersStatsPaymentOrderDTO

Информация о платежном получении.

Name

Type

Description

id

string

Номер платежного поручения.

date

string<date>

Дата платежного поручения. Формат даты: ГГГГ‑ММ‑ДД.

OrdersStatsCommissionType

Услуга:

  • FEE — размещение товара на Маркете.
  • FULFILLMENT — складская обработка.
  • LOYALTY_PARTICIPATION_FEE — участие в программе лояльности и отзывы за баллы, если они подключены.
  • AUCTION_PROMOTION — буст продаж.
  • INSTALLMENT — рассрочка.
  • DELIVERY_TO_CUSTOMER — доставка покупателю.
  • EXPRESS_DELIVERY_TO_CUSTOMER — экспресс-доставка покупателю.
  • AGENCY — прием платежа покупателя.
  • PAYMENT_TRANSFER — перевод платежа покупателя.
  • RETURNED_ORDERS_STORAGE — хранение невыкупов и возвратов.
  • SORTING — обработка заказа.
  • INTAKE_SORTING — организация забора заказов со склада продавца (FBS).
  • RETURN_PROCESSING — обработка заказов на складе (FBY).
  • ILLIQUID_GOODS_SALE — продажа экспроприированных товаров.

Type

Description

OrdersStatsCommissionType

Enum: FEE, FULFILLMENT, LOYALTY_PARTICIPATION_FEE, AUCTION_PROMOTION, INSTALLMENT, DELIVERY_TO_CUSTOMER, EXPRESS_DELIVERY_TO_CUSTOMER, AGENCY, PAYMENT_TRANSFER, RETURNED_ORDERS_STORAGE, SORTING, INTAKE_SORTING, RETURN_PROCESSING, ILLIQUID_GOODS_SALE

OrdersStatsPriceType

Тип скидки или цена на товар:

  • BUYER — цена на товар с учетом скидок, в том числе купонов.
  • CASHBACK — баллы Плюса.
  • MARKETPLACE — купоны.
  • SPASIBO — бонусы СберСпасибо.

Type

Description

OrdersStatsPriceType

Enum: BUYER, CASHBACK, MARKETPLACE, SPASIBO

OrdersStatsItemStatusType

Статус товара:

  • REJECTED — товар был добавлен в созданный заказ, но не был оплачен.
  • RETURNED — товар вернули.

Type

Description

OrdersStatsItemStatusType

Enum: REJECTED, RETURNED

OrdersStatsStockType

Тип товара:

  • DEFECT — товар бракованный.

  • FIT — товар надлежащего качества.

Type

Description

OrdersStatsStockType

Enum: FIT, FREEZE, AVAILABLE, QUARANTINE, UTILIZATION, DEFECT, EXPIRED

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

ApiErrorDTO

Общий формат ошибки.

Name

Type

Description

code*

string

Код ошибки.

message

string

Описание ошибки.

401 Unauthorized

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.
Предыдущая
Передача проверочного кода для передачи заказа
Следующая
Список невыкупов и возвратов
В этой статье: