Scheme de date: Stocuri

Scheme de date: Stocuri. Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

Scheme de date

Cantități alocate locațiilor din depozit

AllocationData · Schemă · Scheme de date: Stocuri

location_codeȘir de caractereObligatoriu: Codul locației din depozit.

Exemplu: "example"
location_idȘir de caractereObligatoriu: Identificatorul locației din depozit.

Exemplu: "example"
location_nameȘir de caractereObligatoriu: Numele locației din depozit.

Exemplu: "example"
on_handNumăr întregObligatoriu: Cantitatea fizică din stoc.

Exemplu: 10

Câmpuri suplimentare: Nu

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Codul este returnat ca JSON, fișierul ca date binare. Fiecare cerere necesită Bearer și permisiunea reveal.

dataCodeContentData Obligatoriu: Datele unui răspuns reușit.

Exemplu: {"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 Obligatoriu: Metadatele răspunsului.

Exemplu: {"request_id":"example-request"}

Câmpuri suplimentare: Nu

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Verifică dimensiunea, suma de control și formatul. O încărcare gata nu înseamnă o livrare recepționată.

dataDigitalUploadData Obligatoriu: Datele unui răspuns reușit.

Exemplu: {"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 Obligatoriu: Metadatele răspunsului.

Exemplu: {"request_id":"example-request"}

Câmpuri suplimentare: Nu

ApiResponse[ImportData]

ApiResponse_ImportData_ · Verifică starea, versiunea și validarea. Ciorna aparține cheii API care a creat-o.

dataImportData Obligatoriu: Datele unui răspuns reușit.

Exemplu: {"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 Obligatoriu: Metadatele răspunsului.

Exemplu: {"request_id":"example-request"}

Câmpuri suplimentare: Nu

Listează · Stocuri — Stocuri — Răspuns

ApiResponse_list_StockData__ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

dataTablou <StockData > Obligatoriu: Exemplu de răspuns · ApiResponse_list_StockData__.

Exemplu: [{"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 Obligatoriu: Metadatele răspunsului.

Exemplu: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Câmpuri suplimentare: Nu

ApiResponse[PoolData]

ApiResponse_PoolData_ · Citește setările și cantitățile înainte de modificare. Răspunsul nu conține coduri sau fișiere.

dataPoolData Obligatoriu: Datele unui răspuns reușit.

Exemplu: {"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 Obligatoriu: Metadatele răspunsului.

Exemplu: {"request_id":"example-request"}

Câmpuri suplimentare: Nu

Obține · Stocuri — Stocuri — Răspuns

ApiResponse_StockDetailData_ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

dataStockDetailData Obligatoriu: Exemplu de răspuns · StockDetailData.

Exemplu: {"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 Obligatoriu: Metadatele răspunsului.

Exemplu: {"request_id":"example"}

Câmpuri suplimentare: Nu

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Citește cel mult 100 de unități pe pagină. Lista arată metadate fără să dezvăluie codurile.

dataUnitsData Obligatoriu: Datele unui răspuns reușit.

Exemplu: {"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 Obligatoriu: Metadatele răspunsului.

Exemplu: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Câmpuri suplimentare: Nu

CodeContentData

CodeContentData · Codul este returnat ca JSON, fișierul ca date binare. Fiecare cerere necesită Bearer și permisiunea reveal.

codeȘir de caractereObligatoriu: Codul digital exact. Păstrează majusculele și spațiile din interior.

minLength: 1maxLength: 512

Exemplu: "DEMO-ONE"
delivery_idȘir de caractere nullOpțional: ID-ul livrării sau atribuirii comenzii.

Șir de caractere:format: "uuid"

Exemplu: null
kindȘir de caractereOpțional: Varianta structurii de date, descrisă prin valorile permise.

const: "code"

Valoare implicită: "code"Exemplu: "code"
payload_idȘir de caractereObligatoriu: ID-ul conținutului; nu este un URL public de descărcare.

format: "uuid"

Exemplu: "00000000-0000-4000-8000-000000000004"
unit_idȘir de caractereObligatoriu: ID-ul unui cod sau fișier individual.

format: "uuid"

Exemplu: "00000000-0000-4000-8000-000000000003"

Câmpuri suplimentare: Nu

DigitalUploadCreate

DigitalUploadCreate · Rezervă spațiu pentru fișier și asociază-l cu un import sau cu unitatea înlocuită.

consumer_idȘir de caractereObligatoriu

ID-ul importului sau unității asociate.

format: "uuid"

Exemplu: "00000000-0000-4000-8000-000000000001"

consumer_kindȘir de caractereObligatoriu

Asocierea încărcării: digital_import / digital_unit.

Restricții

enum: ["digital_import", "digital_unit"]

Exemplu: "digital_import"

filenameȘir de caractereObligatoriu

Fișier

minLength: 1maxLength: 255

Exemplu: "codes.txt"

purposeȘir de caractereObligatoriu

digital_import: TXT/CSV; digital_unit: fișier vândut individual.

Restricții

enum: ["digital_unit", "digital_import"]

Exemplu: "digital_import"

sha256Șir de caractereObligatoriu

SHA-256 (hex, 64)

Restricții

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

Exemplu: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesNumăr întregObligatoriu

Dimensiune în octeți

minimum: 1maximum: 262144000

Exemplu: 18

Câmpuri suplimentare: Nu

DigitalUploadData

DigitalUploadData · Verifică dimensiunea, suma de control și formatul. O încărcare gata nu înseamnă o livrare recepționată.

consumer_idȘir de caractereObligatoriu

ID-ul importului sau unității asociate.

format: "uuid"

Exemplu: "00000000-0000-4000-8000-000000000001"

consumer_kindȘir de caractereObligatoriu

Asocierea încărcării: digital_import / digital_unit.

Restricții

enum: ["digital_import", "digital_unit"]

Exemplu: "digital_import"

expires_atȘir de caractereObligatoriu

Momentul expirării acestei încărcări sau al acestui import.

format: "date-time"

Exemplu: "2026-11-03T13:00:00Z"

filenameȘir de caractereObligatoriu

Fișier

Exemplu: "codes.txt"

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

format: "uuid"

Exemplu: "00000000-0000-4000-8000-000000000002"

product_idȘir de caractereObligatoriu

Identificatorul produsului.

Exemplu: "example"

purposeȘir de caractereObligatoriu

digital_import: TXT/CSV; digital_unit: fișier vândut individual.

Restricții

enum: ["digital_unit", "digital_import"]

Exemplu: "digital_import"

received_bytesNumăr întregObligatoriu

Se încarcă… · Dimensiune în octeți

Exemplu: 18

sha256Șir de caractereObligatoriu

SHA-256 (hex, 64)

Exemplu: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesNumăr întregObligatoriu

Dimensiune în octeți

Exemplu: 18

statusȘir de caractereObligatoriu

Starea acceptată de această operație specifică.

Exemplu: "ready"

Câmpuri suplimentare: Nu

ImportCommit

ImportCommit · Creează o livrare planificată sau recepționată din lotul validat. Unitățile planificate nu pot fi vândute încă.

delivered_atȘir de caractereObligatoriu

Data și ora livrării.

format: "date-time"

Exemplu: "2026-11-03T12:00:00Z"

expected_delivery_versionNumăr întregObligatoriu

Versiunea livrării; 0 pentru o livrare nouă.

minimum: 0maximum: 0

Exemplu: 0

expected_sales_limit_versionNumăr întreg nullOpțional

Versiunea limitei de vânzare; necesară cu publish_for_sale=true.

Număr întreg:minimum: 0maximum: 9223372036854775807

Exemplu: 0

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 2

location_idȘir de caractereObligatoriu

Identificatorul locației din depozit.

Restricții

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

Exemplu: "location-digital"

publish_for_saleValoare booleanăOpțional

true mărește și limita finită de vânzare; false o păstrează.

Valoare implicită: falseExemplu: true

statusȘir de caractereObligatoriu

Starea acceptată de această operație specifică.

Restricții

enum: ["planned", "received"]

Exemplu: "received"

validation_digestȘir de caractereObligatoriu

Suma de control a validării; transmite-o neschimbată la confirmare.

Restricții

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

Exemplu: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idȘir de caractereObligatoriu

Identificatorul depozitului.

Restricții

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

Exemplu: "warehouse-main"

Câmpuri suplimentare: Nu

ImportCreate

ImportCreate · Pregătește o ciornă cu cel mult 1000 de coduri sau 100 de fișiere. Stocul de vânzare nu crește încă.

countNumăr întregObligatoriu

Numărul exact de unități din lot.

minimum: 1maximum: 1000

Exemplu: 2

kindȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții

enum: ["code", "file"]

Exemplu: "code"

Câmpuri suplimentare: Nu

ImportData

ImportData · Verifică starea, versiunea și validarea. Ciorna aparține cheii API care a creat-o.

delivery_idȘir de caractere nullObligatoriu

ID-ul livrării sau atribuirii comenzii.

Exemplu: null

delivery_statusȘir de caractere nullObligatoriu

Starea livrării: planned / received; null înainte de confirmare.

Exemplu: null

delivery_versionNumăr întreg nullObligatoriu

Versiunea curentă a livrării în depozit.

Exemplu: null

expected_countNumăr întregObligatoriu

Numărul așteptat; este acceptat doar lotul complet.

Exemplu: 2

expires_atȘir de caractereObligatoriu

Momentul expirării acestei încărcări sau al acestui import.

format: "date-time"

Exemplu: "2026-11-03T13:00:00Z"

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

format: "uuid"

Exemplu: "00000000-0000-4000-8000-000000000001"

kindȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții

enum: ["code", "file"]

Exemplu: "code"

product_idȘir de caractereObligatoriu

Identificatorul produsului.

Exemplu: "example"

statusȘir de caractereObligatoriu

Starea acceptată de această operație specifică.

Exemplu: "validated"

validated_countNumăr întregObligatoriu

Numărul unităților acceptate la ultima validare reușită.

Exemplu: 2

validation_digestȘir de caractere nullObligatoriu

Suma de control a validării; transmite-o neschimbată la confirmare.

Exemplu: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 2

Câmpuri suplimentare: Nu

ImportReceive

ImportReceive · Recepționează unitățile existente fără să imporți din nou codurile sau fișierele.

expected_delivery_versionNumăr întregObligatoriu: Versiunea livrării; 0 pentru o livrare nouă.

minimum: 1maximum: 9223372036854775807

Exemplu: 1
expected_sales_limit_versionNumăr întreg nullOpțional: Versiunea limitei de vânzare; necesară cu publish_for_sale=true.

Număr întreg:minimum: 0maximum: 9223372036854775807
expected_versionNumăr întregObligatoriu: Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 3
publish_for_saleValoare booleanăOpțional: true mărește și limita finită de vânzare; false o păstrează.

Valoare implicită: false

Câmpuri suplimentare: Nu

ImportValidate

ImportValidate · Verifică întregul lot. Un duplicat sau o intrare incorectă respinge lotul; codurile nu sunt scurtate.

code_columnȘir de caractere nullOpțional

Coloana CSV cu coduri; folosește code.

Șir de caractere:const: "code"

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1

formatȘir de caractere nullOpțional

Listă de coduri: txt / csv; pentru fișiere folosește upload_ids.

Restricții · Șir de caractere 1

enum: ["txt", "csv"]

Exemplu: "txt"

source_upload_idȘir de caractere nullOpțional

Încărcare privată TXT/CSV pregătită a acestui import.

Șir de caractere:format: "uuid"

Exemplu: "00000000-0000-4000-8000-000000000002"

upload_idsTablou <Șir de caractere> nullOpțional

1–100 de încărcări private de fișiere pregătite ale acestui import.

Tablou:minItems: 1maxItems: 100

Tablou / Tablou:format: "uuid"

Câmpuri suplimentare: Nu

ImportWithdrawal

ImportWithdrawal · Retrage doar unitățile libere. Cele rezervate și atribuite rămân asociate comenzilor.

expected_delivery_versionNumăr întregObligatoriu: Versiunea livrării; 0 pentru o livrare nouă.

minimum: 1maximum: 9223372036854775807

Exemplu: 1
expected_order_versionNumăr întregObligatoriu: Versiunea ordinii de atribuire, nu a comenzii clientului.

minimum: 0maximum: 9223372036854775807

Exemplu: 1
expected_versionNumăr întregObligatoriu: Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 3
reasonȘir de caractereObligatoriu: Motivul înregistrat pentru modificare.

minLength: 1maxLength: 500

Exemplu: "Withdraw a revoked license"

Câmpuri suplimentare: Nu

Actualizează · Rezervare manuală — Stocuri — Corpul cererii

ManualReservationUpdate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

expected_versionNumăr întregObligatoriu: Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1
manual_reservedNumăr întregObligatoriu: Cantitatea rezervată manual.

minimum: 0maximum: 2147483647

Exemplu: 1
reasonȘir de caractereOpțional: Motivul înregistrat pentru modificare.

maxLength: 500

Valoare implicită: ""

Câmpuri suplimentare: Nu

PoolChange

PoolChange · Activează coduri sau fișiere individuale începând cu Professional. Dezactivarea păstrează accesul achizițiilor anterioare.

email_modeȘir de caractereOpțional

disabled: fără e-mail; order_link: link către comandă; code_text: poate include și coduri.

Restricții

enum: ["disabled", "order_link", "code_text"]

Valoare implicită: "disabled"Exemplu: "order_link"

enabledValoare booleanăObligatoriu

Indică dacă această setare este activată.

Exemplu: true

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 0maximum: 9223372036854775807

Exemplu: 0

retention_daysNumăr întreg nullOpțional

null: nelimitat; 1–3650 de zile de la primul acces. Codurile nu se șterg automat.

Număr întreg:minimum: 1maximum: 3650

Exemplu: null

Câmpuri suplimentare: Nu

PoolCounts

PoolCounts · Citește setările și cantitățile înainte de modificare. Răspunsul nu conține coduri sau fișiere.

availableNumăr întregObligatoriu: Numărul de unități libere, nerezervate și nelivrate.

Exemplu: 1
heldNumăr întregObligatoriu: Unități rezervate pentru comenzi, încă nelivrate.

Exemplu: 0
issuedNumăr întregObligatoriu: Unități deja livrate pentru achiziții plătite.

Exemplu: 1
plannedNumăr întregObligatoriu: Unități din livrări confirmate, încă nerecepționate.

Exemplu: 0
retiredNumăr întregObligatoriu: Unități retrase păstrate în istoric.

Exemplu: 0
stagedNumăr întregObligatoriu: Unități din importuri neterminate, încă în afara stocului.

Exemplu: 0

Câmpuri suplimentare: Nu

PoolData

PoolData · Citește setările și cantitățile înainte de modificare. Răspunsul nu conține coduri sau fișiere.

configuredValoare booleanăObligatoriu

Dacă setările stocului digital au fost salvate.

Exemplu: true

countsPoolCounts Obligatoriu

Numărul unităților pe stări de stoc.

Exemplu: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_modeȘir de caractereObligatoriu

disabled: fără e-mail; order_link: link către comandă; code_text: poate include și coduri.

Restricții

enum: ["disabled", "order_link", "code_text"]

Exemplu: "order_link"

enabledValoare booleanăObligatoriu

Indică dacă această setare este activată.

Exemplu: true

order_versionNumăr întregObligatoriu

Versiunea ordinii de atribuire a stocului.

Exemplu: 2

product_idȘir de caractereObligatoriu

Identificatorul produsului.

Exemplu: "example"

retention_daysNumăr întreg nullObligatoriu

null: nelimitat; 1–3650 de zile de la primul acces. Codurile nu se șterg automat.

Exemplu: null

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

Actualizează · Limită de vânzări — Stocuri — Corpul cererii

SalesLimitUpdate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

expected_versionNumăr întregObligatoriu: Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1
reasonȘir de caractereOpțional: Motivul înregistrat pentru modificare.

maxLength: 500

Valoare implicită: ""
sellable_limitNumăr întregObligatoriu: Limita de vânzare: -1 înseamnă nelimitat, iar 0 dezactivează disponibilitatea pentru vânzare.

minimum: -1maximum: 2147483647

Exemplu: 1

Câmpuri suplimentare: Nu

Creează · Ajustare de stoc — Stocuri — Corpul cererii

StockAdjustmentCreate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 0maximum: 9223372036854775807

Exemplu: 0

locationsTablou <LocationQuantity > Obligatoriu

Locațiile din depozit.

minItems: 1maxItems: 100

Exemplu: [{"location_id":"example","on_hand":1}]

reasonȘir de caractereObligatoriu

Motivul înregistrat pentru modificare.

minLength: 1maxLength: 500

Exemplu: "Example"

target_idȘir de caractereObligatoriu

Identificatorul produsului sau al variantei vizate de operație.

Restricții

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

Exemplu: "example"

target_typeȘir de caractereObligatoriu

Indică dacă operația vizează un produs sau o variantă.

Restricții

enum: ["product", "variant"]

Exemplu: "product"

warehouse_idȘir de caractereObligatoriu

Identificatorul depozitului.

Restricții

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

Exemplu: "example"

Câmpuri suplimentare: Nu

Actualizează · Stocuri — Stocuri — Corpul cererii

StockAdjustmentUpdate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

expected_versionNumăr întregObligatoriu: Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1
locationsTablou <LocationQuantity > Obligatoriu: Locațiile din depozit.

minItems: 1maxItems: 100

Exemplu: [{"location_id":"example","on_hand":1}]
reasonȘir de caractereObligatoriu: Motivul înregistrat pentru modificare.

minLength: 1maxLength: 500

Exemplu: "Example"

Câmpuri suplimentare: Nu

Listează · Stocuri — Stocuri — Răspuns

StockData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

activeValoare booleanăObligatoriu

Indică dacă resursa este activă.

Exemplu: true

availableNumăr întreg nullObligatoriu

Cantitatea disponibilă pentru vânzare; null reprezintă o cantitate nelimitată.

Exemplu: 5

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (StockData).

Exemplu: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedNumăr întregObligatoriu

Cantitatea rezervată manual.

Exemplu: 2

on_handNumăr întregObligatoriu

Cantitatea fizică din stoc.

Exemplu: 10

reservedNumăr întregObligatoriu

Cantitatea rezervată prin comenzi.

Exemplu: 3

sellable_limitNumăr întregObligatoriu

Limita de vânzare: -1 înseamnă nelimitat, iar 0 dezactivează disponibilitatea pentru vânzare.

Exemplu: 10

target_idȘir de caractereObligatoriu

Identificatorul produsului sau al variantei vizate de operație.

Exemplu: "example"

target_typeȘir de caractereObligatoriu

Indică dacă operația vizează un produs sau o variantă.

Restricții

enum: ["product", "variant"]

Exemplu: "product"

total_reservedNumăr întregObligatoriu

Cantitatea totală rezervată.

Exemplu: 5

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"

Exemplu: "2026-01-01T12:00:00Z"

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

warehouse_idȘir de caractereObligatoriu

Identificatorul depozitului.

Exemplu: "example"

Câmpuri suplimentare: Nu

Obține · Stocuri — Stocuri — Răspuns

StockDetailData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

activeValoare booleanăObligatoriu

Indică dacă resursa este activă.

Exemplu: true

allocationsTablou <AllocationData > Obligatoriu

Cantități alocate locațiilor din depozit.

Exemplu: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableNumăr întreg nullObligatoriu

Cantitatea disponibilă pentru vânzare; null reprezintă o cantitate nelimitată.

Exemplu: 5

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (StockDetailData).

Exemplu: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedNumăr întregObligatoriu

Cantitatea rezervată manual.

Exemplu: 2

on_handNumăr întregObligatoriu

Cantitatea fizică din stoc.

Exemplu: 10

reservedNumăr întregObligatoriu

Cantitatea rezervată prin comenzi.

Exemplu: 3

sellable_limitNumăr întregObligatoriu

Limita de vânzare: -1 înseamnă nelimitat, iar 0 dezactivează disponibilitatea pentru vânzare.

Exemplu: 10

target_idȘir de caractereObligatoriu

Identificatorul produsului sau al variantei vizate de operație.

Exemplu: "example"

target_typeȘir de caractereObligatoriu

Indică dacă operația vizează un produs sau o variantă.

Restricții

enum: ["product", "variant"]

Exemplu: "product"

total_reservedNumăr întregObligatoriu

Cantitatea totală rezervată.

Exemplu: 5

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"

Exemplu: "2026-01-01T12:00:00Z"

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

warehouse_idȘir de caractereObligatoriu

Identificatorul depozitului.

Exemplu: "example"

Câmpuri suplimentare: Nu

UnitData

UnitData · Citește cel mult 100 de unități pe pagină. Lista arată metadate fără să dezvăluie codurile.

content_stateȘir de caractereObligatoriu

Starea conținutului: present / deleting / deleted.

Exemplu: "present"

delivery_idȘir de caractere nullObligatoriu

ID-ul livrării sau atribuirii comenzii.

Exemplu: "delivery-example"

filenameȘir de caractere nullObligatoriu

Fișier

Exemplu: null

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

format: "uuid"

Exemplu: "00000000-0000-4000-8000-000000000003"

issued_atȘir de caractere nullObligatoriu

Prima livrare; null înainte de ea.

Șir de caractere:format: "date-time"

Exemplu: null

kindȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții

enum: ["file", "code"]

Exemplu: "code"

location_idȘir de caractere nullObligatoriu

Identificatorul locației din depozit.

Exemplu: "location-digital"

mime_typeȘir de caractere nullObligatoriu

Tipul conținutului media.

Exemplu: null

payload_idȘir de caractereObligatoriu

ID-ul conținutului; nu este un URL public de descărcare.

format: "uuid"

Exemplu: "00000000-0000-4000-8000-000000000004"

product_idȘir de caractereObligatoriu

Identificatorul produsului.

Exemplu: "example"

size_bytesNumăr întreg nullObligatoriu

Dimensiune în octeți

Exemplu: null

sort_orderNumăr întregObligatoriu

Poziția în colecția ordonată.

Exemplu: 1

stateȘir de caractereObligatoriu

Stare

Exemplu: "available"

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

warehouse_idȘir de caractere nullObligatoriu

Identificatorul depozitului.

Exemplu: "warehouse-main"

Câmpuri suplimentare: Nu

UnitDeletion

UnitDeletion · Retrage un cod sau fișier nevândut și indică motivul. Unitățile rezervate sau atribuite sunt respinse.

expected_versionNumăr întregObligatoriu: Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1

Exemplu: 1
reasonȘir de caractereObligatoriu: Motivul înregistrat pentru modificare.

minLength: 1maxLength: 500

Exemplu: "Withdraw a revoked license"

Câmpuri suplimentare: Nu

UnitReorder

UnitReorder · Trimite pagina completă, nefiltrată, în ordinea dorită. O versiune depășită returnează 409.

expected_order_versionNumăr întregObligatoriu: Versiunea ordinii de atribuire, nu a comenzii clientului.

minimum: 1

Exemplu: 1
unit_idsTablou <Șir de caractere> Obligatoriu: Toate unitățile paginii nefiltrate în ordinea dorită.

minItems: 2maxItems: 100
Tablou:format: "uuid"

Exemplu: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorȘir de caractere nullOpțional: Cursorul paginii nefiltrate; null pentru prima pagină.

Șir de caractere:maxLength: 1024

Câmpuri suplimentare: Nu

UnitReplacement

UnitReplacement · Înlocuiește codul sau fișierul fără să-i schimbi poziția. Modificarea rămâne în istoricul depozitului.

codeȘir de caractere nullOpțional: Codul digital exact. Păstrează majusculele și spațiile din interior.

Șir de caractere:minLength: 1maxLength: 512

Exemplu: "SYNTHETIC-REPLACEMENT"
expected_versionNumăr întregObligatoriu: Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1

Exemplu: 1
reasonȘir de caractereObligatoriu: Motivul înregistrat pentru modificare.

minLength: 1maxLength: 500

Exemplu: "Replace an invalid activation code"
upload_idȘir de caractere nullOpțional: Identificatorul resursei; păstrați-l în forma returnată. · upload_id

Șir de caractere:format: "uuid"

Câmpuri suplimentare: Nu

UnitsData

UnitsData · Citește cel mult 100 de unități pe pagină. Lista arată metadate fără să dezvăluie codurile.

order_versionNumăr întregObligatoriu: Versiunea ordinii de atribuire a stocului.

Exemplu: 2
totalNumăr întregObligatoriu: Suma totală.

Exemplu: 1
unitsTablou <UnitData > Obligatoriu: Metadatele unităților; conținutul necesită o cerere autorizată separată.

Exemplu: [{"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"}]

Câmpuri suplimentare: Da