Léim ar ábhar
ShopentlyLearn

Scéimeanna sonraí: Táirgí

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

Scéimeanna sonraí

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
dataProductFileListData Riachtanach

Sonraí freagra rathúil.

Sampla: {"files":[{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}],"product_version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
dataReleaseListData Riachtanach

Sonraí freagra rathúil.

Sampla: {"current_release_id":"00000000-0000-4000-8000-000000000001","product_version":2,"releases":[{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}],"update_days":365,"update_mode":"period","update_months":null}
metaContextPageMeta ContextMeta PageMeta RequestMeta Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

ApiResponse_UploadData_

ApiResponse_UploadData_ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
dataUploadData Riachtanach

Sonraí freagra rathúil.

Sampla: {"category":"digital","expires_at":"2026-01-01T12:00:00Z","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","product_id":"example","received_bytes":46,"sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Riachtanach

Meiteashonraí an fhreagra.

Sampla: {"request_id":"example"}

Réimsí breise: Níl

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · Léigh an riail rochtana agus leagan an táirge. Fanann an chéad fhoilsiú mar phointe tagartha ama.
dataAudienceData Riachtanach

Sonraí freagra rathúil.

Sampla: {"anchor_at":"2026-11-03T12:00:00Z","effective_at":"2026-11-03T12:00:00Z","file_id":"00000000-0000-4000-8000-000000000007","file_version_id":"00000000-0000-4000-8000-000000000010","historical_access_preserved":true,"id":"00000000-0000-4000-8000-000000000009","lookback_days":null,"mode":"all_purchasers","next_cursor":null,"order_ids":[],"product_version":3,"revision":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

Liostaigh — Táirgí — Freagra

ApiResponse_list_ProductSummaryData__ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
dataEagar <ProductSummaryData > Riachtanach

Sampla freagra · ApiResponse_list_ProductSummaryData__.

Sampla: [{"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Riachtanach

Meiteashonraí an fhreagra.

Sampla: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Réimsí breise: Níl

Faigh — Táirgí — Freagra

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

Sampla freagra · ProductDetailData.

Sampla: {"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","description":"example","features":[{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}],"id":"example","identifiers":{},"media":[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}],"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Riachtanach

Meiteashonraí an fhreagra.

Sampla: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Réimsí breise: Níl

AudienceChange

AudienceChange · Roghnaigh ceannacháin incháilithe. Caithfidh an táirge seo a bheith íoctha agus gan aisíocaíocht sna horduithe roghnaithe.
audienceAudienceSelection Riachtanach

Riail rochtana shainráite don chomhad comhroinnte.

Sampla: {"mode":"all_purchasers"}
expected_versionSlánuimhirRiachtanach

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

minimum: 1maximum: 9223372036854775807
Sampla: 1

Réimsí breise: Níl

AudienceData

AudienceData · Léigh an riail rochtana agus leagan an táirge. Fanann an chéad fhoilsiú mar phointe tagartha ama.
anchor_atTeaghránRiachtanach

An chéad fhoilsiú; ní athraíonn sé nuair a athraítear an riail.

format: "date-time"
Sampla: "2026-11-03T12:00:00Z"
effective_atTeaghránRiachtanach

Am foilsithe na rialach rochtana seo.

format: "date-time"
Sampla: "2026-11-03T12:00:00Z"
file_idTeaghránRiachtanach

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

Sampla: "00000000-0000-4000-8000-000000000007"
file_version_idTeaghránRiachtanach

ID leagan do-athraithe den chomhad.

Sampla: "00000000-0000-4000-8000-000000000010"
historical_access_preservedLuach BooleRoghnach

Coinnítear cearta a deonaíodh cheana nuair a chúngaítear an riail.

Réamhshocrú: trueSampla: true
idTeaghránRiachtanach

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

Sampla: "00000000-0000-4000-8000-000000000009"
lookback_daysSlánuimhir nullRiachtanach

1–3650 lá roimh an gcéad fhoilsiú; recent_and_new amháin.

Sampla: null
modeTeaghránRiachtanach

Riail rochtana shainráite don chomhad comhroinnte. new_purchases / recent_and_new / selected / all_purchasers.

Sampla: "all_purchasers"
next_cursorTeaghrán nullRiachtanach

Luach leanúna don chéad leathanach eile, nó null.

Sampla: null
order_idsEagar <Teaghrán> Riachtanach

Orduithe ina bhfuil an táirge seo íoctha agus gan aisíocaíocht ina leith.

Sampla: []
product_versionSlánuimhirRiachtanach

Leagan reatha táirge le haghaidh rialú comhreatha.

Sampla: 3
revisionSlánuimhirRiachtanach

Athbhreithniú seicheamhach ar an riail rochtana.

Sampla: 1

Réimsí breise: Níl

AudienceSelection

AudienceSelection · Roghnaigh ceannacháin incháilithe. Caithfidh an táirge seo a bheith íoctha agus gan aisíocaíocht sna horduithe roghnaithe.
lookback_daysSlánuimhir nullRoghnach

1–3650 lá roimh an gcéad fhoilsiú; recent_and_new amháin.

Slánuimhir:minimum: 1maximum: 3650
modeTeaghránRiachtanach

Riail rochtana shainráite don chomhad comhroinnte. new_purchases / recent_and_new / selected / all_purchasers.

Srianta
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
Sampla: "new_purchases"
order_idsEagar <Teaghrán> Roghnach

Orduithe ina bhfuil an táirge seo íoctha agus gan aisíocaíocht ina leith.

maxItems: 1000
Srianta · Eagar 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Réamhshocrú: []

Réimsí breise: Níl

Eolas infhaighteachta sa chomhthéacs roghnaithe

AvailabilityData · Scéim · Scéimeanna sonraí: Táirgí
available_fromTeaghrán nullRiachtanach

Tús na hinfhaighteachta.

Teaghrán:format: "date-time"
Sampla: null
available_untilTeaghrán nullRiachtanach

Deireadh na hinfhaighteachta.

Teaghrán:format: "date-time"
Sampla: null
is_availableLuach BooleRiachtanach

An bhfuil an mhír ar fáil sa chomhthéacs seo.

Sampla: true

Réimsí breise: Níl

FileAssign

FileAssign · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
audienceAudienceSelection nullRoghnach

Riail rochtana shainráite don chomhad comhroinnte.

Sampla: {"mode":"new_purchases"}
expected_versionSlánuimhirRiachtanach

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

minimum: 1maximum: 9223372036854775807
Sampla: 1
labelTeaghránRoghnach

Ainm acmhainne sa chomhthéacs cuí.

maxLength: 300
Réamhshocrú: ""
upload_idTeaghránRiachtanach

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

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

Réimsí breise: Níl

FileCategory

FileCategory · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
Teaghrán
Srianta
enum
["internal", "customer_document", "digital"]

Réimsí breise: Tá

Eolas praghais sa chomhthéacs roghnaithe

PriceData · Scéim · Scéimeanna sonraí: Táirgí
amountTeaghránRiachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

Sampla: "0.00"
currencyTeaghránRiachtanach

Cód airgeadra na suime.

Srianta
pattern
"^[A-Z]{3}$"
Sampla: "PLN"
minor_unitsSlánuimhirRiachtanach

Líon na n-ionad deachúlach a úsáideann an t-airgeadra.

minimum: 0maximum: 4
Sampla: 2
tax_includedLuach BooleRiachtanach

An bhfuil cáin sa phraghas seolta.

Sampla: true

Réimsí breise: Níl

Eolas praghasliosta

PriceListData · Scéim · Scéimeanna sonraí: Táirgí
currencyTeaghránRiachtanach

Cód airgeadra na suime.

idTeaghránRiachtanach

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

tax_includedLuach BooleRiachtanach

An bhfuil cáin sa phraghas seolta.

versionSlánuimhirRiachtanach

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

Réimsí breise: Níl

Cruthaigh — Táirgí — Corp an iarratais

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

Aitheantóir branda.

Teaghrán:minLength: 1maxLength: 63
conditionTeaghránRoghnach

Riocht an táirge.

Srianta
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Réamhshocrú: "new"
descriptionTeaghrán nullRoghnach

Cur síos sa teanga roghnaithe.

Teaghrán:maxLength: 100000
feature_value_idsEagar <Teaghrán> Roghnach

Aitheantóirí na luachanna tréithe roghnaithe.

maxItems: 1000
Eagar:minLength: 1maxLength: 63
identifiersProductIdentifiers nullRoghnach

Cóid aitheantais táirge.

market_idsEagar <Teaghrán> Roghnach

Aitheantóirí na margaí roghnaithe.

maxItems: 1000
Eagar:minLength: 1maxLength: 63
media_idsEagar <Teaghrán> Roghnach

Aitheantóirí sócmhainní meán atá ann cheana.

maxItems: 30
Eagar:minLength: 1maxLength: 63
meta_descriptionTeaghrán nullRoghnach

Cur síos inneall cuardaigh sa teanga roghnaithe.

Teaghrán:maxLength: 160
meta_keywordsEagar <Teaghrán> nullRoghnach

Eochairfhocail inneall cuardaigh sa teanga roghnaithe.

Eagar:maxItems: 20
Eagar / Eagar:maxLength: 50
meta_titleTeaghrán nullRoghnach

Teideal inneall cuardaigh sa teanga roghnaithe.

Teaghrán:maxLength: 70
nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

minLength: 1maxLength: 300
Sampla: "Example"
pricingProductPrice Roghnach

Cumraíocht praghsála agus a leaganacha comhreatha.

primary_category_idTeaghrán nullRoghnach

Aitheantóir na príomhchatagóire.

Teaghrán:minLength: 1maxLength: 63
publishedLuach BooleRoghnach

An bhfuil an acmhainn foilsithe.

Réamhshocrú: false
skuTeaghránRiachtanach

Cód aonaid coimeádta stoic.

minLength: 1maxLength: 100
Srianta
pattern
"^\\S+$"
Sampla: "example"
slugTeaghrán nullRoghnach

Cuid de chosán URL sa teanga roghnaithe.

Teaghrán:maxLength: 160
tax_category_idTeaghrán nullRoghnach

Aitheantóir catagóire cánach.

Teaghrán:minLength: 1maxLength: 63
variant_value_idsEagar <Teaghrán> Roghnach

Aitheantóirí luachanna athraitheach roghnaithe.

maxItems: 250
Eagar:minLength: 1maxLength: 63
variants_enabledLuach BooleRoghnach

An úsáideann an táirge athraithigh.

Réamhshocrú: false

Réimsí breise: Níl

Faigh — Táirgí — Freagra

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

Eolas infhaighteachta sa chomhthéacs roghnaithe.

Sampla: {"available_from":null,"available_until":null,"is_available":true}
brand_idTeaghrán nullRiachtanach

Aitheantóir branda.

Sampla: null
conditionTeaghránRiachtanach

Riocht an táirge.

Srianta
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Sampla: "new"
created_atTeaghránRiachtanach

Am cruthaithe.

format: "date-time"
Sampla: "2026-01-01T12:00:00Z"
descriptionTeaghrán nullRiachtanach

Cur síos sa teanga roghnaithe.

Sampla: "example"
featuresEagar <FeatureSelectionData > Riachtanach

Tréithe an táirge.

Sampla: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idTeaghránRiachtanach

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

Sampla: "example"
identifiersOibiachtRéimsí breise: TeaghránRiachtanach

Cóid aitheantais táirge.

Sampla: {}
mediaEagar <ProductMediaData > Riachtanach

Eolas faoi mheáin ceangailte.

Sampla: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_descriptionTeaghrán nullRiachtanach

Cur síos inneall cuardaigh sa teanga roghnaithe.

Sampla: "example"
meta_keywordsEagar <Teaghrán> nullRiachtanach

Eochairfhocail inneall cuardaigh sa teanga roghnaithe.

Sampla: ["example"]
meta_titleTeaghrán nullRiachtanach

Teideal inneall cuardaigh sa teanga roghnaithe.

Sampla: "example"
nameTeaghrán nullRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Example"
numberTeaghránRiachtanach

Uimhir ordaithe nó iarratais atá le léamh ag duine.

Sampla: "example"
pricePriceData nullRiachtanach

Eolas praghais sa chomhthéacs roghnaithe.

Sampla: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionSlánuimhirRiachtanach

Leagan reatha praghais le haghaidh rialú comhreatha.

Sampla: 1
primary_category_idTeaghrán nullRiachtanach

Aitheantóir na príomhchatagóire.

Sampla: "example"
primary_media_idTeaghrán nullRiachtanach

Aitheantóir na príomhshócmhainne meán.

Sampla: "example"
publishedLuach BooleRiachtanach

An bhfuil an acmhainn foilsithe.

Sampla: false
skuTeaghránRiachtanach

Cód aonaid coimeádta stoic.

Sampla: "example"
slugTeaghrán nullRiachtanach

Cuid de chosán URL sa teanga roghnaithe.

Sampla: "example"
tax_category_idTeaghránRiachtanach

Aitheantóir catagóire cánach.

Sampla: "example"
updated_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"
Sampla: "2026-01-01T12:00:00Z"
variants_enabledLuach BooleRiachtanach

An úsáideann an táirge athraithigh.

Sampla: false
versionSlánuimhirRiachtanach

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

Sampla: 1

Réimsí breise: Níl

ProductFileData

ProductFileData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
categoryFileCategory Riachtanach

Catagóir comhaid: internal / customer_document / digital

Sampla: "digital"
created_atTeaghránRiachtanach

Am cruthaithe.

format: "date-time"
Sampla: "2026-01-01T12:00:00Z"
current_version_idTeaghránRiachtanach

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

format: "uuid"
Sampla: "00000000-0000-4000-8000-000000000001"
file_idTeaghránRiachtanach

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

format: "uuid"
Sampla: "00000000-0000-4000-8000-000000000001"
filenameTeaghránRiachtanach

Comhad

Sampla: "manual.pdf"
idTeaghránRiachtanach

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

format: "uuid"
Sampla: "00000000-0000-4000-8000-000000000001"
labelTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Manual"
mime_typeTeaghránRiachtanach

Cineál ábhair meán.

Sampla: "application/pdf"
sha256TeaghránRiachtanach

SHA-256 (hex, 64)

Sampla: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesSlánuimhirRiachtanach

Méid i mbearta

Sampla: 46
stateTeaghránRiachtanach

Stádas

Sampla: "active"
version_numberSlánuimhirRiachtanach

Leagan

Sampla: 1

Réimsí breise: Níl

ProductFileListData

ProductFileListData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
filesEagar <ProductFileData > Riachtanach

Comhaid táirge

Sampla: [{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}]
product_versionSlánuimhirRiachtanach

Leagan reatha táirge le haghaidh rialú comhreatha.

Sampla: 2

Réimsí breise: Níl

Cóid aitheantais táirge

ProductIdentifiers · Scéim · Scéimeanna sonraí: Táirgí
eanTeaghrán nullRoghnach

Aitheantóir EAN an táirge.

Teaghrán:minLength: 1maxLength: 100
isbnTeaghrán nullRoghnach

Aitheantóir ISBN.

Teaghrán:minLength: 1maxLength: 100
mpnTeaghrán nullRoghnach

Uimhir páirte an déantóra.

Teaghrán:minLength: 1maxLength: 100
upcTeaghrán nullRoghnach

Aitheantóir UPC an táirge.

Teaghrán:minLength: 1maxLength: 100

Réimsí breise: Níl

Eolas faoi mheáin ceangailte

ProductMediaData · Scéim · Scéimeanna sonraí: Táirgí
alt_textTeaghrán nullRiachtanach

Téacs malartach d'íomhá.

Sampla: "example"
idTeaghránRiachtanach

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

Sampla: "example"
is_primaryLuach BooleRiachtanach

An é seo an phríomh-mhír.

Sampla: true
kindTeaghránRiachtanach

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

Srianta
enum
["image", "video", "model_3d"]
Sampla: "image"
mime_typeTeaghránRiachtanach

Cineál ábhair meán.

Sampla: "image/jpeg"
positionSlánuimhirRiachtanach

Suíomh sa bhailiúchán ordaithe.

Sampla: 1
urlTeaghrán nullRiachtanach

URL na hacmhainne.

Sampla: "https://example.invalid/product.jpg"

Réimsí breise: Níl

Cumraíocht praghsála agus a leaganacha comhreatha

ProductPrice · Scéim · Scéimeanna sonraí: Táirgí
amountTeaghrán nullRiachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

Teaghrán:maxLength: 19
Srianta · Teaghrán 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Sampla: "0.00"
currencyTeaghránRiachtanach

Cód airgeadra na suime.

Srianta
pattern
"^[A-Z]{3}$"
Sampla: "PLN"
expected_price_list_versionSlánuimhirRiachtanach

Leagan praghasliosta a léadh roimhe agus atá riachtanach don scríobh seo.

minimum: 1maximum: 9223372036854775807
Sampla: 1
expected_versionSlánuimhirRiachtanach

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

minimum: 0maximum: 9223372036854775807
Sampla: 0
kindTeaghránRiachtanach

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

Srianta
enum
["base", "market_fixed"]
Sampla: "base"
price_list_idTeaghránRiachtanach

Aitheantóir praghasliosta.

minLength: 1maxLength: 63
Sampla: "example"
tax_includedLuach BooleRiachtanach

An bhfuil cáin sa phraghas seolta.

Sampla: true

Réimsí breise: Níl

Liostaigh — Táirgí — Freagra

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

Eolas infhaighteachta sa chomhthéacs roghnaithe.

Sampla: {"available_from":null,"available_until":null,"is_available":true}
brand_idTeaghrán nullRiachtanach

Aitheantóir branda.

Sampla: null
conditionTeaghránRiachtanach

Riocht an táirge.

Srianta
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Sampla: "new"
created_atTeaghránRiachtanach

Am cruthaithe.

format: "date-time"
Sampla: "2026-01-01T12:00:00Z"
idTeaghránRiachtanach

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

Sampla: "example"
nameTeaghrán nullRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Example"
numberTeaghránRiachtanach

Uimhir ordaithe nó iarratais atá le léamh ag duine.

Sampla: "example"
pricePriceData nullRiachtanach

Eolas praghais sa chomhthéacs roghnaithe.

Sampla: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionSlánuimhirRiachtanach

Leagan reatha praghais le haghaidh rialú comhreatha.

Sampla: 1
primary_category_idTeaghrán nullRiachtanach

Aitheantóir na príomhchatagóire.

Sampla: "example"
primary_media_idTeaghrán nullRiachtanach

Aitheantóir na príomhshócmhainne meán.

Sampla: "example"
publishedLuach BooleRiachtanach

An bhfuil an acmhainn foilsithe.

Sampla: false
skuTeaghránRiachtanach

Cód aonaid coimeádta stoic.

Sampla: "example"
slugTeaghrán nullRiachtanach

Cuid de chosán URL sa teanga roghnaithe.

Sampla: "example"
tax_category_idTeaghránRiachtanach

Aitheantóir catagóire cánach.

Sampla: "example"
updated_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"
Sampla: "2026-01-01T12:00:00Z"
variants_enabledLuach BooleRiachtanach

An úsáideann an táirge athraithigh.

Sampla: false
versionSlánuimhirRiachtanach

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

Sampla: 1

Réimsí breise: Níl

Nuashonraigh — Táirgí — Corp an iarratais

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

Aitheantóir branda.

Teaghrán:minLength: 1maxLength: 63
conditionTeaghránRoghnach

Riocht an táirge.

Srianta
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionTeaghrán nullRoghnach

Cur síos sa teanga roghnaithe.

Teaghrán:maxLength: 100000
Sampla: null
expected_variant_price_versionsOibiachtRéimsí breise: Slánuimhir
minimum: 0maximum: 9223372036854775807
Roghnach

Leaganacha praghais a léadh roimhe, agus aitheantóir athraithigh mar eochair.

maxProperties: 250
Srianta
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionSlánuimhirRiachtanach

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

minimum: 1maximum: 9223372036854775807
Sampla: 1
feature_value_idsEagar <Teaghrán> Roghnach

Aitheantóirí na luachanna tréithe roghnaithe.

maxItems: 1000
Eagar:minLength: 1maxLength: 63
identifiersProductIdentifiers nullRoghnach

Cóid aitheantais táirge.

market_idsEagar <Teaghrán> Roghnach

Aitheantóirí na margaí roghnaithe.

maxItems: 1000
Eagar:minLength: 1maxLength: 63
media_idsEagar <Teaghrán> Roghnach

Aitheantóirí sócmhainní meán atá ann cheana.

maxItems: 30
Eagar:minLength: 1maxLength: 63
meta_descriptionTeaghrán nullRoghnach

Cur síos inneall cuardaigh sa teanga roghnaithe.

Teaghrán:maxLength: 160
meta_keywordsEagar <Teaghrán> nullRoghnach

Eochairfhocail inneall cuardaigh sa teanga roghnaithe.

Eagar:maxItems: 20
Eagar / Eagar:maxLength: 50
meta_titleTeaghrán nullRoghnach

Teideal inneall cuardaigh sa teanga roghnaithe.

Teaghrán:maxLength: 70
nameTeaghrán nullRoghnach

Ainm acmhainne sa chomhthéacs cuí.

Teaghrán:maxLength: 300
pricingProductPrice Roghnach

Cumraíocht praghsála agus a leaganacha comhreatha.

Sampla: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idTeaghrán nullRoghnach

Aitheantóir na príomhchatagóire.

Teaghrán:minLength: 1maxLength: 63
publishedLuach BooleRoghnach

An bhfuil an acmhainn foilsithe.

skuTeaghránRoghnach

Cód aonaid coimeádta stoic.

minLength: 1maxLength: 100
Srianta
pattern
"^\\S+$"
Sampla: "example"
slugTeaghrán nullRoghnach

Cuid de chosán URL sa teanga roghnaithe.

Teaghrán:maxLength: 160
tax_category_idTeaghrán nullRoghnach

Aitheantóir catagóire cánach.

Teaghrán:minLength: 1maxLength: 63
variant_value_idsEagar <Teaghrán> Roghnach

Aitheantóirí luachanna athraitheach roghnaithe.

maxItems: 250
Eagar:minLength: 1maxLength: 63
variants_enabledLuach BooleRoghnach

An úsáideann an táirge athraithigh.

Réimsí breise: Níl

ProductVersion

ProductVersion · Tá deireadh leis an oibríocht seo agus tugann sí 409 ar ais gan sonraí a athrú. Socraigh rochtain ar gach comhad digiteach trí fhaighteoirí a roghnú.
expected_versionSlánuimhirRiachtanach

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

minimum: 1maximum: 9223372036854775807
Sampla: 1

Réimsí breise: Níl

ReleaseData

ReleaseData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
changelogTeaghránRiachtanach

Cur síos ar athruithe

Sampla: "Manual update"
filesEagar <ReleaseFileData > Riachtanach

Comhaid táirge

Sampla: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
idTeaghránRiachtanach

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

format: "uuid"
Sampla: "00000000-0000-4000-8000-000000000001"
manifest_sha256Teaghrán nullRiachtanach

Eisiúintí digiteacha · SHA-256

Sampla: "1111111111111111111111111111111111111111111111111111111111111111"
published_atTeaghrán nullRiachtanach

Foilsigh an eisiúint · UTC

Teaghrán:format: "date-time"
Sampla: null
release_sequenceSlánuimhir nullRiachtanach

Eisiúintí digiteacha · Suíomh sa bhailiúchán ordaithe.

Sampla: null
stateTeaghránRiachtanach

Stádas

Sampla: "active"
version_labelTeaghránRiachtanach

Leagan

Sampla: "1.0"
withdrawn_atTeaghrán nullRiachtanach

Tarraing an tairiscint siar · UTC

Teaghrán:format: "date-time"
Sampla: null

Réimsí breise: Níl

ReleaseDraft

ReleaseDraft · Tá deireadh leis an oibríocht seo agus tugann sí 409 ar ais gan sonraí a athrú. Socraigh rochtain ar gach comhad digiteach trí fhaighteoirí a roghnú.
changelogTeaghránRoghnach

Cur síos ar athruithe

maxLength: 20000
Réamhshocrú: ""
expected_versionSlánuimhirRiachtanach

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

minimum: 1maximum: 9223372036854775807
Sampla: 1
version_idsEagar <Teaghrán> Riachtanach

Leagan · UUID[]

minItems: 1maxItems: 20
Eagar:format: "uuid"
Sampla: ["00000000-0000-4000-8000-000000000001"]
version_labelTeaghránRiachtanach

Leagan

minLength: 1maxLength: 64
Sampla: "1.0"

Réimsí breise: Níl

ReleaseFileData

ReleaseFileData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
file_idTeaghránRiachtanach

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

format: "uuid"
Sampla: "00000000-0000-4000-8000-000000000001"
sort_orderSlánuimhirRiachtanach

Suíomh sa bhailiúchán ordaithe.

Sampla: 0
version_idTeaghránRiachtanach

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

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

Réimsí breise: Níl

ReleaseListData

ReleaseListData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
current_release_idTeaghrán nullRiachtanach

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

Teaghrán:format: "uuid"
Sampla: "00000000-0000-4000-8000-000000000001"
product_versionSlánuimhirRiachtanach

Leagan reatha táirge le haghaidh rialú comhreatha.

Sampla: 2
releasesEagar <ReleaseData > Riachtanach

Eisiúintí digiteacha

Sampla: [{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}]
update_daysSlánuimhir nullRiachtanach

Líon laethanta (days; null)

Sampla: 365
update_modeTeaghránRiachtanach

Rochtain ar chomhaid amach anseo tar éis ceannaigh: none / period / unlimited

Sampla: "period"
update_monthsSlánuimhir nullRiachtanach

Míonna (months; null)

Sampla: null

Réimsí breise: Níl

UpdatePolicy

UpdatePolicy · Tá deireadh leis an oibríocht seo agus tugann sí 409 ar ais gan sonraí a athrú. Socraigh rochtain ar gach comhad digiteach trí fhaighteoirí a roghnú.
daysSlánuimhir nullRoghnach

Líon laethanta (1–3650; mode=period; months=null)

Slánuimhir:minimum: 1maximum: 3650
Sampla: 365
expected_versionSlánuimhirRiachtanach

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

minimum: 1maximum: 9223372036854775807
Sampla: 1
modeTeaghránRiachtanach

Rochtain ar chomhaid amach anseo tar éis ceannaigh: none / period / unlimited

Srianta
enum
["none", "period", "unlimited"]
Sampla: "period"
monthsSlánuimhir nullRoghnach

Míonna (1–120; mode=period; days=null)

Slánuimhir:minimum: 1maximum: 120
Sampla: null

Réimsí breise: Níl

UploadCreate

UploadCreate · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
filenameTeaghránRiachtanach

Comhad

minLength: 1maxLength: 255
Sampla: "manual.pdf"
product_idTeaghrán nullRoghnach

Aitheantóir táirge.

Srianta · Teaghrán 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Sampla: "example"
sha256TeaghránRiachtanach

SHA-256 (hex, 64)

Srianta
pattern
"^[0-9a-f]{64}$"
Sampla: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesSlánuimhirRiachtanach

Méid i mbearta

minimum: 1maximum: 262144000
Sampla: 46

Réimsí breise: Níl

UploadData

UploadData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
categoryFileCategory Riachtanach

Catagóir comhaid: internal / customer_document / digital

Sampla: "digital"
expires_atTeaghránRiachtanach

Dáta agus am éaga na ndintiúr.

format: "date-time"
Sampla: "2026-01-01T12:00:00Z"
filenameTeaghránRiachtanach

Comhad

Sampla: "manual.pdf"
idTeaghránRiachtanach

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

format: "uuid"
Sampla: "00000000-0000-4000-8000-000000000001"
product_idTeaghrán nullRiachtanach

Aitheantóir táirge.

Sampla: "example"
received_bytesSlánuimhirRiachtanach

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

Sampla: 46
sha256TeaghránRiachtanach

SHA-256 (hex, 64)

Sampla: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesSlánuimhirRiachtanach

Méid i mbearta

Sampla: 46
statusTeaghránRiachtanach

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

Sampla: "ready"

Réimsí breise: Níl