К содержимому
Инвойсбокс
put/v3/billing/api/order/order/{id}

Заказ меняется, пока не оплачен:

  • метод: PUT
  • ресурс: /v3/billing/api/order/order/:uuid - где :uuid это идентификатор заказа
  • тело запроса - объект UpdateOrderRequest
  • тело ответа - объект OrderResponse
Пример запроса и ответа
PUT /v3/billing/api/order/order/019fc671-6d37-77e0-6080-fec092bf521f
Authorization: Bearer b37c4c689295904ed21eee5d9a48d42e
Content-Type: application/json
User-Agent: MyApp 1.0
Accept: application/json

{
  "amount": 15000,
  "vatAmount": 0,
  "basketItems": [
    {
      "sku": "5fe0adcfa7fb4",
      "name": "Бронирование номера, продление на сутки",
      "measure": "шт.",
      "measureCode": "796",
      "quantity": 1,
      "amount": 15000,
      "amountWoVat": 15000,
      "totalAmount": 15000,
      "totalVatAmount": 0,
      "vatCode": "RUS_VAT0",
      "type": "service",
      "paymentType": "full_prepayment"
    }
  ]
}

Суммы заказа и корзины обязаны сходиться — правило описано в разделе как считаются суммы.

Ответ:

{
  "id": "019fc671-6d37-77e0-6080-fec092bf521f",
  "description": "Оплата бронирования № 4412",
  "currencyId": "RUB",
  "amount": 12000,
  "vatAmount": 0,
  "basketItems": [
    {
      "sku": "room-deluxe",
      "name": "Проживание в номере «Делюкс», 2 ночи",
      "measure": "шт",
      "measureCode": "796",
      "quantity": 1,
      "amount": 12000,
      "amountWoVat": 12000,
      "totalAmount": 12000,
      "totalVatAmount": 0,
      "vatCode": "RUS_VAT0",
      "type": "service",
      "paymentType": "full_prepayment"
    }
  ],
  "merchantId": "ffffffff-ffff-ffff-ffff-ffffffffffff",
  "status": "created",
  "shipmentStatus": "unshipped",
  "subtype": "order",
  "createdAt": "2026-08-03T07:05:50+00:00",
  "merchantOrderId": "portal-6c2fcf273e55-docs-example-1785740749696",
  "merchantOrderIdVisible": "portal-6c2fcf273e55-docs-example-1785740749696",
  "expirationDate": "2026-08-04T07:05:49+00:00",
  "internalProperty": {},
  "tags": [
    "agent"
  ],
  "sourceId": "v3",
  "returnUrl": "https://shop.example.com/order/4412?result=return",
  "successUrl": "https://shop.example.com/order/4412?result=success",
  "failUrl": "https://shop.example.com/order/4412?result=fail",
  "paymentUrl": "https://pay.invoicebox.ru/order/019fc671-6c80-eed3-ce48-9bb53f679353",
  "paymentPageUrl": "https://pay.invoicebox.ru/order/019fc671-6c80-eed3-ce48-9bb53f679353",
  "customer": {
    "type": "legal",
    "name": "ООО «Ромашка»",
    "phone": "79001112233",
    "email": "buh@example.invbox.ru",
    "countryId": "RUS"
  },
  "languageId": "ru",
  "processable": true,
  "orderContainerId": "019fc671-6c80-eed3-ce48-9bb53f679353"
}

UpdateOrderRequest

СвойствоТипОписаниеПример значения
descriptionstringОписание заказаОплата номера в отеле
amountfloatСумма заказа19658.45
vatAmountfloatСумма НДС156.56
expirationDatedatetimeСрок действия заказа2026-12-22T00:00:00+00:00
basketItemsarray of BasketItemКорзина заказа
metaDataobjectДополнительные данные заказа
customerCustomerИнформация о заказчике
shopIdstring(36)Идентификатор связанного магазина/маркетплейса06581534-196a-1105-839a-82422289d6d9

Параметры запроса — PUT

9 обязательных из 59
ПолеТипОписание
description#string≤ 1000 символов
amount#numberот 0Денежное значение: ровно два знака после точки. В коде считайте Decimal/BigDecimal, не двоичным float
vatAmount#numberот 0Денежное значение: ровно два знака после точки. В коде считайте Decimal/BigDecimal, не двоичным float
basketItems#BillingProviderDomainOrderEntityBasketItemApiUpdateCollection
sku *#string | integer | null≤ 36 символов
name *#string≤ 300 символов
groupName#string | null≤ 500 символов
measureCode#string | null
originCountry#string | null
originCountryCode#string | null
grossWeight#number | null
netWeight#number | null
quantity *#number
amount *#numberДенежное значение: ровно два знака после точки. В коде считайте Decimal/BigDecimal, не двоичным float
amountWoVat *#numberДенежное значение: ровно два знака после точки. В коде считайте Decimal/BigDecimal, не двоичным float
totalAmount *#numberДенежное значение: ровно два знака после точки. В коде считайте Decimal/BigDecimal, не двоичным float
totalVatAmount *#numberДенежное значение: ровно два знака после точки. В коде считайте Decimal/BigDecimal, не двоичным float
vatCode *#stringRUS_VAT22RUS_VAT20RUS_VAT10RUS_VAT7RUS_VAT5RUS_VAT0
type *#string | integer | null
gtdNumber#string | null≤ 23 символов
paymentType#string | nullfull_prepaymentprepaymentadvancefull_payment
excise#number | nullот 0
metaData#ArrayMap | null
tnved#string | null
rnpt#string | null
gtin#string | null
category#string | null
categoryType#string | null
serviceDate#string | nulldate-time
expirationDate#string | nulldate-time
metaData#ArrayMap | null
parentId#string
returnUrl#string | null
successUrl#string | null
failUrl#string | null
customer#BillingProviderDomainOrderEntityCustomerApiUpdate | null
type#string≤ 50 символов
name#string≤ 255 символов
phone#string≤ 50 символов
email#string≤ 255 символов
vatNumber#string≤ 50 символов
countryId#string≤ 50 символов
registrationAddress#string≤ 1000 символов
taxRegistrationReasonCode#string≤ 50 символов
languageId#string | nullruen
contactId#integer | null
contactCounterpartyId#integer | null
invoiceSetting#BillingProviderDomainOrderEntityInvoiceSettingApiUpdate
customerLocked#boolean
customerLockedFields#ArrayMap
customerHiddenFields#ArrayMap
paymentMethodIdLocked#boolean
paymentMethodId#integer
savePaymentData#boolean
clientId#string
paymentToken#string
paymentMethodCode#string
paymentMethodAutosubmit#boolean
bankDetailId#integer
Страница помогла?
putРедактирование состава заказаДемо
curl -X PUT 'https://api.invoicebox.ru/v3/billing/api/order/order/<id>' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0' \
  -d '{
  "amount": 15000,
  "vatAmount": 0,
  "description": "Оплата бронирования № 4412, продление на ночь",
  "basketItems": [
    {
      "sku": "room-deluxe",
      "name": "Проживание в номере «Делюкс», 3 ночи",
      "measure": "шт",
      "measureCode": "796",
      "quantity": 1,
      "amount": 15000,
      "amountWoVat": 15000,
      "totalAmount": 15000,
      "totalVatAmount": 0,
      "vatCode": "RUS_VAT0",
      "type": "service",
      "paymentType": "full_prepayment"
    }
  ]
}'
getПолучение информации о заказе по его идентификаторуДемо
curl -X GET 'https://api.invoicebox.ru/v3/billing/api/order/order/<id>' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0'
deleteОтмена заказаДемо
curl -X DELETE 'https://api.invoicebox.ru/v3/billing/api/order/order/<id>' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0'