Parameters

Article parameters

An article is the fundamental unit of inventory — a unique product sold on the marketplace, identified by its own SKU. A specific red t-shirt in size medium is one article; the t-shirt available in several colours and sizes is a product, made up of many articles. Each article carries its own data and can have its own images, description and pricing.

This page describes every field of the article model. For how to group articles into products, see Product variations.


Required parameters

ParameterDescriptionData typeMarket-specific
skuYour unique ID for the articleString (1–64)No
statusSale statusfor sale or pausedNo
quantityQuantity in stockInteger (0–500 000)No
main_imageDirect link to the main imageString (1–1500), valid URLNo
marketsCountries the article is for sale inSee Market codesNo
titleArticle nameSee Title and descriptionPer language
descriptionDetailed descriptionSee Title and descriptionPer language
priceArticle priceSee PricesYes
shipping_timeDelivery time to the customerSee Shipping timeYes

Optional parameters

ParameterDescriptionData typeMarket-specific
parent_skuGroup identifier for a productString (1–64)No
categoryCategory of the articleStringNo
propertiesArticle propertiesSee PropertiesPer language
variational_propertiesWhich properties differentiate variantsSee Product variationsNo
brandManufacturer nameString (1–50)No
gtinGlobal identifierString (8–14)No
imagesAdditional image linksList of strings (1–1500), max 10No
unique_selling_pointsKey selling pointsSee Unique selling pointsYes
specificationsTechnical specificationsSee SpecificationsYes
classificationsClassification attributesSee ClassificationsNo
delivery_typeDelivery methodSee Delivery typeYes
kn_numberCombined nomenclature codeString (1–48)No
shipped_fromOrigin of shipmentEU or NON_EUNo
manufacturerManufacturer and GPSR detailsSee ManufacturerNo
shipping_configuration_idsConfiguration IDs overriding your default shipping configurationsList of UUIDsNo

shipping_configuration_ids applies to CDON only. See the Shipping Configurations section.


Standard codes

Market codes

CodeCountry
SESweden
DKDenmark
FIFinland
NONorway

Market codes follow ISO-3166-1 alpha-2.

Language codes

CodeDescription
sv-SESwedish (Sweden)
en-USEnglish (United States)
da-DKDanish (Denmark)
fi-FIFinnish (Finland)
nb-NONorwegian (Norway)

The format combines an ISO-639-1 language code and an ISO-3166-1 alpha-2 region code with a hyphen — for example en-US.

Currency codes

CodeDescriptionMarket
SEKSwedish kronaSE
DKKDanish kroneDK
EUREuroFI
NOKNorwegian kroneNO

Currency codes follow ISO-4217.


Category

A single string holding the category ID. Fetch the tree with List Categories.

{ "category": "1124" }

Properties

Properties are key/value pairs defined by the marketplace, in three types.

FieldTypeRequired
nameStringYes
valueString (1–36)Yes
languageString (5)Required on free-text properties; not used on the others
{
  "properties": [
    { "name": "color",            "value": "Deep Green", "language": "en-US" },
    { "name": "preset-size_SML",  "value": "xxl" },
    { "name": "weight_kg",        "value": "0.5" }
  ]
}

Note that size and preset-size_SML are different properties. size is free text — any
string you like, with a language. preset-size_SML takes a value from a fixed list and needs no
language. Sizes such as xxl belong to the pre-defined property.

Free-text properties

Custom string values, 1–36 characters. A language is required on every free-text property.

color · connection_type · flavor · material · pattern · phone_case_type · size

Pre-defined properties

These take a value from a fixed list.

PropertyAllowed values
preset-colorred, blue, green, orange, yellow, purple, pink, gold, silver, multicolor, white, gray, black, turquoise, brown, beige, transparent
preset-connection_typebluetooth, usb-c, micro-usb, lightning, 3.5mm
preset-hair_typedry hair, normal hair, curly hair, damaged hair, frizzy hair, fine hair, dry scalp, dyed hair
preset-media_formatdvd, blu-ray, 4k ultra hd, cd, vinyl
preset-patternabstract and geometry, animals and animal patterns, nature and environment, plants and fruit, space and scifi, text and quotes, camouflage, glitter, marble and stone, vehicles, flags and symbols, maps, characters and celebrities, fantasy, retro
preset-refurb_gradinga+, a, b, c
preset-refurb_warranty2, 6, 12, 24 (months of warranty)
preset-size_SMLone size, xxs, xs, s, m, l, xl, xxl
preset-skin_typedry skin, normal skin, mature skin, oily skin, mixed skin, acne

Numerical properties

Integers or decimals, sent as strings, 1–50 characters.

shoe_size_eu · shoe_size_uk_men · shoe_size_uk_women · shoe_size_us_men · shoe_size_us_women · size_cm · size_gb · size_m · size_mm · size_unit · volume_l · volume_ml · weight_g · weight_kg


Markets

The countries the article is for sale in.

{ "markets": ["SE", "DK"] }

Prices

Market-specific pricing, VAT included. The amount field is named amount_including_vat — always send that name.

FieldTypeRequiredNotes
marketString (2)YesA market code
amount_including_vatDecimal (1–7)Yes
currencyString (3)YesA currency code
vat_rateDecimalNoDefaults to the market rate
{
  "price": [
    { "market": "SE", "value": { "amount_including_vat": 79, "currency": "SEK" } },
    { "market": "DK", "value": { "amount_including_vat": 99, "currency": "DKK" } }
  ]
}

Shipping time

Delivery time range per market.

FieldTypeRequired
marketString (2)Yes
minInteger 0–21Yes
maxInteger 1–21Yes
{
  "shipping_time": [
    { "market": "SE", "min": 2, "max": 5 },
    { "market": "DK", "min": 4, "max": 9 }
  ]
}

Delivery type

Delivery method per market. Available types: mailbox, service_point, home_delivery.

{
  "delivery_type": [
    { "market": "SE", "value": "mailbox" },
    { "market": "DK", "value": "service_point" }
  ]
}

Title and description

Both are supplied per language.

  • title — String (5–150 characters)
  • description — String (10–4096 characters)
{
  "title": [
    { "language": "sv-SE", "value": "This is the title in Swedish" },
    { "language": "en-US", "value": "This is the title in English" }
  ]
}

Unique selling points

FieldType
languageString (5)
valueList of strings, max 30 characters each
{
  "unique_selling_points": [
    { "language": "en-US", "value": ["Water resistant", "Long battery life"] },
    { "language": "sv-SE", "value": ["Vattenbeständig", "Lång batteritid"] }
  ]
}

Specifications

Technical details organised by language, then by section. Each attribute has a name, a value and an optional description.

{
  "specifications": [
    {
      "language": "en-US",
      "value": [
        {
          "name": "Technical Details",
          "value": [
            { "name": "Screen size",      "value": "6.1 inch", "description": "Screen size measured diagonally" },
            { "name": "Battery capacity", "value": "4500mAh" }
          ]
        }
      ]
    }
  ]
}

Classifications

Product classification attributes.

CONDITION

ValueMeaning
NEWBrand new product
REFURBRefurbished product

RESTRICTED

ValueMeaning
ADULTAdult-only product
{ "classifications": [ { "name": "CONDITION", "value": "REFURB" } ] }

Manufacturer

Manufacturer and EU responsible-person details, as required by GPSR.

FieldTypeRequiredNotes
nameStringYesCompany name
addressObjectYesPhysical address
websiteStringNo
emailStringNo
responsible_personObjectNoRequired if the manufacturer is outside the EU

Address

FieldTypeRequired
street_addressStringYes
cityStringYes
postal_codeStringYes
countryString (2)Yes

Responsible person — only needed if the manufacturer is outside the EU

FieldTypeRequired
nameStringYes
phoneStringNo
emailStringNo
{
  "manufacturer": {
    "name": "Manufacturer Company Name",
    "address": {
      "street_address": "123 Manufacturing Street",
      "city": "Industrial City",
      "postal_code": "12345",
      "country": "SE"
    },
    "website": "https://manufacturer.example.com",
    "email": "[email protected]",
    "responsible_person": {
      "name": "EU representative",
      "phone": "+234-567-8900",
      "email": "[email protected]"
    }
  }
}