Hoppa till innehållet
ShopentlyLearn
Svenska

Datascheman: Produkter

Datascheman: Produkter. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar. Ladda upp filer som multipart/form-data efter att upload_id skapats och koppla dem till produkten. Nedladdning kräver en Bearer-token och behörighet för category; svaret innehåller filens byte, utan offentlig adress eller lösenord. För mode=period används days (1–3650) eller befintliga months, aldrig båda. Villkoren sparas vid köpet; återbetalning tar bara bort åtkomst för den återbetalda raden.
dataProductFileListData Obligatoriskt

Innehållet i ett lyckat svar.

Exempel: {"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 Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar. Ladda upp filer som multipart/form-data efter att upload_id skapats och koppla dem till produkten. Nedladdning kräver en Bearer-token och behörighet för category; svaret innehåller filens byte, utan offentlig adress eller lösenord. För mode=period används days (1–3650) eller befintliga months, aldrig båda. Villkoren sparas vid köpet; återbetalning tar bara bort åtkomst för den återbetalda raden.
dataReleaseListData Obligatoriskt

Innehållet i ett lyckat svar.

Exempel: {"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 Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

ApiResponse_UploadData_

ApiResponse_UploadData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar. Ladda upp filer som multipart/form-data efter att upload_id skapats och koppla dem till produkten. Nedladdning kräver en Bearer-token och behörighet för category; svaret innehåller filens byte, utan offentlig adress eller lösenord. För mode=period används days (1–3650) eller befintliga months, aldrig båda. Villkoren sparas vid köpet; återbetalning tar bara bort åtkomst för den återbetalda raden.
dataUploadData Obligatoriskt

Innehållet i ett lyckat svar.

Exempel: {"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 Obligatoriskt

Metadata för svaret.

Exempel: {"request_id":"example"}

Ytterligare fält: Nej

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · Läs åtkomstregeln och produktversionen. Första publiceringen förblir tidsankaret.
dataAudienceData Obligatoriskt

Innehållet i ett lyckat svar.

Exempel: {"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 Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

Lista — Produkter — Svar

ApiResponse_list_ProductSummaryData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
dataArray <ProductSummaryData > Obligatoriskt

Exempel på svar · ApiResponse_list_ProductSummaryData__.

Exempel: [{"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 Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

Hämta — Produkter — Svar

ApiResponse_ProductDetailData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
dataProductDetailData Obligatoriskt

Exempel på svar · ProductDetailData.

Exempel: {"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 Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

AudienceChange

AudienceChange · Välj berättigade köp. Valda beställningar måste innehålla denna produkt som betald och inte återbetald.
audienceAudienceSelection Obligatoriskt

Uttrycklig åtkomstregel för den gemensamma filen.

Exempel: {"mode":"all_purchasers"}
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807
Exempel: 1

Ytterligare fält: Nej

AudienceData

AudienceData · Läs åtkomstregeln och produktversionen. Första publiceringen förblir tidsankaret.
anchor_atSträngObligatoriskt

Första publiceringen; ändras inte med regeln.

format: "date-time"
Exempel: "2026-11-03T12:00:00Z"
effective_atSträngObligatoriskt

Publiceringstid för åtkomstregeln.

format: "date-time"
Exempel: "2026-11-03T12:00:00Z"
file_idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. · file_id

Exempel: "00000000-0000-4000-8000-000000000007"
file_version_idSträngObligatoriskt

ID för en oföränderlig filversion.

Exempel: "00000000-0000-4000-8000-000000000010"
historical_access_preservedBooleskt värdeValfritt

Tidigare beviljade rättigheter behålls när regeln begränsas.

Standardvärde: trueExempel: true
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

Exempel: "00000000-0000-4000-8000-000000000009"
lookback_daysHeltal nullObligatoriskt

1–3650 dagar före första publiceringen; endast recent_and_new.

Exempel: null
modeSträngObligatoriskt

Uttrycklig åtkomstregel för den gemensamma filen. new_purchases / recent_and_new / selected / all_purchasers.

Exempel: "all_purchasers"
next_cursorSträng nullObligatoriskt

Fortsättningsvärde för nästa sida, eller null.

Exempel: null
order_idsArray <Sträng> Obligatoriskt

Beställningar med denna betalda, inte återbetalda produkt.

Exempel: []
product_versionHeltalObligatoriskt

Aktuell produktversion för samtidighetskontroll.

Exempel: 3
revisionHeltalObligatoriskt

Löpande revision av åtkomstregeln.

Exempel: 1

Ytterligare fält: Nej

AudienceSelection

AudienceSelection · Välj berättigade köp. Valda beställningar måste innehålla denna produkt som betald och inte återbetald.
lookback_daysHeltal nullValfritt

1–3650 dagar före första publiceringen; endast recent_and_new.

Heltal:minimum: 1maximum: 3650
modeSträngObligatoriskt

Uttrycklig åtkomstregel för den gemensamma filen. new_purchases / recent_and_new / selected / all_purchasers.

Begränsningar
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
Exempel: "new_purchases"
order_idsArray <Sträng> Valfritt

Beställningar med denna betalda, inte återbetalda produkt.

maxItems: 1000
Begränsningar · Array 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Standardvärde: []

Ytterligare fält: Nej

Tillgänglighetsinformation för vald kontext

AvailabilityData · Schema · Datascheman: Produkter
available_fromSträng nullObligatoriskt

Tillgänglighetens start.

Sträng:format: "date-time"
Exempel: null
available_untilSträng nullObligatoriskt

Tillgänglighetens slut.

Sträng:format: "date-time"
Exempel: null
is_availableBooleskt värdeObligatoriskt

Anger om artikeln är tillgänglig i denna kontext.

Exempel: true

Ytterligare fält: Nej

FileAssign

FileAssign · Fält, typer och begränsningar för data som API:et tar emot eller returnerar. Ladda upp filer som multipart/form-data efter att upload_id skapats och koppla dem till produkten. Nedladdning kräver en Bearer-token och behörighet för category; svaret innehåller filens byte, utan offentlig adress eller lösenord. För mode=period används days (1–3650) eller befintliga months, aldrig båda. Villkoren sparas vid köpet; återbetalning tar bara bort åtkomst för den återbetalda raden.
audienceAudienceSelection nullValfritt

Uttrycklig åtkomstregel för den gemensamma filen.

Exempel: {"mode":"new_purchases"}
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807
Exempel: 1
labelSträngValfritt

Resursens namn i aktuell kontext.

maxLength: 300
Standardvärde: ""
upload_idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. · upload_id

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

Ytterligare fält: Nej

FileCategory

FileCategory · Fält, typer och begränsningar för data som API:et tar emot eller returnerar. Ladda upp filer som multipart/form-data efter att upload_id skapats och koppla dem till produkten. Nedladdning kräver en Bearer-token och behörighet för category; svaret innehåller filens byte, utan offentlig adress eller lösenord. För mode=period används days (1–3650) eller befintliga months, aldrig båda. Villkoren sparas vid köpet; återbetalning tar bara bort åtkomst för den återbetalda raden. Sträng
Begränsningar
enum
["internal", "customer_document", "digital"]

Ytterligare fält: Ja

Prisinformation i vald kontext

PriceData · Schema · Datascheman: Produkter
amountSträngObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

Exempel: "0.00"
currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar
pattern
"^[A-Z]{3}$"
Exempel: "PLN"
minor_unitsHeltalObligatoriskt

Antal decimaler som används för valutan.

minimum: 0maximum: 4
Exempel: 2
tax_includedBooleskt värdeObligatoriskt

Anger om det skickade priset inkluderar skatt.

Exempel: true

Ytterligare fält: Nej

Information om prislistan

PriceListData · Schema · Datascheman: Produkter
currencySträngObligatoriskt

Valutakod för beloppet.

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (PriceListData).

tax_includedBooleskt värdeObligatoriskt

Anger om det skickade priset inkluderar skatt.

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Ytterligare fält: Nej

Skapa — Produkter — Begärans innehåll

ProductCreate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
brand_idSträng nullValfritt

Varumärkets identifierare.

Sträng:minLength: 1maxLength: 63
conditionSträngValfritt

Produktens skick.

Begränsningar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Standardvärde: "new"
descriptionSträng nullValfritt

Beskrivning på valt språk.

Sträng:maxLength: 100000
feature_value_idsArray <Sträng> Valfritt

Identifierare för valda egenskapsvärden.

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

Produktens identifieringskoder.

market_idsArray <Sträng> Valfritt

Identifierare för valda marknader.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Sträng> Valfritt

Identifierare för redan befintliga medieresurser.

maxItems: 30
Array:minLength: 1maxLength: 63
meta_descriptionSträng nullValfritt

Sökmotorbeskrivning på valt språk.

Sträng:maxLength: 160
meta_keywordsArray <Sträng> nullValfritt

Sökord för sökmotorer på valt språk.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleSträng nullValfritt

Sökmotortitel på valt språk.

Sträng:maxLength: 70
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 300
Exempel: "Example"
pricingProductPrice Valfritt

Priskonfiguration och dess versioner för samtidighetskontroll.

primary_category_idSträng nullValfritt

Huvudkategorins identifierare.

Sträng:minLength: 1maxLength: 63
publishedBooleskt värdeValfritt

Anger om resursen är publicerad.

Standardvärde: false
skuSträngObligatoriskt

Artikelns SKU-kod.

minLength: 1maxLength: 100
Begränsningar
pattern
"^\\S+$"
Exempel: "example"
slugSträng nullValfritt

URL-segment på valt språk.

Sträng:maxLength: 160
tax_category_idSträng nullValfritt

Skattekategorins identifierare.

Sträng:minLength: 1maxLength: 63
variant_value_idsArray <Sträng> Valfritt

Identifierare för valda variantvärden.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBooleskt värdeValfritt

Anger om produkten använder varianter.

Standardvärde: false

Ytterligare fält: Nej

Hämta — Produkter — Svar

ProductDetailData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
availabilityAvailabilityData Obligatoriskt

Tillgänglighetsinformation för vald kontext.

Exempel: {"available_from":null,"available_until":null,"is_available":true}
brand_idSträng nullObligatoriskt

Varumärkets identifierare.

Exempel: null
conditionSträngObligatoriskt

Produktens skick.

Begränsningar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Exempel: "new"
created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
descriptionSträng nullObligatoriskt

Beskrivning på valt språk.

Exempel: "example"
featuresArray <FeatureSelectionData > Obligatoriskt

Produktens egenskaper.

Exempel: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (ProductDetailData).

Exempel: "example"
identifiersObjektYtterligare fält: SträngObligatoriskt

Produktens identifieringskoder.

Exempel: {}
mediaArray <ProductMediaData > Obligatoriskt

Information om bifogade medier.

Exempel: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_descriptionSträng nullObligatoriskt

Sökmotorbeskrivning på valt språk.

Exempel: "example"
meta_keywordsArray <Sträng> nullObligatoriskt

Sökord för sökmotorer på valt språk.

Exempel: ["example"]
meta_titleSträng nullObligatoriskt

Sökmotortitel på valt språk.

Exempel: "example"
nameSträng nullObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Example"
numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"
pricePriceData nullObligatoriskt

Prisinformation i vald kontext.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionHeltalObligatoriskt

Aktuell prisversion för samtidighetskontroll.

Exempel: 1
primary_category_idSträng nullObligatoriskt

Huvudkategorins identifierare.

Exempel: "example"
primary_media_idSträng nullObligatoriskt

Identifierare för primär medieresurs.

Exempel: "example"
publishedBooleskt värdeObligatoriskt

Anger om resursen är publicerad.

Exempel: false
skuSträngObligatoriskt

Artikelns SKU-kod.

Exempel: "example"
slugSträng nullObligatoriskt

URL-segment på valt språk.

Exempel: "example"
tax_category_idSträngObligatoriskt

Skattekategorins identifierare.

Exempel: "example"
updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
variants_enabledBooleskt värdeObligatoriskt

Anger om produkten använder varianter.

Exempel: false
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

ProductFileData

ProductFileData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar. Ladda upp filer som multipart/form-data efter att upload_id skapats och koppla dem till produkten. Nedladdning kräver en Bearer-token och behörighet för category; svaret innehåller filens byte, utan offentlig adress eller lösenord. För mode=period används days (1–3650) eller befintliga months, aldrig båda. Villkoren sparas vid köpet; återbetalning tar bara bort åtkomst för den återbetalda raden.
categoryFileCategory Obligatoriskt

Filkategori: internal / customer_document / digital

Exempel: "digital"
created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
current_version_idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. · current_version_id

format: "uuid"
Exempel: "00000000-0000-4000-8000-000000000001"
file_idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. · file_id

format: "uuid"
Exempel: "00000000-0000-4000-8000-000000000001"
filenameSträngObligatoriskt

Fil

Exempel: "manual.pdf"
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

format: "uuid"
Exempel: "00000000-0000-4000-8000-000000000001"
labelSträngObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Manual"
mime_typeSträngObligatoriskt

Medieinnehållets typ.

Exempel: "application/pdf"
sha256SträngObligatoriskt

SHA-256 (hex, 64)

Exempel: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesHeltalObligatoriskt

Storlek i byte

Exempel: 46
stateSträngObligatoriskt

Status

Exempel: "active"
version_numberHeltalObligatoriskt

Version

Exempel: 1

Ytterligare fält: Nej

ProductFileListData

ProductFileListData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar. Ladda upp filer som multipart/form-data efter att upload_id skapats och koppla dem till produkten. Nedladdning kräver en Bearer-token och behörighet för category; svaret innehåller filens byte, utan offentlig adress eller lösenord. För mode=period används days (1–3650) eller befintliga months, aldrig båda. Villkoren sparas vid köpet; återbetalning tar bara bort åtkomst för den återbetalda raden.
filesArray <ProductFileData > Obligatoriskt

Produktfiler

Exempel: [{"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_versionHeltalObligatoriskt

Aktuell produktversion för samtidighetskontroll.

Exempel: 2

Ytterligare fält: Nej

Produktens identifieringskoder

ProductIdentifiers · Schema · Datascheman: Produkter
eanSträng nullValfritt

Produktens EAN-identifierare.

Sträng:minLength: 1maxLength: 100
isbnSträng nullValfritt

ISBN-identifierare.

Sträng:minLength: 1maxLength: 100
mpnSträng nullValfritt

Tillverkarens artikelnummer.

Sträng:minLength: 1maxLength: 100
upcSträng nullValfritt

Produktens UPC-identifierare.

Sträng:minLength: 1maxLength: 100

Ytterligare fält: Nej

Information om bifogade medier

ProductMediaData · Schema · Datascheman: Produkter
alt_textSträng nullObligatoriskt

Alternativtext för en bild.

Exempel: "example"
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (ProductMediaData).

Exempel: "example"
is_primaryBooleskt värdeObligatoriskt

Anger om detta är huvudposten.

Exempel: true
kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar
enum
["image", "video", "model_3d"]
Exempel: "image"
mime_typeSträngObligatoriskt

Medieinnehållets typ.

Exempel: "image/jpeg"
positionHeltalObligatoriskt

Position i den ordnade samlingen.

Exempel: 1
urlSträng nullObligatoriskt

Resursens URL.

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

Ytterligare fält: Nej

Priskonfiguration och dess versioner för samtidighetskontroll

ProductPrice · Schema · Datascheman: Produkter
amountSträng nullObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

Sträng:maxLength: 19
Begränsningar · Sträng 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Exempel: "0.00"
currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar
pattern
"^[A-Z]{3}$"
Exempel: "PLN"
expected_price_list_versionHeltalObligatoriskt

Tidigare läst prislistversion som krävs för skrivningen.

minimum: 1maximum: 9223372036854775807
Exempel: 1
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 0maximum: 9223372036854775807
Exempel: 0
kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar
enum
["base", "market_fixed"]
Exempel: "base"
price_list_idSträngObligatoriskt

Prislistans identifierare.

minLength: 1maxLength: 63
Exempel: "example"
tax_includedBooleskt värdeObligatoriskt

Anger om det skickade priset inkluderar skatt.

Exempel: true

Ytterligare fält: Nej

Lista — Produkter — Svar

ProductSummaryData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
availabilityAvailabilityData Obligatoriskt

Tillgänglighetsinformation för vald kontext.

Exempel: {"available_from":null,"available_until":null,"is_available":true}
brand_idSträng nullObligatoriskt

Varumärkets identifierare.

Exempel: null
conditionSträngObligatoriskt

Produktens skick.

Begränsningar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Exempel: "new"
created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (ProductSummaryData).

Exempel: "example"
nameSträng nullObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Example"
numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"
pricePriceData nullObligatoriskt

Prisinformation i vald kontext.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionHeltalObligatoriskt

Aktuell prisversion för samtidighetskontroll.

Exempel: 1
primary_category_idSträng nullObligatoriskt

Huvudkategorins identifierare.

Exempel: "example"
primary_media_idSträng nullObligatoriskt

Identifierare för primär medieresurs.

Exempel: "example"
publishedBooleskt värdeObligatoriskt

Anger om resursen är publicerad.

Exempel: false
skuSträngObligatoriskt

Artikelns SKU-kod.

Exempel: "example"
slugSträng nullObligatoriskt

URL-segment på valt språk.

Exempel: "example"
tax_category_idSträngObligatoriskt

Skattekategorins identifierare.

Exempel: "example"
updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
variants_enabledBooleskt värdeObligatoriskt

Anger om produkten använder varianter.

Exempel: false
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Uppdatera — Produkter — Begärans innehåll

ProductUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
brand_idSträng nullValfritt

Varumärkets identifierare.

Sträng:minLength: 1maxLength: 63
conditionSträngValfritt

Produktens skick.

Begränsningar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionSträng nullValfritt

Beskrivning på valt språk.

Sträng:maxLength: 100000
Exempel: null
expected_variant_price_versionsObjektYtterligare fält: Heltal
minimum: 0maximum: 9223372036854775807
Valfritt

Tidigare lästa prisversioner, kopplade till variantidentifierare.

maxProperties: 250
Begränsningar
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807
Exempel: 1
feature_value_idsArray <Sträng> Valfritt

Identifierare för valda egenskapsvärden.

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

Produktens identifieringskoder.

market_idsArray <Sträng> Valfritt

Identifierare för valda marknader.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Sträng> Valfritt

Identifierare för redan befintliga medieresurser.

maxItems: 30
Array:minLength: 1maxLength: 63
meta_descriptionSträng nullValfritt

Sökmotorbeskrivning på valt språk.

Sträng:maxLength: 160
meta_keywordsArray <Sträng> nullValfritt

Sökord för sökmotorer på valt språk.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleSträng nullValfritt

Sökmotortitel på valt språk.

Sträng:maxLength: 70
nameSträng nullValfritt

Resursens namn i aktuell kontext.

Sträng:maxLength: 300
pricingProductPrice Valfritt

Priskonfiguration och dess versioner för samtidighetskontroll.

Exempel: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idSträng nullValfritt

Huvudkategorins identifierare.

Sträng:minLength: 1maxLength: 63
publishedBooleskt värdeValfritt

Anger om resursen är publicerad.

skuSträngValfritt

Artikelns SKU-kod.

minLength: 1maxLength: 100
Begränsningar
pattern
"^\\S+$"
Exempel: "example"
slugSträng nullValfritt

URL-segment på valt språk.

Sträng:maxLength: 160
tax_category_idSträng nullValfritt

Skattekategorins identifierare.

Sträng:minLength: 1maxLength: 63
variant_value_idsArray <Sträng> Valfritt

Identifierare för valda variantvärden.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBooleskt värdeValfritt

Anger om produkten använder varianter.

Ytterligare fält: Nej

ProductVersion

ProductVersion · Den här åtgärden har tagits bort och ger 409 utan att ändra data. Ange åtkomst för varje digital fil genom att välja mottagare.
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807
Exempel: 1

Ytterligare fält: Nej

ReleaseData

ReleaseData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar. Ladda upp filer som multipart/form-data efter att upload_id skapats och koppla dem till produkten. Nedladdning kräver en Bearer-token och behörighet för category; svaret innehåller filens byte, utan offentlig adress eller lösenord. För mode=period används days (1–3650) eller befintliga months, aldrig båda. Villkoren sparas vid köpet; återbetalning tar bara bort åtkomst för den återbetalda raden.
changelogSträngObligatoriskt

Beskrivning av ändringar

Exempel: "Manual update"
filesArray <ReleaseFileData > Obligatoriskt

Produktfiler

Exempel: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

format: "uuid"
Exempel: "00000000-0000-4000-8000-000000000001"
manifest_sha256Sträng nullObligatoriskt

Digitala utgåvor · SHA-256

Exempel: "1111111111111111111111111111111111111111111111111111111111111111"
published_atSträng nullObligatoriskt

Publicera utgåva · UTC

Sträng:format: "date-time"
Exempel: null
release_sequenceHeltal nullObligatoriskt

Digitala utgåvor · Position i den ordnade samlingen.

Exempel: null
stateSträngObligatoriskt

Status

Exempel: "active"
version_labelSträngObligatoriskt

Version

Exempel: "1.0"
withdrawn_atSträng nullObligatoriskt

Dra tillbaka erbjudandet · UTC

Sträng:format: "date-time"
Exempel: null

Ytterligare fält: Nej

ReleaseDraft

ReleaseDraft · Den här åtgärden har tagits bort och ger 409 utan att ändra data. Ange åtkomst för varje digital fil genom att välja mottagare.
changelogSträngValfritt

Beskrivning av ändringar

maxLength: 20000
Standardvärde: ""
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807
Exempel: 1
version_idsArray <Sträng> Obligatoriskt

Version · UUID[]

minItems: 1maxItems: 20
Array:format: "uuid"
Exempel: ["00000000-0000-4000-8000-000000000001"]
version_labelSträngObligatoriskt

Version

minLength: 1maxLength: 64
Exempel: "1.0"

Ytterligare fält: Nej

ReleaseFileData

ReleaseFileData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar. Ladda upp filer som multipart/form-data efter att upload_id skapats och koppla dem till produkten. Nedladdning kräver en Bearer-token och behörighet för category; svaret innehåller filens byte, utan offentlig adress eller lösenord. För mode=period används days (1–3650) eller befintliga months, aldrig båda. Villkoren sparas vid köpet; återbetalning tar bara bort åtkomst för den återbetalda raden.
file_idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. · file_id

format: "uuid"
Exempel: "00000000-0000-4000-8000-000000000001"
sort_orderHeltalObligatoriskt

Position i den ordnade samlingen.

Exempel: 0
version_idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. · version_id

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

Ytterligare fält: Nej

ReleaseListData

ReleaseListData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar. Ladda upp filer som multipart/form-data efter att upload_id skapats och koppla dem till produkten. Nedladdning kräver en Bearer-token och behörighet för category; svaret innehåller filens byte, utan offentlig adress eller lösenord. För mode=period används days (1–3650) eller befintliga months, aldrig båda. Villkoren sparas vid köpet; återbetalning tar bara bort åtkomst för den återbetalda raden.
current_release_idSträng nullObligatoriskt

Resursens identifierare; bevara den som den returneras. · current_release_id

Sträng:format: "uuid"
Exempel: "00000000-0000-4000-8000-000000000001"
product_versionHeltalObligatoriskt

Aktuell produktversion för samtidighetskontroll.

Exempel: 2
releasesArray <ReleaseData > Obligatoriskt

Digitala utgåvor

Exempel: [{"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 nullObligatoriskt

Antal dagar (days; null)

Exempel: 365
update_modeSträngObligatoriskt

Åtkomst till framtida filer efter köp: none / period / unlimited

Exempel: "period"
update_monthsHeltal nullObligatoriskt

Månader (months; null)

Exempel: null

Ytterligare fält: Nej

UpdatePolicy

UpdatePolicy · Den här åtgärden har tagits bort och ger 409 utan att ändra data. Ange åtkomst för varje digital fil genom att välja mottagare.
daysHeltal nullValfritt

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

Heltal:minimum: 1maximum: 3650
Exempel: 365
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807
Exempel: 1
modeSträngObligatoriskt

Åtkomst till framtida filer efter köp: none / period / unlimited

Begränsningar
enum
["none", "period", "unlimited"]
Exempel: "period"
monthsHeltal nullValfritt

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

Heltal:minimum: 1maximum: 120
Exempel: null

Ytterligare fält: Nej

UploadCreate

UploadCreate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar. Ladda upp filer som multipart/form-data efter att upload_id skapats och koppla dem till produkten. Nedladdning kräver en Bearer-token och behörighet för category; svaret innehåller filens byte, utan offentlig adress eller lösenord. För mode=period används days (1–3650) eller befintliga months, aldrig båda. Villkoren sparas vid köpet; återbetalning tar bara bort åtkomst för den återbetalda raden.
filenameSträngObligatoriskt

Fil

minLength: 1maxLength: 255
Exempel: "manual.pdf"
product_idSträng nullValfritt

Produktens identifierare.

Begränsningar · Sträng 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exempel: "example"
sha256SträngObligatoriskt

SHA-256 (hex, 64)

Begränsningar
pattern
"^[0-9a-f]{64}$"
Exempel: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesHeltalObligatoriskt

Storlek i byte

minimum: 1maximum: 262144000
Exempel: 46

Ytterligare fält: Nej

UploadData

UploadData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar. Ladda upp filer som multipart/form-data efter att upload_id skapats och koppla dem till produkten. Nedladdning kräver en Bearer-token och behörighet för category; svaret innehåller filens byte, utan offentlig adress eller lösenord. För mode=period används days (1–3650) eller befintliga months, aldrig båda. Villkoren sparas vid köpet; återbetalning tar bara bort åtkomst för den återbetalda raden.
categoryFileCategory Obligatoriskt

Filkategori: internal / customer_document / digital

Exempel: "digital"
expires_atSträngObligatoriskt

Datum och tid när autentiseringsuppgiften upphör att gälla.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
filenameSträngObligatoriskt

Fil

Exempel: "manual.pdf"
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

format: "uuid"
Exempel: "00000000-0000-4000-8000-000000000001"
product_idSträng nullObligatoriskt

Produktens identifierare.

Exempel: "example"
received_bytesHeltalObligatoriskt

Laddar upp… · Storlek i byte

Exempel: 46
sha256SträngObligatoriskt

SHA-256 (hex, 64)

Exempel: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesHeltalObligatoriskt

Storlek i byte

Exempel: 46
statusSträngObligatoriskt

Status som accepteras av den aktuella operationen.

Exempel: "ready"

Ytterligare fält: Nej