Lieferadressen aktualisieren
Lieferadressen aktualisieren
Beschreibung
Diese Methode aktualisiert alle Lieferadressen eines Kunden.
Die übergebenen Lieferadressen müssen eindeutig sein, Sie dürfen also keine zwei oder mehr identische Adressen übergeben.
Die übergebenen Adressen ersetzen/aktualisieren die vorhandenen Adressen eines Kunden, dabei können optional externe Adress-Ids gesetzt werden:
- Übergabe einer externen Ids zu einer Adresse:
- Existiert im Shop bereits eine Adresse mit der übergebenen externen ID wird die Adresse aktualisiert. Das betrifft auch eingeschränkte Lieferadressen an Kontakten.
- Bereits vorhandenen Adressen ohne externe Id wird die externe ID zugewiesen
- In den übrigen Fällen wird eine neue Adresse mit der übergebenen externen Id angelegt.
- Keine Übergabe einer externen Id zu einer Adresse:
- Ist die Adresse bereits vorhanden wird sie beibehalten, eine vorhandene externe Id wird entfernt.
- Sonst wird die Adresse neu angelegt.
- Adressen die vor dem Aufruf vorhanden waren aber nicht übergeben wurden werden entfernt. Das betrifft auch eingeschränkte Lieferadressen an Kontakten.
Anfrage
Syntax
PUT /v2/customer/<uuid>/delivery-addresses HTTP/1.1
Host: api.cobai.com
Date: Datum/Uhrzeit
Authorization: Signatur
Request-Parameter
Diese Methode benutzt keine Requestparameter
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 folgendem Aufbau:
<addresses>
<address>
<externalAddressIdentifier>some-external-id</externalAddressIdentifier>
<city>Ort</city>
<countryIso>DE</countryIso>
<houseNumber>3</houseNumber>
<name1>Anderswo AG</name1>
<name2></name2>
<name3></name3>
<name4></name4>
<postcode>12345</postcode>
<street>Weg</street>
</address>
...
</addresses>
Feldname | Pflicht | Typ | Bemerkung |
---|---|---|---|
externalAddressIdentifier | C(255) | Externe Id der Adresse. Diese Id bliebt der Adresse auch bei Änderungen auf Shopseite weiter zugeordnet. | |
name1 | C(40) | ||
name2 | C(40) | ||
name3 | C(40) | ||
name4 | 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. |
Sie können alle Lieferadressen eines Kunden löschen indem Sie einen leeren Request Body übergeben.
Antwortdokument
Als Antwort erhalten Sie ein XML-Dokument mit allen hinterlegten Lieferadressen oder im Fehlerfall ein BadRequest
Antwortdokument.