Заказы
Заказы всех каналов: позиции, итоги, статус и оплата. Лента отдаёт изменённое в порядке коммитов; статус меняется и заказ отменяется по правилам магазина.
Заказы
Объекты
Order
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
numberstring или nullобязательноНомер заказа, который видят покупатель и сотрудники; null, пока номера ещё нет.
channelstringобязательноОткуда пришёл заказ: web — витрина; pos — касса; marketplace — маркетплейс, например Mercado Libre; external — учётная система магазина; manual — черновик заказа сотрудника или приложения; subscription — день подписки на питание.
- Значения:
webposmarketplaceexternalmanualsubscription
app_idinteger или nullобязательноПриложение, оформившее заказ своим черновиком (/v1/draft-orders), — его id из /v1/me; null у заказов витрины, кассы и сотрудников.
location_idintegerобязательноТочка, которая обслуживает заказ: пункт самовывоза или точка, с которой списывается остаток.
legal_entity_idinteger или nullобязательноЮрлицо, на которое оформлена продажа (/v1/legal-entities); null — продажа не распределена между юрлицами, её юрлицо — юрлицо магазина по умолчанию.
statusstringобязательноСтатус заказа: код из списка статусов магазина (/v1/order-statuses). Магазин может добавлять свои статусы; постоянный смысл даёт status_group.
status_groupstringобязательноПостоянный смысл статуса: pos_open — открытый счёт на кассе; placed — оформлен; pending_payment — ждёт оплаты; paid — оплачен; confirmed — принят магазином; preparing — готовится; ready — готов; ready_for_pickup — готов к выдаче; out_for_delivery — в пути; delivery_failed — доставка не удалась; delivered — доставлен; completed — завершён; cancelled — отменён; refunded — возвращён.
- Значения:
pos_openplacedpending_paymentpaidconfirmedpreparingreadyready_for_pickupout_for_deliverydelivery_faileddeliveredcompletedcancelledrefunded
payment_statusstringобязательноОплата заказа: unpaid — не оплачен; partial — оплачен частично; paid — оплачен; partially_refunded — частично возвращён; refunded — возвращён.
- Значения:
unpaidpartialpaidpartially_refundedrefunded
sale_typestringобязательноretail — продажа покупателю; staff — продажа сотруднику; wholesale — оптовая продажа.
- Значения:
retailstaffwholesale
currencystringобязательноВалюта сумм, код ISO 4217: валюта магазина.
items_totalintegerобязательноСумма позиций до скидки заказа.
discountintegerобязательноСкидка заказа на товары: сумма applied_discounts[].amount и items[].discount.
applied_discountsмассив objectобязательноСостав скидки на товары — журнал применённых скидок. Строки переписываются при пересчёте заказа: id живёт до пересчёта.
Поля · 8
idintegerобязательноСтрока журнала; на неё ссылается items[].discount_allocations[].applied_discount_id.
sourcestringобязательноКак скидка попала в заказ: automatic — правило магазина; pick — правило, которое отметил кассир; promocode — промокод покупателя; manual — ручная скидка кассира; offline_capture — расхождение офлайн-продажи кассы с расчётом сервера, не решение продавца; loyalty_program — бонусная программа; external_pos — внешняя касса, которая провела продажу.
- Значения:
promocodeautomaticpickmanualoffline_captureloyalty_programexternal_pos
kindstring или nullобязательноЗа что скидка: promo — акция; employee — сотруднику; expiry — уценка по сроку годности; payment_method — за способ оплаты; markdown — уценка товара по состоянию; goodwill — навстречу покупателю; comp — за счёт заведения; other — иное. null — скидка внешней кассы, офлайн-расхождение или скидка до появления этой оси.
- Значения:
promoemployeeexpirypayment_methodmarkdowngoodwillcompothernull
nameobject или nullобязательноИмя правила или бонусной программы на момент продажи; null у промокода, ручной скидки, офлайн-расхождения и внешней кассы.
codestring или nullобязательноПромокод, который ввёл покупатель; null — скидка не по промокоду.
reasonstring или nullобязательноПричина ручной скидки словами кассира; null у остальных.
order_item_idinteger или nullобязательноПозиция, которую уценили отдельно; null — скидка на заказ, её доли по позициям — в items[].discount_allocations.
amountintegerобязательноСумма скидки.
delivery_costintegerобязательноДоставка к оплате — после скидки на доставку.
delivery_discountintegerобязательноСнято с доставки скидкой: цена доставки до скидки — delivery_cost + delivery_discount.
delivery_discountsмассив objectобязательноСостав скидки на доставку: сумма amount равна delivery_discount.
Поля · 6
idintegerобязательноСтрока журнала скидок доставки.
sourcestringобязательноКак скидка попала в заказ — значения как у applied_discounts[].source.
- Значения:
promocodeautomaticpickmanualoffline_captureloyalty_programexternal_pos
kindstring или nullобязательноЗа что скидка — значения как у applied_discounts[].kind.
- Значения:
promoemployeeexpirypayment_methodmarkdowngoodwillcompothernull
nameobject или nullобязательноИмя правила на момент продажи; null — скидка по промокоду.
codestring или nullобязательноПромокод, который ввёл покупатель; null — скидка не по промокоду.
amountintegerобязательноСумма скидки на доставку.
delivery_tax_linesмассив object или nullобязательноНалог доставки по классу магазина по умолчанию — её доля налога своей ставки в tax_lines; null — доставки к оплате нет или налог неизвестен.
Поля · 6
regimestringобязательноКакой налог: vat — налог на добавленную стоимость (IVA); income — на прибыль; turnover — оборотный (Ingresos Brutos); municipal — муниципальный сбор; internal — акциз; social — социальные взносы; other — прочее. Налог продажи — vat: класс налога товара классифицирует НДС.
- Значения:
vatincometurnovermunicipalinternalsocialother
kindstringобязательноtaxed — по ставке; exempt — освобождено законом; untaxed — вне периметра налога. У строк exempt и untaxed rate_bps 0 и amount 0: сумма — в base.
- Значения:
taxedexemptuntaxed
rate_bpsintegerобязательноСтавка в базисных пунктах: 2100 — это 21 %.
baseintegerобязательноБаза налога, без налога. Цены — с налогом: base + amount — сколько покупатель заплатил за эту часть.
amountintegerобязательноСумма налога. Налог продажи считается по ставке для всего заказа: база к ближайшей единице, налог остатком; позиции и доставка получают доли, поэтому их строки в сумме дают строку заказа.
jurisdictionstring или nullобязательноПровинция или муниципалитет у налогов, которым они нужны (turnover, municipal); иначе null.
platform_discountintegerобязательноСкидка за счёт площадки-агрегатора: продажу магазина не уменьшает.
platform_service_feeintegerобязательноСервисный сбор площадки-агрегатора: входит в total, но не продажа магазина.
platform_delivery_feeintegerобязательноДоставка, которую везёт площадка-агрегатор: входит в total, но не продажа магазина.
totalintegerобязательноСумма заказа к оплате.
tax_linesмассив object или nullобязательноНалог продажи по классификации товаров на момент продажи: облагаемая часть заказа (позиции, кроме продажи подарочных карт, визиты сверх оплаченного пакетом, доставка) по ставкам. По каждой ставке tax_lines позиций и delivery_tax_lines в сумме дают строку заказа. Юридически значимый налог — в фискальном документе: его определяет юрлицо-эмитент по своему налоговому статусу. null — у магазина нет налоговых классов или облагаемой части у заказа нет.
Поля · 6
regimestringобязательноКакой налог: vat — налог на добавленную стоимость (IVA); income — на прибыль; turnover — оборотный (Ingresos Brutos); municipal — муниципальный сбор; internal — акциз; social — социальные взносы; other — прочее. Налог продажи — vat: класс налога товара классифицирует НДС.
- Значения:
vatincometurnovermunicipalinternalsocialother
kindstringобязательноtaxed — по ставке; exempt — освобождено законом; untaxed — вне периметра налога. У строк exempt и untaxed rate_bps 0 и amount 0: сумма — в base.
- Значения:
taxedexemptuntaxed
rate_bpsintegerобязательноСтавка в базисных пунктах: 2100 — это 21 %.
baseintegerобязательноБаза налога, без налога. Цены — с налогом: base + amount — сколько покупатель заплатил за эту часть.
amountintegerобязательноСумма налога. Налог продажи считается по ставке для всего заказа: база к ближайшей единице, налог остатком; позиции и доставка получают доли, поэтому их строки в сумме дают строку заказа.
jurisdictionstring или nullобязательноПровинция или муниципалитет у налогов, которым они нужны (turnover, municipal); иначе null.
gift_card_issue_amountinteger или nullобязательноНоминал подарочной карты, которую продаёт заказ: обязательство магазина, не выручка; null, если заказ не продаёт карту.
reservation_deposit_amountinteger или nullобязательноАванс брони стола или записи на услугу: предоплата, не выручка; null, если заказ не аванс.
account_payment_amountinteger или nullобязательноПогашение долга покупателя: деньги в счёт долга, не выручка; null, если заказ не погашение.
service_package_issue_amountinteger или nullобязательноПроданные в заказе пакеты визитов: обязательство магазина визитами, не выручка — выручкой становится визит, погашенный пакетом; null, если пакетов в заказе нет.
payment_methodstring или nullобязательноСпособ оплаты, выбранный при оформлении: manual — ручной способ магазина (manual_payment_method_id). Фактические оплаты — в /v1/payments. null, если способ не выбран.
- Значения:
cashmercadopagocryptobybittrc20balancemodopaywaymercadopago_qrmercadopago_pointmercadopago_transfergift_cardsubscriptiondepositexternalmanualoffseton_accountexchange_creditbonpuntoservice_packagenull
manual_payment_method_idinteger или nullобязательноРучной способ оплаты магазина (/v1/manual-payment-methods), когда payment_method — manual; иначе null.
delivery_method_idinteger или nullобязательноСпособ доставки магазина (/v1/delivery-methods); null, если у заказа его нет, например у продажи на кассе.
fulfilment_typestring или nullобязательноКак заказ доходит до покупателя — по способу доставки на момент заказа: self_pickup — самовывоз с точки; home_delivery — доставка по адресу; parcel_locker — постамат; mail_post — почта; pos — выдача на кассе; aggregator — доставка площадкой-агрегатором; manual_courier — курьер, которого магазин находит сам. null, если неизвестно.
- Значения:
self_pickuphome_deliveryparcel_lockermail_postposaggregatormanual_couriernull
delivery_slotsмассив objectобязательноОкна доставки, выбранные покупателем, по возрастанию начала; пусто — без окна.
Поля · 2
fromstringобязательноНачало окна.
tostringобязательноКонец окна.
shipmentobject или nullобязательноОтправление у перевозчика или номер службы без интеграции, вписанный магазином; null — у заказа его нет. Наклейка — GET /v1/orders/{order}/shipment/label при label_available.
Поля · 8
carrierstringобязательноПеревозчик — ключ модуля: andreani, correo_argentino, uber_direct, mercadolibre (Mercado Envíos); courier_service — служба без интеграции, номер вписал магазин (POST /v1/orders/{order}/shipment/tracking), служба — в carrier_name, статусов нет.
- Значения:
andreanicorreo_argentinouber_directmercadolibrecourier_service
carrier_namestring или nullобязательноСлужба, как её назвал магазин, у номера, вписанного вручную; null — у перевозчика с интеграцией (его называет carrier) или магазин службу не назвал.
tracking_numberstringобязательноНомер отправления у перевозчика: по нему его ищут в кабинете перевозчика и отслеживают.
tracking_urlstring или nullобязательноСтраница отслеживания у перевозчика; null — перевозчик её не дал.
statusstring или nullобязательноПоследний статус: accepted — принято, посылка у магазина; preparing — перевозчик готовит отправку; courier_assigned — курьер едет за посылкой; picked_up — курьер забрал; in_transit — в пути; arrived_at_branch — ждёт в отделении; out_for_delivery — у курьера на последней миле; delivery_failed — попытка вручения не удалась, перевозчик повторит; delivered — вручено; not_delivered — перевозчик окончательно не вручил; returned — возвращено отправителю; lost — потеряно; cancelled — отменено; unknown — статус перевозчика вне набора, его текст — в events[].description. null — статуса ещё нет. Поздний промежуточный статус не отменяет delivered, cancelled, returned и lost.
- Значения:
acceptedpreparingcourier_assignedpicked_upin_transitarrived_at_branchout_for_deliverydelivery_faileddeliverednot_deliveredreturnedlostcancelledunknownnull
status_atstring (date-time) или nullобязательноМомент последнего статуса.
eventsмассив objectобязательноИстория статусов по времени события у перевозчика.
Поля · 3
statusstringобязательноСтатус — значения как у shipment.status.
- Значения:
acceptedpreparingcourier_assignedpicked_upin_transitarrived_at_branchout_for_deliverydelivery_faileddeliverednot_deliveredreturnedlostcancelledunknown
descriptionstring или nullобязательноСтатус словами перевозчика; null — перевозчик текста не дал.
occurred_atstring (date-time)обязательноМомент события у перевозчика.
label_availablebooleanобязательноНаклейку можно скачать: файл у магазина или перевозчик выдаёт её по запросу.
previous_shipmentsмассив objectобязательноОтправления, заменённые перевыпуском (прежнее отменили и выпустили новое), от старых к новым; форма — как у shipment, без label_available.
Поля · 7
carrierstringобязательноПеревозчик — значения как у shipment.carrier.
- Значения:
andreanicorreo_argentinouber_directmercadolibrecourier_service
carrier_namestring или nullобязательноСлужба у номера, вписанного вручную, — как у shipment.carrier_name.
tracking_numberstringобязательноНомер отправления у перевозчика.
tracking_urlstring или nullобязательноСтраница отслеживания у перевозчика; null — перевозчик её не дал.
statusstring или nullобязательноПоследний статус — значения как у shipment.status.
- Значения:
acceptedpreparingcourier_assignedpicked_upin_transitarrived_at_branchout_for_deliverydelivery_faileddeliverednot_deliveredreturnedlostcancelledunknownnull
status_atstring (date-time) или nullобязательноМомент последнего статуса.
eventsмассив objectобязательноИстория статусов по времени события у перевозчика.
Поля · 3
statusstringобязательноСтатус — значения как у shipment.status.
- Значения:
acceptedpreparingcourier_assignedpicked_upin_transitarrived_at_branchout_for_deliverydelivery_faileddeliverednot_deliveredreturnedlostcancelledunknown
descriptionstring или nullобязательноСтатус словами перевозчика; null — перевозчик текста не дал.
occurred_atstring (date-time)обязательноМомент события у перевозчика.
shipment_attemptobject или nullобязательноНезакрытый выпуск отправления; null — его нет.
Поля · 3
statestringобязательноqueued — выпуск запрошен через API и ждёт очереди; in_progress — запрос к перевозчику идёт прямо сейчас; outcome_unknown — связь с перевозчиком оборвалась после запроса, и неизвестно, создано ли отправление: новый выпуск закрыт, пока магазин не сверится с перевозчиком в панели; failed — запрошенный выпуск не удался, отправления нет, причина — в error.
- Значения:
queuedin_progressoutcome_unknownfailed
started_atstring (date-time)обязательноКогда выпуск запрошен или начался.
errorobject или nullобязательноПочему запрошенный выпуск не удался; null — если не отказ.
Поля · 2
codestringобязательноПричина машинным кодом: no_carrier — у способа доставки нет перевозчика с интеграцией; not_shippable — заказ уже не отгружается; awaits_bill_payment — счёт не оплачен; carrier_rejected — перевозчик отказал; shipment_data_invalid — данных заказа или настроек перевозчика не хватает; request_expired — запрос не дождался исполнения; internal_error — сбой сервиса до обращения к перевозчику.
- Значения:
no_carriernot_shippableawaits_bill_paymentcarrier_rejectedshipment_data_invalidrequest_expiredinternal_error
messagestringобязательноПричина словами магазина на языке ответа; если отказал перевозчик — с его словами.
merged_into_order_idinteger или nullобязательноЗаказ, в который влит этот при объединении счетов стола: его позиции и оплаты — там, а этот остаётся пустой отменённой записью. null, если не влит.
cancel_reasonstring или nullобязательноСистемная причина отмены: payment_init_failed — оплата не запустилась; payment_declined — оплата отклонена; cashier_void — аннулирован на кассе; shift_closed — смена кассы закрыта; order_timeout — не оплачен вовремя; merged — влит в другой заказ; items_moved — позиции перенесены в другой заказ; sale_void — продажа аннулирована; subscription_day_unserved — день подписки не обслужен; booking_forfeit_reverted — удержание брони отменено; service_package_term_extended — срок пакета визитов продлили, сгорание отменено; membership_renewal_void — счёт продления абонемента погашен: договор отменён или окончен. null, если заказ не отменён или причину указал человек.
- Значения:
payment_init_failedpayment_declinedcashier_voidshift_closedorder_timeoutmergeditems_movedsale_voidsubscription_day_unservedbooking_forfeit_revertedservice_package_term_extendedmembership_renewal_voidnull
itemsмассив objectобязательноПозиции заказа: исторический факт, названия — на момент продажи.
Поля · 15
idintegerобязательноID позиции.
variant_idinteger или nullобязательноВариант позиции; null у позиции без варианта, например у подарочной карты, проданной на кассе.
product_idinteger или nullобязательноТовар позиции; null у позиции без варианта.
product_nameсловарь stringобязательноНазвание товара на момент продажи, по языкам.
variant_nameсловарь stringобязательноНазвание варианта на момент продажи, по языкам; пустой объект, если у варианта не было названия.
quantitystringобязательноКоличество десятичной строкой в unit: штуки у штучной позиции, мера у весовой или объёмной ("480" граммов).
unitstring или nullобязательноЕдиница quantity: pcs, g или ml; null, если вариант больше не знает единицу своей меры.
- Значения:
pcsgmlnull
unit_priceinteger или nullобязательноЦена одной штуки; null у весовой или объёмной позиции — её сумма в total.
totalintegerобязательноСумма позиции.
discountintegerобязательноСкидка на позицию.
discount_allocationsмассив objectобязательноИз каких скидок журнала сложилась скидка позиции: сумма amount равна items[].discount.
Поля · 2
applied_discount_idintegerобязательноСтрока applied_discounts этого заказа.
amountintegerобязательноДоля этой скидки на позиции.
is_giftbooleanобязательноПодарок акции или промокода: позиция с ценой и скидкой 100 %.
tax_linesмассив object или nullобязательноНалог позиции — её доля налога своей ставки в tax_lines заказа. Описывает облагаемую часть позиции: визит, частью оплаченный пакетом, — только остатком. null — позиция вне продажи (продажа подарочной карты, визит, целиком оплаченный пакетом, позиция с полной скидкой) или налог неизвестен.
Поля · 6
regimestringобязательноКакой налог: vat — налог на добавленную стоимость (IVA); income — на прибыль; turnover — оборотный (Ingresos Brutos); municipal — муниципальный сбор; internal — акциз; social — социальные взносы; other — прочее. Налог продажи — vat: класс налога товара классифицирует НДС.
- Значения:
vatincometurnovermunicipalinternalsocialother
kindstringобязательноtaxed — по ставке; exempt — освобождено законом; untaxed — вне периметра налога. У строк exempt и untaxed rate_bps 0 и amount 0: сумма — в base.
- Значения:
taxedexemptuntaxed
rate_bpsintegerобязательноСтавка в базисных пунктах: 2100 — это 21 %.
baseintegerобязательноБаза налога, без налога. Цены — с налогом: base + amount — сколько покупатель заплатил за эту часть.
amountintegerобязательноСумма налога. Налог продажи считается по ставке для всего заказа: база к ближайшей единице, налог остатком; позиции и доставка получают доли, поэтому их строки в сумме дают строку заказа.
jurisdictionstring или nullобязательноПровинция или муниципалитет у налогов, которым они нужны (turnover, municipal); иначе null.
cost_amountinteger или nullСебестоимость позиции на момент продажи: сумма в минимальных единицах currency за всю позицию, а не ставка. null — не посчитана. Только со scope costs:read.
cost_basisstring или nullЧем посчитана себестоимость: variant — себестоимость варианта; recipe — сумма тех-карты; standard — по нормативной тех-карте, оценка; partial — только известная часть тех-карты, нижняя граница; backfill — оценена позже по цене каталога, а не на момент продажи; external — взята из внешней кассы, которая провела продажу; unknown — считать не из чего. Только со scope costs:read.
- Значения:
variantrecipeunknownbackfillstandardpartialexternalnull
customerobject или nullПокупатель заказа; null у заказа без покупателя. Только со scope customers:read.
Поля · 4
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
namestring или nullобязательноИмя покупателя; null, если неизвестно.
phonestring или nullобязательноОсновной телефон покупателя в формате E.164, например +5491123456789; null, если неизвестен.
emailstring или nullобязательноEmail покупателя; null, если неизвестен.
delivery_addressobject или nullАдрес доставки на момент заказа; null у самовывоза — пункт выдачи в location_id. Только со scope customers:read.
Поля · 16
kindstringобязательноaddress — адрес покупателя; branch — пункт выдачи перевозчика (branch, address_line).
- Значения:
addressbranch
recipientstring или nullобязательноКто получает заказ; null, если не указан.
phonestring или nullобязательноТелефон получателя; null, если не указан.
streetstring или nullобязательноУлица.
housestring или nullобязательноНомер дома.
apartmentstring или nullобязательноКвартира или офис.
floorstring или nullобязательноЭтаж.
entrancestring или nullобязательноПодъезд.
districtstring или nullобязательноРайон.
citystring или nullобязательноГород.
provincestring или nullобязательноПровинция или область.
postal_codestring или nullобязательноПочтовый индекс.
address_linestring или nullобязательноАдрес пункта выдачи перевозчика одной строкой; null у адреса покупателя.
commentstring или nullобязательноКомментарий покупателя к адресу, например как пройти.
locationobject или nullобязательноТочка адреса на карте; null, если неизвестна.
Поля · 2
latnumberобязательноШирота в градусах.
lngnumberобязательноДолгота в градусах.
branchobject или nullобязательноПункт выдачи перевозчика, когда kind — branch; иначе null.
Поля · 2
external_idstring или nullобязательноID пункта выдачи в системе перевозчика.
namestring или nullобязательноНазвание пункта выдачи.
customer_commentstring или nullКомментарий покупателя к заказу. Только со scope customers:read.
fiscal_receptorobject или nullКому выписывается фискальный документ заказа, зафиксировано на заказе; null — розничная продажа без реквизитов. Только со scope customers:read.
Поля · 5
id_typestringобязательноВид идентификатора: tax_id — налоговый номер организации (CUIT в Аргентине); personal_id — налоговый номер физлица (CUIL); national_id — удостоверение личности (DNI); passport — паспорт; none — без идентификатора.
- Значения:
tax_idpersonal_idnational_idpassportnone
id_numberstring или nullобязательноНомер идентификатора; null, когда id_type — none.
namestring или nullобязательноНаименование или полное имя для документа; null, если не задано.
tax_statusstringобязательноНалоговый статус: registered — плательщик НДС (Responsable Inscripto в Аргентине); small_taxpayer — упрощённый режим (Monotributo); exempt — освобождён от НДС; final_consumer — конечный потребитель; not_categorized — без категории; foreign — иностранный покупатель.
- Значения:
registeredsmall_taxpayerexemptfinal_consumernot_categorizedforeign
addressstring или nullобязательноФискальный адрес одной строкой; null, если не задан.
external_fiscal_documentobject или nullДокумент продажи во внешней кассе: заказ ушёл в кассу магазина или пришёл из неё, и документ выпускает касса, а не мы — фискальных документов по такому заказу нет. null — документа кассы нет: документ наш или касса о нём не сообщила. Только со scope fiscal:read.
Поля · 3
issuerstringобязательноКасса, выпускающая документ: fudo — FuDo, poster — Poster.
statusstringобязательноpending — счёт в кассе открыт, документ касса выпустит при закрытии; issued — касса документ выпустила.
- Значения:
pendingissued
numberstring или nullобязательноНомер документа в кассе; null, пока документ не выпущен или если касса номер не отдаёт.
placed_atstring (date-time)обязательноКогда заказ оформлен.
confirmed_atstring (date-time) или nullобязательноКогда магазин подтвердил заказ; null до подтверждения.
completed_atstring (date-time) или nullобязательноКогда заказ завершён; null до завершения.
cancelled_atstring (date-time) или nullобязательноКогда заказ отменён; null, если не отменён.
refunded_atstring (date-time) или nullобязательноКогда заказ возвращён полностью; null, если не возвращён.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
Методы
Заказы, изменённые с указанного момента: позиции, суммы, статус заказа и статус оплаты
get/orders
Scope: orders:read
Параметры
Строка запроса
limitintegerРазмер страницы: до 250 записей; по умолчанию 50.
- Минимум:
- 1
- Максимум:
- 250
cursorstringНепрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.
- Макс. длина:
- 4096
updated_sincestring (date-time)Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.
- Шаблон:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
include_deletedbooleantrue — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.
numberstringТолько заказ с этим номером.
- Макс. длина:
- 16
Ответы
200Успешно
application/json
Записи страницы.
deletedмассив objectобязательноЗаписи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.
Поля · 2
idintegerобязательноID стёртой записи.
deleted_atstring (date-time)обязательноКогда запись стёрта.
next_cursorstring или nullобязательноКурсор следующей страницы; null на последней.
has_morebooleanобязательноtrue, если есть следующая страница.
sync_cursorstring или nullобязательноНа последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/orders" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Заказ
get/orders/{order}
Scope: orders:read
Параметры
Путь
orderintegerобязательноID заказа.
Ответы
200Успешно
application/json
Возвращает Order
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/orders/{order}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Наклейка текущего отправления заказа у перевозчика, PDF; на ней данные получателя, поэтому нужен и customers:read
get/orders/{order}/shipment/label
Scope: orders:readcustomers:read
Параметры
Путь
orderintegerобязательноID заказа.
Ответы
200Успешно
application/pdf
string (binary)
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/orders/{order}/shipment/label" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"Перевести заказ в другой статус магазина
post/orders/{order}/status
Scope: orders:write
Параметры
Путь
orderintegerобязательноID заказа.
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
Тело запроса application/json
statusstringобязательноСтатус заказа: код из списка статусов магазина (/v1/order-statuses). Магазин может добавлять свои статусы; постоянный смысл даёт status_group.
- Макс. длина:
- 50
commentstring или nullКомментарий к смене, остаётся в истории заказа.
- Макс. длина:
- 500
delivery_failure_reasonstring или nullПри переходе в статус группы delivery_failed — почему: customer_absent — никого нет по адресу; refused — покупатель отказался от заказа; wrong_address — адрес не найден; no_contact — с покупателем не удалось связаться; other — другая причина, объяснённая в comment.
- Значения:
customer_absentrefusedwrong_addressno_contactothernull
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
application/json
Возвращает Order
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 409
order_transition_refusedЗаказ нельзя перевести в этот статус - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/orders/{order}/status" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"status": "string",
"comment": "string",
"delivery_failure_reason": "customer_absent"
}{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Отменить заказ
post/orders/{order}/cancel
Scope: orders:write
Параметры
Путь
orderintegerобязательноID заказа.
Строка запроса
consentobjectСогласия на последствия правки по видам: consent[<consent_kind>]=<consent_token> из ответа 409 consent_required. Уже данные согласия сохраняются, когда спрашивается следующий вид.
Поля · 1
order_cancelstringОтмена заказа возвращает полученные деньги покупателю, в подписку или в бронь, выпускает кредит-ноту на фискальный документ, отменяет отправление перевозчика и оставляет уже собранный товар в потерях.
- Мин. длина:
- 64
- Макс. длина:
- 64
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
Тело запроса application/json
statusstringСтатус заказа: код из списка статусов магазина (/v1/order-statuses). Магазин может добавлять свои статусы; постоянный смысл даёт status_group.
- Макс. длина:
- 50
commentstring или nullПричина отмены словами, остаётся в истории заказа.
- Макс. длина:
- 500
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
application/json
Возвращает Order
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
consent_requiredНужно согласие на последствия - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 409
order_cancel_refusedЗаказ нельзя отменить - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/orders/{order}/cancel" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"status": "string",
"comment": "string"
}{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Выпустить отправление у перевозчика заказа: запрос исполняется в фоне, итог — в заказе и событием order.updated
post/orders/{order}/shipment
Scope: orders:write
Параметры
Путь
orderintegerобязательноID заказа.
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
application/json
Возвращает Order
202Принято: исход — по адресу из Location
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
Locationstring (uri)обязательноАдрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.
application/json
Возвращает Order
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 409
shipment_in_progressВыпуск отправления уже идёт - 409
shipment_outcome_unknownИсход прошлого выпуска неизвестен - 409
shipment_refusedОтправление сейчас не выпустить - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/orders/{order}/shipment" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Записать номер отслеживания у службы доставки без интеграции: номер, ссылку и название службы
post/orders/{order}/shipment/tracking
Scope: orders:write
Параметры
Путь
orderintegerобязательноID заказа.
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
Тело запроса application/json
tracking_numberstringобязательноНомер у службы доставки: буквы и цифры, внутри — пробел, точка, косая черта, дефис и подчёркивание; до 64 символов.
- Макс. длина:
- 64
- Шаблон:
^[\p{L}\p{N}](?:[\p{L}\p{N} .\/_-]*[\p{L}\p{N}])?$
tracking_urlstring (uri) или nullСтраница отслеживания у службы, http или https; null или без поля — ссылки нет.
- Макс. длина:
- 500
carrier_namestring или nullНазвание службы, как его увидит покупатель: «Correo Argentino», «OCA»; null или без поля — без названия.
- Макс. длина:
- 100
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
application/json
Возвращает Order
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 409
shipment_in_progressВыпуск отправления уже идёт - 409
shipment_tracking_refusedНомер отслеживания вручную не записать - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/orders/{order}/shipment/tracking" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"tracking_number": "string",
"tracking_url": "string",
"carrier_name": "string"
}{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Снять номер отслеживания, записанный вручную
post/orders/{order}/shipment/tracking/clear
Scope: orders:write
Параметры
Путь
orderintegerобязательноID заказа.
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
application/json
Возвращает Order
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 409
shipment_in_progressВыпуск отправления уже идёт - 409
shipment_tracking_refusedНомер отслеживания вручную не записать - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/orders/{order}/shipment/tracking/clear" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}