- Request
- Responses
- 200 OK
- Body
- OrderDTO
- CurrencyType
- OrderPaymentType
- OrderPaymentMethodType
- OrderItemDTO
- OrderItemSubsidyDTO
- OrderDeliveryDTO
- OrderBuyerDTO
- OrderTaxSystemType
- OrderVatType
- OrderItemPromoDTO
- OrderItemInstanceDTO
- OrderItemDetailDTO
- OrderItemInstanceType
- OrderSubsidyType
- OrderDeliveryType
- OrderDeliveryPartnerType
- OrderCourierDTO
- OrderDeliveryDatesDTO
- RegionDTO
- OrderDeliveryAddressDTO
- OrderLiftType
- OrderDeliveryDispatchType
- OrderTrackDTO
- OrderShipmentDTO
- OrderDeliveryEacType
- OrderBuyerType
- OrderPromoType
- OrderItemStatusType
- RegionType
- GpsDTO
- OrderParcelStatusType
- OrderParcelBoxDTO
- 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 |
Type |
Description |
campaignId* |
integer<int64> |
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. |
orderId* |
integer<int64> |
Идентификатор заказа. |
Body
{
"order": {
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"delivery": {
"dates": {
"realDeliveryDate": "string"
}
}
}
}
Name |
Type |
Description |
order* |
Заказ. |
OrderStatusChangeDTO
Заказ.
Name |
Type |
Description |
status* |
Статус заказа:
Также могут возвращаться другие значения. Обрабатывать их не требуется.
|
|
substatus |
Этап обработки заказа (если он имеет статус Возможные значения для заказа в статусе
Возможные значения для заказа в статусе
Также могут возвращаться другие значения. Обрабатывать их не требуется.
|
|
delivery |
Информация о доставке. |
OrderStatusType
Статус заказа:
-
CANCELLED
— заказ отменен. -
DELIVERED
— заказ получен покупателем. -
DELIVERY
— заказ передан в службу доставки. -
PICKUP
— заказ доставлен в пункт самовывоза. -
PROCESSING
— заказ находится в обработке. -
UNPAID
— заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).
Также могут возвращаться другие значения. Обрабатывать их не требуется.
Type |
Description |
Enum: |
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.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
Type |
Description |
Enum: |
OrderStatusChangeDeliveryDTO
Информация о доставке.
Name |
Type |
Description |
dates |
Диапазон дат доставки. |
OrderStatusChangeDeliveryDatesDTO
Диапазон дат доставки.
Name |
Type |
Description |
realDeliveryDate |
string<date> |
Фактическая дата доставки. |
Responses
200 OK
В случае успешного изменения статуса заказа возвращается обновленная информация о заказе
Body
{
"order": {
"id": 0,
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"creationDate": "23-09-2022 09:12:41",
"currency": "RUR",
"itemsTotal": 0,
"total": 0,
"deliveryTotal": 0,
"subsidyTotal": 0,
"totalWithSubsidy": 0,
"buyerItemsTotal": 0,
"buyerTotal": 0,
"buyerItemsTotalBeforeDiscount": 0,
"buyerTotalBeforeDiscount": 0,
"paymentType": "PREPAID",
"paymentMethod": "SHOP_PREPAID",
"fake": false,
"items": [
{
"id": 0,
"offerId": "string",
"feedCategoryId": "string",
"offerName": "string",
"price": 0,
"buyerPrice": 0,
"buyerPriceBeforeDiscount": 0,
"priceBeforeDiscount": 0,
"count": 0,
"vat": "VAT_18",
"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": "NOT_SUBSIDY",
"amount": 0
}
],
"requiredInstanceTypes": [
"CIS"
]
}
],
"subsidies": [
{
"type": "NOT_SUBSIDY",
"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": "VAT_18",
"deliveryServiceId": 0,
"liftType": "NOT_NEEDED",
"liftPrice": 0,
"outletCode": "string",
"outletStorageLimitDate": "23-09-2022",
"dispatchType": "UNKNOWN",
"tracks": [
{
"trackCode": "string",
"deliveryServiceId": 0
}
],
"shipments": [
{
"id": 0,
"status": "NEW",
"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 |
Type |
Description |
order |
Заказ. |
OrderDTO
Заказ.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор заказа. |
status |
Статус заказа:
Также могут возвращаться другие значения. Обрабатывать их не требуется.
|
|
substatus |
Этап обработки заказа (если он имеет статус Возможные значения для заказа в статусе
Возможные значения для заказа в статусе
Также могут возвращаться другие значения. Обрабатывать их не требуется.
|
|
creationDate |
string<date-dd-MM-yyyy-HH-mm-ss> |
Дата и время оформления заказа. Формат даты и времени:
|
currency |
Валюта, в которой указаны цены товаров в заказе. Принимает значение
|
|
itemsTotal |
number<decimal> |
Общая сумма заказа в валюте заказа без учета стоимости доставки и вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр Для отделения целой части от дробной используется точка. |
total |
number<decimal> |
Этот параметр устарел. Чтобы узнать соответствующее значение, сложите значения Общая сумма заказа в валюте заказа с учетом стоимости доставки, но без учета вознаграждения партнеру за скидки по промокодам, купонам, кешбэку и акциям (параметр Для отделения целой части от дробной используется точка. |
deliveryTotal |
number<decimal> |
Стоимость доставки в валюте заказа. Для отделения целой части от дробной используется точка. |
subsidyTotal |
number<decimal> |
Этот параметр устарел. Чтобы узнать соответствующее значение, сложите значения всех субсидий в Общее вознаграждение партнеру за DBS-доставку и все скидки:
Передается в валюте, указанной в параметре Для отделения целой части от дробной используется точка. |
totalWithSubsidy |
number<decimal> |
Этот параметр устарел. Чтобы узнать соответствующее значение, сложите значения Сумма стоимости всех товаров в заказе и вознаграждения за них в валюте магазина
(сумма параметров |
buyerItemsTotal |
number<decimal> |
Стоимость всех товаров в заказе в валюте покупателя после применения скидок и без учета стоимости доставки. |
buyerTotal |
number<decimal> |
Стоимость всех товаров в заказе в валюте покупателя после применения скидок и с учетом стоимости доставки. |
buyerItemsTotalBeforeDiscount |
number<decimal> |
Стоимость всех товаров в заказе в валюте покупателя до применения скидок и без учета стоимости доставки. |
buyerTotalBeforeDiscount |
number<decimal> |
Стоимость всех товаров в заказе в валюте покупателя до применения скидок и с учетом стоимости доставки. |
paymentType |
Тип оплаты заказа:
Если параметр отсутствует, заказ будет оплачен при получении.
|
|
paymentMethod |
Способ оплаты заказа. Возможные значения, если выбрана оплата при оформлении заказа (
Возможные значения, если выбрана оплата при получении заказа (
Значение по умолчанию:
|
|
fake |
boolean |
Тип заказа:
|
items |
Список товаров в заказе. |
|
subsidies |
Список субсидий по типам.
Передается в валюте заказа, для отделения целой части от дробной используется точка. |
|
delivery |
Информация о доставке. |
|
buyer |
Информация о покупателе. Параметры |
|
notes |
string |
Комментарий к заказу. |
taxSystem |
Система налогообложения (СНО) магазина на момент оформления заказа:
Используется только совместно с параметром
|
|
cancelRequested |
boolean |
Только для модели DBS Запрошена ли отмена. |
expiryDate |
string<date-dd-MM-yyyy-HH-mm-ss> |
Дата, после которой загруженный прайс-лист считается не актуальным и требует обновления. Формат даты: Параметр возвращается при размещении прайс-листа на сервере Маркета.
|
CurrencyType
Коды валют. Возможные значения:
BYR
— белорусский рубль.KZT
— казахстанский тенге.RUR
— российский рубль.UAH
— украинская гривна.
Type |
Description |
Enum: |
OrderPaymentType
Тип оплаты заказа:
-
PREPAID
— оплата при оформлении заказа. -
POSTPAID
— оплата при получении заказа.
Если параметр отсутствует, заказ будет оплачен при получении.
Type |
Description |
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
— банковской картой. -
CASH_ON_DELIVERY
— наличными. -
B2B_ACCOUNT_POSTPAYMENT
— заказ оплачивает организация после доставки.
Значение по умолчанию: CASH_ON_DELIVERY
.
Type |
Description |
Enum: |
OrderItemDTO
Список товаров в заказе.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор товара в заказе. Позволяет идентифицировать товар в рамках данного заказа. |
offerId |
string |
Идентификатор вашего товарного предложения для определенного товара. Описание поля в Справке для продавцов
|
feedCategoryId |
string |
Идентификатор категории, указанный в каталоге. Внимание Параметр устарел и не рекомендуется к использованию. |
offerName |
string |
Название товара. |
price |
number<decimal> |
Цена товара в валюте заказа без учета вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр Для отделения целой части от дробной используется точка. |
buyerPrice |
number<decimal> |
Цена товара в валюте покупателя. В цене уже учтены скидки по:
Для отделения целой части от дробной используется точка. |
buyerPriceBeforeDiscount |
number<decimal> |
Стоимость товара в валюте покупателя до применения скидок. Для отделения целой части от дробной используется точка. |
priceBeforeDiscount |
number<decimal> |
Стоимость товара в валюте магазина до применения скидок. Для отделения целой части от дробной используется точка. |
count |
integer |
Количество единиц товара. |
vat |
Ставка налога на добавленную стоимость (НДС) на товар.
|
|
shopSku |
string |
Ваш SKU — идентификатор товара в вашей системе. Внимание Параметр устарел и не рекомендуется к использованию. Вместо него используйте параметр
|
subsidy |
number<decimal> |
Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:
Передается в валюте заказа, для отделения целой части от дробной используется точка. |
partnerWarehouseId |
string |
Идентификатор склада в системе партнера, на который сформирован заказ. Внимание Параметр устарел, временно поддерживается, но не доступен для ввода и редактирования. |
promos |
Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям. |
|
instances |
Информация о маркировке единиц товара. Возвращаются данные для маркировки, переданные в запросе PUT campaigns/{campaignId}/orders/{orderId}/cis. Если магазин еще не передавал коды для этого заказа, |
|
details |
Информация об удалении товара из заказа.
|
|
subsidies |
Список субсидий по типам.
Передается в валюте заказа, для отделения целой части от дробной используется точка. |
|
requiredInstanceTypes |
Список необходимых маркировок товара. |
OrderItemSubsidyDTO
Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:
- по промокодам;
- по купонам;
- по баллам Плюса;
- по акциям.
Передается в валюте заказа, для отделения целой части от дробной используется точка.
Name |
Type |
Description |
type |
Тип субсидии, которые дает Маркет:
|
|
amount |
number<decimal> |
Сумма субсидии. |
OrderDeliveryDTO
Информация о доставке.
Name |
Type |
Description |
id |
string |
Идентификатор доставки, присвоенный магазином. Указывается, только если магазин передал данный идентификатор в ответе на запрос методом POST cart. |
type |
Способ доставки заказа.
|
|
serviceName |
string |
Наименование службы доставки. |
price |
number<decimal> |
До 1 июля 2021 в нем возвращалась ваша стоимость доставки заказа. Сейчас Маркет всегда передает в этом поле 0, так как поле устарело и не используется, а стоимость доставки заказа рассчитывает автоматически, по единому тарифу на доставку. |
deliveryPartnerType |
Тип сотрудничества со службой доставки в рамках конкретного заказа.
|
|
courier |
Информация о курьере. |
|
dates |
Диапазон дат доставки. |
|
region |
Регион доставки. |
|
address |
Адрес доставки. Указывается, если |
|
vat |
Ставка налога на добавленную стоимость (НДС) на услугу доставки заказа:
Используется только совместно с параметром
|
|
deliveryServiceId |
integer<int64> |
Идентификатор службы доставки. |
liftType |
Тип подъема заказа на этаж:
|
|
liftPrice |
number<decimal> |
Стоимость подъема на этаж. |
outletCode |
string |
Идентификатор пункта самовывоза, присвоенный магазином. |
outletStorageLimitDate |
string<date-dd-MM-yyyy> |
Дата, до которой заказ будет храниться в пункте выдачи. Возвращается, когда заказ переходит в статус
|
dispatchType |
Способ отгрузки:
|
|
tracks |
Информация для отслеживания перемещений посылки. |
|
shipments |
Информация о посылках. В параметре может указываться несколько посылок. |
|
estimated |
boolean |
Приблизительная ли дата доставки. |
eacType |
Тип кода подтверждения ЭАПП.
|
|
eacCode |
string |
Код подтверждения ЭАПП (для типа |
OrderBuyerDTO
Информация о покупателе.
Параметры id
, lastName
, firstName
и middleName
возвращаются, только если вы работаете по модели DBS.
Name |
Type |
Description |
id |
string |
Идентификатор покупателя. |
lastName |
string |
Фамилия покупателя. |
firstName |
string |
Имя покупателя. |
middleName |
string |
Отчество покупателя. |
type |
Тип покупателя: физическое лицо или организация. Этот параметр используется FBS- и FBY-магазинами, размещающими товары на витрине business.market.yandex.ru.
|
OrderTaxSystemType
Система налогообложения (СНО) магазина на момент оформления заказа:
-
ECHN
— единый сельскохозяйственный налог (ЕСХН). -
ENVD
— единый налог на вмененный доход (ЕНВД). -
OSN
— общая система налогообложения (ОСН). -
PSN
— патентная система налогообложения (ПСН). -
USN
— упрощенная система налогообложения (УСН). -
USN_MINUS_COST
— упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»).
Используется только совместно с параметром payment-method=YANDEX
.
Type |
Description |
Enum: |
OrderVatType
Ставка налога на добавленную стоимость (НДС) на услугу доставки заказа:
-
NO_VAT
— НДС не облагается, используется только для отдельных видов услуг. -
VAT_0
— НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров. -
VAT_10_110
— НДС 10/110. Расчетная ставка НДС 10%, применяется только для случая предоплаты. -
VAT_20_120
— НДС 20/120. Расчетная ставка НДС 20%, применяется только для случая предоплаты. -
VAT_18_118
— НДС 18/118. Ставка использовалась до 1 января 2019 года.
Используется только совместно с параметром payment-method=YANDEX
.
Type |
Description |
Enum: |
OrderItemPromoDTO
Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям.
Name |
Type |
Description |
type* |
Тип скидки.
|
|
discount |
number<decimal> |
Размер пользовательской скидки в валюте покупателя. |
subsidy |
number<decimal> |
Вознаграждение партнеру от Маркета за товар, проданный в рамках акции. Передается в валюте заказа, для отделения целой части от дробной используется точка. |
shopPromoId |
string |
Идентификатор акции поставщика. |
marketPromoId |
string |
Идентификатор акции в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером. Параметр передается, только если параметр |
OrderItemInstanceDTO
Переданные вами для данной позиции коды маркировки или УИНы. Коды «Честного знака» возвращаются в двух вариантах — с криптохвостом и без.
Name |
Type |
Description |
cis |
string |
Код идентификации единицы товара в системе «Честный ЗНАК» без криптохвоста. |
cisFull |
string |
Код идентификации единицы товара в системе «Честный ЗНАК» с криптохвостом. |
uin |
string |
УИН ювелирного изделия (16-значный код) Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК. |
rnpt |
string |
Регистрационный номер партии товара. Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации. |
gtd |
string |
Грузовая таможенная декларация. Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации. |
OrderItemDetailDTO
Детали по товару в заказе.
Name |
Type |
Description |
itemCount |
integer<int64> |
Количество единиц товара. |
itemStatus |
Возвращенный или невыкупленный товар.
|
|
updateDate |
string<date-dd-MM-yyyy> |
Формат даты:
|
OrderItemInstanceType
Вид маркировки товара.
Type |
Description |
Enum: |
OrderSubsidyType
Тип субсидии, которые дает Маркет:
SBER_SPASIBO
— компенсация при оплате заказа бонусами СберСпасибо. Не используется с июля 2021 года.YANDEX_CASHBACK
— компенсация при оплате заказа баллами Плюса.SUBSIDY
— компенсация скидки:- по промокодам;
- по купонам;
- по акциям.
DELIVERY
— компенсация стоимости доставки магазину, который работает по модели DBS.
Type |
Description |
Enum: |
OrderDeliveryType
Способ доставки заказа:
-
DELIVERY
— курьерская доставка. -
PICKUP
— самовывоз. -
POST
— почта. -
DIGITAL
— для цифровых товаров.
Type |
Description |
Enum: |
OrderDeliveryPartnerType
Тип сотрудничества со службой доставки в рамках конкретного заказа:
SHOP
— магазин работает со службой доставки напрямую или доставляет заказы самостоятельно.YANDEX_MARKET
— магазин работает со службой доставки через Маркет.
Type |
Description |
Enum: |
OrderCourierDTO
Информация о курьере.
Name |
Type |
Description |
fullName |
string |
Полное имя курьера. |
phone |
string |
Номер телефона курьера. |
phoneExtension |
string |
Добавочный номер телефона. |
vehicleNumber |
string |
Номер транспортного средства. |
vehicleDescription |
string |
Описание машины. Например, модель и цвет. |
OrderDeliveryDatesDTO
Диапазон дат доставки.
Name |
Type |
Description |
fromDate |
string<date-dd-MM-yyyy> |
Ближайшая дата доставки. Формат даты:
|
toDate |
string<date-dd-MM-yyyy> |
Самая поздняя дата доставки. Если параметр Формат даты:
|
fromTime |
string<time> |
Начало интервала времени доставки. Передается только совместно с параметром Формат времени: 24-часовой, Минимальное значение: |
toTime |
string<time> |
Конец интервала времени доставки. Передается только совместно с параметром Формат времени: 24-часовой, Максимальное значение: |
realDeliveryDate |
string<date-dd-MM-yyyy> |
Дата, когда товар доставлен до пункта выдачи заказа (в случае самовывоза) или до покупателя (если заказ доставляет курьер).
|
RegionDTO
Регион доставки.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор региона. |
name* |
string |
Название региона. |
type* |
Тип региона.
|
|
parent |
Информация о родительском регионе. Указываются родительские регионы до уровня страны. |
|
children |
Дочерние регионы. |
OrderDeliveryAddressDTO
Адрес доставки.
Указывается, если type=DELIVERY
, type=POST
или type=PICKUP
(адрес пункта выдачи).
Name |
Type |
Description |
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 |
GPS-координаты. |
OrderLiftType
Тип подъема заказа на этаж:
NOT_NEEDED
— не требуется.MANUAL
— ручной.ELEVATOR
— лифт.CARGO_ELEVATOR
— грузовой лифт.FREE
— любой из перечисленных выше, если включена опция бесплатного подъема.
Type |
Description |
Enum: |
OrderDeliveryDispatchType
Способ отгрузки:
BUYER
— доставка покупателю.MARKET_PARTNER_OUTLET
— доставка в пункт выдачи партнера.MARKET_BRANDED_OUTLET
— доставка в пункт выдачи заказов Маркета.SHOP_OUTLET
— доставка в пункт выдачи заказов магазина.DROPOFF
— доставка в пункт выдачи, который принимает заказы от продавцов и передает их курьерам.
Type |
Description |
Enum: |
OrderTrackDTO
Информация о трек-номере посылки (DBS).
Name |
Type |
Description |
trackCode |
string |
Трек‑номер посылки. |
deliveryServiceId |
integer<int64> |
Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. |
OrderShipmentDTO
Список посылок.
В параметре может указываться несколько посылок.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор посылки, присвоенный Маркетом. |
status |
Статус заказа в партнерской службе доставки.
|
|
shipmentDate |
string<date-dd-MM-yyyy> |
День, в который нужно отгрузить заказ службе доставки. Формат даты: Если заказ сделан организацией, параметр не возвращается до согласования даты доставки.
|
shipmentTime |
string |
Только для модели Экспресс Время, к которому магазин должен упаковать заказ и перевести его в статус Формат времени: 24-часовой, Если заказ сделан организацией, параметр не возвращается до согласования даты доставки. |
tracks |
Только для модели DBS Информация для отслеживания перемещений посылки.
|
|
boxes |
Список грузовых мест. |
OrderDeliveryEacType
Тип кода подтверждения ЭАПП:
MERCHANT_TO_COURIER
— продавец передает код курьеру.COURIER_TO_MERCHANT
— курьер передает код продавцу.CHECKING_BY_MERCHANT
— продавец проверяет код на своей стороне.
Type |
Description |
Enum: |
OrderBuyerType
Тип покупателя:
PERSON
— физическое лицо.BUSINESS
— организация.
Type |
Description |
Enum: |
OrderPromoType
Тип скидки:
DIRECT_DISCOUNT
— прямая скидка, которую устанавливает продавец или Маркет.BLUE_FLASH
— флеш-акция.MARKET_COUPON
— скидка по промокоду от Маркета.MARKET_PROMOCODE
— скидка по промокоду магазина.MARKET_DEAL
— скидка в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером.MARKET_COIN
— скидка по купонам.CHEAPEST_AS_GIFT
— самый дешевый товар в подарок.DCO_EXTRA_DISCOUNT
— дополнительная скидка, необходимая для расчета субсидии от Маркета.
Type |
Description |
Enum: |
OrderItemStatusType
Возвращенный или невыкупленный товар.
Type |
Description |
Enum: |
RegionType
Тип региона.
Возможные значения:
-
CITY_DISTRICT
— район города. -
CITY
— крупный город. -
CONTINENT
— континент. -
COUNTRY_DISTRICT
— область. -
COUNTRY
— страна. -
REGION
— регион. -
REPUBLIC_AREA
— район субъекта федерации. -
REPUBLIC
— субъект федерации. -
SUBWAY_STATION
— станция метро. -
VILLAGE
— город. -
OTHER
— неизвестный регион.
Type |
Description |
Enum: |
GpsDTO
GPS-координаты широты и долготы.
Name |
Type |
Description |
latitude* |
number<decimal> |
Широта. |
longitude* |
number<decimal> |
Долгота. |
OrderParcelStatusType
Статус заказа в партнерской службе доставки.
Type |
Description |
Enum: |
OrderParcelBoxDTO
Информация о грузоместе.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор грузоместа. |
fulfilmentId |
string |
Идентификатор грузового места в информационной системе магазина. |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
Name |
Type |
Description |
code* |
string |
Код ошибки. |
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |