Products V5

Create or update product variations

Returns a process-id to query results. The limit for the number of product variations in one request is 500.

post/v5/products

Headers

X-Request-Timestampstring yyyy-MM-dd'T'HH:mm:ss.SSSXXX

Holds the optional client side update request timestamp, in ISO DateTime format

Request body

productReferencestring required

The productReference groups all variations, that you want to combine into one product. This is not visible to the customer. The productReference can be freely assigned and may consist of maximum 50 characters. You can only use the productReference once within your product catalog. You should therefore use a value that makes sense for all variations of the product and does not refer to any specifics of a particular variation. You will find the product reference, for example, in the product overview in the portal.

skustring required

Identifier for a product variation, provided by the partner, must be unique for a partner. It is mandatory, may consist of a maximum of 50 characters and must not contain leading or trailing spaces or non-printable Unicode control characters.

eanstring required

External identifier of a product, must be unique in a partner assortment, must not start with a 2.

pznstring

Pharmazentralnummer, a german standard for identifying pharmaceutical products.

mpnstring

Manufacturer part number, may consist of a maximum of 50 characters.

moinstring

Is an identifier, generated by the OTTO marketplace, for a product variation together with the associated content. Is used in the context of "Wettbewerb am Artikel" to confirm the content of the existing variation and its correctness and to put the own offer live for this variation.

releaseDatestring date-time

ISO8601 Date (e.g. 2024-08-01T08:00:00+0100) on which the product is released by the manufacturer, e.g. computer games.

Example request

[
  {
    "productReference": "UBN-11779",
    "sku": "3858389911564",
    "ean": "3858389911564",
    "pzn": "PZN-4908802",
    "mpn": "H2G2-42",
    "moin": "M00A1234BC",
    "releaseDate": "2019-10-19T00:00:00Z",
    "productDescription": {
      "category": "Outdoorjacke",
      "brandId": "CMWBBRW2",
      "productLine": "501",
      "productionDate": "2021-07-02T09:30:52.093Z",
      "multiPack": true,
      "fscCertified": true,
      "productUrl": "http://myproduct.somewhere.com/productname/",
      "description": "<p>Some example words...<b>in bold</b>...some more</p>",
      "bulletPoints": [
        "My top key information..."
      ],
      "attributes": [
        {
          "name": "Materialzusammensetzung",
          "values": [
            "100% Baumwolle"
          ]
        }
      ]
    },
    "mediaAssets": [
      {
        "type": "IMAGE",
        "location": "http://apartners.url/image-location"
      }
    ],
    "order": {
      "maxOrderQuantity": {
        "quantity": 10,
        "periodInDays": 7
      }
    },
    "pricing": {
      "standardPrice": {
        "amount": 19.95,
        "currency": "EUR"
      },
      "vat": "FULL",
      "msrp": {
        "amount": 19.95,
        "currency": "EUR"
      },
      "sale": {
        "salePrice": {
          "amount": 19.95,
          "currency": "EUR"
        },
        "startDate": "2019-10-19T09:30:00Z",
        "endDate": "2019-10-19T09:30:00Z"
      },
      "normPriceInfo": {
        "normAmount": 100,
        "normUnit": "g",
        "salesAmount": 500,
        "salesUnit": "g"
      }
    },
    "logistics": {
      "packingUnitCount": 3,
      "packingUnits": [
        {
          "weight": 365,
          "width": 600,
          "height": 200,
          "length": 300
        }
      ]
    },
    "compliance": {
      "productSafety": {
        "addresses": [
          {
            "name": "Die Musterfirma GmbH",
            "address": "Musterstraße 1, 12345, Musterstadt, Deutschland",
            "regionCode": "DE",
            "email": "info@die-musterfirma.de",
            "url": "https://musterfirma/kontakt-information",
            "phone": "+ 49 40 123456789",
            "roles": [
              "DISTRIBUTOR"
            ],
            "components": [
              "mouse"
            ]
          }
        ]
      },
      "foodInformation": {
        "addresses": [
          {
            "name": "Die Musterfirma GmbH",
            "address": "Musterstraße 1, 12345, Musterstadt, Deutschland",
            "regionCode": "DE",
            "email": "info@die-musterfirma.de",
            "url": "https://musterfirma/kontakt-information",
            "phone": "+ 49 40 123456789",
            "roles": [
              "FOOD_BUSINESS_OPERATOR"
            ],
            "components": [
              "Salad"
            ]
          }
        ]
      }
    }
  }
]

Response

The request for a modification of the specified product variations was accepted and will be executed

state'pending' | 'done'

the current state of the process

messagestring

a human-readable message describing the current state of the process

totalinteger

the total work to complete for this process

progressinteger

the fraction of work that is already completed, as compared to the total work

succeededinteger

the number of successfully processed variations

failedinteger

the number of failed processed variations

unchangedinteger

the number of unchanged and not processed variations

pingAfterstring date-time

recommendation when to poll this resource again to receive a meaningful update - ISO8601 date

Example response

{
  "total": 7,
  "progress": 7,
  "succeeded": 4,
  "failed": 2,
  "unchanged": 1,
  "pingAfter": "2020-05-13T10:40:01.815Z",
  "links": [
    {
      "rel": "self",
      "href": "/v5/products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.