Преминете към съдържанието
ShopentlyLearn

Схеми на данните: Складови наличности

Схеми на данните: Складови наличности. Полета, типове и ограничения на данните, приемани или връщани от API.

Схеми на данните

Количества, разпределени по складови места

AllocationData · Схема · Схеми на данните: Складови наличности
location_codeНизЗадължително

Код на складовото място.

Пример: "example"
location_idНизЗадължително

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

Пример: "example"
location_nameНизЗадължително

Име на складовото място.

Пример: "example"
on_handЦяло числоЗадължително

Физическо складово количество.

Пример: 10

Допълнителни полета: Не

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Кодът се връща като JSON, файлът — като двоични данни. Всяка заявка изисква Bearer и право reveal.
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"}

Допълнителни полета: Не

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Провери размера, контролната сума и формата. Завършено качване още не означава приета доставка.
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"}

Допълнителни полета: Не

ApiResponse[ImportData]

ApiResponse_ImportData_ · Провери състоянието, версията и валидацията. Черновата принадлежи на API ключа, който я е създал.
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"}

Допълнителни полета: Не

Списък · Наличности — Складови наличности — Отговор

ApiResponse_list_StockData__ · Полета, типове и ограничения на данните, приемани или връщани от API.
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"}

Допълнителни полета: Не

ApiResponse[PoolData]

ApiResponse_PoolData_ · Прочети настройките и количествата преди промяна. Отговорът не съдържа кодове или файлово съдържание.
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"}

Допълнителни полета: Не

Получаване · Наличности — Складови наличности — Отговор

ApiResponse_StockDetailData_ · Полета, типове и ограничения на данните, приемани или връщани от API.
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"}

Допълнителни полета: Не

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Прочети до 100 единици на страница. Списъкът показва метаданни, без да разкрива кодове.
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"}

Допълнителни полета: Не

CodeContentData

CodeContentData · Кодът се връща като JSON, файлът — като двоични данни. Всяка заявка изисква Bearer и право reveal.
codeНизЗадължително

Точното съдържание на цифровия код. Запазете регистъра и вътрешните интервали.

minLength: 1maxLength: 512
Пример: "DEMO-ONE"
delivery_idНиз nullНезадължително

ID на доставката или предоставянето по поръчка.

Низ:format: "uuid"
Пример: null
kindНизНезадължително

Вариант на структурата от данни, определен от допустимите стойности.

const: "code"
По подразбиране: "code"Пример: "code"
payload_idНизЗадължително

ID на съдържанието; не е публичен адрес за изтегляне.

format: "uuid"
Пример: "00000000-0000-4000-8000-000000000004"
unit_idНизЗадължително

ID на един индивидуален код или файл.

format: "uuid"
Пример: "00000000-0000-4000-8000-000000000003"

Допълнителни полета: Не

DigitalUploadCreate

DigitalUploadCreate · Резервирай място за файл и го свържи с импорт или единица за замяна.
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

Допълнителни полета: Не

DigitalUploadData

DigitalUploadData · Провери размера, контролната сума и формата. Завършено качване още не означава приета доставка.
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"

Допълнителни полета: Не

ImportCommit

ImportCommit · Създай планирана или получена доставка от проверената партида. Планираните единици още не се продават.
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"

Допълнителни полета: Не

ImportCreate

ImportCreate · Подготви чернова с до 1000 кода или 100 файла. Запасът за продажба още не се увеличава.
countЦяло числоЗадължително

Точен брой единици в партидата.

minimum: 1maximum: 1000
Пример: 2
kindНизЗадължително

Вариант на структурата от данни, определен от допустимите стойности.

Ограничения
enum
["code", "file"]
Пример: "code"

Допълнителни полета: Не

ImportData

ImportData · Провери състоянието, версията и валидацията. Черновата принадлежи на API ключа, който я е създал.
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

Допълнителни полета: Не

ImportReceive

ImportReceive · Приеми съществуващите единици без повторен импорт на кодове или файлове.
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

Допълнителни полета: Не

ImportValidate

ImportValidate · Провери цялата партида. Дубликат или невалиден запис отхвърля партидата; кодовете не се съкращават.
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"

Допълнителни полета: Не

ImportWithdrawal

ImportWithdrawal · Изтегли само свободните единици. Резервираните и предоставените остават свързани с поръчките.
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"

Допълнителни полета: Не

Промяна · Ръчна резервация — Складови наличности — Тяло на заявката

ManualReservationUpdate · Полета, типове и ограничения на данните, приемани или връщани от API.
expected_versionЦяло числоЗадължително

Версията, прочетена преди записа; несъответствие отхвърля актуализацията.

minimum: 1maximum: 9223372036854775807
Пример: 1
manual_reservedЦяло числоЗадължително

Ръчно резервирано количество.

minimum: 0maximum: 2147483647
Пример: 1
reasonНизНезадължително

Записана причина за промяната.

maxLength: 500
По подразбиране: ""

Допълнителни полета: Не

PoolChange

PoolChange · Включи индивидуални кодове или файлове от Professional. Изключването запазва достъпа до предишни покупки.
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

Допълнителни полета: Не

PoolCounts

PoolCounts · Прочети настройките и количествата преди промяна. Отговорът не съдържа кодове или файлово съдържание.
availableЦяло числоЗадължително

Брой свободни единици, които не са резервирани или предоставени.

Пример: 1
heldЦяло числоЗадължително

Единици, резервирани за поръчки, още непредоставени.

Пример: 0
issuedЦяло числоЗадължително

Единици, вече предоставени за платени покупки.

Пример: 1
plannedЦяло числоЗадължително

Единици на потвърдени, още неприети доставки.

Пример: 0
retiredЦяло числоЗадължително

Изтеглени единици, запазени в историята.

Пример: 0
stagedЦяло числоЗадължително

Единици на незавършени импорти, още не са запас.

Пример: 0

Допълнителни полета: Не

PoolData

PoolData · Прочети настройките и количествата преди промяна. Отговорът не съдържа кодове или файлово съдържание.
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

Допълнителни полета: Не

Промяна · Лимит на продажбите — Складови наличности — Тяло на заявката

SalesLimitUpdate · Полета, типове и ограничения на данните, приемани или връщани от API.
expected_versionЦяло числоЗадължително

Версията, прочетена преди записа; несъответствие отхвърля актуализацията.

minimum: 1maximum: 9223372036854775807
Пример: 1
reasonНизНезадължително

Записана причина за промяната.

maxLength: 500
По подразбиране: ""
sellable_limitЦяло числоЗадължително

Лимит на продажбите: -1 означава неограничено, а 0 спира наличните продажби.

minimum: -1maximum: 2147483647
Пример: 1

Допълнителни полета: Не

Създаване · Корекция на наличност — Складови наличности — Тяло на заявката

StockAdjustmentCreate · Полета, типове и ограничения на данните, приемани или връщани от API.
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"

Допълнителни полета: Не

Промяна · Наличности — Складови наличности — Тяло на заявката

StockAdjustmentUpdate · Полета, типове и ограничения на данните, приемани или връщани от API.
expected_versionЦяло числоЗадължително

Версията, прочетена преди записа; несъответствие отхвърля актуализацията.

minimum: 1maximum: 9223372036854775807
Пример: 1
locationsМасив <LocationQuantity > Задължително

Складови места.

minItems: 1maxItems: 100
Пример: [{"location_id":"example","on_hand":1}]
reasonНизЗадължително

Записана причина за промяната.

minLength: 1maxLength: 500
Пример: "Example"

Допълнителни полета: Не

Списък · Наличности — Складови наличности — Отговор

StockData · Полета, типове и ограничения на данните, приемани или връщани от API.
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"

Допълнителни полета: Не

Получаване · Наличности — Складови наличности — Отговор

StockDetailData · Полета, типове и ограничения на данните, приемани или връщани от API.
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"

Допълнителни полета: Не

UnitData

UnitData · Прочети до 100 единици на страница. Списъкът показва метаданни, без да разкрива кодове.
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 на съдържанието; не е публичен адрес за изтегляне.

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"

Допълнителни полета: Не

UnitDeletion

UnitDeletion · Премахни непродаден код или файл с причина. Резервирани или предоставени единици се отхвърлят.
expected_versionЦяло числоЗадължително

Версията, прочетена преди записа; несъответствие отхвърля актуализацията.

minimum: 1
Пример: 1
reasonНизЗадължително

Записана причина за промяната.

minLength: 1maxLength: 500
Пример: "Withdraw a revoked license"

Допълнителни полета: Не

UnitReorder

UnitReorder · Изпрати цялата нефилтрирана страница в желания ред. Остаряла версия връща 409.
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

Допълнителни полета: Не

UnitReplacement

UnitReplacement · Замени код или файл без промяна на реда. Промяната се запазва в складовата история.
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"

Допълнителни полета: Не

UnitsData

UnitsData · Прочети до 100 единици на страница. Списъкът показва метаданни, без да разкрива кодове.
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"}]

Допълнителни полета: Да