Schematy danych · Rabaty

Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

Schematy danych

ApiResponse[CampaignData]

ApiResponse_CampaignData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataCampaignData Wymagane: Dane poprawnej odpowiedzi.

Przykład: {"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 Wymagane: Metadane odpowiedzi.

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

Dodatkowe pola: Nie

ApiResponse[list[CampaignData]]

ApiResponse_list_CampaignData__ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataTablica <CampaignData > Wymagane: Dane poprawnej odpowiedzi.

Przykład: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane: Metadane odpowiedzi.

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

Dodatkowe pola: Nie

CampaignCreate

CampaignCreate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

audienceTekstOpcjonalne

Klienci

Ograniczenia

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

Wartość domyślna: "all"

benefit_typeTekstOpcjonalne

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia

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

Wartość domyślna: "percentage"

category_idsTablica <Tekst> Opcjonalne

Identyfikatory powiązanych kategorii.

maxItems: 1000

Ograniczenia · Tablica 1

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

codeTekst nullOpcjonalne

Stały kod przeznaczony do przetwarzania przez integrację.

Ograniczenia · Tekst 1

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

Przykład: "LEARN10"

combine_couponsWartość logicznaOpcjonalne

Łącz z innymi kodami

Wartość domyślna: false

combine_promotionsWartość logicznaOpcjonalne

Zezwól na użycie kodu na produktach objętych automatyczną promocją

Wartość domyślna: false

customer_idsTablica <Tekst> Opcjonalne

Dane klienta zapisane dla tego zasobu.

maxItems: 1000

Ograniczenia · Tablica 1

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

ends_atTekst nullOpcjonalne

Aktywny do

Tekst:format: "date-time"

free_shippingWartość logicznaOpcjonalne

Darmowa dostawa

Wartość domyślna: false

marketsTablica <MarketData-Input > Wymagane

Rynki dostępne w kontekście sklepu.

minItems: 1maxItems: 1000

Przykład: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityLiczba całkowitaOpcjonalne

Minimalna liczba sztuk w koszyku

minimum: 1maximum: 2147483647

Wartość domyślna: 1

nameTekstWymagane

Nazwa zasobu we właściwym kontekście.

minLength: 1maxLength: 160

Przykład: "Autumn guide offer"

per_customer_limitLiczba całkowitaOpcjonalne

Limit użyć na klienta

minimum: -1maximum: 2147483647

Wartość domyślna: -1

percentageTekstOpcjonalne

Procentowy

maxLength: 19

Ograniczenia

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

Wartość domyślna: "10"

product_idsTablica <Tekst> Opcjonalne

Identyfikatory powiązanych produktów.

maxItems: 1000

Ograniczenia · Tablica 1

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

product_scopeTekstOpcjonalne

Produkty

Ograniczenia

enum: ["all", "selected"]

Wartość domyślna: "all"

show_accountWartość logicznaOpcjonalne

Na koncie klienta

Wartość domyślna: false

show_cartWartość logicznaOpcjonalne

W koszyku

Wartość domyślna: false

show_productWartość logicznaOpcjonalne

Na stronach produktów

Wartość domyślna: false

starts_atTekst nullOpcjonalne

Aktywny od

Tekst:format: "date-time"

usage_limitLiczba całkowitaOpcjonalne

Limit użyć

minimum: -1maximum: 2147483647

Wartość domyślna: -1

Dodatkowe pola: Nie

CampaignData

CampaignData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

audienceTekstOpcjonalne

Klienci

Ograniczenia

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

Wartość domyślna: "all"

benefit_typeTekstOpcjonalne

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia

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

Wartość domyślna: "percentage"

category_idsTablica <Tekst> Opcjonalne

Identyfikatory powiązanych kategorii.

maxItems: 1000

Ograniczenia · Tablica 1

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

codeTekst nullOpcjonalne

Stały kod przeznaczony do przetwarzania przez integrację.

Ograniczenia · Tekst 1

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

combine_couponsWartość logicznaOpcjonalne

Łącz z innymi kodami

Wartość domyślna: false

combine_promotionsWartość logicznaOpcjonalne

Zezwól na użycie kodu na produktach objętych automatyczną promocją

Wartość domyślna: false

created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"

Przykład: "2026-10-07T10:00:00Z"

created_byCreatorData Wymagane

Utworzony przez

Przykład: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_idsTablica <Tekst> Opcjonalne

Dane klienta zapisane dla tego zasobu.

maxItems: 1000

Ograniczenia · Tablica 1

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

enabledWartość logicznaWymagane

Czy ustawienie jest włączone.

Przykład: false

ends_atTekst nullOpcjonalne

Aktywny do

Tekst:format: "date-time"

free_shippingWartość logicznaOpcjonalne

Darmowa dostawa

Wartość domyślna: false

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API.

Przykład: "example-campaign"

kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia

enum: ["coupon", "promotion"]

Przykład: "coupon"

marketsTablica <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Wymagane

Rynki dostępne w kontekście sklepu.

minItems: 1maxItems: 1000

Przykład: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantityLiczba całkowitaOpcjonalne

Minimalna liczba sztuk w koszyku

minimum: 1maximum: 2147483647

Wartość domyślna: 1

nameTekstWymagane

Nazwa zasobu we właściwym kontekście.

minLength: 1maxLength: 160

Przykład: "Autumn guide offer"

per_customer_limitLiczba całkowitaOpcjonalne

Limit użyć na klienta

minimum: -1maximum: 2147483647

Wartość domyślna: -1

percentageTekstOpcjonalne

Procentowy

maxLength: 19

Ograniczenia

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

Wartość domyślna: "10"

product_idsTablica <Tekst> Opcjonalne

Identyfikatory powiązanych produktów.

maxItems: 1000

Ograniczenia · Tablica 1

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

product_scopeTekstOpcjonalne

Produkty

Ograniczenia

enum: ["all", "selected"]

Wartość domyślna: "all"

show_accountWartość logicznaOpcjonalne

Na koncie klienta

Wartość domyślna: false

show_cartWartość logicznaOpcjonalne

W koszyku

Wartość domyślna: false

show_productWartość logicznaOpcjonalne

Na stronach produktów

Wartość domyślna: false

starts_atTekst nullOpcjonalne

Aktywny od

Tekst:format: "date-time"

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-10-07T10:00:00Z"

usage_limitLiczba całkowitaOpcjonalne

Limit użyć

minimum: -1maximum: 2147483647

Wartość domyślna: -1

used_countLiczba całkowitaWymagane

Wykorzystano

Przykład: 0

versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

CampaignStatus

CampaignStatus · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

enabledWartość logicznaWymagane: Czy ustawienie jest włączone.

Przykład: false
expected_versionLiczba całkowitaWymagane: Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807

Przykład: 1

Dodatkowe pola: Nie

CampaignUpdate

CampaignUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

audienceTekstOpcjonalne

Klienci

Ograniczenia

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

Wartość domyślna: "all"

benefit_typeTekstOpcjonalne

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia

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

Wartość domyślna: "percentage"

category_idsTablica <Tekst> Opcjonalne

Identyfikatory powiązanych kategorii.

maxItems: 1000

Ograniczenia · Tablica 1

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

codeTekst nullOpcjonalne

Stały kod przeznaczony do przetwarzania przez integrację.

Ograniczenia · Tekst 1

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

Przykład: "LEARN10"

combine_couponsWartość logicznaOpcjonalne

Łącz z innymi kodami

Wartość domyślna: false

combine_promotionsWartość logicznaOpcjonalne

Zezwól na użycie kodu na produktach objętych automatyczną promocją

Wartość domyślna: false

customer_idsTablica <Tekst> Opcjonalne

Dane klienta zapisane dla tego zasobu.

maxItems: 1000

Ograniczenia · Tablica 1

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

ends_atTekst nullOpcjonalne

Aktywny do

Tekst:format: "date-time"

expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807

Przykład: 1

free_shippingWartość logicznaOpcjonalne

Darmowa dostawa

Wartość domyślna: false

marketsTablica <MarketData-Input > Wymagane

Rynki dostępne w kontekście sklepu.

minItems: 1maxItems: 1000

Przykład: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityLiczba całkowitaOpcjonalne

Minimalna liczba sztuk w koszyku

minimum: 1maximum: 2147483647

Wartość domyślna: 1

nameTekstWymagane

Nazwa zasobu we właściwym kontekście.

minLength: 1maxLength: 160

Przykład: "Autumn guide offer"

per_customer_limitLiczba całkowitaOpcjonalne

Limit użyć na klienta

minimum: -1maximum: 2147483647

Wartość domyślna: -1

percentageTekstOpcjonalne

Procentowy

maxLength: 19

Ograniczenia

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

Wartość domyślna: "10"

product_idsTablica <Tekst> Opcjonalne

Identyfikatory powiązanych produktów.

maxItems: 1000

Ograniczenia · Tablica 1

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

product_scopeTekstOpcjonalne

Produkty

Ograniczenia

enum: ["all", "selected"]

Wartość domyślna: "all"

show_accountWartość logicznaOpcjonalne

Na koncie klienta

Wartość domyślna: false

show_cartWartość logicznaOpcjonalne

W koszyku

Wartość domyślna: false

show_productWartość logicznaOpcjonalne

Na stronach produktów

Wartość domyślna: false

starts_atTekst nullOpcjonalne

Aktywny od

Tekst:format: "date-time"

usage_limitLiczba całkowitaOpcjonalne

Limit użyć

minimum: -1maximum: 2147483647

Wartość domyślna: -1

Dodatkowe pola: Nie

CreatorData

CreatorData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia

enum: ["admin", "api"]

Przykład: "admin"

labelTekstWymagane

Nazwa zasobu we właściwym kontekście.

Przykład: "Editorial integration"

referenceTekstWymagane

Identyfikator wskazanego obiektu.

Przykład: "learn-api-key"

Dodatkowe pola: Nie

MarketData

MarketData-Input · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

currencyTekstWymagane

Kod waluty kwoty.

Ograniczenia

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

Przykład: "PLN"

fixed_amountTekstOpcjonalne

Kwota rabatu

maxLength: 19

Ograniczenia

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

Wartość domyślna: "0"

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

Ograniczenia

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

Przykład: "poland"

maximum_priceTekst nullOpcjonalne

Maksymalna cena produktu

Tekst:maxLength: 19

Ograniczenia · Tekst 1

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

minimum_priceTekst nullOpcjonalne

Minimalna cena produktu

Tekst:maxLength: 19

Ograniczenia · Tekst 1

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

minimum_subtotalTekstOpcjonalne

Minimalna wartość koszyka

maxLength: 19

Ograniczenia

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

Wartość domyślna: "0"

minor_unitsLiczba całkowitaWymagane

Liczba cyfr części ułamkowej używanych przez walutę.

minimum: 0maximum: 4

Przykład: 2

Dodatkowe pola: Nie

MarketData

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

currencyTekstWymagane

Kod waluty kwoty.

Ograniczenia

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

Przykład: "PLN"

fixed_amountTekstOpcjonalne

Kwota rabatu

maxLength: 19

Ograniczenia

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

Wartość domyślna: "0"

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

Ograniczenia

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

Przykład: "poland"

maximum_priceTekst nullOpcjonalne

Maksymalna cena produktu

Tekst:maxLength: 19

Ograniczenia · Tekst 1

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

minimum_priceTekst nullOpcjonalne

Minimalna cena produktu

Tekst:maxLength: 19

Ograniczenia · Tekst 1

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

minimum_subtotalTekstOpcjonalne

Minimalna wartość koszyka

maxLength: 19

Ograniczenia

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

Wartość domyślna: "0"

minor_unitsLiczba całkowitaWymagane

Liczba cyfr części ułamkowej używanych przez walutę.

minimum: 0maximum: 4

Przykład: 0

Dodatkowe pola: Nie