Scéimeanna sonraí: Stoc

Scéimeanna sonraí: Stoc. Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

Scéimeanna sonraí

Cainníochtaí a shanntar do shuíomhanna stórais

AllocationData · Scéim · Scéimeanna sonraí: Stoc

location_codeTeaghránRiachtanach: Cód suímh stórais.

Sampla: "example"
location_idTeaghránRiachtanach: Aitheantóir suímh stórais.

Sampla: "example"
location_nameTeaghránRiachtanach: Ainm suímh stórais.

Sampla: "example"
on_handSlánuimhirRiachtanach: Cainníocht fhisiciúil stoic.

Sampla: 10

Réimsí breise: Níl

Liostaigh · Stoc — Stoc — Freagra

ApiResponse_list_StockData__ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

dataEagar <StockData > Riachtanach: Sampla freagra · ApiResponse_list_StockData__.

Sampla: [{"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 Riachtanach: Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

Faigh · Stoc — Stoc — Freagra

ApiResponse_StockDetailData_ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

dataStockDetailData Riachtanach: Sampla freagra · StockDetailData.

Sampla: {"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 Riachtanach: Meiteashonraí an fhreagra.

Sampla: {"request_id":"example"}

Réimsí breise: Níl

Nuashonraigh · Áirithint láimhe — Stoc — Corp an iarratais

ManualReservationUpdate · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

expected_versionSlánuimhirRiachtanach: Leagan a léadh roimh scríobh; diúltaítear don nuashonrú mura n-oireann sé.

minimum: 1maximum: 9223372036854775807

Sampla: 1
manual_reservedSlánuimhirRiachtanach: Cainníocht curtha in áirithe de láimh.

minimum: 0maximum: 2147483647

Sampla: 1
reasonTeaghránRoghnach: Cúis taifeadta don athrú.

maxLength: 500

Réamhshocrú: ""

Réimsí breise: Níl

Nuashonraigh · Teorainn díolacháin — Stoc — Corp an iarratais

SalesLimitUpdate · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

expected_versionSlánuimhirRiachtanach: Leagan a léadh roimh scríobh; diúltaítear don nuashonrú mura n-oireann sé.

minimum: 1maximum: 9223372036854775807

Sampla: 1
reasonTeaghránRoghnach: Cúis taifeadta don athrú.

maxLength: 500

Réamhshocrú: ""
sellable_limitSlánuimhirRiachtanach: Teorainn díolacháin: ciallaíonn -1 neamhtheoranta agus díchumasaíonn 0 díolacháin atá ar fáil.

minimum: -1maximum: 2147483647

Sampla: 1

Réimsí breise: Níl

Cruthaigh · Coigeartú stoic — Stoc — Corp an iarratais

StockAdjustmentCreate · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

expected_versionSlánuimhirRiachtanach

Leagan a léadh roimh scríobh; diúltaítear don nuashonrú mura n-oireann sé.

minimum: 0maximum: 9223372036854775807

Sampla: 0

locationsEagar <LocationQuantity > Riachtanach

Suíomhanna stórais.

minItems: 1maxItems: 100

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

reasonTeaghránRiachtanach

Cúis taifeadta don athrú.

minLength: 1maxLength: 500

Sampla: "Example"

target_idTeaghránRiachtanach

Aitheantóir an táirge nó an athraithigh a dtéann an oibríocht i bhfeidhm air.

Srianta

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

Sampla: "example"

target_typeTeaghránRiachtanach

An mbaineann an oibríocht le táirge nó athraitheach.

Srianta

enum: ["product", "variant"]

Sampla: "product"

warehouse_idTeaghránRiachtanach

Aitheantóir stórais.

Srianta

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

Sampla: "example"

Réimsí breise: Níl

Nuashonraigh · Stoc — Stoc — Corp an iarratais

StockAdjustmentUpdate · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

expected_versionSlánuimhirRiachtanach: Leagan a léadh roimh scríobh; diúltaítear don nuashonrú mura n-oireann sé.

minimum: 1maximum: 9223372036854775807

Sampla: 1
locationsEagar <LocationQuantity > Riachtanach: Suíomhanna stórais.

minItems: 1maxItems: 100

Sampla: [{"location_id":"example","on_hand":1}]
reasonTeaghránRiachtanach: Cúis taifeadta don athrú.

minLength: 1maxLength: 500

Sampla: "Example"

Réimsí breise: Níl

Liostaigh · Stoc — Stoc — Freagra

StockData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

activeLuach BooleRiachtanach

An bhfuil an acmhainn gníomhach.

Sampla: true

availableSlánuimhir nullRiachtanach

Cainníocht atá ar fáil le díol; léiríonn null méid neamhtheoranta.

Sampla: 5

idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. (StockData).

Sampla: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedSlánuimhirRiachtanach

Cainníocht curtha in áirithe de láimh.

Sampla: 2

on_handSlánuimhirRiachtanach

Cainníocht fhisiciúil stoic.

Sampla: 10

reservedSlánuimhirRiachtanach

Cainníocht curtha in áirithe ag orduithe.

Sampla: 3

sellable_limitSlánuimhirRiachtanach

Teorainn díolacháin: ciallaíonn -1 neamhtheoranta agus díchumasaíonn 0 díolacháin atá ar fáil.

Sampla: 10

target_idTeaghránRiachtanach

Aitheantóir an táirge nó an athraithigh a dtéann an oibríocht i bhfeidhm air.

Sampla: "example"

target_typeTeaghránRiachtanach

An mbaineann an oibríocht le táirge nó athraitheach.

Srianta

enum: ["product", "variant"]

Sampla: "product"

total_reservedSlánuimhirRiachtanach

Cainníocht iomlán curtha in áirithe.

Sampla: 5

updated_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"

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

versionSlánuimhirRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

Sampla: 1

warehouse_idTeaghránRiachtanach

Aitheantóir stórais.

Sampla: "example"

Réimsí breise: Níl

Faigh · Stoc — Stoc — Freagra

StockDetailData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

activeLuach BooleRiachtanach

An bhfuil an acmhainn gníomhach.

Sampla: true

allocationsEagar <AllocationData > Riachtanach

Cainníochtaí a shanntar do shuíomhanna stórais.

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

availableSlánuimhir nullRiachtanach

Cainníocht atá ar fáil le díol; léiríonn null méid neamhtheoranta.

Sampla: 5

idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. (StockDetailData).

Sampla: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedSlánuimhirRiachtanach

Cainníocht curtha in áirithe de láimh.

Sampla: 2

on_handSlánuimhirRiachtanach

Cainníocht fhisiciúil stoic.

Sampla: 10

reservedSlánuimhirRiachtanach

Cainníocht curtha in áirithe ag orduithe.

Sampla: 3

sellable_limitSlánuimhirRiachtanach

Teorainn díolacháin: ciallaíonn -1 neamhtheoranta agus díchumasaíonn 0 díolacháin atá ar fáil.

Sampla: 10

target_idTeaghránRiachtanach

Aitheantóir an táirge nó an athraithigh a dtéann an oibríocht i bhfeidhm air.

Sampla: "example"

target_typeTeaghránRiachtanach

An mbaineann an oibríocht le táirge nó athraitheach.

Srianta

enum: ["product", "variant"]

Sampla: "product"

total_reservedSlánuimhirRiachtanach

Cainníocht iomlán curtha in áirithe.

Sampla: 5

updated_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"

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

versionSlánuimhirRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

Sampla: 1

warehouse_idTeaghránRiachtanach

Aitheantóir stórais.

Sampla: "example"

Réimsí breise: Níl