Datu shēmas: Krājumi

Datu shēmas: Krājumi. API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

Datu shēmas

Noliktavas atrašanās vietām piešķirtie daudzumi

AllocationData · Shēma · Datu shēmas: Krājumi

location_codeVirkneObligāts: Noliktavas atrašanās vietas kods.

Piemērs: "example"
location_idVirkneObligāts: Noliktavas atrašanās vietas identifikators.

Piemērs: "example"
location_nameVirkneObligāts: Noliktavas atrašanās vietas nosaukums.

Piemērs: "example"
on_handVesels skaitlisObligāts: Fiziskais krājumu daudzums.

Piemērs: 10

Papildu lauki: Nē

Saraksts · Krājumi — Krājumi — Atbilde

ApiResponse_list_StockData__ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataMasīvs <StockData > Obligāts: Atbildes piemērs · ApiResponse_list_StockData__.

Piemērs: [{"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 Obligāts: Atbildes metadati.

Piemērs: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildu lauki: Nē

Iegūt · Krājumi — Krājumi — Atbilde

ApiResponse_StockDetailData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataStockDetailData Obligāts: Atbildes piemērs · StockDetailData.

Piemērs: {"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 Obligāts: Atbildes metadati.

Piemērs: {"request_id":"example"}

Papildu lauki: Nē

Atjaunināt · Manuāla rezervācija — Krājumi — Pieprasījuma saturs

ManualReservationUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

expected_versionVesels skaitlisObligāts: Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1
manual_reservedVesels skaitlisObligāts: Manuāli rezervētais daudzums.

minimum: 0maximum: 2147483647

Piemērs: 1
reasonVirkneNeobligāts: Reģistrētais izmaiņas iemesls.

maxLength: 500

Noklusējums: ""

Papildu lauki: Nē

Atjaunināt · Pārdošanas limits — Krājumi — Pieprasījuma saturs

SalesLimitUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

expected_versionVesels skaitlisObligāts: Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1
reasonVirkneNeobligāts: Reģistrētais izmaiņas iemesls.

maxLength: 500

Noklusējums: ""
sellable_limitVesels skaitlisObligāts: Pārdošanas limits: -1 nozīmē neierobežotu daudzumu, 0 atspējo pārdošanu.

minimum: -1maximum: 2147483647

Piemērs: 1

Papildu lauki: Nē

Izveidot · Krājumu korekcija — Krājumi — Pieprasījuma saturs

StockAdjustmentCreate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 0maximum: 9223372036854775807

Piemērs: 0

locationsMasīvs <LocationQuantity > Obligāts

Noliktavas atrašanās vietas.

minItems: 1maxItems: 100

Piemērs: [{"location_id":"example","on_hand":1}]

reasonVirkneObligāts

Reģistrētais izmaiņas iemesls.

minLength: 1maxLength: 500

Piemērs: "Example"

target_idVirkneObligāts

Darbības ietekmētā produkta vai varianta identifikators.

Ierobežojumi

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

Piemērs: "example"

target_typeVirkneObligāts

Vai darbība attiecas uz produktu vai variantu.

Ierobežojumi

enum: ["product", "variant"]

Piemērs: "product"

warehouse_idVirkneObligāts

Noliktavas identifikators.

Ierobežojumi

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

Piemērs: "example"

Papildu lauki: Nē

Atjaunināt · Krājumi — Krājumi — Pieprasījuma saturs

StockAdjustmentUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

expected_versionVesels skaitlisObligāts: Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1
locationsMasīvs <LocationQuantity > Obligāts: Noliktavas atrašanās vietas.

minItems: 1maxItems: 100

Piemērs: [{"location_id":"example","on_hand":1}]
reasonVirkneObligāts: Reģistrētais izmaiņas iemesls.

minLength: 1maxLength: 500

Piemērs: "Example"

Papildu lauki: Nē

Saraksts · Krājumi — Krājumi — Atbilde

StockData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

activeLoģiska vērtībaObligāts

Vai resurss ir aktīvs.

Piemērs: true

availableVesels skaitlis nullObligāts

Pārdošanai pieejamais daudzums; null nozīmē neierobežotu daudzumu.

Piemērs: 5

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (StockData).

Piemērs: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedVesels skaitlisObligāts

Manuāli rezervētais daudzums.

Piemērs: 2

on_handVesels skaitlisObligāts

Fiziskais krājumu daudzums.

Piemērs: 10

reservedVesels skaitlisObligāts

Ar pasūtījumiem rezervētais daudzums.

Piemērs: 3

sellable_limitVesels skaitlisObligāts

Pārdošanas limits: -1 nozīmē neierobežotu daudzumu, 0 atspējo pārdošanu.

Piemērs: 10

target_idVirkneObligāts

Darbības ietekmētā produkta vai varianta identifikators.

Piemērs: "example"

target_typeVirkneObligāts

Vai darbība attiecas uz produktu vai variantu.

Ierobežojumi

enum: ["product", "variant"]

Piemērs: "product"

total_reservedVesels skaitlisObligāts

Kopējais rezervētais daudzums.

Piemērs: 5

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

warehouse_idVirkneObligāts

Noliktavas identifikators.

Piemērs: "example"

Papildu lauki: Nē

Iegūt · Krājumi — Krājumi — Atbilde

StockDetailData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

activeLoģiska vērtībaObligāts

Vai resurss ir aktīvs.

Piemērs: true

allocationsMasīvs <AllocationData > Obligāts

Noliktavas atrašanās vietām piešķirtie daudzumi.

Piemērs: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableVesels skaitlis nullObligāts

Pārdošanai pieejamais daudzums; null nozīmē neierobežotu daudzumu.

Piemērs: 5

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (StockDetailData).

Piemērs: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedVesels skaitlisObligāts

Manuāli rezervētais daudzums.

Piemērs: 2

on_handVesels skaitlisObligāts

Fiziskais krājumu daudzums.

Piemērs: 10

reservedVesels skaitlisObligāts

Ar pasūtījumiem rezervētais daudzums.

Piemērs: 3

sellable_limitVesels skaitlisObligāts

Pārdošanas limits: -1 nozīmē neierobežotu daudzumu, 0 atspējo pārdošanu.

Piemērs: 10

target_idVirkneObligāts

Darbības ietekmētā produkta vai varianta identifikators.

Piemērs: "example"

target_typeVirkneObligāts

Vai darbība attiecas uz produktu vai variantu.

Ierobežojumi

enum: ["product", "variant"]

Piemērs: "product"

total_reservedVesels skaitlisObligāts

Kopējais rezervētais daudzums.

Piemērs: 5

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

warehouse_idVirkneObligāts

Noliktavas identifikators.

Piemērs: "example"

Papildu lauki: Nē