Dropshipping – API-Referenz

Fach-API für die Kunden- und Lieferantenseite des Dropshippings. Basis ist https://core-backend.reybex.com/api (Staging: https://io-staging-partner.reybex.com/api). Authentifizierung wie im API: --header "authorization: Basic $TOKEN".

Partner stehen unter Kunden- und Lieferantenverwaltung. Belege unter Auftragsverwaltung.

Der schreibende Weg des Kunden ist POST /api/dropshippingCustomer/. Der des Lieferanten ist POST /api/dropshippingVendor/. Der Körper ist der Datensatz selbst. Der Dienst liest ihn zusätzlich als dropshippingCustomer beziehungsweise dropshippingVendor. Leere Objekte werden zu null.

1. Grundlagen

Objekt	Rolle
DropshippingCustomer	Mandant, der Ware vom Lieferanten bezieht
DropshippingVendor	Lieferantenmandant und Aufschlag
MaterialSyncRule	Ein- oder Ausschluss von Warengruppe, Marke, Art oder Lieferant

status ist 0, 1 oder 2. type 0 ist der Standard.

Die Zahlen in den Beispielen sind Beispiel-Ids eines Mandanten. 30001 ist der Partner. 4001 ist das Lager.

1.1 Suchschlüssel

Ziel	Suchschlüssel
Partner	customerNo
Lager	code, sonst name
Belegart, Versandart	code oder name, sonst id

1.2 Antwortformat

Speichern liefert { "id": 9950 }. Die Artikelsynchronisation liefert { "success": true }.

2. Kunde

POST /api/dropshippingCustomer/

customer ist der Partner. customerTenant ist die Id des Kundenmandanten. warehouse ist das Lager der Zulieferung.

2.1 Pflichtfelder

Auflösung, wenn ein Pflichtfeld fehlt

Die API setzt Pflicht-Referenzen nicht von selbst. Fehlt ein Feld, in dieser Reihenfolge füllen. Der erste Treffer gilt.

1. Angabe – Wert aus dem Auftrag für dieses Feld.
2. Vorlage – dasselbe Feld aus GET /api/dropshippingCustomer/{id}. id nicht übernehmen.
3. Standard – Wert aus der Tabelle.
4. Domäne – Lager über GET /api/domains/warehouses?take=1&sort=code, wenn der Auftrag ein Lager verlangt.
5. Stopp – Partner fehlt. Kundenkonfiguration nicht anlegen.

Feld	Pflicht	Vorlage	Standard	Domäne
customer	ja	customer	—	—
status	nein	status	0	—
type	nein	type	0	—
useInExcludeMatGroup	nein	useInExcludeMatGroup	true	—
warehouse	nein	warehouse	—	warehouses

2.2 Anlegen

{
  "customer": { "customerNo": "KD-1000" },
  "customerTenant": "200",
  "warehouse": { "code": "HL" },
  "status": 0,
  "type": 0,
  "defaultShippingCosts": 4.9
}

Response: { "id": 9950 }

Filter der Synchronisation: POST /api/dropshippingCustomer/materialSyncConfig

{
  "dropshippingCustomer": { "id": 9950 },
  "vendorSelect": [],
  "brandSelect": [],
  "matGroupSelect": []
}

useInExcludeVendor, useInExcludeBrand und useInExcludeMatGroup true bedeutet Ausschluss der gewählten Werte, false bedeutet Einschluss.

Status setzen: POST /api/dropshippingCustomer/dropshippingCustomerStatus.

Bestellungen aus dem Nachrichtenkopf lesen: GET /api/dropshippingCustomer/dropshippingOrdersFromCommHead.

Lesen: GET /api/dropshippingCustomer/9950.

3. Lieferant

POST /api/dropshippingVendor/

vendor ist der Lieferant. salesSurcharge ist der Aufschlag. Standard 100. isMatCodeCopiedFromVendor true übernimmt die Artikelnummer des Lieferanten.

{
  "vendor": { "customerNo": "LF-200" },
  "warehouse": { "code": "HL" },
  "salesSurcharge": 100,
  "status": 0,
  "type": 0,
  "exportMode": 0,
  "mappingType": 0,
  "isMatCodeCopiedFromVendor": true
}

Response: { "id": 9960 }

Ohne id sucht die API den Mandanten des Lieferanten. Artikel, die der Lieferant freigibt: GET /api/dropshippingVendor/getSyncableMaterials.

Übernehmen: POST /api/dropshippingVendor/copyMaterialsFromList.

Lesen: GET /api/dropshippingVendor/9960.

4. Endpoint-Katalog

Methode	Pfad	Bedeutung
GET	/api/dropshippingCustomer/{id}	Ein Kunde oder die Liste
POST	/api/dropshippingCustomer/	Kunde speichern
POST	/api/dropshippingCustomer/materialSyncConfig	Filter speichern
POST	/api/dropshippingCustomer/dropshippingCustomerStatus	Status ändern
GET	/api/dropshippingCustomer/dropshippingOrdersFromCommHead	Bestellungen aus Nachrichten
GET	/api/dropshippingVendor/{id}	Ein Lieferant oder die Liste
POST	/api/dropshippingVendor/	Lieferant speichern
GET	/api/dropshippingVendor/getSyncableMaterials	Freigegebene Artikel
POST	/api/dropshippingVendor/copyMaterialsFromList	Artikel übernehmen

5. Häufige Fehler

Situation	Ursache
Kunde ohne Partner	customer fehlt
status abgelehnt	Wert ist nicht 0, 1 oder 2
Kein Lieferantenmandant	Zur vendor-Id gibt es keinen Mandanten