Создать заказ для клиента-физического лица

POST

https://secured-openapi.tbank.ru/api/v2/checkout/order

Метод для создания заказа в системе Корзина.

Авторизация

Security

Bearer API Token

MTLS-сертификат

RPS

Ограничение — 20 запросов в секунду

Scopes

Корзина. Работа с заказом → Создание магазином заказа клиента

Запрос

Header parameters

X-Request-Id

String<uuid>

Уникальный идентификатор для трассировки запроса. Не влияет на логику исполнения запроса.

Request body schema application/json

Required

shopId

String<uuid>

Уникальный идентификатор магазина в системе Корзина от Т-Банка. Выдается продавцу специалистом Т-Банка во время интеграции.

amount

Number

Устаревшее — используйте itemsAmount. Сумма заказа в копейках с учетом доставки. Обязательное поле, если не указано значение itemsAmount.

itemsAmount

Number

Сумма заказа в копейках без учета доставки. Например, 3 рубля 12 копеек — 312 копеек. Параметр должен быть равен сумме всех параметров amount, переданных в объекте orderItems.

Минимальная сумма операции через СБП — 10 рублей.

Required

orderId

String

Requirements: <= 36 characters

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

Required

taxation

String

Requirements: [osn, usn_income, usn_income_outcome, patent, envd, esn, self]

Система налогообложения, по которой работает продавец:

osn — общая.
usn_income — упрощенная (доходы).
usn_income_outcome — упрощенная (доходы минус расходы).
patent — патентная.
envd — единый налог на вмененный доход.
esn — единый сельскохозяйственный налог.
self — НПД. В этом случае информация о чеке не отправляется в Интернет-эквайринг.

description

String

Requirements: <= 250 characters

Описание заказа.

customerKey

String

Requirements: <= 128 characters

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

successPageUrl

String<url>

Requirements: <= 1000 characters

URL для редиректа на страницу магазина после успешной оплаты покупателем.

isForceRedirect

Boolean

Флаг для принудительного редиректа на страницу успеха магазина после выполнения оплаты покупателем:

true — покупатель сразу перенаправляется на страницу успеха магазина, которая указана в successPageUrl;
false — покупатель перенаправляется на страницу успеха Корзины от Т-Банка.

shoppingCartPageUrl

String<url>

Requirements: <= 1000 characters

URL для редиректа на страницу магазина с товарной корзиной.

deliveryPayment

Array of objects ()

Requirements: <= 1000 items

Массив для переопределения способов доставки и оплаты заказа. Настройки по умолчанию указываются при выпуске уникального идентификатора магазина.

Required

deliveryKind

String

Requirements: [disabled, by_merchant, courier, post_office, delivery_point, merchant_delivery_point]

Способ доставки, доступный для заказа. Доступны три группы:

disabled — доставка не поддерживается.
by_merchant — доставка средствами продавца.
Доставка с помощью сервиса MetaShip:

courier — доставка курьерской службой;
post_office — доставка в почтовое отделение;
delivery_point — доставка в пункт выдачи заказов;
merchant_delivery_point — доставка в пункт выдачи заказов продавца.

При оформлении заказа можно выбирать значения в рамках одной группы. Например, заказ может быть создан только способом by_merchant или только с типами, которые относятся к третьей группе.

paymentTypes

Array

Requirements: [card, sbp, on_delivery, dolyame, pos], <= 5 items

Способы оплаты, доступные для покупателя при использовании способа доставки, который указан в параметре deliveryKind:

card — оплата банковской картой;
sbp — оплата через СБП;
on_delivery — оплата при получении;
dolyame — оплата частями через сервис Долями;
pos — оплата через сервис POS-кредитования.

Required

orderItems

Array of objects ()

Requirements: <= 4000 items

Модель создания товара.

Required

name

String

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

Required

quantity

Number

Количество товара.

Required

amount

Number

Суммарная стоимость товара в копейках. Рассчитывается как price * quantity.

Required

price

Number

Стоимость одного товара в копейках.

description

String

Requirements: <= 250 characters

Описание товара. Отображается в интерфейсе Корзины от Т-Банка.

Required

tax

String

Requirements: [none, vat0, vat10, vat20, vat110, vat118, vat120]

Cтавка НДС:

none — без НДС;
vat0 — 0%;
vat10 — 10%;
vat20 — 20%;
vat110 — 10/110;
vat118 — 18/118, устаревшее;
vat120 — 20/120.

excise

Number

Cумма акциза.

paymentMethod

String

Requirements: [full_payment, full_prepayment, prepayment, advance, partial_payment, credit, credit_payment]

Способ расчета заказа:

full_payment — полный расчет;
full_prepayment — 100% предоплата;
prepayment — предоплата;
advance — аванс;
partial_payment — частичный расчет и кредит;
credit — передача в кредит;
credit_payment — оплата кредита.

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

Поле обязательное, если продавец работает с ФФД 1.2.

paymentObject

String

Requirements: [commodity, excise, job, service, gambling_bet, gambling_prize, lottery, lottery_prize, intellectual_activity, payment, agent_commission, contribution, property_rights, unrealization, tax_reduction, trade_fee, resort_tax, pledge, income_decrease, ie_pension_insurance_without_payments, ie_pension_insurance_with_payments, ie_medical_insurance_without_payments, ie_medical_insurance_with_payments, social_insurance, casino_chips, agent_payment, excisable_goods_without_marking_code, excisable_goods_with_marking_code, goods_without_marking_code, goods_with_marking_code, another]

Категория предмета расчета — товара или услуги:

commodity — товар;
excise — подакцизный товар;
job — работа;
service — услуга;
gambling_bet — ставка азартной игры;
gambling_prize — выигрыш азартной игры;
lottery — лотерейный билет;
gambling_prize — выигрыш азартной игры;
lottery_prize — выигрыш лотереи;
intellectual_activity — предоставление результатов интеллектуальной деятельности;
payment — платеж;
agent_commission — агентское вознаграждение;
contribution — составной предмет расчета;
property_rights — имущественное право;
unrealization — внереализационный доход;
tax_reduction — иные платежи и взносы;
trade_fee — торговый сбор;
resort_tax — курортный сбор;
pledge — залог;
income_decrease — расход;
ie_pension_insurance_without_payments — взносы на ОПС ИП;
ie_pension_insurance_with_payments — взносы на ОПС;
ie_medical_insurance_without_payments — взносы на ОМС ИП;
ie_medical_insurance_with_payments — взносы на ОМС;
social_insurance — взносы на ОСС;
casino_chips — платеж казино;
agent_payment — выдача ДС;
excisable_goods_without_marking_code — АТНМ;
excisable_goods_with_marking_code — АТМ;
goods_without_marking_code — ТНМ;
goods_with_marking_code — ТМ;
another — иной предмет расчета.

countryCode

String

Requirements: <= 3 characters

Код страны.

declarationNumber

String

Номер декларации.

measurementUnit

String

Единица измерения товара.

markCode

Object

Код маркировки в машиночитаемой форме. Формируется в соответствии с определенными требованиями и используется для маркировки потребительской упаковки, товаров или товарных ярлыков.

markCodeType

String

Requirements: [ean8, ean13, itf14, gs10, gs1m, short, fur, egais20, egais30, rawcode]

Тип штрихкода:

ean8 — код товара в формате EAN-8;
ean13 — код товара в формате EAN-13;
itf14 — код товара в формате ITF-14;
gs10 — код товара в формате GS1, нанесенный на товар, не подлежащий маркировке;
gs1m — код товара в формате GS1, нанесенный на товар, подлежащий маркировке;
short — код товара в формате короткого кода маркировки, нанесенный на товар;
fur — контрольно-идентификационный знак мехового изделия;
egais20 — код товара в формате ЕГАИС-2.0;
egais30 — код товара в формате ЕГАИС-3.0;
rawcode — код маркировки, как он был прочитан сканером.

value

String

Значение.

markQuantity

Object

Параметр для обозначения дробного количества маркированного товара.

numerator

Number

Числитель дробной части предмета расчета. Значение должно быть строго меньше значения реквизита Знаменатель.

denominator

Number

Знаменатель дробной части предмета расчета. Значение равно количеству товара в партии (упаковке) c общим кодом маркировки товара.

article

String

Requirements: <= 250 characters

Артикул товара. Обязательное поле при работе со службами доставки — способы доставки courier, post_office, delivery_point, merchant_delivery_point.

weight

Number<double>

Requirements: < 1000

Вес одной единицы товара. Общий вес позиции равен count * weight в кг. Обязательное поле при работе со службами доставки — способы доставки courier, post_office, delivery_point, merchant_delivery_point.

declaredValue

Integer<int32>

Объявленная ценность в копейках. Обязательное поле при работе со службами доставки — способы доставки courier, post_office, delivery_point, merchant_delivery_point.

externalProductId

String

Requirements: <= 256 characters

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

deliveryCondition

Object

Объект условий доставки.

price

Number

Цена товара в копейках. Только для способа доставки by_merchant.

Required

tax

String

Requirements: [none, vat0, vat10, vat20, vat110, vat118, vat120]

Cтавка НДС:

none — без НДС;
vat0 — 0%;
vat10 — 10%;
vat20 — 20%;
vat110 — 10/110;
vat118 — 18/118, устаревшее;
vat120 — 20/120.

shippingParameters

Object

Параметры доставки.

metashipShopId

String<uuid>

ID магазина в системе MetaShip.

metashipWarehouseId

String<uuid>

ID склада в системе MetaShip.

types

Array

Устаревшее — используйте deliveryPayment и deliveryKind.

Тип доставки:

Courier — курьерская доставка;
PostOffice — почтовое отправление;
DeliveryPoint — ПВЗ.

services

Array of objects ()

Дополнительные услуги служб доставки.

Required

service

String

Дополнительные услуги служб доставки:

barcode-generation — генерация штрихкода на стороне MetaShip: YandexDelivery и DPD.
dress-fitting — есть примерка: CDEK и DPD.
crate — обрешетка (защитный каркас) груза: ПЭК и DPD.
fragile — хрупкое: Почта России.
sms — SMS-информирование: DPD, Почта России и CDEK.
shelf-life-days — срок хранения заказа в ОПС. Можно указать количество дней в value int.

value

String

Срок хранения заказа — количество дней.

Required

weight

Number<double>

Requirements: < 1000

Вес товара в килограммах.

Required

height

Integer<int32>

Requirements: >= 1 and <= 1000

Высота товара в сантиметрах.

Required

width

Integer<int32>

Requirements: >= 1 and <= 1000

Ширина товара в сантиметрах.

Required

length

Integer<int32>

Requirements: >= 1 and <= 1000

Длина товара в сантиметрах.

declaredValue

Number<double>

freeDelivery

Object

Параметр устарел, используйте файл настройки доставок. Параметры бесплатной доставки.

postOffice

Object

Почтовое отделение.

deliveryPriceBefore

Number

Доставка бесплатная, если цена доставки меньше или равна этому числу.

checkoutPriceAfter

Number

Доставка бесплатная, если сумма корзины больше или равна этому числу.

courier

Object

Курьер.

deliveryPriceBefore

Number

Доставка бесплатная, если цена доставки меньше или равна этому числу.

checkoutPriceAfter

Number

Доставка бесплатная, если сумма корзины больше или равна этому числу.

deliveryPoint

Object

Пункт выдачи заказов.

deliveryPriceBefore

Number

Доставка бесплатная, если цена доставки меньше или равна этому числу.

checkoutPriceAfter

Number

Доставка бесплатная, если сумма корзины больше или равна этому числу.

data

Object

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

discountInfo

Object

Информация о скидке. Параметр нужен для отображения скидки в интерфейсе Корзины от Т-Банка. Заказ передается с учетом всех скидок.

promoCodeId

String

Requirements: <= 256 characters

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

discountAmount

Number

Суммарная скидка заказа в копейках. Целое положительное число.

Ответ

201

Успешный запрос

400

Ошибка при создании заказа

401

Ошибка аутентификации

403

Ошибка авторизации

422

Ошибка при обработке данных

429

Слишком много запросов

500

Ошибка сервера

Это полезный материал?

Обратиться в поддержку

Получить консультацию по интеграции