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

dataCodeContentData Riachtanach

Sonraí freagra rathúil.

Sampla: {"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 Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

dataDigitalUploadData Riachtanach

Sonraí freagra rathúil.

Sampla: {"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 Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

dataImportData Riachtanach

Sonraí freagra rathúil.

Sampla: {"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 Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

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

dataPoolData Riachtanach

Sonraí freagra rathúil.

Sampla: {"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 Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

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

dataUnitsData Riachtanach

Sonraí freagra rathúil.

Sampla: {"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 Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

codeTeaghránRiachtanach

An cód digiteach cruinn. Coinnigh ceannlitreacha agus spásanna inmheánacha.

minLength: 1maxLength: 512

Sampla: "DEMO-ONE"

delivery_idTeaghrán | nullRoghnach

ID an tseachadta nó leithdháileadh an ordaithe.

Teaghrán:format: "uuid"

Sampla: null

kindTeaghránRoghnach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

const: "code"

Réamhshocrú: "code"Sampla: "code"

payload_idTeaghránRiachtanach

ID an ábhair; ní URL poiblí íoslódála é.

format: "uuid"

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

unit_idTeaghránRiachtanach

ID cóid nó comhaid aonair.

format: "uuid"

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

Réimsí breise: Níl

consumer_idTeaghránRiachtanach

ID na hiompórtála nó an aonaid nasctha.

format: "uuid"

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

consumer_kindTeaghránRiachtanach

Ceangal na huaslódála: digital_import / digital_unit.

Srianta

enum

["digital_import", "digital_unit"]

Sampla: "digital_import"

filenameTeaghránRiachtanach

Comhad

minLength: 1maxLength: 255

Sampla: "codes.txt"

purposeTeaghránRiachtanach

digital_import: TXT/CSV; digital_unit: comhad a dhíoltar ina aonar.

Srianta

enum

["digital_unit", "digital_import"]

Sampla: "digital_import"

sha256TeaghránRiachtanach

SHA-256 (hex, 64)

Srianta

pattern

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

Sampla: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesSlánuimhirRiachtanach

Méid i mbearta

minimum: 1maximum: 262144000

Sampla: 18

Réimsí breise: Níl

consumer_idTeaghránRiachtanach

ID na hiompórtála nó an aonaid nasctha.

format: "uuid"

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

consumer_kindTeaghránRiachtanach

Ceangal na huaslódála: digital_import / digital_unit.

Srianta

enum

["digital_import", "digital_unit"]

Sampla: "digital_import"

expires_atTeaghránRiachtanach

Am éaga an uaslódála nó an iompórtála seo.

format: "date-time"

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

filenameTeaghránRiachtanach

Comhad

Sampla: "codes.txt"

idTeaghránRiachtanach

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

format: "uuid"

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

product_idTeaghránRiachtanach

Aitheantóir táirge.

Sampla: "example"

purposeTeaghránRiachtanach

digital_import: TXT/CSV; digital_unit: comhad a dhíoltar ina aonar.

Srianta

enum

["digital_unit", "digital_import"]

Sampla: "digital_import"

received_bytesSlánuimhirRiachtanach

Á n-uaslódáil… · Méid i mbearta

Sampla: 18

sha256TeaghránRiachtanach

SHA-256 (hex, 64)

Sampla: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesSlánuimhirRiachtanach

Méid i mbearta

Sampla: 18

statusTeaghránRiachtanach

Stádas a ghlacann an oibríocht áirithe seo.

Sampla: "ready"

Réimsí breise: Níl

delivered_atTeaghránRiachtanach

Dáta agus am seachadta.

format: "date-time"

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

expected_delivery_versionSlánuimhirRiachtanach

Leagan seachadta; 0 do sheachadadh nua.

minimum: 0maximum: 0

Sampla: 0

expected_sales_limit_versionSlánuimhir | nullRoghnach

Leagan na teorann díolacháin; riachtanach le publish_for_sale=true.

Slánuimhir:minimum: 0maximum: 9223372036854775807

Sampla: 0

expected_versionSlánuimhirRiachtanach

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

minimum: 1maximum: 9223372036854775807

Sampla: 2

location_idTeaghránRiachtanach

Aitheantóir suímh stórais.

Srianta

pattern

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

Sampla: "location-digital"

publish_for_saleLuach BooleRoghnach

Méadaíonn true an teorainn dhíolacháin chríochnaitheach freisin; fágann false mar atá í.

Réamhshocrú: falseSampla: true

statusTeaghránRiachtanach

Stádas a ghlacann an oibríocht áirithe seo.

Srianta

enum

["planned", "received"]

Sampla: "received"

validation_digestTeaghránRiachtanach

Suim sheiceála an bhailíochtaithe; seol gan athrú í don deimhniú.

Srianta

pattern

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

Sampla: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idTeaghránRiachtanach

Aitheantóir stórais.

Srianta

pattern

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

Sampla: "warehouse-main"

Réimsí breise: Níl

countSlánuimhirRiachtanach

Líon beacht na n-aonad sa bhaisc.

minimum: 1maximum: 1000

Sampla: 2

kindTeaghránRiachtanach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

Srianta

enum

["code", "file"]

Sampla: "code"

Réimsí breise: Níl

delivery_idTeaghrán | nullRiachtanach

ID an tseachadta nó leithdháileadh an ordaithe.

Sampla: null

delivery_statusTeaghrán | nullRiachtanach

Stádas seachadta: planned / received; null roimh dheimhniú.

Sampla: null

delivery_versionSlánuimhir | nullRiachtanach

Leagan reatha an tseachadta stórais.

Sampla: null

expected_countSlánuimhirRiachtanach

Líon ionchais; ní ghlactar ach le baisc iomlán.

Sampla: 2

expires_atTeaghránRiachtanach

Am éaga an uaslódála nó an iompórtála seo.

format: "date-time"

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

idTeaghránRiachtanach

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

format: "uuid"

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

kindTeaghránRiachtanach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

Srianta

enum

["code", "file"]

Sampla: "code"

product_idTeaghránRiachtanach

Aitheantóir táirge.

Sampla: "example"

statusTeaghránRiachtanach

Stádas a ghlacann an oibríocht áirithe seo.

Sampla: "validated"

validated_countSlánuimhirRiachtanach

Líon na n-aonad a glacadh sa bhailíochtú rathúil is déanaí.

Sampla: 2

validation_digestTeaghrán | nullRiachtanach

Suim sheiceála an bhailíochtaithe; seol gan athrú í don deimhniú.

Sampla: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionSlánuimhirRiachtanach

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

Sampla: 2

Réimsí breise: Níl

expected_delivery_versionSlánuimhirRiachtanach

Leagan seachadta; 0 do sheachadadh nua.

minimum: 1maximum: 9223372036854775807

Sampla: 1

expected_sales_limit_versionSlánuimhir | nullRoghnach

Leagan na teorann díolacháin; riachtanach le publish_for_sale=true.

Slánuimhir:minimum: 0maximum: 9223372036854775807

expected_versionSlánuimhirRiachtanach

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

minimum: 1maximum: 9223372036854775807

Sampla: 3

publish_for_saleLuach BooleRoghnach

Méadaíonn true an teorainn dhíolacháin chríochnaitheach freisin; fágann false mar atá í.

Réamhshocrú: false

Réimsí breise: Níl

code_columnTeaghrán | nullRoghnach

Colún CSV ina bhfuil na cóid; úsáid code.

Teaghrán:const: "code"

expected_versionSlánuimhirRiachtanach

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

minimum: 1maximum: 9223372036854775807

Sampla: 1

formatTeaghrán | nullRoghnach

Liosta cód: txt / csv; úsáid upload_ids do chomhaid.

Srianta · Teaghrán 1

enum

["txt", "csv"]

Sampla: "txt"

source_upload_idTeaghrán | nullRoghnach

Uaslódáil phríobháideach réidh TXT/CSV don iompórtáil seo.

Teaghrán:format: "uuid"

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

upload_idsEagar <Teaghrán> | nullRoghnach

1–100 uaslódáil chomhaid phríobháideacha réidh don iompórtáil seo.

Eagar:minItems: 1maxItems: 100

Eagar / Eagar:format: "uuid"

Réimsí breise: Níl

expected_delivery_versionSlánuimhirRiachtanach

Leagan seachadta; 0 do sheachadadh nua.

minimum: 1maximum: 9223372036854775807

Sampla: 1

expected_order_versionSlánuimhirRiachtanach

Leagan an oird leithdháilte, ní ordú an chustaiméara.

minimum: 0maximum: 9223372036854775807

Sampla: 1

expected_versionSlánuimhirRiachtanach

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

minimum: 1maximum: 9223372036854775807

Sampla: 3

reasonTeaghránRiachtanach

Cúis taifeadta don athrú.

minLength: 1maxLength: 500

Sampla: "Withdraw a revoked license"

Réimsí breise: Níl

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

email_modeTeaghránRoghnach

disabled: gan ríomhphost; order_link: nasc ordaithe; code_text: féadfar cóid a chur leis.

Srianta

enum

["disabled", "order_link", "code_text"]

Réamhshocrú: "disabled"Sampla: "order_link"

enabledLuach BooleRiachtanach

An bhfuil an socrú seo cumasaithe.

Sampla: true

expected_versionSlánuimhirRiachtanach

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

minimum: 0maximum: 9223372036854775807

Sampla: 0

retention_daysSlánuimhir | nullRoghnach

null: gan teorainn; 1–3650 lá ón gcéad rochtain. Ní scriostar cóid go huathoibríoch.

Slánuimhir:minimum: 1maximum: 3650

Sampla: null

Réimsí breise: Níl

availableSlánuimhirRiachtanach

Líon na n-aonad saor nach bhfuil curtha in áirithe ná eisithe.

Sampla: 1

heldSlánuimhirRiachtanach

Aonaid in áirithe d’orduithe, nár eisíodh fós.

Sampla: 0

issuedSlánuimhirRiachtanach

Aonaid a eisíodh cheana do cheannacháin íoctha.

Sampla: 1

plannedSlánuimhirRiachtanach

Aonaid seachadtaí deimhnithe nár fuarthas fós.

Sampla: 0

retiredSlánuimhirRiachtanach

Aonaid aistarraingthe a choinnítear sa stair.

Sampla: 0

stagedSlánuimhirRiachtanach

Aonaid iompórtálacha neamhchríochnaithe, nach stoc iad fós.

Sampla: 0

Réimsí breise: Níl

configuredLuach BooleRiachtanach

An bhfuil socruithe an stoic dhigitigh sábháilte.

Sampla: true

countsPoolCounts Riachtanach

Líon na n-aonad de réir stádas stoic.

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

email_modeTeaghránRiachtanach

disabled: gan ríomhphost; order_link: nasc ordaithe; code_text: féadfar cóid a chur leis.

Srianta

enum

["disabled", "order_link", "code_text"]

Sampla: "order_link"

enabledLuach BooleRiachtanach

An bhfuil an socrú seo cumasaithe.

Sampla: true

order_versionSlánuimhirRiachtanach

Leagan oird leithdháilte an stoic.

Sampla: 2

product_idTeaghránRiachtanach

Aitheantóir táirge.

Sampla: "example"

retention_daysSlánuimhir | nullRiachtanach

null: gan teorainn; 1–3650 lá ón gcéad rochtain. Ní scriostar cóid go huathoibríoch.

Sampla: null

versionSlánuimhirRiachtanach

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

Sampla: 1

Réimsí breise: Níl

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

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

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

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

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

content_stateTeaghránRiachtanach

Stádas an ábhair: present / deleting / deleted.

Sampla: "present"

delivery_idTeaghrán | nullRiachtanach

ID an tseachadta nó leithdháileadh an ordaithe.

Sampla: "delivery-example"

filenameTeaghrán | nullRiachtanach

Comhad

Sampla: null

idTeaghránRiachtanach

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

format: "uuid"

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

issued_atTeaghrán | nullRiachtanach

An chéad eisiúint; null roimpi.

Teaghrán:format: "date-time"

Sampla: null

kindTeaghránRiachtanach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

Srianta

enum

["file", "code"]

Sampla: "code"

location_idTeaghrán | nullRiachtanach

Aitheantóir suímh stórais.

Sampla: "location-digital"

mime_typeTeaghrán | nullRiachtanach

Cineál ábhair meán.

Sampla: null

payload_idTeaghránRiachtanach

ID an ábhair; ní URL poiblí íoslódála é.

format: "uuid"

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

product_idTeaghránRiachtanach

Aitheantóir táirge.

Sampla: "example"

size_bytesSlánuimhir | nullRiachtanach

Méid i mbearta

Sampla: null

sort_orderSlánuimhirRiachtanach

Suíomh sa bhailiúchán ordaithe.

Sampla: 1

stateTeaghránRiachtanach

Stádas

Sampla: "available"

versionSlánuimhirRiachtanach

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

Sampla: 1

warehouse_idTeaghrán | nullRiachtanach

Aitheantóir stórais.

Sampla: "warehouse-main"

Réimsí breise: Níl

expected_versionSlánuimhirRiachtanach

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

minimum: 1

Sampla: 1

reasonTeaghránRiachtanach

Cúis taifeadta don athrú.

minLength: 1maxLength: 500

Sampla: "Withdraw a revoked license"

Réimsí breise: Níl

expected_order_versionSlánuimhirRiachtanach

Leagan an oird leithdháilte, ní ordú an chustaiméara.

minimum: 1

Sampla: 1

unit_idsEagar <Teaghrán> Riachtanach

Gach aonad ar an leathanach neamhscagtha san ord atá ag teastáil.

minItems: 2maxItems: 100

Eagar:format: "uuid"

Sampla: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]

window_cursorTeaghrán | nullRoghnach

Cúrsóir an leathanaigh neamhscagtha; null don chéad leathanach.

Teaghrán:maxLength: 1024

Réimsí breise: Níl

codeTeaghrán | nullRoghnach

An cód digiteach cruinn. Coinnigh ceannlitreacha agus spásanna inmheánacha.

Teaghrán:minLength: 1maxLength: 512

Sampla: "SYNTHETIC-REPLACEMENT"

expected_versionSlánuimhirRiachtanach

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

minimum: 1

Sampla: 1

reasonTeaghránRiachtanach

Cúis taifeadta don athrú.

minLength: 1maxLength: 500

Sampla: "Replace an invalid activation code"

upload_idTeaghrán | nullRoghnach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. · upload_id

Teaghrán:format: "uuid"

Réimsí breise: Níl

order_versionSlánuimhirRiachtanach

Leagan oird leithdháilte an stoic.

Sampla: 2

totalSlánuimhirRiachtanach

Suim iomlán.

Sampla: 1

unitsEagar <UnitData > Riachtanach

Meiteashonraí na n-aonad; teastaíonn iarratas údaraithe ar leith don ábhar.

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

Réimsí breise: Tá