Перейти к основному содержимому

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

/api/v2/checkout/order

POST

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

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

Авторизация

Security

Bearer API Token

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

Сумма заказа в копейках без учёта доставки. Обязательное поле, если не указано значение amount.

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

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

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 — доставка средствами продавца;
  • courier — доставка курьерской службой;
  • post_office — доставка посредством почтового отправления;
  • delivery_point — заказ можно забрать из пункта выдачи заказов;
  • merchant_delivery_point — заказ можно забрать из пункта выдачи заказов продавца.

paymentTypes

Array

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

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

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 (deprecated);
  • 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 — оплата кредита.

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

Артикул товарной позиции. Обязателен при работе со службами доставки.

weight

Number<double>

Requirements: < 1000

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

declaredValue

Integer<int32>

Объявленная ценность в копейках. Обязателен при работе со службами доставки.

externalProductId

String

Requirements: <= 256 characters

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

deliveryCondition

Object

Позиция условия доставки.

price

Number

Цена позиции в копейках.

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 (deprecated);
  • 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

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

discountInfo

Object

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

promoCodeId

String

Requirements: <= 256 characters

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

discountAmount

Number

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

Ответ

201

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

400

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

401

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

403

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

422

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

429

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

500

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

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

Обратиться в поддержку
Получить консультацию по интеграции
Loading...

openapi@tinkoff.ru

APIСценарииПодключение

АО «Тинькофф Банк» использует файлы «cookie», с целью персонализации сервисов и повышения удобства пользования веб-сайтом. «Cookie» представляют собой небольшие файлы, содержащие информацию о предыдущих посещениях веб-сайта. Если вы не хотите использовать файлы «cookie», измените настройки браузера.