Bestellungen-API

Bestellungen abfragen, Status aktualisieren und Sendungen verwalten.

Endpunkte
GET

/orders

orders:read

Erhalten Sie eine paginierte Bestellliste. Unterstuetzt Filterung nach Status und Datumsbereich.

GET

/orders/:id

orders:read

Erhalten Sie eine Bestellung mit allen Positionen und Versanddetails.

PUT

/orders/:id/status

orders:write

Aktualisieren Sie den Status einer Bestellung (z.B. als versendet markieren).

POST

/orders/:id/shipment

orders:write

Fuegen Sie Sendungsverfolgungsinformationen zu einer Bestellung hinzu.

Feldreferenz
FeldTypErforderlichBeschreibung

id

string

Nein

Eindeutige Bestell-ID (schreibgeschuetzt)

orderNumber

string

Nein

Lesbare Bestellnummer (schreibgeschuetzt)

customerId

string

Nein

Kunden-ID (fehlt bei Gastbestellungen)

status

string

Nein

PENDING, CONFIRMED, PROCESSING, SHIPPED, DELIVERED, CANCELLED, REFUNDED

paymentStatus

string

Nein

pending, paid, refunded, failed

paymentMethod

string

Nein

Verwendete Zahlungsmethode (z.B. stripe, cod)

total

integer

Nein

Gesamtbetrag in Cent (schreibgeschuetzt)

items

OrderLine[]

Nein

Array von Positionen (schreibgeschuetzt)

shippingAddress

Address

Nein

Versandadresse-Objekt

fulfillmentType

string

Nein

shipping, pickup, delivery oder digital

createdAt

datetime

Nein

ISO 8601 Zeitstempel (schreibgeschuetzt)

updatedAt

datetime

Nein

ISO 8601 Zeitstempel (schreibgeschützt)

Abfrageparameter (Liste)
FeldTypErforderlichBeschreibung

page

integer

Nein

Seitennummer (Standard: 1)

limit

integer

Nein

Elemente pro Seite (Standard: 20, Max: 100)

Beispiel
Letzte Bestellungen auflisten
bash
curl "https://api.mercozy.com/api/v1/external/orders?page=1&limit=10" \
  -H "X-API-Key: mk_live_your_key_here"
Bestellstatus aktualisieren
bash
curl -X PUT "https://api.mercozy.com/api/v1/external/orders/ord_abc123/status" \
  -H "X-API-Key: mk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "shipped"
  }'
Sendungsverfolgung erstellen
bash
curl -X POST "https://api.mercozy.com/api/v1/external/orders/ord_abc123/shipment" \
  -H "X-API-Key: mk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "carrier": "fedex",
    "trackingNumber": "7489236401",
    "trackingUrl": "https://www.fedex.com/track?id=7489236401"
  }'