Gå til indhold
ShopentlyLearn

Dataskemaer: Produkter

Dataskemaer: Produkter. Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Dataskemaer

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer. Upload filer som multipart/form-data efter oprettelse af upload_id, og knyt dem til produktet. Download kræver et Bearer-token og rettighed til category; svaret indeholder filens bytes uden offentlig adresse eller adgangskode. Ved mode=period vælges days (1–3650) eller den hidtidige months, aldrig begge. Vilkårene gemmes ved købet; en refundering fjerner kun adgang til den refunderede ordrelinje.
dataProductFileListData Obligatorisk

Indholdet af et vellykket svar.

Eksempel: {"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 Obligatorisk

Svarmetadata.

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

Yderligere felter: Nej

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer. Upload filer som multipart/form-data efter oprettelse af upload_id, og knyt dem til produktet. Download kræver et Bearer-token og rettighed til category; svaret indeholder filens bytes uden offentlig adresse eller adgangskode. Ved mode=period vælges days (1–3650) eller den hidtidige months, aldrig begge. Vilkårene gemmes ved købet; en refundering fjerner kun adgang til den refunderede ordrelinje.
dataReleaseListData Obligatorisk

Indholdet af et vellykket svar.

Eksempel: {"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 Obligatorisk

Svarmetadata.

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

Yderligere felter: Nej

ApiResponse_UploadData_

ApiResponse_UploadData_ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer. Upload filer som multipart/form-data efter oprettelse af upload_id, og knyt dem til produktet. Download kræver et Bearer-token og rettighed til category; svaret indeholder filens bytes uden offentlig adresse eller adgangskode. Ved mode=period vælges days (1–3650) eller den hidtidige months, aldrig begge. Vilkårene gemmes ved købet; en refundering fjerner kun adgang til den refunderede ordrelinje.
dataUploadData Obligatorisk

Indholdet af et vellykket svar.

Eksempel: {"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 Obligatorisk

Svarmetadata.

Eksempel: {"request_id":"example"}

Yderligere felter: Nej

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · Læs adgangsreglen og produktversionen. Første offentliggørelse forbliver tidsgrundlaget.
dataAudienceData Obligatorisk

Indholdet af et vellykket svar.

Eksempel: {"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 Obligatorisk

Svarmetadata.

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

Yderligere felter: Nej

Vis liste — Produkter — Svar

ApiResponse_list_ProductSummaryData__ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
dataArray <ProductSummaryData > Obligatorisk

Eksempel på svar · ApiResponse_list_ProductSummaryData__.

Eksempel: [{"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 Obligatorisk

Svarmetadata.

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

Yderligere felter: Nej

Hent — Produkter — Svar

ApiResponse_ProductDetailData_ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
dataProductDetailData Obligatorisk

Eksempel på svar · ProductDetailData.

Eksempel: {"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 Obligatorisk

Svarmetadata.

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

Yderligere felter: Nej

AudienceChange

AudienceChange · Vælg berettigede køb. Valgte ordrer skal indeholde dette produkt som betalt og ikke refunderet.
audienceAudienceSelection Obligatorisk

Udtrykkelig adgangsregel for den fælles fil.

Eksempel: {"mode":"all_purchasers"}
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1

Yderligere felter: Nej

AudienceData

AudienceData · Læs adgangsreglen og produktversionen. Første offentliggørelse forbliver tidsgrundlaget.
anchor_atStrengObligatorisk

Første offentliggørelse; ændres ikke ved en ny regel.

format: "date-time"
Eksempel: "2026-11-03T12:00:00Z"
effective_atStrengObligatorisk

Tidspunkt for offentliggørelse af adgangsreglen.

format: "date-time"
Eksempel: "2026-11-03T12:00:00Z"
file_idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. · file_id

Eksempel: "00000000-0000-4000-8000-000000000007"
file_version_idStrengObligatorisk

ID for en uforanderlig filversion.

Eksempel: "00000000-0000-4000-8000-000000000010"
historical_access_preservedBoolesk værdiValgfrit

Tidligere tildelte rettigheder bevares, når reglen begrænses.

Standard: trueEksempel: true
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

Eksempel: "00000000-0000-4000-8000-000000000009"
lookback_daysHeltal nullObligatorisk

1–3650 dage før første offentliggørelse; kun recent_and_new.

Eksempel: null
modeStrengObligatorisk

Udtrykkelig adgangsregel for den fælles fil. new_purchases / recent_and_new / selected / all_purchasers.

Eksempel: "all_purchasers"
next_cursorStreng nullObligatorisk

Fortsættelsesværdi for næste side eller null.

Eksempel: null
order_idsArray <Streng> Obligatorisk

Ordrer med dette betalte, ikke refunderede produkt.

Eksempel: []
product_versionHeltalObligatorisk

Aktuel produktversion til samtidighedskontrol.

Eksempel: 3
revisionHeltalObligatorisk

Fortløbende revision af adgangsreglen.

Eksempel: 1

Yderligere felter: Nej

AudienceSelection

AudienceSelection · Vælg berettigede køb. Valgte ordrer skal indeholde dette produkt som betalt og ikke refunderet.
lookback_daysHeltal nullValgfrit

1–3650 dage før første offentliggørelse; kun recent_and_new.

Heltal:minimum: 1maximum: 3650
modeStrengObligatorisk

Udtrykkelig adgangsregel for den fælles fil. new_purchases / recent_and_new / selected / all_purchasers.

Begrænsninger
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
Eksempel: "new_purchases"
order_idsArray <Streng> Valgfrit

Ordrer med dette betalte, ikke refunderede produkt.

maxItems: 1000
Begrænsninger · Array 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Standard: []

Yderligere felter: Nej

Tilgængelighedsoplysninger for den valgte kontekst

AvailabilityData · Skema · Dataskemaer: Produkter
available_fromStreng nullObligatorisk

Begyndelsen af tilgængelighedsperioden.

Streng:format: "date-time"
Eksempel: null
available_untilStreng nullObligatorisk

Slutningen af tilgængelighedsperioden.

Streng:format: "date-time"
Eksempel: null
is_availableBoolesk værdiObligatorisk

Om varen er tilgængelig i denne kontekst.

Eksempel: true

Yderligere felter: Nej

FileAssign

FileAssign · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer. Upload filer som multipart/form-data efter oprettelse af upload_id, og knyt dem til produktet. Download kræver et Bearer-token og rettighed til category; svaret indeholder filens bytes uden offentlig adresse eller adgangskode. Ved mode=period vælges days (1–3650) eller den hidtidige months, aldrig begge. Vilkårene gemmes ved købet; en refundering fjerner kun adgang til den refunderede ordrelinje.
audienceAudienceSelection nullValgfrit

Udtrykkelig adgangsregel for den fælles fil.

Eksempel: {"mode":"new_purchases"}
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
labelStrengValgfrit

Ressourcens navn i den relevante kontekst.

maxLength: 300
Standard: ""
upload_idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. · upload_id

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

Yderligere felter: Nej

FileCategory

FileCategory · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer. Upload filer som multipart/form-data efter oprettelse af upload_id, og knyt dem til produktet. Download kræver et Bearer-token og rettighed til category; svaret indeholder filens bytes uden offentlig adresse eller adgangskode. Ved mode=period vælges days (1–3650) eller den hidtidige months, aldrig begge. Vilkårene gemmes ved købet; en refundering fjerner kun adgang til den refunderede ordrelinje.
Streng
Begrænsninger
enum
["internal", "customer_document", "digital"]

Yderligere felter: Ja

Prisoplysninger i den valgte kontekst

PriceData · Skema · Dataskemaer: Produkter
amountStrengObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

Eksempel: "0.00"
currencyStrengObligatorisk

Valutakode for beløbet.

Begrænsninger
pattern
"^[A-Z]{3}$"
Eksempel: "PLN"
minor_unitsHeltalObligatorisk

Antal decimaler, som valutaen bruger.

minimum: 0maximum: 4
Eksempel: 2
tax_includedBoolesk værdiObligatorisk

Om den indsendte pris inkluderer afgifter.

Eksempel: true

Yderligere felter: Nej

Prislisteoplysninger

PriceListData · Skema · Dataskemaer: Produkter
currencyStrengObligatorisk

Valutakode for beløbet.

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (PriceListData).

tax_includedBoolesk værdiObligatorisk

Om den indsendte pris inkluderer afgifter.

versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Yderligere felter: Nej

Opret — Produkter — Forespørgselsindhold

ProductCreate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
brand_idStreng nullValgfrit

Mærkeidentifikator.

Streng:minLength: 1maxLength: 63
conditionStrengValgfrit

Produktets stand.

Begrænsninger
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Standard: "new"
descriptionStreng nullValgfrit

Beskrivelse på det valgte sprog.

Streng:maxLength: 100000
feature_value_idsArray <Streng> Valgfrit

Identifikatorer for valgte egenskabsværdier.

maxItems: 1000
Array:minLength: 1maxLength: 63
identifiersProductIdentifiers nullValgfrit

Produktidentifikationskoder.

market_idsArray <Streng> Valgfrit

Identifikatorer for valgte markeder.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Streng> Valgfrit

Identifikatorer for allerede eksisterende medier.

maxItems: 30
Array:minLength: 1maxLength: 63
meta_descriptionStreng nullValgfrit

Beskrivelse til søgemaskiner på det valgte sprog.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfrit

Nøgleord til søgemaskiner på det valgte sprog.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleStreng nullValgfrit

Titel til søgemaskiner på det valgte sprog.

Streng:maxLength: 70
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

minLength: 1maxLength: 300
Eksempel: "Example"
pricingProductPrice Valgfrit

Priskonfiguration og dens versioner til samtidighedskontrol.

primary_category_idStreng nullValgfrit

Identifikator for primær kategori.

Streng:minLength: 1maxLength: 63
publishedBoolesk værdiValgfrit

Om ressourcen er offentliggjort.

Standard: false
skuStrengObligatorisk

SKU-varekode.

minLength: 1maxLength: 100
Begrænsninger
pattern
"^\\S+$"
Eksempel: "example"
slugStreng nullValgfrit

URL-stisegment på det valgte sprog.

Streng:maxLength: 160
tax_category_idStreng nullValgfrit

Identifikator for afgiftskategori.

Streng:minLength: 1maxLength: 63
variant_value_idsArray <Streng> Valgfrit

Identifikatorer for valgte variantværdier.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBoolesk værdiValgfrit

Om produktet bruger varianter.

Standard: false

Yderligere felter: Nej

Hent — Produkter — Svar

ProductDetailData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
availabilityAvailabilityData Obligatorisk

Tilgængelighedsoplysninger for den valgte kontekst.

Eksempel: {"available_from":null,"available_until":null,"is_available":true}
brand_idStreng nullObligatorisk

Mærkeidentifikator.

Eksempel: null
conditionStrengObligatorisk

Produktets stand.

Begrænsninger
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Eksempel: "new"
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
descriptionStreng nullObligatorisk

Beskrivelse på det valgte sprog.

Eksempel: "example"
featuresArray <FeatureSelectionData > Obligatorisk

Produktegenskaber.

Eksempel: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (ProductDetailData).

Eksempel: "example"
identifiersObjektYderligere felter: StrengObligatorisk

Produktidentifikationskoder.

Eksempel: {}
mediaArray <ProductMediaData > Obligatorisk

Oplysninger om tilknyttede medier.

Eksempel: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_descriptionStreng nullObligatorisk

Beskrivelse til søgemaskiner på det valgte sprog.

Eksempel: "example"
meta_keywordsArray <Streng> nullObligatorisk

Nøgleord til søgemaskiner på det valgte sprog.

Eksempel: ["example"]
meta_titleStreng nullObligatorisk

Titel til søgemaskiner på det valgte sprog.

Eksempel: "example"
nameStreng nullObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"
numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "example"
pricePriceData nullObligatorisk

Prisoplysninger i den valgte kontekst.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionHeltalObligatorisk

Aktuel prisversion til samtidighedskontrol.

Eksempel: 1
primary_category_idStreng nullObligatorisk

Identifikator for primær kategori.

Eksempel: "example"
primary_media_idStreng nullObligatorisk

Identifikator for primært medie.

Eksempel: "example"
publishedBoolesk værdiObligatorisk

Om ressourcen er offentliggjort.

Eksempel: false
skuStrengObligatorisk

SKU-varekode.

Eksempel: "example"
slugStreng nullObligatorisk

URL-stisegment på det valgte sprog.

Eksempel: "example"
tax_category_idStrengObligatorisk

Identifikator for afgiftskategori.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
variants_enabledBoolesk værdiObligatorisk

Om produktet bruger varianter.

Eksempel: false
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

ProductFileData

ProductFileData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer. Upload filer som multipart/form-data efter oprettelse af upload_id, og knyt dem til produktet. Download kræver et Bearer-token og rettighed til category; svaret indeholder filens bytes uden offentlig adresse eller adgangskode. Ved mode=period vælges days (1–3650) eller den hidtidige months, aldrig begge. Vilkårene gemmes ved købet; en refundering fjerner kun adgang til den refunderede ordrelinje.
categoryFileCategory Obligatorisk

Filkategori: internal / customer_document / digital

Eksempel: "digital"
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
current_version_idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. · current_version_id

format: "uuid"
Eksempel: "00000000-0000-4000-8000-000000000001"
file_idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. · file_id

format: "uuid"
Eksempel: "00000000-0000-4000-8000-000000000001"
filenameStrengObligatorisk

Fil

Eksempel: "manual.pdf"
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

format: "uuid"
Eksempel: "00000000-0000-4000-8000-000000000001"
labelStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Manual"
mime_typeStrengObligatorisk

Mediets indholdstype.

Eksempel: "application/pdf"
sha256StrengObligatorisk

SHA-256 (hex, 64)

Eksempel: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesHeltalObligatorisk

Størrelse i byte

Eksempel: 46
stateStrengObligatorisk

Status

Eksempel: "active"
version_numberHeltalObligatorisk

Version

Eksempel: 1

Yderligere felter: Nej

ProductFileListData

ProductFileListData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer. Upload filer som multipart/form-data efter oprettelse af upload_id, og knyt dem til produktet. Download kræver et Bearer-token og rettighed til category; svaret indeholder filens bytes uden offentlig adresse eller adgangskode. Ved mode=period vælges days (1–3650) eller den hidtidige months, aldrig begge. Vilkårene gemmes ved købet; en refundering fjerner kun adgang til den refunderede ordrelinje.
filesArray <ProductFileData > Obligatorisk

Produktfiler

Eksempel: [{"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_versionHeltalObligatorisk

Aktuel produktversion til samtidighedskontrol.

Eksempel: 2

Yderligere felter: Nej

Produktidentifikationskoder

ProductIdentifiers · Skema · Dataskemaer: Produkter
eanStreng nullValgfrit

Produktets EAN-identifikator.

Streng:minLength: 1maxLength: 100
isbnStreng nullValgfrit

ISBN-identifikator.

Streng:minLength: 1maxLength: 100
mpnStreng nullValgfrit

Producentens varenummer.

Streng:minLength: 1maxLength: 100
upcStreng nullValgfrit

Produktets UPC-identifikator.

Streng:minLength: 1maxLength: 100

Yderligere felter: Nej

Oplysninger om tilknyttede medier

ProductMediaData · Skema · Dataskemaer: Produkter
alt_textStreng nullObligatorisk

Alternativ tekst til et billede.

Eksempel: "example"
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (ProductMediaData).

Eksempel: "example"
is_primaryBoolesk værdiObligatorisk

Om dette er det primære element.

Eksempel: true
kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger
enum
["image", "video", "model_3d"]
Eksempel: "image"
mime_typeStrengObligatorisk

Mediets indholdstype.

Eksempel: "image/jpeg"
positionHeltalObligatorisk

Placering i den sorterede samling.

Eksempel: 1
urlStreng nullObligatorisk

Ressourcens URL.

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

Yderligere felter: Nej

Priskonfiguration og dens versioner til samtidighedskontrol

ProductPrice · Skema · Dataskemaer: Produkter
amountStreng nullObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

Streng:maxLength: 19
Begrænsninger · Streng 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Eksempel: "0.00"
currencyStrengObligatorisk

Valutakode for beløbet.

Begrænsninger
pattern
"^[A-Z]{3}$"
Eksempel: "PLN"
expected_price_list_versionHeltalObligatorisk

Tidligere læst prislisteversion, som kræves til denne skriveoperation.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 0maximum: 9223372036854775807
Eksempel: 0
kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger
enum
["base", "market_fixed"]
Eksempel: "base"
price_list_idStrengObligatorisk

Prislisteidentifikator.

minLength: 1maxLength: 63
Eksempel: "example"
tax_includedBoolesk værdiObligatorisk

Om den indsendte pris inkluderer afgifter.

Eksempel: true

Yderligere felter: Nej

Vis liste — Produkter — Svar

ProductSummaryData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
availabilityAvailabilityData Obligatorisk

Tilgængelighedsoplysninger for den valgte kontekst.

Eksempel: {"available_from":null,"available_until":null,"is_available":true}
brand_idStreng nullObligatorisk

Mærkeidentifikator.

Eksempel: null
conditionStrengObligatorisk

Produktets stand.

Begrænsninger
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Eksempel: "new"
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (ProductSummaryData).

Eksempel: "example"
nameStreng nullObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"
numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "example"
pricePriceData nullObligatorisk

Prisoplysninger i den valgte kontekst.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionHeltalObligatorisk

Aktuel prisversion til samtidighedskontrol.

Eksempel: 1
primary_category_idStreng nullObligatorisk

Identifikator for primær kategori.

Eksempel: "example"
primary_media_idStreng nullObligatorisk

Identifikator for primært medie.

Eksempel: "example"
publishedBoolesk værdiObligatorisk

Om ressourcen er offentliggjort.

Eksempel: false
skuStrengObligatorisk

SKU-varekode.

Eksempel: "example"
slugStreng nullObligatorisk

URL-stisegment på det valgte sprog.

Eksempel: "example"
tax_category_idStrengObligatorisk

Identifikator for afgiftskategori.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
variants_enabledBoolesk værdiObligatorisk

Om produktet bruger varianter.

Eksempel: false
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Opdater — Produkter — Forespørgselsindhold

ProductUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
brand_idStreng nullValgfrit

Mærkeidentifikator.

Streng:minLength: 1maxLength: 63
conditionStrengValgfrit

Produktets stand.

Begrænsninger
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionStreng nullValgfrit

Beskrivelse på det valgte sprog.

Streng:maxLength: 100000
Eksempel: null
expected_variant_price_versionsObjektYderligere felter: Heltal
minimum: 0maximum: 9223372036854775807
Valgfrit

Tidligere læste prisversioner med variantidentifikator som nøgle.

maxProperties: 250
Begrænsninger
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
feature_value_idsArray <Streng> Valgfrit

Identifikatorer for valgte egenskabsværdier.

maxItems: 1000
Array:minLength: 1maxLength: 63
identifiersProductIdentifiers nullValgfrit

Produktidentifikationskoder.

market_idsArray <Streng> Valgfrit

Identifikatorer for valgte markeder.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Streng> Valgfrit

Identifikatorer for allerede eksisterende medier.

maxItems: 30
Array:minLength: 1maxLength: 63
meta_descriptionStreng nullValgfrit

Beskrivelse til søgemaskiner på det valgte sprog.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfrit

Nøgleord til søgemaskiner på det valgte sprog.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleStreng nullValgfrit

Titel til søgemaskiner på det valgte sprog.

Streng:maxLength: 70
nameStreng nullValgfrit

Ressourcens navn i den relevante kontekst.

Streng:maxLength: 300
pricingProductPrice Valgfrit

Priskonfiguration og dens versioner til samtidighedskontrol.

Eksempel: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idStreng nullValgfrit

Identifikator for primær kategori.

Streng:minLength: 1maxLength: 63
publishedBoolesk værdiValgfrit

Om ressourcen er offentliggjort.

skuStrengValgfrit

SKU-varekode.

minLength: 1maxLength: 100
Begrænsninger
pattern
"^\\S+$"
Eksempel: "example"
slugStreng nullValgfrit

URL-stisegment på det valgte sprog.

Streng:maxLength: 160
tax_category_idStreng nullValgfrit

Identifikator for afgiftskategori.

Streng:minLength: 1maxLength: 63
variant_value_idsArray <Streng> Valgfrit

Identifikatorer for valgte variantværdier.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBoolesk værdiValgfrit

Om produktet bruger varianter.

Yderligere felter: Nej

ProductVersion

ProductVersion · Denne handling er udgået og giver 409 uden at ændre data. Angiv adgang til hver digital fil via valg af modtagere.
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1

Yderligere felter: Nej

ReleaseData

ReleaseData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer. Upload filer som multipart/form-data efter oprettelse af upload_id, og knyt dem til produktet. Download kræver et Bearer-token og rettighed til category; svaret indeholder filens bytes uden offentlig adresse eller adgangskode. Ved mode=period vælges days (1–3650) eller den hidtidige months, aldrig begge. Vilkårene gemmes ved købet; en refundering fjerner kun adgang til den refunderede ordrelinje.
changelogStrengObligatorisk

Beskrivelse af ændringer

Eksempel: "Manual update"
filesArray <ReleaseFileData > Obligatorisk

Produktfiler

Eksempel: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

format: "uuid"
Eksempel: "00000000-0000-4000-8000-000000000001"
manifest_sha256Streng nullObligatorisk

Digitale udgaver · SHA-256

Eksempel: "1111111111111111111111111111111111111111111111111111111111111111"
published_atStreng nullObligatorisk

Udgiv udgave · UTC

Streng:format: "date-time"
Eksempel: null
release_sequenceHeltal nullObligatorisk

Digitale udgaver · Placering i den sorterede samling.

Eksempel: null
stateStrengObligatorisk

Status

Eksempel: "active"
version_labelStrengObligatorisk

Version

Eksempel: "1.0"
withdrawn_atStreng nullObligatorisk

Træk tilbud tilbage · UTC

Streng:format: "date-time"
Eksempel: null

Yderligere felter: Nej

ReleaseDraft

ReleaseDraft · Denne handling er udgået og giver 409 uden at ændre data. Angiv adgang til hver digital fil via valg af modtagere.
changelogStrengValgfrit

Beskrivelse af ændringer

maxLength: 20000
Standard: ""
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
version_idsArray <Streng> Obligatorisk

Version · UUID[]

minItems: 1maxItems: 20
Array:format: "uuid"
Eksempel: ["00000000-0000-4000-8000-000000000001"]
version_labelStrengObligatorisk

Version

minLength: 1maxLength: 64
Eksempel: "1.0"

Yderligere felter: Nej

ReleaseFileData

ReleaseFileData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer. Upload filer som multipart/form-data efter oprettelse af upload_id, og knyt dem til produktet. Download kræver et Bearer-token og rettighed til category; svaret indeholder filens bytes uden offentlig adresse eller adgangskode. Ved mode=period vælges days (1–3650) eller den hidtidige months, aldrig begge. Vilkårene gemmes ved købet; en refundering fjerner kun adgang til den refunderede ordrelinje.
file_idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. · file_id

format: "uuid"
Eksempel: "00000000-0000-4000-8000-000000000001"
sort_orderHeltalObligatorisk

Placering i den sorterede samling.

Eksempel: 0
version_idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. · version_id

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

Yderligere felter: Nej

ReleaseListData

ReleaseListData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer. Upload filer som multipart/form-data efter oprettelse af upload_id, og knyt dem til produktet. Download kræver et Bearer-token og rettighed til category; svaret indeholder filens bytes uden offentlig adresse eller adgangskode. Ved mode=period vælges days (1–3650) eller den hidtidige months, aldrig begge. Vilkårene gemmes ved købet; en refundering fjerner kun adgang til den refunderede ordrelinje.
current_release_idStreng nullObligatorisk

Ressourceidentifikator; bevar den som returneret. · current_release_id

Streng:format: "uuid"
Eksempel: "00000000-0000-4000-8000-000000000001"
product_versionHeltalObligatorisk

Aktuel produktversion til samtidighedskontrol.

Eksempel: 2
releasesArray <ReleaseData > Obligatorisk

Digitale udgaver

Eksempel: [{"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_daysHeltal nullObligatorisk

Antal dage (days; null)

Eksempel: 365
update_modeStrengObligatorisk

Adgang til fremtidige filer efter køb: none / period / unlimited

Eksempel: "period"
update_monthsHeltal nullObligatorisk

Måneder (months; null)

Eksempel: null

Yderligere felter: Nej

UpdatePolicy

UpdatePolicy · Denne handling er udgået og giver 409 uden at ændre data. Angiv adgang til hver digital fil via valg af modtagere.
daysHeltal nullValgfrit

Antal dage (1–3650; mode=period; months=null)

Heltal:minimum: 1maximum: 3650
Eksempel: 365
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
modeStrengObligatorisk

Adgang til fremtidige filer efter køb: none / period / unlimited

Begrænsninger
enum
["none", "period", "unlimited"]
Eksempel: "period"
monthsHeltal nullValgfrit

Måneder (1–120; mode=period; days=null)

Heltal:minimum: 1maximum: 120
Eksempel: null

Yderligere felter: Nej

UploadCreate

UploadCreate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer. Upload filer som multipart/form-data efter oprettelse af upload_id, og knyt dem til produktet. Download kræver et Bearer-token og rettighed til category; svaret indeholder filens bytes uden offentlig adresse eller adgangskode. Ved mode=period vælges days (1–3650) eller den hidtidige months, aldrig begge. Vilkårene gemmes ved købet; en refundering fjerner kun adgang til den refunderede ordrelinje.
filenameStrengObligatorisk

Fil

minLength: 1maxLength: 255
Eksempel: "manual.pdf"
product_idStreng nullValgfrit

Produktidentifikator.

Begrænsninger · Streng 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Eksempel: "example"
sha256StrengObligatorisk

SHA-256 (hex, 64)

Begrænsninger
pattern
"^[0-9a-f]{64}$"
Eksempel: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesHeltalObligatorisk

Størrelse i byte

minimum: 1maximum: 262144000
Eksempel: 46

Yderligere felter: Nej

UploadData

UploadData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer. Upload filer som multipart/form-data efter oprettelse af upload_id, og knyt dem til produktet. Download kræver et Bearer-token og rettighed til category; svaret indeholder filens bytes uden offentlig adresse eller adgangskode. Ved mode=period vælges days (1–3650) eller den hidtidige months, aldrig begge. Vilkårene gemmes ved købet; en refundering fjerner kun adgang til den refunderede ordrelinje.
categoryFileCategory Obligatorisk

Filkategori: internal / customer_document / digital

Eksempel: "digital"
expires_atStrengObligatorisk

Dato og tidspunkt for legitimationsoplysningens udløb.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
filenameStrengObligatorisk

Fil

Eksempel: "manual.pdf"
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

format: "uuid"
Eksempel: "00000000-0000-4000-8000-000000000001"
product_idStreng nullObligatorisk

Produktidentifikator.

Eksempel: "example"
received_bytesHeltalObligatorisk

Uploader… · Størrelse i byte

Eksempel: 46
sha256StrengObligatorisk

SHA-256 (hex, 64)

Eksempel: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesHeltalObligatorisk

Størrelse i byte

Eksempel: 46
statusStrengObligatorisk

Status accepteret af denne specifikke operation.

Eksempel: "ready"

Yderligere felter: Nej