Scéimeanna sonraí · Lascainí

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

Scéimeanna sonraí

ApiResponse[CampaignData]

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

dataCampaignData Riachtanach: Sonraí freagra rathúil.

Sampla: {"created_at":"2026-10-07T10:00:00Z","created_by":{"kind":"admin","label":"Editorial integration","reference":"learn-api-key"},"enabled":false,"id":"example-campaign","kind":"coupon","markets":[{"currency":"PLN","market_id":"poland","minor_units":0}],"name":"Autumn guide offer","updated_at":"2026-10-07T10:00:00Z","used_count":0,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Riachtanach: Meiteashonraí an fhreagra.

Sampla: {"locale":"example","market_code":"example","market_id":"poland","pagination":{"has_more":false,"limit":1,"next_cursor":null},"request_id":"learn-example-request"}

Réimsí breise: Níl

ApiResponse[list[CampaignData]]

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

dataEagar <CampaignData > Riachtanach: Sonraí freagra rathúil.

Sampla: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Riachtanach: Meiteashonraí an fhreagra.

Sampla: {"locale":"example","market_code":"example","market_id":"poland","pagination":{"has_more":false,"limit":1,"next_cursor":null},"request_id":"learn-example-request"}

Réimsí breise: Níl

CampaignCreate

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

audienceTeaghránRoghnach

Custaiméirí

Srianta

enum: ["all", "guest", "customer", "selected"]

Réamhshocrú: "all"

benefit_typeTeaghránRoghnach

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

Srianta

enum: ["percentage", "fixed", "none"]

Réamhshocrú: "percentage"

category_idsEagar <Teaghrán> Roghnach

Aitheantóirí catagóirí gaolmhara.

maxItems: 1000

Srianta · Eagar 1

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

codeTeaghrán nullRoghnach

Cód cobhsaí atá inléite ag meaisín.

Srianta · Teaghrán 1

pattern: "^[A-Za-z0-9]{6,16}$"

Sampla: "LEARN10"

combine_couponsLuach BooleRoghnach

Cuir le cóid eile

Réamhshocrú: false

combine_promotionsLuach BooleRoghnach

Ceadaigh an cód seo ar tháirgí le tairiscintí uathoibríocha

Réamhshocrú: false

customer_idsEagar <Teaghrán> Roghnach

Eolas custaiméara taifeadta don acmhainn seo.

maxItems: 1000

Srianta · Eagar 1

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

ends_atTeaghrán nullRoghnach

Gníomhach go dtí

Teaghrán:format: "date-time"

free_shippingLuach BooleRoghnach

Seachadadh saor in aisce

Réamhshocrú: false

marketsEagar <MarketData-Input > Riachtanach

Margaí atá ar fáil i gcomhthéacs an tsiopa.

minItems: 1maxItems: 1000

Sampla: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantitySlánuimhirRoghnach

Íoslíon earraí sa chiseán

minimum: 1maximum: 2147483647

Réamhshocrú: 1

nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

minLength: 1maxLength: 160

Sampla: "Autumn guide offer"

per_customer_limitSlánuimhirRoghnach

Teorainn úsáide in aghaidh an chustaiméara

minimum: -1maximum: 2147483647

Réamhshocrú: -1

percentageTeaghránRoghnach

Céatadán

maxLength: 19

Srianta

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Réamhshocrú: "10"

product_idsEagar <Teaghrán> Roghnach

Aitheantóirí táirgí gaolmhara.

maxItems: 1000

Srianta · Eagar 1

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

product_scopeTeaghránRoghnach

Táirgí

Srianta

enum: ["all", "selected"]

Réamhshocrú: "all"

show_accountLuach BooleRoghnach

I gcuntas an chustaiméara

Réamhshocrú: false

show_cartLuach BooleRoghnach

Sa chiseán

Réamhshocrú: false

show_productLuach BooleRoghnach

Ar leathanaigh táirgí

Réamhshocrú: false

starts_atTeaghrán nullRoghnach

Gníomhach ó

Teaghrán:format: "date-time"

usage_limitSlánuimhirRoghnach

Teorainn úsáide

minimum: -1maximum: 2147483647

Réamhshocrú: -1

Réimsí breise: Níl

CampaignData

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

audienceTeaghránRoghnach

Custaiméirí

Srianta

enum: ["all", "guest", "customer", "selected"]

Réamhshocrú: "all"

benefit_typeTeaghránRoghnach

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

Srianta

enum: ["percentage", "fixed", "none"]

Réamhshocrú: "percentage"

category_idsEagar <Teaghrán> Roghnach

Aitheantóirí catagóirí gaolmhara.

maxItems: 1000

Srianta · Eagar 1

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

codeTeaghrán nullRoghnach

Cód cobhsaí atá inléite ag meaisín.

Srianta · Teaghrán 1

pattern: "^[A-Za-z0-9]{6,16}$"

combine_couponsLuach BooleRoghnach

Cuir le cóid eile

Réamhshocrú: false

combine_promotionsLuach BooleRoghnach

Ceadaigh an cód seo ar tháirgí le tairiscintí uathoibríocha

Réamhshocrú: false

created_atTeaghránRiachtanach

Am cruthaithe.

format: "date-time"

Sampla: "2026-10-07T10:00:00Z"

created_byCreatorData Riachtanach

Cruthaithe ag

Sampla: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_idsEagar <Teaghrán> Roghnach

Eolas custaiméara taifeadta don acmhainn seo.

maxItems: 1000

Srianta · Eagar 1

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

enabledLuach BooleRiachtanach

An bhfuil an socrú seo cumasaithe.

Sampla: false

ends_atTeaghrán nullRoghnach

Gníomhach go dtí

Teaghrán:format: "date-time"

free_shippingLuach BooleRoghnach

Seachadadh saor in aisce

Réamhshocrú: false

idTeaghránRiachtanach

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

Sampla: "example-campaign"

kindTeaghránRiachtanach

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

Srianta

enum: ["coupon", "promotion"]

Sampla: "coupon"

marketsEagar <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Riachtanach

Margaí atá ar fáil i gcomhthéacs an tsiopa.

minItems: 1maxItems: 1000

Sampla: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantitySlánuimhirRoghnach

Íoslíon earraí sa chiseán

minimum: 1maximum: 2147483647

Réamhshocrú: 1

nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

minLength: 1maxLength: 160

Sampla: "Autumn guide offer"

per_customer_limitSlánuimhirRoghnach

Teorainn úsáide in aghaidh an chustaiméara

minimum: -1maximum: 2147483647

Réamhshocrú: -1

percentageTeaghránRoghnach

Céatadán

maxLength: 19

Srianta

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Réamhshocrú: "10"

product_idsEagar <Teaghrán> Roghnach

Aitheantóirí táirgí gaolmhara.

maxItems: 1000

Srianta · Eagar 1

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

product_scopeTeaghránRoghnach

Táirgí

Srianta

enum: ["all", "selected"]

Réamhshocrú: "all"

show_accountLuach BooleRoghnach

I gcuntas an chustaiméara

Réamhshocrú: false

show_cartLuach BooleRoghnach

Sa chiseán

Réamhshocrú: false

show_productLuach BooleRoghnach

Ar leathanaigh táirgí

Réamhshocrú: false

starts_atTeaghrán nullRoghnach

Gníomhach ó

Teaghrán:format: "date-time"

updated_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"

Sampla: "2026-10-07T10:00:00Z"

usage_limitSlánuimhirRoghnach

Teorainn úsáide

minimum: -1maximum: 2147483647

Réamhshocrú: -1

used_countSlánuimhirRiachtanach

Líon na n-úsáidí

Sampla: 0

versionSlánuimhirRiachtanach

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

Sampla: 1

Réimsí breise: Níl

CampaignStatus

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

enabledLuach BooleRiachtanach: An bhfuil an socrú seo cumasaithe.

Sampla: false
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

CampaignUpdate

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

audienceTeaghránRoghnach

Custaiméirí

Srianta

enum: ["all", "guest", "customer", "selected"]

Réamhshocrú: "all"

benefit_typeTeaghránRoghnach

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

Srianta

enum: ["percentage", "fixed", "none"]

Réamhshocrú: "percentage"

category_idsEagar <Teaghrán> Roghnach

Aitheantóirí catagóirí gaolmhara.

maxItems: 1000

Srianta · Eagar 1

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

codeTeaghrán nullRoghnach

Cód cobhsaí atá inléite ag meaisín.

Srianta · Teaghrán 1

pattern: "^[A-Za-z0-9]{6,16}$"

Sampla: "LEARN10"

combine_couponsLuach BooleRoghnach

Cuir le cóid eile

Réamhshocrú: false

combine_promotionsLuach BooleRoghnach

Ceadaigh an cód seo ar tháirgí le tairiscintí uathoibríocha

Réamhshocrú: false

customer_idsEagar <Teaghrán> Roghnach

Eolas custaiméara taifeadta don acmhainn seo.

maxItems: 1000

Srianta · Eagar 1

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

ends_atTeaghrán nullRoghnach

Gníomhach go dtí

Teaghrán:format: "date-time"

expected_versionSlánuimhirRiachtanach

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

minimum: 1maximum: 9223372036854775807

Sampla: 1

free_shippingLuach BooleRoghnach

Seachadadh saor in aisce

Réamhshocrú: false

marketsEagar <MarketData-Input > Riachtanach

Margaí atá ar fáil i gcomhthéacs an tsiopa.

minItems: 1maxItems: 1000

Sampla: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantitySlánuimhirRoghnach

Íoslíon earraí sa chiseán

minimum: 1maximum: 2147483647

Réamhshocrú: 1

nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

minLength: 1maxLength: 160

Sampla: "Autumn guide offer"

per_customer_limitSlánuimhirRoghnach

Teorainn úsáide in aghaidh an chustaiméara

minimum: -1maximum: 2147483647

Réamhshocrú: -1

percentageTeaghránRoghnach

Céatadán

maxLength: 19

Srianta

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Réamhshocrú: "10"

product_idsEagar <Teaghrán> Roghnach

Aitheantóirí táirgí gaolmhara.

maxItems: 1000

Srianta · Eagar 1

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

product_scopeTeaghránRoghnach

Táirgí

Srianta

enum: ["all", "selected"]

Réamhshocrú: "all"

show_accountLuach BooleRoghnach

I gcuntas an chustaiméara

Réamhshocrú: false

show_cartLuach BooleRoghnach

Sa chiseán

Réamhshocrú: false

show_productLuach BooleRoghnach

Ar leathanaigh táirgí

Réamhshocrú: false

starts_atTeaghrán nullRoghnach

Gníomhach ó

Teaghrán:format: "date-time"

usage_limitSlánuimhirRoghnach

Teorainn úsáide

minimum: -1maximum: 2147483647

Réamhshocrú: -1

Réimsí breise: Níl

CreatorData

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

kindTeaghránRiachtanach

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

Srianta

enum: ["admin", "api"]

Sampla: "admin"

labelTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Editorial integration"

referenceTeaghránRiachtanach

Aitheantóir na heintitis dá dtagraítear.

Sampla: "learn-api-key"

Réimsí breise: Níl

MarketData

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

currencyTeaghránRiachtanach

Cód airgeadra na suime.

Srianta

pattern: "^[A-Z]{3}$"

Sampla: "PLN"

fixed_amountTeaghránRoghnach

Méid na lascaine

maxLength: 19

Srianta

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Réamhshocrú: "0"

market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

Srianta

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

Sampla: "poland"

maximum_priceTeaghrán nullRoghnach

Uasphraghas an táirge

Teaghrán:maxLength: 19

Srianta · Teaghrán 1

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

minimum_priceTeaghrán nullRoghnach

Íosphraghas an táirge

Teaghrán:maxLength: 19

Srianta · Teaghrán 1

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

minimum_subtotalTeaghránRoghnach

Íosluach an chiseáin

maxLength: 19

Srianta

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Réamhshocrú: "0"

minor_unitsSlánuimhirRiachtanach

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

minimum: 0maximum: 4

Sampla: 2

Réimsí breise: Níl

MarketData

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

currencyTeaghránRiachtanach

Cód airgeadra na suime.

Srianta

pattern: "^[A-Z]{3}$"

Sampla: "PLN"

fixed_amountTeaghránRoghnach

Méid na lascaine

maxLength: 19

Srianta

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Réamhshocrú: "0"

market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

Srianta

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

Sampla: "poland"

maximum_priceTeaghrán nullRoghnach

Uasphraghas an táirge

Teaghrán:maxLength: 19

Srianta · Teaghrán 1

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

minimum_priceTeaghrán nullRoghnach

Íosphraghas an táirge

Teaghrán:maxLength: 19

Srianta · Teaghrán 1

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

minimum_subtotalTeaghránRoghnach

Íosluach an chiseáin

maxLength: 19

Srianta

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Réamhshocrú: "0"

minor_unitsSlánuimhirRiachtanach

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

minimum: 0maximum: 4

Sampla: 0

Réimsí breise: Níl