Cobai V2 API
Cobai V2 API
Breadcrumbs

Kunden anlegen

Beschreibung

Mit dieser Methode können Sie neue Kunden anlegen.

Anfrage

Syntax 

POST /v2/customer/ HTTP/1.1
Host: api.cobai.com
Date: Datum/Uhrzeit
Content-Length: Länge
Content-Type: application/xml
Authorization: Signatur

Request-Parameter

Name

Typ

Default

Beschreibung

allow_id1_reuse

boolean

false

Eine Prüfung auf doppelt vergebene Kundennummern findet nicht statt wenn true.

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 Kunden innerhalb des Root-Elements <customer/>. Die folgenden Felder können übergeben werden:

Feldname

Pflicht

Typ

Bemerkung

externalAccountId1


C(15)

Kundennummer im Warenwirtschaftssystem, muss systemweit eindeutig sein. Siehe auch Request Parameter 'allow_id1_reuse'.

externalAccountId2


C(15)

Infofeld, wird bisher nicht verwendet.

name1


C(40)


name2


C(40)


city


C(40)


postcode


C(10)


street


C(60)


houseNumber


C(10)

Sie können die Hausnummer auch im Feld "street" übergeben wenn die Daten nicht getrennt vorliegen.

countryNameIso


C(3)

Verwenden Sie nur Codes aus der Liste der freigegebenen Länderkennzeichen.

fon


C(30)


fax


C(30)


mail


C(200)


priceListTypeName


C(4)

Bitte beachten Sie dazu die Hinweise zu Preislistennamen.

inAutoDeliveryMode



true wenn der Kunden automatisch beliefert werden soll, sonst false.

Antwort

Erfolgsfall

Im Erfolgsfall wird im Zielsystem ein neuer Kunden angelegt. Sie erhalten als Antwort HTTP-Status 201 Created, einen Location-Header mit der Url des Kunden sowie ein Antwortdokument mit den gespeicherten Kundendaten.

Fehlerfall

Im Fehlerfall wird kein neuer Kunde 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 Kunden.

Antwortdokument

Als Antwort auf die Anfrage erhalten sie ein Antwortdokument mit folgendem Inhalt:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<customer xmlns:atom="http://www.w3.org/2005/atom">
    <city>Testingen</city>
    <countryNameIso>AT</countryNameIso>
    <externalAccountId1>ABCDEF</externalAccountId1>
    <fax></fax>
    <fon>12345</fon>
    <houseNumber>1</houseNumber>
    <inAutoDeliveryMode>false</inAutoDeliveryMode>
    <mail></mail>
    <name1>Testfirma geändert</name1>
    <name2></name2>
    <postcode>1234</postcode>
    <priceListTypeName>F100</priceListTypeName>
    <atom:link rel="self" href="http://api.cobai.com/v1/customer/fe81c542-0d72-41e6-af06-87e9cbefb070"/>
    <street>Testweg</street>
    <uuid>fe81c542-0d72-41e6-af06-87e9cbefb070</uuid>
</customer>

Die UUID des Kunden ist sein eindeutiger Schlüssel. Speichern Sie die UUID oder die vollständige Url aus dem Location-Header in Ihrem System, ohne sie können Sie keine Änderungen an dem gerade angelegten Kunden vornehmen.