Beschreibung
Mit dieser Methode können Sie neue Produkte anlegen.
Anfrage
Syntax
POST /v2/product/ HTTP/1.1
Host: api.cobai.com
Date: Datum/Uhrzeit
Content-Length: Länge
Content-Type: application/xml
Authorization: Signatur
Request-Parameter
Diese Methode benutzt keine zusätzlichen Request-Parameter
Request-Header
Diese Methode benutzt zusätzlich zu den Standard-Requestheadern keine weiteren Header.
Request-Body
Im Request-Body erwartet die Methode ein XML-Dokument mit den Daten des anzulegenden Produktes innerhalb des Root-Elements mit folgendem Aufbau:
<product>
<head>
<category>Warengruppe</category>
<make>Marke</make>
<title>Titel</title>
<description>Beschreibung (lang)</description>
<keywords>
<keyword>Zusätzlicher Suchbegriff</keyword>
</keywords>
<attributes>
<attribute>Name eines Attributes</attribute>
</attributes>
</head>
<items>
<item>
<sku>Artikelnummer</sku>
<manufacturerMaterialNumber>Herstellerteilenummer</manufacturerMaterialNumber>
<text>Artikeltext für Warenkorb und Auftragsbestätigungen</text>
<tax>Steuercode</tax>
<content>Inhalt bei grundpreisangabepflichtigen Produkten</content>
<unit>Inhaltsmengeneinheit bei grundpreisangabepflichtigen Produkten</unit>
<attributeValues>
<value>Wert eines Attributes</value>
</attributeValues>
</item>
</items>
<product>
|
Feldname |
Pflicht |
Typ |
Bemerkung |
|---|---|---|---|
|
make |
|
C(60) |
Marke |
|
title |
|
C(200) |
Kurztitel des Produktes |
|
description |
|
C(3500) |
Beschreibung (lang) des Produktes |
|
category |
|
C |
Verwenden Sie nur gültige Warengruppen-IDs. Eine Liste aller IDs erhalten sie über die Servicemethode Warengruppenliste abrufen. Achtung: Verwenden Sie nur Warengruppen, die keine weiteren Unterwarengruppen enthalten. |
|
keywords/keyword |
|
C |
Geben Sie hier zusätzliche Suchbegriffe an mit denen der Artikel über die Volltextsuche gefunden werden soll. Innerhalb des |
|
attributes/attribute |
|
C(100) |
Maximal 6 Attributnamen |
|
items/item |
|
- |
Die einzelnen Varianten eines Artikels, z.B. Farbvarianten. Wenn Ihr Artikel keine Varianten enthält nehmen Sie nur ein einzelnes item-Tag innerhalb des items-Tags auf. |
|
sku |
|
C(32) |
Ihre Artikelnummer. Bitte achten Sie darauf, nicht mit den Shop-Artikelnummern zu kollidieren. |
|
manufacturerMaterialNumber |
|
C(32) |
Die Teilenummer des Herstellers (Herstellerartikelnummer) |
|
text |
|
C(80) |
Die Artikelbeschreibung. Dieser Text wird im Warenkorb angezeigt und in allen ausgehenden Mails verwendet in denen Artikel beschrieben werden (z.B. Auftragsbestätigungen). |
|
tax |
|
N(1) |
Steuercode: 1 - Volle Steuer, 2 - halbe Steuer, 0 - steuerbefreit |
|
content |
|
N(6) |
Der Inhalt bei Produkten für die ein Grundpreis angegeben werden muss. Geben Sie den Inhalt als ganze Zahl an. |
|
unit |
|
C(2) |
Die Inhaltsmengeneinheit des Inhalts, falls im Feld content ein Inhalt angegeben wird. Erlaubte Werte:
|
|
attributeValues/value |
|
C(100) |
Ausprägung eines Attributes. Es sind maximal 6 Attributwerte erlaubt. |
Antwort
Erfolgsfall
Im Erfolgsfall wird im Zielsystem ein neues Produkt angelegt. Sie erhalten als Antwort HTTP-Status 201 Created und ein Antwortdokument mit der Standardproduktnummer (SPN) sowie der Url des Produktes.
Fehlerfall
Im Fehlerfall wird kein neues Produkt angelegt. Sie erhalten als Antwort HTTP-Status 400 Bad Request und ein BadRequest Antwort-Dokument.
Antwortheader
Location: Im Location-Header erhalten Sie die URL des neu angelegten Produktes.
Antwortdokument
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<productResponse xmlns:atom="http://www.w3.org/2005/atom">
<spn>1234567890</spn>
<atom:link rel="self" href="http://api.cobai.com/v1/product/1234567890"/>
</productResponse>
Speichern Sie die Url des Artikels und die Standardproduktnummer, sie können andernfalls keine Änderungen am Produkt vornehmen und keine Produktabbildungen zuordnen.