- Request
- Responses
- 200 OK
- Body
- OrderDTO
- OrderBuyerDTO
- CurrencyType
- OrderDeliveryDTO
- OrderItemDTO
- OrderPaymentMethodType
- OrderPaymentType
- OrderSubsidyDTO
- OrderTaxSystemType
- OrderBuyerType
- OrderDeliveryAddressDTO
- OrderCourierDTO
- OrderDeliveryDatesDTO
- OrderDeliveryPartnerType
- OrderDeliveryDispatchType
- OrderDeliveryEacType
- OrderLiftType
- RegionDTO
- OrderShipmentDTO
- OrderTrackDTO
- OrderDeliveryType
- OrderVatType
- OrderItemDetailDTO
- OrderItemInstanceDTO
- OrderItemPromoDTO
- OrderItemInstanceType
- OrderItemSubsidyDTO
- OrderSubsidyType
- GpsDTO
- RegionType
- OrderParcelBoxDTO
- OrderItemStatusType
- OrderPromoType
- OrderItemSubsidyType
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 420 Method Failure
- 500 Internal Server Error
Изменение статуса заказа
Изменяет статус заказа. Возможные изменения статусов:
- Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса
"status": "PROCESSING"
и этапа обработки"substatus": "STARTED"
нужно перевести в статус"status": "PROCESSING"
и этап обработки"substatus": "READY_TO_SHIP"
. - Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса
"status": "PROCESSING"
и этапа обработки"substatus": "STARTED"
нужно перевести в статус"status": "CANCELLED"
с причиной отмены заказа"substatus": "SHOP_FAILED"
. - Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса
"status": "PROCESSING"
и этапа обработки"substatus": "READY_TO_SHIP"
нужно перевести в статус"status": "CANCELLED"
с причиной отмены заказа"substatus": "SHOP_FAILED"
.
⚙️ Лимит: 1 000 000 запросов в час |
---|
Request
PUT
https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/status
Path parameters
Name |
Description |
campaignId* |
Type: integer<int64> Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. |
orderId* |
Type: integer<int64> Идентификатор заказа. |
Body
application/json
{
"order": {
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"delivery": {
"dates": {
"realDeliveryDate": "string"
}
}
}
}
Name |
Description |
order* |
Type: OrderStatusChangeDTO Заказ. |
OrderStatusChangeDTO
Заказ.
Name |
Description |
status* |
Type: OrderStatusType Статус заказа:
Также могут возвращаться другие значения. Обрабатывать их не требуется. Enum: |
delivery |
Type: OrderStatusChangeDeliveryDTO Информация о доставке. |
substatus |
Type: OrderSubstatusType Этап обработки заказа (если он имеет статус
Также могут возвращаться другие значения. Обрабатывать их не требуется. Enum: |
OrderStatusType
Статус заказа:
-
CANCELLED
— отменен. -
DELIVERED
— получен покупателем. -
DELIVERY
— передан в службу доставки. -
PICKUP
— доставлен в пункт самовывоза. -
PROCESSING
— находится в обработке. -
PENDING
— ожидает обработки со стороны продавца. -
UNPAID
— оформлен, но еще не оплачен (если выбрана оплата при оформлении). -
PLACING
— оформляется, подготовка к резервированию. -
RESERVED
— зарезервирован, но недооформлен. -
PARTIALLY_RETURNED
— возвращен частично. -
RETURNED
— возвращен полностью. -
UNKNOWN
— неизвестный статус.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
Type |
Description |
Enum: |
OrderStatusChangeDeliveryDTO
Информация о доставке.
Name |
Description |
dates |
Type: OrderStatusChangeDeliveryDatesDTO Диапазон дат доставки. |
OrderSubstatusType
Этап обработки заказа (если он имеет статус PROCESSING
) или причина отмены заказа (если он имеет статус CANCELLED
).
-
Значения для заказа в статусе
PROCESSING
:-
STARTED
— заказ подтвержден, его можно начать обрабатывать. -
READY_TO_SHIP
— заказ собран и готов к отправке.
-
-
Значения для заказа в статусе
CANCELLED
:-
PROCESSING_EXPIRED
— значение более не используется. -
REPLACING_ORDER
— покупатель решил заменить товар другим по собственной инициативе. -
RESERVATION_EXPIRED
— покупатель не завершил оформление зарезервированного заказа в течение 10 минут. -
SHOP_FAILED
— магазин не может выполнить заказ. -
USER_CHANGED_MIND
— покупатель отменил заказ по личным причинам. -
USER_NOT_PAID
— покупатель не оплатил заказ (для типа оплатыPREPAID
) в течение 30 минут. -
USER_REFUSED_DELIVERY
— покупателя не устроили условия доставки. -
USER_REFUSED_PRODUCT
— покупателю не подошел товар. -
USER_REFUSED_QUALITY
— покупателя не устроило качество товара. -
USER_UNREACHABLE
— не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:- не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
- перерыв между первым и третьим звонком не менее 90 минут;
- соединение не короче 5 секунд.
Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.
-
-
TECHNICAL_ERROR
— техническая ошибка на стороне Маркета. Обратитесь в поддержку.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
Type |
Description |
Enum: |
OrderStatusChangeDeliveryDatesDTO
Диапазон дат доставки.
Name |
Description |
realDeliveryDate |
Type: string<date> Только для модели DBS Фактическая дата доставки.
|
Responses
200 OK
В случае успешного изменения статуса заказа возвращается обновленная информация о заказе.
Body
application/json
{
"order": {
"id": 0,
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"creationDate": "23-09-2022 09:12:41",
"updatedAt": "23-09-2022 09:12:41",
"currency": "RUR",
"itemsTotal": 0,
"deliveryTotal": 0,
"buyerItemsTotal": 0,
"buyerTotal": 0,
"buyerItemsTotalBeforeDiscount": 0,
"buyerTotalBeforeDiscount": 0,
"paymentType": "PREPAID",
"paymentMethod": "CASH_ON_DELIVERY",
"fake": false,
"items": [
{
"id": 0,
"offerId": "string",
"offerName": "string",
"price": 0,
"buyerPrice": 0,
"buyerPriceBeforeDiscount": 0,
"priceBeforeDiscount": 0,
"count": 0,
"vat": "NO_VAT",
"shopSku": "string",
"subsidy": 0,
"partnerWarehouseId": "string",
"promos": [
{
"type": "DIRECT_DISCOUNT",
"discount": 0,
"subsidy": 0,
"shopPromoId": "string",
"marketPromoId": "string"
}
],
"instances": [
{
"cis": "string",
"cisFull": "string",
"uin": "string",
"rnpt": "string",
"gtd": "string"
}
],
"details": [
{
"itemCount": 0,
"itemStatus": "REJECTED",
"updateDate": "23-09-2022"
}
],
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0
}
],
"requiredInstanceTypes": [
"CIS"
]
}
],
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0
}
],
"delivery": {
"id": "string",
"type": "DELIVERY",
"serviceName": "string",
"price": 0,
"deliveryPartnerType": "SHOP",
"courier": {
"fullName": "string",
"phone": "string",
"phoneExtension": "string",
"vehicleNumber": "string",
"vehicleDescription": "string"
},
"dates": {
"fromDate": "23-09-2022",
"toDate": "23-09-2022",
"fromTime": "string",
"toTime": "string",
"realDeliveryDate": "23-09-2022"
},
"region": {
"id": 0,
"name": "string",
"type": "OTHER",
"parent": {
"id": 0,
"name": "string",
"type": "OTHER",
"children": [
null
]
},
"children": [
null
]
},
"address": {
"country": "string",
"postcode": "string",
"city": "string",
"district": "string",
"subway": "string",
"street": "string",
"house": "string",
"block": "string",
"entrance": "string",
"entryphone": "string",
"floor": "string",
"apartment": "string",
"phone": "string",
"recipient": "string",
"gps": {
"latitude": 0,
"longitude": 0
}
},
"vat": "NO_VAT",
"deliveryServiceId": 0,
"liftType": "NOT_NEEDED",
"liftPrice": 0,
"outletCode": "string",
"outletStorageLimitDate": "23-09-2022",
"dispatchType": "UNKNOWN",
"tracks": [
{
"trackCode": "string",
"deliveryServiceId": 0
}
],
"shipments": [
{
"id": 0,
"shipmentDate": "23-09-2022",
"shipmentTime": "string",
"tracks": [
{
"trackCode": "string",
"deliveryServiceId": 0
}
],
"boxes": [
{
"id": 0,
"fulfilmentId": "string"
}
]
}
],
"estimated": false,
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "string"
},
"buyer": {
"id": "string",
"lastName": "string",
"firstName": "string",
"middleName": "string",
"type": "PERSON"
},
"notes": "string",
"taxSystem": "OSN",
"cancelRequested": false,
"expiryDate": "23-09-2022 09:12:41"
}
}
Name |
Description |
order |
Type: OrderDTO Заказ. |
OrderDTO
Заказ.
Name |
Description |
buyer |
Type: OrderBuyerDTO Информация о покупателе. Параметры |
buyerItemsTotal |
Type: number<decimal> Этот параметр устарел. Стоимость всех товаров в заказе в валюте покупателя после применения скидок и без учета стоимости доставки. |
buyerItemsTotalBeforeDiscount |
Type: number<decimal> Стоимость всех товаров в заказе в валюте покупателя без учета стоимости доставки и до применения скидок по:
|
buyerTotal |
Type: number<decimal> Этот параметр устарел. Стоимость всех товаров в заказе в валюте покупателя после применения скидок и с учетом стоимости доставки. |
buyerTotalBeforeDiscount |
Type: number<decimal> Этот параметр устарел. Стоимость всех товаров в заказе в валюте покупателя до применения скидок и с учетом стоимости доставки ( |
cancelRequested |
Type: boolean Только для модели DBS Запрошена ли отмена. |
creationDate |
Type: string<date-dd-MM-yyyy-HH-mm-ss> Дата и время оформления заказа. Формат даты и времени: Example: |
currency |
Type: CurrencyType Валюта, в которой указаны цены на товары в заказе. Принимает значение Enum: |
delivery |
Type: OrderDeliveryDTO Информация о доставке. |
deliveryTotal |
Type: number<decimal> Стоимость доставки. |
expiryDate |
Type: string<date-dd-MM-yyyy-HH-mm-ss> Дата, после которой заказ будет отменен, если не сменит статус. Формат даты: Example: |
fake |
Type: boolean Тип заказа:
|
id |
Type: integer<int64> Идентификатор заказа. |
items |
Type: OrderItemDTO[] Список товаров в заказе. |
itemsTotal |
Type: number<decimal> Платеж покупателя. |
notes |
Type: string Комментарий к заказу. |
paymentMethod |
Type: OrderPaymentMethodType Способ оплаты заказа:
Значение по умолчанию: Enum: |
paymentType |
Type: OrderPaymentType Тип оплаты заказа:
Если параметр отсутствует, заказ будет оплачен при получении. Enum: |
status |
Type: OrderStatusType Статус заказа:
Также могут возвращаться другие значения. Обрабатывать их не требуется. Enum: |
subsidies |
Type: OrderSubsidyDTO[] Список субсидий по типам.
Передается в валюте заказа. |
substatus |
Type: OrderSubstatusType Этап обработки заказа (если он имеет статус
Также могут возвращаться другие значения. Обрабатывать их не требуется. Enum: |
taxSystem |
Type: OrderTaxSystemType Система налогообложения (СНО) магазина на момент оформления заказа:
Enum: |
updatedAt |
Type: string<date-dd-MM-yyyy-HH-mm-ss> Дата и время последнего обновления заказа. Формат даты и времени: Example: |
OrderBuyerDTO
Информация о покупателе.
Параметры id
, lastName
, firstName
и middleName
возвращаются, только если вы работаете по модели DBS.
Name |
Description |
firstName |
Type: string Имя покупателя. |
id |
Type: string Идентификатор покупателя. |
lastName |
Type: string Фамилия покупателя. |
middleName |
Type: string Отчество покупателя. |
type |
Type: OrderBuyerType Тип покупателя: физическое лицо или организация. Этот параметр используется FBS- и FBY-магазинами, размещающими товары на витрине business.market.yandex.ru. Enum: |
CurrencyType
Коды валют. Возможные значения:
BYR
— белорусский рубль.KZT
— казахстанский тенге.RUR
— российский рубль.UAH
— украинская гривна.
Type |
Description |
Enum: |
OrderDeliveryDTO
Информация о доставке.
Name |
Description |
address |
Type: OrderDeliveryAddressDTO Адрес доставки. Указывается, если |
courier |
Type: OrderCourierDTO Информация о курьере. |
dates |
Type: OrderDeliveryDatesDTO Диапазон дат доставки. |
deliveryPartnerType |
Type: OrderDeliveryPartnerType Тип сотрудничества со службой доставки в рамках конкретного заказа. Enum: |
deliveryServiceId |
Type: integer<int64> Идентификатор службы доставки. |
dispatchType |
Type: OrderDeliveryDispatchType Способ отгрузки:
Enum: |
eacCode |
Type: string Код подтверждения ЭАПП (для типа |
eacType |
Type: OrderDeliveryEacType Тип кода подтверждения ЭАПП. Enum: |
estimated |
Type: boolean Приблизительная ли дата доставки. |
id |
Type: string Идентификатор доставки, присвоенный магазином. Указывается, только если магазин передал данный идентификатор в ответе на запрос методом POST cart. |
liftPrice |
Type: number<decimal> Стоимость подъема на этаж. |
liftType |
Type: OrderLiftType Тип подъема заказа на этаж:
Enum: |
outletCode |
Type: string Идентификатор пункта самовывоза, присвоенный магазином. |
outletStorageLimitDate |
Type: string<date-dd-MM-yyyy> Дата, до которой заказ будет храниться в пункте выдачи. Возвращается, когда заказ переходит в статус Один раз дату можно поменять с помощью метода PUT campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit. Example: |
price |
Type: number<decimal> Этот параметр устарел. Стоимость доставки смотрите в параметре Стоимость доставки в валюте заказа. |
region |
Type: RegionDTO Регион доставки. |
serviceName |
Type: string Наименование службы доставки. |
shipments |
Type: OrderShipmentDTO[] Информация о посылках. В параметре может указываться несколько посылок. |
tracks |
Type: OrderTrackDTO[] Информация для отслеживания перемещений посылки. |
type |
Type: OrderDeliveryType Способ доставки заказа. Enum: |
vat |
Type: OrderVatType Ставка налога на добавленную стоимость (НДС) на товар:
Используется только совместно с параметром Enum: |
OrderItemDTO
Список товаров в заказе.
Name |
Description |
buyerPrice |
Type: number<decimal> Цена на товар в валюте покупателя. В цене уже учтены скидки по:
|
buyerPriceBeforeDiscount |
Type: number<decimal> Стоимость товара в валюте покупателя до применения скидок по:
|
count |
Type: integer Количество единиц товара. |
details |
Type: OrderItemDetailDTO[] Информация об удалении товара из заказа.
|
id |
Type: integer<int64> Идентификатор товара в заказе. Позволяет идентифицировать товар в рамках данного заказа. |
instances |
Type: OrderItemInstanceDTO[] Информация о маркировке единиц товара. Возвращаются данные для маркировки, переданные в запросе PUT campaigns/{campaignId}/orders/{orderId}/cis. Если магазин еще не передавал коды для этого заказа, |
offerId |
Type: string Идентификатор вашего товарного предложения для определенного товара. Описание поля в Справке Маркета для продавцов Min length: Max length: Pattern: |
offerName |
Type: string Название товара. |
partnerWarehouseId |
Type: string Этот параметр устарел. Не используйте его. Идентификатор склада в системе партнера, на который сформирован заказ. |
price |
Type: number<decimal> Цена на товар в валюте заказа без учета вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр |
priceBeforeDiscount |
Type: number<decimal> Этот параметр устарел. Стоимость товара в валюте магазина до применения скидок. |
promos |
Type: OrderItemPromoDTO[] Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям. |
requiredInstanceTypes |
Type: OrderItemInstanceType[] Список необходимых маркировок товара.
Enum: |
shopSku |
Type: string Этот параметр устарел. Вместо него используйте Ваш SKU — идентификатор товара в вашей системе. Min length: Max length: Pattern: |
subsidies |
Type: OrderItemSubsidyDTO[] Список субсидий по типам.
Передается в валюте заказа. |
subsidy |
Type: number<decimal> Этот параметр устарел. Вместо него используйте Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:
Передается в валюте заказа. |
vat |
Type: OrderVatType Ставка налога на добавленную стоимость (НДС) на товар. Enum: |
OrderPaymentMethodType
Способ оплаты заказа:
-
Значения, если выбрана оплата при оформлении заказа (
"paymentType": "PREPAID"
):-
YANDEX
— банковской картой. -
APPLE_PAY
— Apple Pay. -
GOOGLE_PAY
— Google Pay. -
CREDIT
— в кредит. -
TINKOFF_CREDIT
— в кредит в Тинькофф Банке. -
TINKOFF_INSTALLMENTS
— рассрочка в Тинькофф Банке. -
EXTERNAL_CERTIFICATE
— подарочным сертификатом (например, из приложения «Сбербанк Онлайн»). -
SBP
— через систему быстрых платежей. -
B2B_ACCOUNT_PREPAYMENT
— заказ оплачивает организация.
-
-
Значения, если выбрана оплата при получении заказа (
"paymentType": "POSTPAID"
):-
CARD_ON_DELIVERY
— банковской картой. -
BOUND_CARD_ON_DELIVERY
— привязанной картой при получении. -
CASH_ON_DELIVERY
— наличными. -
B2B_ACCOUNT_POSTPAYMENT
— заказ оплачивает организация после доставки.
-
-
UNKNOWN
— неизвестный тип.
Значение по умолчанию: CASH_ON_DELIVERY
.
Type |
Description |
Enum: |
OrderPaymentType
Тип оплаты заказа:
-
PREPAID
— оплата при оформлении заказа. -
POSTPAID
— оплата при получении заказа. -
UNKNOWN
— неизвестный тип.
Если параметр отсутствует, заказ будет оплачен при получении.
Type |
Description |
Enum: |
OrderSubsidyDTO
Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:
- по промокодам, купонам и акциям;
- по баллам Плюса;
- по доставке (DBS).
Передается в валюте заказа.
Name |
Description |
amount |
Type: number<decimal> Сумма субсидии. |
type |
Type: OrderSubsidyType Тип субсидии:
Enum: |
OrderTaxSystemType
Система налогообложения (СНО) магазина на момент оформления заказа:
-
ECHN
— единый сельскохозяйственный налог (ЕСХН). -
ENVD
— единый налог на вмененный доход (ЕНВД). -
OSN
— общая система налогообложения (ОСН). -
PSN
— патентная система налогообложения (ПСН). -
USN
— упрощенная система налогообложения (УСН). -
USN_MINUS_COST
— упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»). -
NPD
— налог на профессиональный доход (НПД). -
UNKNOWN_VALUE
— неизвестное значение. Используется только совместно с параметромpayment-method=YANDEX
.
Type |
Description |
Enum: |
OrderBuyerType
Тип покупателя:
-
PERSON
— физическое лицо. -
BUSINESS
— организация.
Type |
Description |
Enum: |
OrderDeliveryAddressDTO
Адрес доставки.
Указывается, если type=DELIVERY
, type=POST
или type=PICKUP
(адрес пункта выдачи).
Name |
Description |
apartment |
Type: string Квартира или офис. |
block |
Type: string Корпус или строение. |
city |
Type: string Город или населенный пункт. Обязательный параметр. |
country |
Type: string Страна. Обязательный параметр. |
district |
Type: string Район. |
entrance |
Type: string Подъезд. |
entryphone |
Type: string Код домофона. |
floor |
Type: string Этаж. |
gps |
Type: GpsDTO GPS-координаты. |
house |
Type: string Дом или владение. Обязательный параметр. |
phone |
Type: string Телефон получателя заказа. Обязательный параметр. |
postcode |
Type: string Почтовый индекс. Указывается, если выбрана доставка почтой ( |
recipient |
Type: string Фамилия, имя и отчество получателя заказа. Обязательный параметр. |
street |
Type: string Улица. Обязательный параметр. |
subway |
Type: string Станция метро. |
OrderCourierDTO
Информация о курьере.
Name |
Description |
fullName |
Type: string Полное имя курьера. |
phone |
Type: string Номер телефона курьера. |
phoneExtension |
Type: string Добавочный номер телефона. |
vehicleDescription |
Type: string Описание машины. Например, модель и цвет. |
vehicleNumber |
Type: string Номер транспортного средства. |
OrderDeliveryDatesDTO
Диапазон дат доставки.
Name |
Description |
fromDate |
Type: string<date-dd-MM-yyyy> Ближайшая дата доставки. Формат даты: Example: |
fromTime |
Type: string<time> Начало интервала времени доставки. Передается только совместно с параметром Формат времени: 24-часовой, Минимальное значение: |
realDeliveryDate |
Type: string<date-dd-MM-yyyy> Дата, когда товар доставлен до пункта выдачи заказа (в случае самовывоза) или до покупателя (если заказ доставляет курьер). Example: |
toDate |
Type: string<date-dd-MM-yyyy> Самая поздняя дата доставки. Если параметр Формат даты: Example: |
toTime |
Type: string<time> Конец интервала времени доставки. Передается только совместно с параметром Формат времени: 24-часовой, Максимальное значение: |
OrderDeliveryPartnerType
Тип сотрудничества со службой доставки в рамках конкретного заказа:
-
SHOP
— магазин работает со службой доставки напрямую или доставляет заказы самостоятельно. -
YANDEX_MARKET
— магазин работает со службой доставки через Маркет. -
UNKNOWN
— неизвестный тип.
Type |
Description |
Enum: |
OrderDeliveryDispatchType
Способ отгрузки:
-
BUYER
— доставка покупателю. -
MARKET_PARTNER_OUTLET
— доставка в пункт выдачи партнера. -
MARKET_BRANDED_OUTLET
— доставка в пункт выдачи заказов Маркета. -
SHOP_OUTLET
— доставка в пункт выдачи заказов магазина. -
DROPOFF
— доставка в пункт выдачи, который принимает заказы от продавцов и передает их курьерам. -
UNKNOWN
— неизвестный тип.
Type |
Description |
Enum: |
OrderDeliveryEacType
Тип кода подтверждения ЭАПП:
-
MERCHANT_TO_COURIER
— продавец передает код курьеру. -
COURIER_TO_MERCHANT
— курьер передает код продавцу. -
CHECKING_BY_MERCHANT
— продавец проверяет код на своей стороне.
Type |
Description |
Enum: |
OrderLiftType
Тип подъема заказа на этаж:
-
NOT_NEEDED
— не требуется. -
MANUAL
— ручной. -
ELEVATOR
— лифт. -
CARGO_ELEVATOR
— грузовой лифт. -
FREE
— любой из перечисленных выше, если включена опция бесплатного подъема. -
UNKNOWN
— неизвестный тип.
Type |
Description |
Enum: |
RegionDTO
Регион доставки.
Name |
Description |
name* |
Type: string Название региона. |
type* |
Type: RegionType Тип региона. Enum: |
children |
Type: RegionDTO[] Дочерние регионы. |
id |
Type: integer<int64> Идентификатор региона. |
parent |
Type: RegionDTO Информация о родительском регионе. Указываются родительские регионы до уровня страны. |
OrderShipmentDTO
Список посылок.
В параметре может указываться несколько посылок.
Name |
Description |
boxes |
Type: OrderParcelBoxDTO[] Список грузовых мест. |
id |
Type: integer<int64> Идентификатор посылки, присвоенный Маркетом. |
shipmentDate |
Type: string<date-dd-MM-yyyy> День, в который нужно отгрузить заказ службе доставки. Формат даты: Если заказ сделан организацией, параметр не возвращается до согласования даты доставки. Иногда Маркет может перенести дату отгрузкиУ таких заказов обновится параметр Example: |
shipmentTime |
Type: string Только для модели Экспресс Время, к которому магазин должен упаковать заказ и перевести его в статус Поле может появиться не сразу. Запрашивайте информацию о заказе в течении 5–10 минут, пока оно не вернется. Формат времени: 24-часовой, Если заказ сделан организацией, параметр не возвращается до согласования даты доставки. |
tracks |
Type: OrderTrackDTO[] Только для модели DBS Информация для отслеживания перемещений посылки.
|
OrderTrackDTO
Информация о трек-номере посылки (DBS).
Name |
Description |
deliveryServiceId |
Type: integer<int64> Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. |
trackCode |
Type: string Трек‑номер посылки. |
OrderDeliveryType
Способ доставки заказа:
-
DELIVERY
— курьерская доставка. -
PICKUP
— самовывоз. -
POST
— почта. -
DIGITAL
— для цифровых товаров. -
UNKNOWN
— неизвестный тип.
Type |
Description |
Enum: |
OrderVatType
Ставка налога на добавленную стоимость (НДС) на товар:
-
NO_VAT
— НДС не облагается, используется только для отдельных видов услуг. -
VAT_0
— НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров. -
VAT_10
— НДС 10%. Например, используется при реализации отдельных продовольственных и медицинских товаров. -
VAT_10_110
— НДС 10/110. Расчетная ставка НДС 10%, применяется только при предоплате. -
VAT_20
— НДС 20%. Основная ставка с 2019 года. -
VAT_20_120
— НДС 20/120. Расчетная ставка НДС 20%, применяется только при предоплате. -
VAT_18
— НДС 18%. Основная ставка до 2019 года. -
VAT_18_118
— НДС 18/118. Ставка использовалась до 1 января 2019 года при предоплате. -
UNKNOWN_VALUE
— неизвестный тип.
Используется только совместно с параметром payment-method=YANDEX
.
Type |
Description |
Enum: |
OrderItemDetailDTO
Детали по товару в заказе.
Name |
Description |
itemCount |
Type: integer<int64> Количество единиц товара. |
itemStatus |
Type: OrderItemStatusType Возвращенный или невыкупленный товар:
Enum: |
updateDate |
Type: string<date-dd-MM-yyyy> Формат даты: Example: |
OrderItemInstanceDTO
Переданные вами для данной позиции коды маркировки или УИНы. Коды «Честного знака» возвращаются в двух вариантах — с криптохвостом и без.
Name |
Description |
cis |
Type: string Код идентификации единицы товара в системе «Честный ЗНАК» без криптохвоста. |
cisFull |
Type: string Код идентификации единицы товара в системе «Честный ЗНАК» с криптохвостом. |
gtd |
Type: string Грузовая таможенная декларация. Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации. |
rnpt |
Type: string Регистрационный номер партии товара. Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации. |
uin |
Type: string УИН ювелирного изделия (16-значный код) Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК. |
OrderItemPromoDTO
Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям.
Name |
Description |
type* |
Type: OrderPromoType Тип скидки. Enum: |
discount |
Type: number<decimal> Размер пользовательской скидки в валюте покупателя. |
marketPromoId |
Type: string Идентификатор акции в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером. Параметр передается, только если параметр |
shopPromoId |
Type: string Идентификатор акции поставщика. |
subsidy |
Type: number<decimal> Вознаграждение партнеру от Маркета за товар, проданный в рамках акции. Передается в валюте заказа. |
OrderItemInstanceType
Вид маркировки товара:
-
CIS
— КИЗ, идентификатор единицы товара в системе «Честный ЗНАК». -
UIN
— УИН, уникальный идентификационный номер. -
RNPT
— РНПТ, регистрационный номер партии товара. -
GTD
— номер ГТД, грузовой таможенной декларации.
Type |
Description |
Enum: |
OrderItemSubsidyDTO
Общее вознаграждение партнеру за все скидки на товар:
- по промокодам, купонам и акциям;
- по баллам Плюса.
Передается в валюте заказа.
Name |
Description |
amount |
Type: number<decimal> Сумма субсидии. |
type |
Type: OrderItemSubsidyType Тип субсидии:
Enum: |
OrderSubsidyType
Тип субсидии:
-
YANDEX_CASHBACK
— скидка по подписке Яндекс Плюс. -
SUBSIDY
— скидка Маркета (по акциям, промокодам, купонам и т. д.) -
DELIVERY
— скидка за доставку (DBS).
Type |
Description |
Enum: |
GpsDTO
GPS-координаты широты и долготы.
Name |
Description |
latitude* |
Type: number<decimal> Широта. |
longitude* |
Type: number<decimal> Долгота. |
RegionType
Тип региона.
Возможные значения:
-
CITY_DISTRICT
— район города. -
CITY
— крупный город. -
CONTINENT
— континент. -
COUNTRY_DISTRICT
— область. -
COUNTRY
— страна. -
REGION
— регион. -
REPUBLIC_AREA
— район субъекта федерации. -
REPUBLIC
— субъект федерации. -
SUBWAY_STATION
— станция метро. -
VILLAGE
— город. -
OTHER
— неизвестный регион.
Type |
Description |
Enum: |
OrderParcelBoxDTO
Информация о грузоместе.
Name |
Description |
fulfilmentId |
Type: string Идентификатор грузового места в информационной системе магазина. |
id |
Type: integer<int64> Идентификатор грузоместа. |
OrderItemStatusType
Возвращенный или невыкупленный товар:
-
REJECTED
— невыкупленный. -
RETURNED
— возвращенный.
Type |
Description |
Enum: |
OrderPromoType
Тип скидки:
-
DIRECT_DISCOUNT
— прямая скидка, которую устанавливает продавец или Маркет. -
BLUE_SET
— комплекты. -
BLUE_FLASH
— флеш-акция. -
MARKET_COUPON
— скидка по промокоду Маркета. -
MARKET_PROMOCODE
— скидка по промокоду магазина. -
MARKET_BLUE
— скидка на Маркете. -
YANDEX_PLUS
— бесплатная доставка с подпиской Яндекс Плюс. -
YANDEX_EMPLOYEE
— бесплатная доставка по определенным адресам. -
LIMITED_FREE_DELIVERY_PROMO
— бесплатная доставка по ограниченному предложению. -
FREE_DELIVERY_THRESHOLD
— бесплатная доставка при достижении определенной суммы заказа. -
MULTICART_DISCOUNT
— скидка за то, что оформлена мультикорзина. -
FREE_DELIVERY_FOR_LDI
— бесплатная доставка за то, что один из товаров крупногабаритный. -
FREE_DELIVERY_FOR_LSC
— бесплатная доставка за то, что одна из корзин в мультикорзине крупногабаритная. -
FREE_PICKUP
— бесплатная доставка в пункт выдачи заказов. -
CHEAPEST_AS_GIFT
— самый дешевый товар в подарок. -
CASHBACK
— кешбэк. -
SUPPLIER_MULTICART_DISCOUNT
— скидка за доставку. -
SPREAD_DISCOUNT_COUNT
— скидка за количество одинаковых товаров. -
SPREAD_DISCOUNT_RECEIPT
— скидка от суммы чека. -
ANNOUNCEMENT_PROMO
— информационная акция, скидка не применяется к товарам. -
DISCOUNT_BY_PAYMENT_TYPE
— прямая скидка при оплате картой Плюса. -
PERCENT_DISCOUNT
— прямая скидка в процентах. -
DCO_EXTRA_DISCOUNT
— дополнительная скидка, необходимая для расчета субсидии от Маркета. -
EMPTY_PROMO
— скрытые промокоды. -
BLOCKING_PROMO
— блокирующее промо. -
UNKNOWN
— неизвестный тип.
Устаревшие типы:
-
GENERIC_BUNDLE
. -
MARKET_DEAL
. -
MARKET_PRIME
. -
MARKET_COIN
. -
BERU_PLUS
. -
PRICE_DROP_AS_YOU_SHOP
. -
SECRET_SALE
.
Type |
Description |
Enum: |
OrderItemSubsidyType
Тип субсидии:
-
YANDEX_CASHBACK
— скидка по подписке Яндекс Плюс. -
SUBSIDY
— скидка Маркета (по акциям, промокодам, купонам и т. д.).
Type |
Description |
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
ApiErrorDTO
Общий формат ошибки.
Name |
Description |
code* |
Type: string Код ошибки. |
message |
Type: string Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |