Схеми на данните
Количества, разпределени по складови места
AllocationData · Схема · Схеми на данните: Складови наличности
location_codeНизЗадължителноКод на складовото място.
location_idНизЗадължителноИдентификатор на складовото място.
location_nameНизЗадължителноИме на складовото място.
on_handЦяло числоЗадължителноФизическо складово количество.
Допълнителни полета: Не
ApiResponse[CodeContentData]
ApiResponse_CodeContentData_ · Кодът се връща като JSON, файлът — като двоични данни. Всяка заявка изисква Bearer и право reveal.
dataCodeContentDataЗадължителноДанни на успешния отговор.
metaContextPageMetaContextMetaPageMetaRequestMetaЗадължителноМетаданни на отговора.
Допълнителни полета: Не
ApiResponse[DigitalUploadData]
ApiResponse_DigitalUploadData_ · Провери размера, контролната сума и формата. Завършено качване още не означава приета доставка.
dataDigitalUploadDataЗадължителноДанни на успешния отговор.
metaContextPageMetaContextMetaPageMetaRequestMetaЗадължителноМетаданни на отговора.
Допълнителни полета: Не
ApiResponse[ImportData]
ApiResponse_ImportData_ · Провери състоянието, версията и валидацията. Черновата принадлежи на API ключа, който я е създал.
dataImportDataЗадължителноДанни на успешния отговор.
metaContextPageMetaContextMetaPageMetaRequestMetaЗадължителноМетаданни на отговора.
Допълнителни полета: Не
Списък · Наличности — Складови наличности — Отговор
ApiResponse_list_StockData__ · Полета, типове и ограничения на данните, приемани или връщани от API.
dataМасив <StockData> ЗадължителноПримерен отговор · ApiResponse_list_StockData__.
metaContextPageMetaContextMetaPageMetaRequestMetaЗадължителноМетаданни на отговора.
Допълнителни полета: Не
ApiResponse[PoolData]
ApiResponse_PoolData_ · Прочети настройките и количествата преди промяна. Отговорът не съдържа кодове или файлово съдържание.
dataPoolDataЗадължителноДанни на успешния отговор.
metaContextPageMetaContextMetaPageMetaRequestMetaЗадължителноМетаданни на отговора.
Допълнителни полета: Не
Получаване · Наличности — Складови наличности — Отговор
ApiResponse_StockDetailData_ · Полета, типове и ограничения на данните, приемани или връщани от API.
dataStockDetailDataЗадължителноПримерен отговор · StockDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaЗадължителноМетаданни на отговора.
Допълнителни полета: Не
ApiResponse[UnitsData]
ApiResponse_UnitsData_ · Прочети до 100 единици на страница. Списъкът показва метаданни, без да разкрива кодове.
dataUnitsDataЗадължителноДанни на успешния отговор.
metaContextPageMetaContextMetaPageMetaRequestMetaЗадължителноМетаданни на отговора.
Допълнителни полета: Не
CodeContentData
CodeContentData · Кодът се връща като JSON, файлът — като двоични данни. Всяка заявка изисква Bearer и право reveal.
codeНизЗадължителноТочното съдържание на цифровия код. Запазете регистъра и вътрешните интервали.
minLength:1maxLength:512delivery_idНиз nullНезадължителноID на доставката или предоставянето по поръчка.
Низ:format:"uuid"kindНизНезадължителноВариант на структурата от данни, определен от допустимите стойности.
const:"code"payload_idНизЗадължителноID на съдържанието; не е публичен адрес за изтегляне.
format:"uuid"unit_idНизЗадължителноID на един индивидуален код или файл.
format:"uuid"
Допълнителни полета: Не
DigitalUploadCreate
DigitalUploadCreate · Резервирай място за файл и го свържи с импорт или единица за замяна.
consumer_idНизЗадължителноID на свързания импорт или единица.
format:"uuid"consumer_kindНизЗадължителноВръзка на качването: digital_import / digital_unit.
Ограничения
enum["digital_import", "digital_unit"]
filenameНизЗадължителноФайл
minLength:1maxLength:255purposeНизЗадължителноdigital_import: TXT/CSV; digital_unit: файл, продаван поотделно.
Ограничения
enum["digital_unit", "digital_import"]
sha256НизЗадължителноSHA-256 (hex, 64)
Ограничения
pattern"^[0-9a-f]{64}$"
size_bytesЦяло числоЗадължителноРазмер в байтове
minimum:1maximum:262144000
Допълнителни полета: Не
DigitalUploadData
DigitalUploadData · Провери размера, контролната сума и формата. Завършено качване още не означава приета доставка.
consumer_idНизЗадължителноID на свързания импорт или единица.
format:"uuid"consumer_kindНизЗадължителноВръзка на качването: digital_import / digital_unit.
Ограничения
enum["digital_import", "digital_unit"]
expires_atНизЗадължителноСрокът на валидност на това качване или импорт.
format:"date-time"filenameНизЗадължителноФайл
idНизЗадължителноИдентификатор на ресурса; запазете го във върнатия вид.
format:"uuid"product_idНизЗадължителноИдентификатор на продукта.
purposeНизЗадължителноdigital_import: TXT/CSV; digital_unit: файл, продаван поотделно.
Ограничения
enum["digital_unit", "digital_import"]
received_bytesЦяло числоЗадължителноКачване… · Размер в байтове
sha256НизЗадължителноSHA-256 (hex, 64)
size_bytesЦяло числоЗадължителноРазмер в байтове
statusНизЗадължителноСтатус, приеман от тази конкретна операция.
Допълнителни полета: Не
ImportCommit
ImportCommit · Създай планирана или получена доставка от проверената партида. Планираните единици още не се продават.
delivered_atНизЗадължителноДата и час на доставяне.
format:"date-time"expected_delivery_versionЦяло числоЗадължителноВерсия на доставката; 0 за нова доставка.
minimum:0maximum:0expected_sales_limit_versionЦяло число nullНезадължителноВерсия на лимита за продажба; нужна при publish_for_sale=true.
Цяло число:minimum:0maximum:9223372036854775807expected_versionЦяло числоЗадължителноВерсията, прочетена преди записа; несъответствие отхвърля актуализацията.
minimum:1maximum:9223372036854775807location_idНизЗадължителноИдентификатор на складовото място.
Ограничения
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
publish_for_saleБулева стойностНезадължителноtrue увеличава и крайния лимит за продажба; false не го променя.
statusНизЗадължителноСтатус, приеман от тази конкретна операция.
Ограничения
enum["planned", "received"]
validation_digestНизЗадължителноКонтролна сума на проверката; изпрати непроменена при потвърждение.
Ограничения
pattern"^[0-9a-f]{64}$"
warehouse_idНизЗадължителноИдентификатор на склада.
Ограничения
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Допълнителни полета: Не
ImportCreate
ImportCreate · Подготви чернова с до 1000 кода или 100 файла. Запасът за продажба още не се увеличава.
countЦяло числоЗадължителноТочен брой единици в партидата.
minimum:1maximum:1000kindНизЗадължителноВариант на структурата от данни, определен от допустимите стойности.
Ограничения
enum["code", "file"]
Допълнителни полета: Не
ImportData
ImportData · Провери състоянието, версията и валидацията. Черновата принадлежи на API ключа, който я е създал.
delivery_idНиз nullЗадължителноID на доставката или предоставянето по поръчка.
delivery_statusНиз nullЗадължителноСъстояние на доставка: planned / received; преди потвърждение null.
delivery_versionЦяло число nullЗадължителноТекуща версия на складовата доставка.
expected_countЦяло числоЗадължителноОчакван брой; приема се само цялата партида.
expires_atНизЗадължителноСрокът на валидност на това качване или импорт.
format:"date-time"idНизЗадължителноИдентификатор на ресурса; запазете го във върнатия вид.
format:"uuid"kindНизЗадължителноВариант на структурата от данни, определен от допустимите стойности.
Ограничения
enum["code", "file"]
product_idНизЗадължителноИдентификатор на продукта.
statusНизЗадължителноСтатус, приеман от тази конкретна операция.
validated_countЦяло числоЗадължителноБрой единици, приети при последната успешна проверка.
validation_digestНиз nullЗадължителноКонтролна сума на проверката; изпрати непроменена при потвърждение.
versionЦяло числоЗадължителноВерсия на ресурса за контрол на едновременни записи.
Допълнителни полета: Не
ImportReceive
ImportReceive · Приеми съществуващите единици без повторен импорт на кодове или файлове.
expected_delivery_versionЦяло числоЗадължителноВерсия на доставката; 0 за нова доставка.
minimum:1maximum:9223372036854775807expected_sales_limit_versionЦяло число nullНезадължителноВерсия на лимита за продажба; нужна при publish_for_sale=true.
Цяло число:minimum:0maximum:9223372036854775807expected_versionЦяло числоЗадължителноВерсията, прочетена преди записа; несъответствие отхвърля актуализацията.
minimum:1maximum:9223372036854775807publish_for_saleБулева стойностНезадължителноtrue увеличава и крайния лимит за продажба; false не го променя.
Допълнителни полета: Не
ImportValidate
ImportValidate · Провери цялата партида. Дубликат или невалиден запис отхвърля партидата; кодовете не се съкращават.
code_columnНиз nullНезадължителноCSV колона с кодове; използвай code.
Низ:const:"code"expected_versionЦяло числоЗадължителноВерсията, прочетена преди записа; несъответствие отхвърля актуализацията.
minimum:1maximum:9223372036854775807formatНиз nullНезадължителноСписък с кодове: txt / csv; за файлове използвай upload_ids.
Ограничения · Низ 1
enum["txt", "csv"]
source_upload_idНиз nullНезадължителноГотово частно TXT/CSV качване на този импорт.
Низ:format:"uuid"upload_idsМасив <Низ> nullНезадължително1–100 готови частни качвания на файлове от този импорт.
Масив:minItems:1maxItems:100Масив / Масив:format:"uuid"
Допълнителни полета: Не
ImportWithdrawal
ImportWithdrawal · Изтегли само свободните единици. Резервираните и предоставените остават свързани с поръчките.
expected_delivery_versionЦяло числоЗадължителноВерсия на доставката; 0 за нова доставка.
minimum:1maximum:9223372036854775807expected_order_versionЦяло числоЗадължителноВерсия на реда за предоставяне, не на клиентската поръчка.
minimum:0maximum:9223372036854775807expected_versionЦяло числоЗадължителноВерсията, прочетена преди записа; несъответствие отхвърля актуализацията.
minimum:1maximum:9223372036854775807reasonНизЗадължителноЗаписана причина за промяната.
minLength:1maxLength:500
Допълнителни полета: Не
Промяна · Ръчна резервация — Складови наличности — Тяло на заявката
ManualReservationUpdate · Полета, типове и ограничения на данните, приемани или връщани от API.
expected_versionЦяло числоЗадължителноВерсията, прочетена преди записа; несъответствие отхвърля актуализацията.
minimum:1maximum:9223372036854775807manual_reservedЦяло числоЗадължителноРъчно резервирано количество.
minimum:0maximum:2147483647reasonНизНезадължителноЗаписана причина за промяната.
maxLength:500
Допълнителни полета: Не
PoolChange
PoolChange · Включи индивидуални кодове или файлове от Professional. Изключването запазва достъпа до предишни покупки.
email_modeНизНезадължителноdisabled: без имейл; order_link: връзка към поръчката; code_text: възможни и кодове.
Ограничения
enum["disabled", "order_link", "code_text"]
enabledБулева стойностЗадължителноДали тази настройка е включена.
expected_versionЦяло числоЗадължителноВерсията, прочетена преди записа; несъответствие отхвърля актуализацията.
minimum:0maximum:9223372036854775807retention_daysЦяло число nullНезадължителноnull: без срок; 1–3650 дни от първия достъп. Кодовете не се изтриват автоматично.
Цяло число:minimum:1maximum:3650
Допълнителни полета: Не
PoolCounts
PoolCounts · Прочети настройките и количествата преди промяна. Отговорът не съдържа кодове или файлово съдържание.
availableЦяло числоЗадължителноБрой свободни единици, които не са резервирани или предоставени.
heldЦяло числоЗадължителноЕдиници, резервирани за поръчки, още непредоставени.
issuedЦяло числоЗадължителноЕдиници, вече предоставени за платени покупки.
plannedЦяло числоЗадължителноЕдиници на потвърдени, още неприети доставки.
retiredЦяло числоЗадължителноИзтеглени единици, запазени в историята.
stagedЦяло числоЗадължителноЕдиници на незавършени импорти, още не са запас.
Допълнителни полета: Не
PoolData
PoolData · Прочети настройките и количествата преди промяна. Отговорът не съдържа кодове или файлово съдържание.
configuredБулева стойностЗадължителноДали настройките на цифровия запас са записани.
countsPoolCountsЗадължителноБрой единици по състояние на запаса.
email_modeНизЗадължителноdisabled: без имейл; order_link: връзка към поръчката; code_text: възможни и кодове.
Ограничения
enum["disabled", "order_link", "code_text"]
enabledБулева стойностЗадължителноДали тази настройка е включена.
order_versionЦяло числоЗадължителноВерсия на реда за предоставяне на запаса.
product_idНизЗадължителноИдентификатор на продукта.
retention_daysЦяло число nullЗадължителноnull: без срок; 1–3650 дни от първия достъп. Кодовете не се изтриват автоматично.
versionЦяло числоЗадължителноВерсия на ресурса за контрол на едновременни записи.
Допълнителни полета: Не
Промяна · Лимит на продажбите — Складови наличности — Тяло на заявката
SalesLimitUpdate · Полета, типове и ограничения на данните, приемани или връщани от API.
expected_versionЦяло числоЗадължителноВерсията, прочетена преди записа; несъответствие отхвърля актуализацията.
minimum:1maximum:9223372036854775807reasonНизНезадължителноЗаписана причина за промяната.
maxLength:500sellable_limitЦяло числоЗадължителноЛимит на продажбите: -1 означава неограничено, а 0 спира наличните продажби.
minimum:-1maximum:2147483647
Допълнителни полета: Не
Създаване · Корекция на наличност — Складови наличности — Тяло на заявката
StockAdjustmentCreate · Полета, типове и ограничения на данните, приемани или връщани от API.
expected_versionЦяло числоЗадължителноВерсията, прочетена преди записа; несъответствие отхвърля актуализацията.
minimum:0maximum:9223372036854775807locationsМасив <LocationQuantity> ЗадължителноСкладови места.
minItems:1maxItems:100reasonНизЗадължителноЗаписана причина за промяната.
minLength:1maxLength:500target_idНизЗадължителноИдентификатор на продукта или варианта, засегнат от операцията.
Ограничения
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
target_typeНизЗадължителноДали операцията се отнася за продукт или вариант.
Ограничения
enum["product", "variant"]
warehouse_idНизЗадължителноИдентификатор на склада.
Ограничения
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Допълнителни полета: Не
Промяна · Наличности — Складови наличности — Тяло на заявката
StockAdjustmentUpdate · Полета, типове и ограничения на данните, приемани или връщани от API.
expected_versionЦяло числоЗадължителноВерсията, прочетена преди записа; несъответствие отхвърля актуализацията.
minimum:1maximum:9223372036854775807locationsМасив <LocationQuantity> ЗадължителноСкладови места.
minItems:1maxItems:100reasonНизЗадължителноЗаписана причина за промяната.
minLength:1maxLength:500
Допълнителни полета: Не
Списък · Наличности — Складови наличности — Отговор
StockData · Полета, типове и ограничения на данните, приемани или връщани от API.
activeБулева стойностЗадължителноДали ресурсът е активен.
availableЦяло число nullЗадължителноКоличество, налично за продажба; null означава неограничено количество.
idНизЗадължителноИдентификатор на ресурса; запазете го във върнатия вид. (StockData).
manual_reservedЦяло числоЗадължителноРъчно резервирано количество.
on_handЦяло числоЗадължителноФизическо складово количество.
reservedЦяло числоЗадължителноКоличество, резервирано от поръчки.
sellable_limitЦяло числоЗадължителноЛимит на продажбите: -1 означава неограничено, а 0 спира наличните продажби.
target_idНизЗадължителноИдентификатор на продукта или варианта, засегнат от операцията.
target_typeНизЗадължителноДали операцията се отнася за продукт или вариант.
Ограничения
enum["product", "variant"]
total_reservedЦяло числоЗадължителноОбщо резервирано количество.
updated_atНизЗадължителноВреме на последната актуализация.
format:"date-time"versionЦяло числоЗадължителноВерсия на ресурса за контрол на едновременни записи.
warehouse_idНизЗадължителноИдентификатор на склада.
Допълнителни полета: Не
Получаване · Наличности — Складови наличности — Отговор
StockDetailData · Полета, типове и ограничения на данните, приемани или връщани от API.
activeБулева стойностЗадължителноДали ресурсът е активен.
allocationsМасив <AllocationData> ЗадължителноКоличества, разпределени по складови места.
availableЦяло число nullЗадължителноКоличество, налично за продажба; null означава неограничено количество.
idНизЗадължителноИдентификатор на ресурса; запазете го във върнатия вид. (StockDetailData).
manual_reservedЦяло числоЗадължителноРъчно резервирано количество.
on_handЦяло числоЗадължителноФизическо складово количество.
reservedЦяло числоЗадължителноКоличество, резервирано от поръчки.
sellable_limitЦяло числоЗадължителноЛимит на продажбите: -1 означава неограничено, а 0 спира наличните продажби.
target_idНизЗадължителноИдентификатор на продукта или варианта, засегнат от операцията.
target_typeНизЗадължителноДали операцията се отнася за продукт или вариант.
Ограничения
enum["product", "variant"]
total_reservedЦяло числоЗадължителноОбщо резервирано количество.
updated_atНизЗадължителноВреме на последната актуализация.
format:"date-time"versionЦяло числоЗадължителноВерсия на ресурса за контрол на едновременни записи.
warehouse_idНизЗадължителноИдентификатор на склада.
Допълнителни полета: Не
UnitData
UnitData · Прочети до 100 единици на страница. Списъкът показва метаданни, без да разкрива кодове.
content_stateНизЗадължителноСъстояние на съдържанието: present / deleting / deleted.
delivery_idНиз nullЗадължителноID на доставката или предоставянето по поръчка.
filenameНиз nullЗадължителноФайл
idНизЗадължителноИдентификатор на ресурса; запазете го във върнатия вид.
format:"uuid"issued_atНиз nullЗадължителноПърво предоставяне; преди него null.
Низ:format:"date-time"kindНизЗадължителноВариант на структурата от данни, определен от допустимите стойности.
Ограничения
enum["file", "code"]
location_idНиз nullЗадължителноИдентификатор на складовото място.
mime_typeНиз nullЗадължителноТип на медийното съдържание.
payload_idНизЗадължителноID на съдържанието; не е публичен адрес за изтегляне.
format:"uuid"product_idНизЗадължителноИдентификатор на продукта.
size_bytesЦяло число nullЗадължителноРазмер в байтове
sort_orderЦяло числоЗадължителноПозиция в подредената колекция.
stateНизЗадължителноСтатус
versionЦяло числоЗадължителноВерсия на ресурса за контрол на едновременни записи.
warehouse_idНиз nullЗадължителноИдентификатор на склада.
Допълнителни полета: Не
UnitDeletion
UnitDeletion · Премахни непродаден код или файл с причина. Резервирани или предоставени единици се отхвърлят.
expected_versionЦяло числоЗадължителноВерсията, прочетена преди записа; несъответствие отхвърля актуализацията.
minimum:1reasonНизЗадължителноЗаписана причина за промяната.
minLength:1maxLength:500
Допълнителни полета: Не
UnitReorder
UnitReorder · Изпрати цялата нефилтрирана страница в желания ред. Остаряла версия връща 409.
expected_order_versionЦяло числоЗадължителноВерсия на реда за предоставяне, не на клиентската поръчка.
minimum:1unit_idsМасив <Низ> ЗадължителноВсички единици от нефилтрираната страница в желания ред.
minItems:2maxItems:100Масив:format:"uuid"window_cursorНиз nullНезадължителноКурсор на нефилтрираната страница; null за първата страница.
Низ:maxLength:1024
Допълнителни полета: Не
UnitReplacement
UnitReplacement · Замени код или файл без промяна на реда. Промяната се запазва в складовата история.
codeНиз nullНезадължителноТочното съдържание на цифровия код. Запазете регистъра и вътрешните интервали.
Низ:minLength:1maxLength:512expected_versionЦяло числоЗадължителноВерсията, прочетена преди записа; несъответствие отхвърля актуализацията.
minimum:1reasonНизЗадължителноЗаписана причина за промяната.
minLength:1maxLength:500upload_idНиз nullНезадължителноИдентификатор на ресурса; запазете го във върнатия вид. · upload_id
Низ:format:"uuid"
Допълнителни полета: Не
UnitsData
UnitsData · Прочети до 100 единици на страница. Списъкът показва метаданни, без да разкрива кодове.
order_versionЦяло числоЗадължителноВерсия на реда за предоставяне на запаса.
totalЦяло числоЗадължителноОбща сума.
unitsМасив <UnitData> ЗадължителноМетаданни на единиците; съдържанието изисква отделна упълномощена заявка.
Допълнителни полета: Да