Curosa
Supplier Portal API Reference New

Fulfilment

Sendungen

Sendungen abrufen und den Sendungsstatus für das Kunden-Fulfillment aktualisieren

Übersicht

Die Shipments-Endpunkte ermöglichen es Ihnen, Kundensendungen einzusehen und den Fulfillment-Status zu aktualisieren, während Bestellungen Ihren Versand-Workflow durchlaufen.

Authentifizierung

Alle Endpunkte erfordern eine Authentifizierung. Geben Sie Ihr API-Token im Authorization-Header an. Weitere Informationen zum Erhalt eines Tokens finden Sie im Authentifizierungsleitfaden.

Sendungen auflisten

Rufen Sie eine Liste von Sendungen ab.

Endpunkt: GET https://curosa.com/api/v1/shipments

Anfrage

curl --location 'https://curosa.com/api/v1/shipments?status=pending' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

Abfrageparameter

Parameter Typ Beschreibung
status String Optionaler Filter für den Sendungsstatus (Beispiel: pending)

Versandbereite Sendungen auflisten

Rufen Sie Sendungen ab, die heute versandbereit sind und noch nicht als versendet oder abgeholt markiert wurden.

Endpunkt: GET https://curosa.com/api/v1/shipments/ready-to-ship

Anfrage

curl --location 'https://curosa.com/api/v1/shipments/ready-to-ship' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

Antwortverhalten

Dieser Endpunkt gibt Sendungen zurück, die:

  • am aktuellen Tag versendet werden sollen
  • derzeit nicht als versendet markiert sind
  • derzeit nicht als abgeholt markiert sind

Sendung abrufen

Rufen Sie eine bestimmte Sendung anhand der Bestellnummer ab.

Endpunkt: GET https://curosa.com/api/v1/shipments/{order_number}

Anfrage

curl --location 'https://curosa.com/api/v1/shipments/OSN-01260312-002001' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

Pfadparameter

Parameter Typ Beschreibung
order_number String Bestellnummer der Sendung

Sendung als versendet markieren

Markieren Sie eine Sendung als versendet und geben Sie Informationen zum Versanddienstleister/Tracking an.

Endpunkt: POST https://curosa.com/api/v1/shipments/{order_number}/shipped

Anfrage

curl --location 'https://curosa.com/api/v1/shipments/OSN-01260312-002001/shipped' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
    "carrier": "DHL",
    "tracking_number": "DHL-123456789",
    "is_collected": false
}'

Anforderungskörper (Request Body)

Feld Typ Erforderlich Beschreibung
carrier String Ja Name des Versanddienstleisters
tracking_number String Ja Sendungsverfolgungsnummer des Dienstleisters
is_collected Boolean Nein Auf true setzen, wenn die Sendung bereits abgeholt wurde

Sendung als abgeholt markieren

Markieren Sie eine Sendung als vom Versanddienstleister abgeholt.

Endpunkt: POST https://curosa.com/api/v1/shipments/{order_number}/collected

Anfrage

curl --location 'https://curosa.com/api/v1/shipments/OSN-01260312-002001/collected' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
    "carrier": "DHL",
    "tracking_number": "DHL-123456789"
}'

Anforderungskörper (Request Body)

Feld Typ Erforderlich Beschreibung
carrier String Ja Name des Versanddienstleisters
tracking_number String Ja Sendungsverfolgungsnummer des Dienstleisters

Ratenbegrenzung

Die Endpunkte für Sendungen sind auf 3.600 Anfragen pro Stunde begrenzt. Das aktuelle Limit und die verbleibenden Anfragen werden in den Antwort-Headern als x-ratelimit-limit und x-ratelimit-remaining zurückgegeben.