Схеми даних: Складські залишки

location_codeРядокОбов’язкове

Код місця зберігання на складі.

Приклад: "example"

location_idРядокОбов’язкове

Ідентифікатор місця зберігання на складі.

Приклад: "example"

location_nameРядокОбов’язкове

Назва місця зберігання на складі.

Приклад: "example"

on_handЦіле числоОбов’язкове

Фізична кількість на складі.

Приклад: 10

Додаткові поля: Ні

dataCodeContentData Обов’язкове

Дані успішної відповіді.

Приклад: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Обов’язкове

Метадані відповіді.

Приклад: {"request_id":"example-request"}

Додаткові поля: Ні

dataDigitalUploadData Обов’язкове

Дані успішної відповіді.

Приклад: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Обов’язкове

Метадані відповіді.

Приклад: {"request_id":"example-request"}

Додаткові поля: Ні

dataImportData Обов’язкове

Дані успішної відповіді.

Приклад: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Обов’язкове

Метадані відповіді.

Приклад: {"request_id":"example-request"}

Додаткові поля: Ні

dataМасив <StockData > Обов’язкове

Приклад відповіді · ApiResponse_list_StockData__.

Приклад: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Обов’язкове

Метадані відповіді.

Приклад: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Додаткові поля: Ні

dataPoolData Обов’язкове

Дані успішної відповіді.

Приклад: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Обов’язкове

Метадані відповіді.

Приклад: {"request_id":"example-request"}

Додаткові поля: Ні

dataStockDetailData Обов’язкове

Приклад відповіді · StockDetailData.

Приклад: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Обов’язкове

Метадані відповіді.

Приклад: {"request_id":"example"}

Додаткові поля: Ні

dataUnitsData Обов’язкове

Дані успішної відповіді.

Приклад: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Обов’язкове

Метадані відповіді.

Приклад: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Додаткові поля: Ні

codeРядокОбов’язкове

Точний текст цифрового коду. Зберігайте регістр і внутрішні пробіли.

minLength: 1maxLength: 512

Приклад: "DEMO-ONE"

delivery_idРядок | nullНеобов’язкове

ID постачання або видачі замовлення.

Рядок:format: "uuid"

Приклад: null

kindРядокНеобов’язкове

Різновид структури даних, визначений допустимими значеннями.

const: "code"

За замовчуванням: "code"Приклад: "code"

payload_idРядокОбов’язкове

ID вмісту; не є публічним URL завантаження.

format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000004"

unit_idРядокОбов’язкове

ID одного індивідуального коду або файлу.

format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000003"

Додаткові поля: Ні

consumer_idРядокОбов’язкове

ID пов’язаного імпорту або одиниці.

format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000001"

consumer_kindРядокОбов’язкове

Призначення завантаження: digital_import / digital_unit.

Обмеження

enum

["digital_import", "digital_unit"]

Приклад: "digital_import"

filenameРядокОбов’язкове

Файл

minLength: 1maxLength: 255

Приклад: "codes.txt"

purposeРядокОбов’язкове

digital_import: TXT/CSV; digital_unit: файл, що продається окремо.

Обмеження

enum

["digital_unit", "digital_import"]

Приклад: "digital_import"

sha256РядокОбов’язкове

SHA-256 (hex, 64)

Обмеження

pattern

"^[0-9a-f]{64}$"

Приклад: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesЦіле числоОбов’язкове

Розмір у байтах

minimum: 1maximum: 262144000

Приклад: 18

Додаткові поля: Ні

consumer_idРядокОбов’язкове

ID пов’язаного імпорту або одиниці.

format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000001"

consumer_kindРядокОбов’язкове

Призначення завантаження: digital_import / digital_unit.

Обмеження

enum

["digital_import", "digital_unit"]

Приклад: "digital_import"

expires_atРядокОбов’язкове

Строк дії цього завантаження або імпорту.

format: "date-time"

Приклад: "2026-11-03T13:00:00Z"

filenameРядокОбов’язкове

Файл

Приклад: "codes.txt"

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000002"

product_idРядокОбов’язкове

Ідентифікатор товару.

Приклад: "example"

purposeРядокОбов’язкове

digital_import: TXT/CSV; digital_unit: файл, що продається окремо.

Обмеження

enum

["digital_unit", "digital_import"]

Приклад: "digital_import"

received_bytesЦіле числоОбов’язкове

Передавання… · Розмір у байтах

Приклад: 18

sha256РядокОбов’язкове

SHA-256 (hex, 64)

Приклад: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesЦіле числоОбов’язкове

Розмір у байтах

Приклад: 18

statusРядокОбов’язкове

Статус, допустимий для цієї конкретної операції.

Приклад: "ready"

Додаткові поля: Ні

delivered_atРядокОбов’язкове

Дата й час доставки.

format: "date-time"

Приклад: "2026-11-03T12:00:00Z"

expected_delivery_versionЦіле числоОбов’язкове

Версія постачання; 0 для нового постачання.

minimum: 0maximum: 0

Приклад: 0

expected_sales_limit_versionЦіле число | nullНеобов’язкове

Версія ліміту продажу; потрібна за publish_for_sale=true.

Ціле число:minimum: 0maximum: 9223372036854775807

Приклад: 0

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 2

location_idРядокОбов’язкове

Ідентифікатор місця зберігання на складі.

Обмеження

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

Приклад: "location-digital"

publish_for_saleЛогічне значенняНеобов’язкове

true також збільшує скінченний ліміт продажу; false його не змінює.

За замовчуванням: falseПриклад: true

statusРядокОбов’язкове

Статус, допустимий для цієї конкретної операції.

Обмеження

enum

["planned", "received"]

Приклад: "received"

validation_digestРядокОбов’язкове

Контрольна сума перевірки; передайте без змін для підтвердження.

Обмеження

pattern

"^[0-9a-f]{64}$"

Приклад: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idРядокОбов’язкове

Ідентифікатор складу.

Обмеження

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

Приклад: "warehouse-main"

Додаткові поля: Ні

countЦіле числоОбов’язкове

Точна кількість одиниць у партії.

minimum: 1maximum: 1000

Приклад: 2

kindРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження

enum

["code", "file"]

Приклад: "code"

Додаткові поля: Ні

delivery_idРядок | nullОбов’язкове

ID постачання або видачі замовлення.

Приклад: null

delivery_statusРядок | nullОбов’язкове

Стан постачання: planned / received; до підтвердження null.

Приклад: null

delivery_versionЦіле число | nullОбов’язкове

Поточна версія складського постачання.

Приклад: null

expected_countЦіле числоОбов’язкове

Очікувана кількість; приймається лише повна партія.

Приклад: 2

expires_atРядокОбов’язкове

Строк дії цього завантаження або імпорту.

format: "date-time"

Приклад: "2026-11-03T13:00:00Z"

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000001"

kindРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження

enum

["code", "file"]

Приклад: "code"

product_idРядокОбов’язкове

Ідентифікатор товару.

Приклад: "example"

statusРядокОбов’язкове

Статус, допустимий для цієї конкретної операції.

Приклад: "validated"

validated_countЦіле числоОбов’язкове

Одиниці, прийняті останньою успішною перевіркою.

Приклад: 2

validation_digestРядок | nullОбов’язкове

Контрольна сума перевірки; передайте без змін для підтвердження.

Приклад: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 2

Додаткові поля: Ні

expected_delivery_versionЦіле числоОбов’язкове

Версія постачання; 0 для нового постачання.

minimum: 1maximum: 9223372036854775807

Приклад: 1

expected_sales_limit_versionЦіле число | nullНеобов’язкове

Версія ліміту продажу; потрібна за publish_for_sale=true.

Ціле число:minimum: 0maximum: 9223372036854775807

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 3

publish_for_saleЛогічне значенняНеобов’язкове

true також збільшує скінченний ліміт продажу; false його не змінює.

За замовчуванням: false

Додаткові поля: Ні

code_columnРядок | nullНеобов’язкове

Стовпець CSV із кодами; використовуйте code.

Рядок:const: "code"

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 1

formatРядок | nullНеобов’язкове

Список кодів: txt / csv; для файлів використовуйте upload_ids.

Обмеження · Рядок 1

enum

["txt", "csv"]

Приклад: "txt"

source_upload_idРядок | nullНеобов’язкове

Готове приватне завантаження TXT/CSV цього імпорту.

Рядок:format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000002"

upload_idsМасив <Рядок> | nullНеобов’язкове

1–100 готових приватних завантажень файлів цього імпорту.

Масив:minItems: 1maxItems: 100

Масив / Масив:format: "uuid"

Додаткові поля: Ні

expected_delivery_versionЦіле числоОбов’язкове

Версія постачання; 0 для нового постачання.

minimum: 1maximum: 9223372036854775807

Приклад: 1

expected_order_versionЦіле числоОбов’язкове

Версія черговості видачі, а не замовлення покупця.

minimum: 0maximum: 9223372036854775807

Приклад: 1

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 3

reasonРядокОбов’язкове

Записана причина зміни.

minLength: 1maxLength: 500

Приклад: "Withdraw a revoked license"

Додаткові поля: Ні

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 1

manual_reservedЦіле числоОбов’язкове

Кількість, зарезервована вручну.

minimum: 0maximum: 2147483647

Приклад: 1

reasonРядокНеобов’язкове

Записана причина зміни.

maxLength: 500

За замовчуванням: ""

Додаткові поля: Ні

email_modeРядокНеобов’язкове

disabled: без листа; order_link: посилання на замовлення; code_text: можливі коди в тексті.

Обмеження

enum

["disabled", "order_link", "code_text"]

За замовчуванням: "disabled"Приклад: "order_link"

enabledЛогічне значенняОбов’язкове

Чи ввімкнено це налаштування.

Приклад: true

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 0maximum: 9223372036854775807

Приклад: 0

retention_daysЦіле число | nullНеобов’язкове

null: безстроково; 1–3650 днів від першого доступу. Коди автоматично не видаляються.

Ціле число:minimum: 1maximum: 3650

Приклад: null

Додаткові поля: Ні

availableЦіле числоОбов’язкове

Кількість вільних одиниць, які не зарезервовані й не видані.

Приклад: 1

heldЦіле числоОбов’язкове

Одиниці, зарезервовані для замовлень, але ще не видані.

Приклад: 0

issuedЦіле числоОбов’язкове

Одиниці, вже видані для оплачених покупок.

Приклад: 1

plannedЦіле числоОбов’язкове

Одиниці підтверджених, але ще не прийнятих постачань.

Приклад: 0

retiredЦіле числоОбов’язкове

Відкликані одиниці, збережені в історії.

Приклад: 0

stagedЦіле числоОбов’язкове

Одиниці незавершених імпортів, ще не складський запас.

Приклад: 0

Додаткові поля: Ні

configuredЛогічне значенняОбов’язкове

Чи збережені налаштування цифрового запасу.

Приклад: true

countsPoolCounts Обов’язкове

Кількість одиниць за станом запасу.

Приклад: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_modeРядокОбов’язкове

disabled: без листа; order_link: посилання на замовлення; code_text: можливі коди в тексті.

Обмеження

enum

["disabled", "order_link", "code_text"]

Приклад: "order_link"

enabledЛогічне значенняОбов’язкове

Чи ввімкнено це налаштування.

Приклад: true

order_versionЦіле числоОбов’язкове

Версія черговості видачі цифрового запасу.

Приклад: 2

product_idРядокОбов’язкове

Ідентифікатор товару.

Приклад: "example"

retention_daysЦіле число | nullОбов’язкове

null: безстроково; 1–3650 днів від першого доступу. Коди автоматично не видаляються.

Приклад: null

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1

Додаткові поля: Ні

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 1

reasonРядокНеобов’язкове

Записана причина зміни.

maxLength: 500

За замовчуванням: ""

sellable_limitЦіле числоОбов’язкове

Ліміт продажу: -1 означає відсутність ліміту, а 0 вимикає доступність продажу.

minimum: -1maximum: 2147483647

Приклад: 1

Додаткові поля: Ні

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 0maximum: 9223372036854775807

Приклад: 0

locationsМасив <LocationQuantity > Обов’язкове

Місця зберігання на складі.

minItems: 1maxItems: 100

Приклад: [{"location_id":"example","on_hand":1}]

reasonРядокОбов’язкове

Записана причина зміни.

minLength: 1maxLength: 500

Приклад: "Example"

target_idРядокОбов’язкове

Ідентифікатор товару або варіанта, якого стосується операція.

Обмеження

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

Приклад: "example"

target_typeРядокОбов’язкове

Чи стосується операція товару або варіанта.

Обмеження

enum

["product", "variant"]

Приклад: "product"

warehouse_idРядокОбов’язкове

Ідентифікатор складу.

Обмеження

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

Приклад: "example"

Додаткові поля: Ні

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 1

locationsМасив <LocationQuantity > Обов’язкове

Місця зберігання на складі.

minItems: 1maxItems: 100

Приклад: [{"location_id":"example","on_hand":1}]

reasonРядокОбов’язкове

Записана причина зміни.

minLength: 1maxLength: 500

Приклад: "Example"

Додаткові поля: Ні

activeЛогічне значенняОбов’язкове

Чи є ресурс активним.

Приклад: true

availableЦіле число | nullОбов’язкове

Кількість, доступна для продажу; null означає необмежену кількість.

Приклад: 5

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (StockData).

Приклад: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedЦіле числоОбов’язкове

Кількість, зарезервована вручну.

Приклад: 2

on_handЦіле числоОбов’язкове

Фізична кількість на складі.

Приклад: 10

reservedЦіле числоОбов’язкове

Кількість, зарезервована замовленнями.

Приклад: 3

sellable_limitЦіле числоОбов’язкове

Ліміт продажу: -1 означає відсутність ліміту, а 0 вимикає доступність продажу.

Приклад: 10

target_idРядокОбов’язкове

Ідентифікатор товару або варіанта, якого стосується операція.

Приклад: "example"

target_typeРядокОбов’язкове

Чи стосується операція товару або варіанта.

Обмеження

enum

["product", "variant"]

Приклад: "product"

total_reservedЦіле числоОбов’язкове

Загальна зарезервована кількість.

Приклад: 5

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1

warehouse_idРядокОбов’язкове

Ідентифікатор складу.

Приклад: "example"

Додаткові поля: Ні

activeЛогічне значенняОбов’язкове

Чи є ресурс активним.

Приклад: true

allocationsМасив <AllocationData > Обов’язкове

Кількості, розподілені між місцями зберігання на складі.

Приклад: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableЦіле число | nullОбов’язкове

Кількість, доступна для продажу; null означає необмежену кількість.

Приклад: 5

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (StockDetailData).

Приклад: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedЦіле числоОбов’язкове

Кількість, зарезервована вручну.

Приклад: 2

on_handЦіле числоОбов’язкове

Фізична кількість на складі.

Приклад: 10

reservedЦіле числоОбов’язкове

Кількість, зарезервована замовленнями.

Приклад: 3

sellable_limitЦіле числоОбов’язкове

Ліміт продажу: -1 означає відсутність ліміту, а 0 вимикає доступність продажу.

Приклад: 10

target_idРядокОбов’язкове

Ідентифікатор товару або варіанта, якого стосується операція.

Приклад: "example"

target_typeРядокОбов’язкове

Чи стосується операція товару або варіанта.

Обмеження

enum

["product", "variant"]

Приклад: "product"

total_reservedЦіле числоОбов’язкове

Загальна зарезервована кількість.

Приклад: 5

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1

warehouse_idРядокОбов’язкове

Ідентифікатор складу.

Приклад: "example"

Додаткові поля: Ні

content_stateРядокОбов’язкове

Стан вмісту: present / deleting / deleted.

Приклад: "present"

delivery_idРядок | nullОбов’язкове

ID постачання або видачі замовлення.

Приклад: "delivery-example"

filenameРядок | nullОбов’язкове

Файл

Приклад: null

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000003"

issued_atРядок | nullОбов’язкове

Час першої видачі; до неї null.

Рядок:format: "date-time"

Приклад: null

kindРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження

enum

["file", "code"]

Приклад: "code"

location_idРядок | nullОбов’язкове

Ідентифікатор місця зберігання на складі.

Приклад: "location-digital"

mime_typeРядок | nullОбов’язкове

Тип вмісту медіафайлу.

Приклад: null

payload_idРядокОбов’язкове

ID вмісту; не є публічним URL завантаження.

format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000004"

product_idРядокОбов’язкове

Ідентифікатор товару.

Приклад: "example"

size_bytesЦіле число | nullОбов’язкове

Розмір у байтах

Приклад: null

sort_orderЦіле числоОбов’язкове

Позиція у впорядкованому списку.

Приклад: 1

stateРядокОбов’язкове

Статус

Приклад: "available"

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1

warehouse_idРядок | nullОбов’язкове

Ідентифікатор складу.

Приклад: "warehouse-main"

Додаткові поля: Ні

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1

Приклад: 1

reasonРядокОбов’язкове

Записана причина зміни.

minLength: 1maxLength: 500

Приклад: "Withdraw a revoked license"

Додаткові поля: Ні

expected_order_versionЦіле числоОбов’язкове

Версія черговості видачі, а не замовлення покупця.

minimum: 1

Приклад: 1

unit_idsМасив <Рядок> Обов’язкове

Усі одиниці нефільтрованої сторінки в потрібному порядку.

minItems: 2maxItems: 100

Масив:format: "uuid"

Приклад: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]

window_cursorРядок | nullНеобов’язкове

Курсор нефільтрованої сторінки; null для першої.

Рядок:maxLength: 1024

Додаткові поля: Ні

codeРядок | nullНеобов’язкове

Точний текст цифрового коду. Зберігайте регістр і внутрішні пробіли.

Рядок:minLength: 1maxLength: 512

Приклад: "SYNTHETIC-REPLACEMENT"

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1

Приклад: 1

reasonРядокОбов’язкове

Записана причина зміни.

minLength: 1maxLength: 500

Приклад: "Replace an invalid activation code"

upload_idРядок | nullНеобов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. · upload_id

Рядок:format: "uuid"

Додаткові поля: Ні

order_versionЦіле числоОбов’язкове

Версія черговості видачі цифрового запасу.

Приклад: 2

totalЦіле числоОбов’язкове

Загальна сума.

Приклад: 1

unitsМасив <UnitData > Обов’язкове

Метадані одиниць; для вмісту потрібен окремий авторизований запит.

Приклад: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

Додаткові поля: Так