Skip to content

enums

OrderBuyerType

Bases: StrEnum

Кто покупатель

BUSINESS class-attribute instance-attribute

Python
1
BUSINESS = 'BUSINESS'

организация

PERSON class-attribute instance-attribute

Python
1
PERSON = 'PERSON'

физическое лицо

OrderDeliveryDispatchType

Bases: StrEnum

Способ отгрузки.

BUYER class-attribute instance-attribute

Python
1
BUYER = 'BUYER'

Покупателем

DROPOFF class-attribute instance-attribute

Python
1
DROPOFF = 'DROPOFF'

Dropoff

MARKET_BRANDED_OUTLET class-attribute instance-attribute

Python
1
MARKET_BRANDED_OUTLET = 'MARKET_BRANDED_OUTLET'

Брендированный пункт выдачи маркета

MARKET_PARTNER_OUTLET class-attribute instance-attribute

Python
1
MARKET_PARTNER_OUTLET = 'MARKET_PARTNER_OUTLET'

Пункт выдачи партнера

SHOP_OUTLET class-attribute instance-attribute

Python
1
SHOP_OUTLET = 'SHOP_OUTLET'

Пункт выдачи магазина

UNKNOWN class-attribute instance-attribute

Python
1
UNKNOWN = 'UNKNOWN'

Неизвестно

OrderDeliveryEacType

Bases: StrEnum

Тип кода подтверждения ЭАПП

CHECKING_BY_MERCHANT class-attribute instance-attribute

Python
1
CHECKING_BY_MERCHANT = 'CHECKING_BY_MERCHANT'

продавец проверяет код на своей стороне

COURIER_TO_MERCHANT class-attribute instance-attribute

Python
1
COURIER_TO_MERCHANT = 'COURIER_TO_MERCHANT'

курьер передает код продавцу

MERCHANT_TO_COURIER class-attribute instance-attribute

Python
1
MERCHANT_TO_COURIER = 'MERCHANT_TO_COURIER'

продавец передает код курьеру

OrderDeliveryPartnerType

Bases: StrEnum

Тип сотрудничества со службой доставки в рамках конкретного заказа:

Принимает значение YANDEX_MARKET — магазин работает со службой доставки через Маркет.

SHOP class-attribute instance-attribute

Python
1
SHOP = 'SHOP'

Доставка своими силами (rFBS)

YANDEX_MARKET class-attribute instance-attribute

Python
1
YANDEX_MARKET = 'YANDEX_MARKET'

магазин работает со службой доставки через Маркет

OrderDeliveryType

Bases: StrEnum

Способ доставки заказа

DELIVERY class-attribute instance-attribute

Python
1
DELIVERY = 'DELIVERY'

курьерская доставка.

PICKUP class-attribute instance-attribute

Python
1
PICKUP = 'PICKUP'

самовывоз.

POST class-attribute instance-attribute

Python
1
POST = 'POST'

почта.

OrderItemInstanceType

Bases: StrEnum

Вид маркировки товара.

OrderItemStatusType

Bases: StrEnum

Возвращенный или невыкупленный товар.

REJECTED class-attribute instance-attribute

Python
1
REJECTED = 'REJECTED'

Невыкупленный товар

RETURNED class-attribute instance-attribute

Python
1
RETURNED = 'RETURNED'

Возвращенный товар

OrderLiftType

Bases: StrEnum

Тип подъема заказа на этаж.

CARGO_ELEVATOR class-attribute instance-attribute

Python
1
CARGO_ELEVATOR = 'CARGO_ELEVATOR'

Грузовой лифт

ELEVATOR class-attribute instance-attribute

Python
1
ELEVATOR = 'ELEVATOR'

Пассажирский лифт

FREE class-attribute instance-attribute

Python
1
FREE = 'FREE'

Бесплатно

MANUAL class-attribute instance-attribute

Python
1
MANUAL = 'MANUAL'

Вручную по лестнице

NOT_NEEDED class-attribute instance-attribute

Python
1
NOT_NEEDED = 'NOT_NEEDED'

Не нужно

UNKNOWN class-attribute instance-attribute

Python
1
UNKNOWN = 'UNKNOWN'

Неизвестно

OrderParcelStatusType

Bases: StrEnum

Статус заказа в партнерской службе доставки.

CREATED class-attribute instance-attribute

Python
1
CREATED = 'CREATED'

Создан

ERROR class-attribute instance-attribute

Python
1
ERROR = 'ERROR'

Ошибка

NEW class-attribute instance-attribute

Python
1
NEW = 'NEW'

Новый

READY_TO_SHIP class-attribute instance-attribute

Python
1
READY_TO_SHIP = 'READY_TO_SHIP'

Готов к отгрузке

UNKNOWN class-attribute instance-attribute

Python
1
UNKNOWN = 'UNKNOWN'

Неизвестно

OrderPaymentMethodType

Bases: StrEnum

Способ оплаты заказа.

Возможные значения, если выбрана оплата при оформлении заказа ("paymentType": "PREPAID"):

  • YANDEX — банковской картой.
  • APPLE_PAY — Apple Pay.
  • GOOGLE_PAY — Google Pay.
  • CREDIT — в кредит.
  • TINKOFF_CREDIT — в кредит в Тинькофф Банке.
  • TINKOFF_INSTALLMENTS — рассрочка в Тинькофф Банке.
  • EXTERNAL_CERTIFICATE — подарочным сертификатом (например, из приложения «Сбербанк Онлайн»).
  • SBP — через систему быстрых платежей.

Возможные значения, если выбрана оплата при получении заказа ("paymentType": "POSTPAID"):

  • CARD_ON_DELIVERY — банковской картой.
  • CASH_ON_DELIVERY — наличными.

Значение по умолчанию: CASH_ON_DELIVERY.

  • B2B_ACCOUNT_PREPAYMENT — заказ оплачивает организация.
  • B2B_ACCOUNT_POSTPAYMENT - заказ оплачивает организация после доставки.

APPLE_PAY class-attribute instance-attribute

Python
1
APPLE_PAY = 'APPLE_PAY'

Apple Pay

B2B_ACCOUNT_POSTPAYMENT class-attribute instance-attribute

Python
1
B2B_ACCOUNT_POSTPAYMENT = 'B2B_ACCOUNT_POSTPAYMENT'

заказ оплачивает организация после доставки

B2B_ACCOUNT_PREPAYMENT class-attribute instance-attribute

Python
1
B2B_ACCOUNT_PREPAYMENT = 'B2B_ACCOUNT_PREPAYMENT'

заказ оплачивает организация

CARD_ON_DELIVERY class-attribute instance-attribute

Python
1
CARD_ON_DELIVERY = 'CARD_ON_DELIVERY'

банковской картой

CASH_ON_DELIVERY class-attribute instance-attribute

Python
1
CASH_ON_DELIVERY = 'CASH_ON_DELIVERY'

наличными

CREDIT class-attribute instance-attribute

Python
1
CREDIT = 'CREDIT'

в кредит

EXTERNAL_CERTIFICATE class-attribute instance-attribute

Python
1
EXTERNAL_CERTIFICATE = 'EXTERNAL_CERTIFICATE'

подарочным сертификатом (например, из приложения «Сбербанк Онлайн»)

GOOGLE_PAY class-attribute instance-attribute

Python
1
GOOGLE_PAY = 'GOOGLE_PAY'

Google Pay

SBP class-attribute instance-attribute

Python
1
SBP = 'SBP'

через систему быстрых платежей

TINKOFF_CREDIT class-attribute instance-attribute

Python
1
TINKOFF_CREDIT = 'TINKOFF_CREDIT'

в кредит в Тинькофф Банке

TINKOFF_INSTALLMENTS class-attribute instance-attribute

Python
1
TINKOFF_INSTALLMENTS = 'TINKOFF_INSTALLMENTS'

рассрочка в Тинькофф Банке

YANDEX class-attribute instance-attribute

Python
1
YANDEX = 'YANDEX'

банковской картой

OrderPaymentType

Bases: StrEnum

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

  • PREPAID — оплата при оформлении заказа.
  • POSTPAID — оплата при получении заказа.

Если параметр отсутствует, заказ будет оплачен при получении.

POSTPAID class-attribute instance-attribute

Python
1
POSTPAID = 'POSTPAID'

оплата при получении заказа

PREPAID class-attribute instance-attribute

Python
1
PREPAID = 'PREPAID'

оплата при оформлении заказа

OrderPromoType

Bases: StrEnum

Тип скидки

MARKET_COIN class-attribute instance-attribute

Python
1
MARKET_COIN = 'MARKET_COIN'

скидка по купонам.

MARKET_COUPON class-attribute instance-attribute

Python
1
MARKET_COUPON = 'MARKET_COUPON'

скидка по промокоду от Маркета

MARKET_DEAL class-attribute instance-attribute

Python
1
MARKET_DEAL = 'MARKET_DEAL'

скидка в рамках соглашения на оказание услуг по продвижению сервиса между маркетплейсом Яндекс Маркета и партнером.

OrderStatusType

Bases: StrEnum

Статус заказа:

  • CANCELLED — заказ отменен.
  • DELIVERED — заказ получен покупателем.
  • DELIVERY — заказ передан в службу доставки.
  • PICKUP — заказ доставлен в пункт самовывоза.
  • PROCESSING — заказ находится в обработке.
  • UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).

Также могут возвращаться другие значения. Обрабатывать их не требуется.

CANCELLED class-attribute instance-attribute

Python
1
CANCELLED = 'CANCELLED'

заказ отменен.

DELIVERED class-attribute instance-attribute

Python
1
DELIVERED = 'DELIVERED'

заказ получен покупателем.

DELIVERY class-attribute instance-attribute

Python
1
DELIVERY = 'DELIVERY'

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

PICKUP class-attribute instance-attribute

Python
1
PICKUP = 'PICKUP'

заказ доставлен в пункт самовывоза.

PROCESSING class-attribute instance-attribute

Python
1
PROCESSING = 'PROCESSING'

заказ находится в обработке.

UNPAID class-attribute instance-attribute

Python
1
UNPAID = 'UNPAID'

заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).

OrderSubsidyType

Bases: StrEnum

Тип субсидии.

DELIVERY class-attribute instance-attribute

Python
1
DELIVERY = 'DELIVERY'

Доставка

NOT_SUBSIDY class-attribute instance-attribute

Python
1
NOT_SUBSIDY = 'NOT_SUBSIDY'

Не субсидия

SBER_SPASIBO class-attribute instance-attribute

Python
1
SBER_SPASIBO = 'SBER_SPASIBO'

СберСпасибо

SUBSIDY class-attribute instance-attribute

Python
1
SUBSIDY = 'SUBSIDY'

Субсидия

YANDEX_CASHBACK class-attribute instance-attribute

Python
1
YANDEX_CASHBACK = 'YANDEX_CASHBACK'

Яндекс.Кэшбек

OrderSubstatusType

Bases: StrEnum

Этап обработки заказа (если он имеет статус 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 — не удалось связаться с покупателем.

Также могут возвращаться другие значения. Обрабатывать их не требуется.

PROCESSING_EXPIRED class-attribute instance-attribute

Python
1
PROCESSING_EXPIRED = 'PROCESSING_EXPIRED'

значение более не используется.

READY_TO_SHIP class-attribute instance-attribute

Python
1
READY_TO_SHIP = 'READY_TO_SHIP'

заказ собран и готов к отправке.

REPLACING_ORDER class-attribute instance-attribute

Python
1
REPLACING_ORDER = 'REPLACING_ORDER'

покупатель решил заменить товар другим по собственной инициативе.

RESERVATION_EXPIRED class-attribute instance-attribute

Python
1
RESERVATION_EXPIRED = 'RESERVATION_EXPIRED'

покупатель не завершил оформление зарезервированного заказа в течение 10 минут.

SHOP_FAILED class-attribute instance-attribute

Python
1
SHOP_FAILED = 'SHOP_FAILED'

магазин не может выполнить заказ.

STARTED class-attribute instance-attribute

Python
1
STARTED = 'STARTED'

заказ подтвержден, его можно начать обрабатывать.

USER_CHANGED_MIND class-attribute instance-attribute

Python
1
USER_CHANGED_MIND = 'USER_CHANGED_MIND'

покупатель отменил заказ по личным причинам.

USER_NOT_PAID class-attribute instance-attribute

Python
1
USER_NOT_PAID = 'USER_NOT_PAID'

покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.

USER_REFUSED_DELIVERY class-attribute instance-attribute

Python
1
USER_REFUSED_DELIVERY = 'USER_REFUSED_DELIVERY'

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

USER_REFUSED_PRODUCT class-attribute instance-attribute

Python
1
USER_REFUSED_PRODUCT = 'USER_REFUSED_PRODUCT'

покупателю не подошел товар.

USER_REFUSED_QUALITY class-attribute instance-attribute

Python
1
USER_REFUSED_QUALITY = 'USER_REFUSED_QUALITY'

покупателя не устроило качество товара.

USER_UNREACHABLE class-attribute instance-attribute

Python
1
USER_UNREACHABLE = 'USER_UNREACHABLE'

не удалось связаться с покупателем.

OrderTaxSystemType

Bases: StrEnum

Система налогообложения (СНО) магазина на момент оформления заказа

ECHN class-attribute instance-attribute

Python
1
ECHN = 'ECHN'

единый сельскохозяйственный налог (ЕСХН).

ENVD class-attribute instance-attribute

Python
1
ENVD = 'ENVD'

единый налог на вмененный доход (ЕНВД).

OSN class-attribute instance-attribute

Python
1
OSN = 'OSN'

общая система налогообложения (ОСН).

PSN class-attribute instance-attribute

Python
1
PSN = 'PSN'

патентная система налогообложения (ПСН).

USN class-attribute instance-attribute

Python
1
USN = 'USN'

упрощенная система налогообложения (УСН).

USN_MINUS_COST class-attribute instance-attribute

Python
1
USN_MINUS_COST = 'USN_MINUS_COST'

упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»).

OrderVatType

Bases: StrEnum

Ставка налога на добавленную стоимость (НДС) на услугу доставки заказа:

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

NO_VAT class-attribute instance-attribute

Python
1
NO_VAT = 'NO_VAT'

НДС не облагается, используется только для отдельных видов услуг.

VAT_0 class-attribute instance-attribute

Python
1
VAT_0 = 'VAT_0'

НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров.

VAT_10_110 class-attribute instance-attribute

Python
1
VAT_10_110 = 'VAT_10_110'

НДС 10/110. Расчетная ставка НДС 10%, применяется только для случая предоплаты.

VAT_18_118 class-attribute instance-attribute

Python
1
VAT_18_118 = 'VAT_18_118'

НДС 18/118. Ставка использовалась до 1 января 2019 года.

VAT_20 class-attribute instance-attribute

Python
1
VAT_20 = 'VAT_20'

НДС 20. Используется в тестовых заказах

VAT_20_120 class-attribute instance-attribute

Python
1
VAT_20_120 = 'VAT_20_120'

НДС 20/120. Расчетная ставка НДС 20%, применяется только для случая предоплаты.