logo
API docs by Redocly

RPIS Cargo API (1)

Download OpenAPI specification:Download

License: RPIS API License Terms of Service

Die RPIS Cargo-API ist eine HTTPS-REST-API. Es handelt sich um die Schnittstelle, die RheinPorts verwendet, um Cargo-Status-Updates von Terminal und Barge Operators zu empfangen.

Overview diagram

Durch diese Schritte können Sie Ihre Zollanmeldungen effizient und systematisch über die RPIS Cargo API verwalten

  1. Der RPIS-Benutzer erstellt eine Reise
    Wichtig ist die richtige Voyage-ID einzugeben, da sie zwischen allen Logistikpartnern geteilt wird.


  2. Halten RPIS mit der Cargo-Planung auf dem neuesten Stand:

Update Type API Endpoint
Senden von Lade- und Löschlisten POST cargo-move-list
NB: Move List Updates
Aktualisierung eines bestimmten Artikels PUT cargo-item-by-container-no
PUT cargo-item-by-bulk-id
Cargo-Item-Referenzoptionen
  1. Teilen Sie uns den Fortschritt Ihres Umschlags mit.
Update Type API Endpoint
Ein Umschlagereignis übermitteln POST handling-event-by-container-no
POST handling-event-by-bulk-id
NB: Zoll Risiko Analyze
  1. Status-Updates zu Ihrem Cargo im Schweizer Zoll können über die folgenden Endpunkte abgerufen werden:
Request Type API Endpoint
Für Informationen zur gesamten Cargoliste GET ch-customs-list
Für Informationen zu einzelnen Artikeln GET ch-customs-item-by-container-no
GET ch-customs-item-by-bulk-id
Cargo-Item-Referenzoptionen

Move List Updates

Updates an cargo-move-list ERSETZEN die gesamte Liste. Zuvor gesendete Informationen zu bestimmten Containern oder Cargo-Artikeln in dieser Reise werden überschrieben.

Zoll Risiko Analyze

Nach dem Senden dieser Benachrichtigung beginnt Schweizer Zoll seiner Prüfung, und sie kann nicht zurückgenommen werden. Melden Sie die Waren nur als vor Ort, wenn Sie sicher sind, dass sie exportiert werden.

Cargo-Item-Referenzoptionen

Für die Nutzung der RPIS Cargo API gibt es drei Optionen, um auf einzelne Cargo-Items zu verweisen:

  1. Bulk-ID: Wenn Sie Ihre eigene interne Referenz verwenden möchten, müssen Sie das Attribut bulkId beim Senden der cargo-move-list ausfüllen. Wenn Sie eine leere Bulk-ID senden, wird eine für Sie erstellt. Um die Bulk-ID herauszufinden, müssen Sie den Endpunkt GET ch-customs-list mit der Voyage-ID aufrufen.
  2. Containernummer: Container-Umschläge müssen mit der Containernummer referenziert werden.

Diese Optionen ermöglichen eine flexible Referenzierung für die Verwaltung einzelner Cargo-Items in der API.

Ladeliste oder Löschliste


Der /cargo-move-list -Endpunkt wird verwendet, um Lade- und Löschlisten, einschließlich des aktuellen Status, zu übermitteln.

Authorizations:
basicAuth
path Parameters
voyageId
required
string
Value: ""
Request Body schema: application/json
required
required
object (vehicle)

Dieses Objekt muss eine Barge definieren

required
object (handling)

Das handling-Objekt enthält Details zu Zeit, Ort und Richtung des Handlings

required
object (cargo)

Alle Details zum Cargo und seiner Verpackung

Responses

Request samples

Content type
application/json
{
  • "vehicle": {
    },
  • "handling": {
    },
  • "cargo": {
    }
}

Customs status von Ladelisten und Löschlisten abfragen


Der /ch-customs-list -Endpunkt wird verwendet, um Lade- und Löschlisten, einschließlich des aktuellen Status, zu übermitteln.

Authorizations:
basicAuth
path Parameters
voyage-id
required
string
Value: ""

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cargo status übermitteln (Container-nummer)


Der /cargo-update-item -Endpunkt wird verwendet, um RPIS mit dem Status eines Cargos zu aktualisieren

Authorizations:
basicAuth
path Parameters
voyage-id
required
string
Value: ""
container-no
required
string
Value: ""
Request Body schema: application/json
required
required
object (handling)

Das handling-Objekt enthält Details zu Zeit, Ort und Richtung des Handlings

required
object (container)

Wenn Containers transportiert werden, sollten die Details in diesem Objekt eingetragen werden

required
object (vehicle)

Dieses Objekt muss eine Barge definieren

Responses

Request samples

Content type
application/json
{
  • "handling": {
    },
  • "container": {
    },
  • "vehicle": {
    }
}

Cargo status übermitteln (Bulk ID)

Der PUT cargo-item-by-bulk-id -Endpunkt wird verwendet, um RPIS mit dem Status eines Cargos zu aktualisieren

Authorizations:
basicAuth
path Parameters
voyage-id
required
string
Value: ""
bulk-id
required
string
Value: ""
Request Body schema: application/json
required
required
object (vehicle)

Dieses Objekt muss eine Barge definieren

required
object (handling)

Das handling-Objekt enthält Details zu Zeit, Ort und Richtung des Handlings

required
object (bulk)

Wenn Massengut transportiert wird, sollten die Details in diesem Objekt eingetragen werden

Responses

Request samples

Content type
application/json
{
  • "vehicle": {
    },
  • "handling": {
    },
  • "bulk": {
    }
}

Ein Umschlagereignis ist eingetreten


Der /handling-event-by-container-no -Endpunkt wird genutzt, um RPIS darüber zu informieren, dass ein Umschlagereignis ist eingetreten.

Authorizations:
basicAuth
path Parameters
voyage-id
required
string
Value: ""
container-no
required
string
Value: ""
Request Body schema: application/json
required
handlingEvent
string (handlingEvent)
Enum: "PRELIMINARY_LOADING" "CONFIRMED_LOADING" "PRELIMINARY_DISCHARGE" "CONFIRMED_DISCHARGE" "CARGO_ON_SITE"


Das Handling-Event informiert RPIS über den aktuellen Bearbeitungszustand des Cargo-Objekts
Die möglichen Werte sind:
"PRELIMINARY_LOADING" (Vorläufiges Laden): Der Cargo ist zum Laden vorgesehen
"CONFIRMED_LOADING" (Bestätigtes Laden): Der Cargo wurde geladen
"PRELIMINARY_DISCHARGE" (Vorläufiges Löschen): Der Cargo ist zum Löschen vorgesehen
"CONFIRMED_DISCHARGE" (Bestätigtes Löschen): Der Cargo wurde gelöscht
"CARGO_ON_SITE" (Cargo vor Ort): Der Cargo befindet sich physisch vor Ort und wartet auf das Laden

Responses

Request samples

Content type
application/json
{
  • "handlingEvent": "PRELIMINARY_LOADING"
}

Ein Umschlagereignis ist eingetreten


Der /handling-event-by-bulk-id -Endpunkt wird genutzt, um RPIS darüber zu informieren, dass ein Umschlagereignis ist eingetreten.

Authorizations:
basicAuth
path Parameters
voyage-id
required
string
Value: ""
bulk-id
required
string
Value: ""
Request Body schema: application/json
required
handlingEvent
string (handlingEvent)
Enum: "PRELIMINARY_LOADING" "CONFIRMED_LOADING" "PRELIMINARY_DISCHARGE" "CONFIRMED_DISCHARGE" "CARGO_ON_SITE"


Das Handling-Event informiert RPIS über den aktuellen Bearbeitungszustand des Cargo-Objekts
Die möglichen Werte sind:
"PRELIMINARY_LOADING" (Vorläufiges Laden): Der Cargo ist zum Laden vorgesehen
"CONFIRMED_LOADING" (Bestätigtes Laden): Der Cargo wurde geladen
"PRELIMINARY_DISCHARGE" (Vorläufiges Löschen): Der Cargo ist zum Löschen vorgesehen
"CONFIRMED_DISCHARGE" (Bestätigtes Löschen): Der Cargo wurde gelöscht
"CARGO_ON_SITE" (Cargo vor Ort): Der Cargo befindet sich physisch vor Ort und wartet auf das Laden

Responses

Request samples

Content type
application/json
{
  • "handlingEvent": "PRELIMINARY_LOADING"
}

Ein Transportereignis ist eingetreten


Der /transport-event-by-terminal-location -Endpunkt wird genutzt, um RPIS darüber zu informieren, dass ein Transportereignis ist eingetreten.

Authorizations:
basicAuth
path Parameters
voyage-id
required
string
Value: ""
terminal-location
required
string
Value: ""
Request Body schema: application/json
required
transportEvent
string (transportEvent)
Enum: "VEHICLE_ARRIVAL" "HANDLING_START" "HANDLING_PAUSE" "HANDLING_STOP" "VEHICLE_DEPARTURE"


Das Transport-Event informiert RPIS über den aktuellen Bearbeitungszustand des Transportstopps eine Reise
Die möglichen Werte sind:
"VEHICLE_ARRIVAL" (Schiff Angekommen)
"HANDLING_START" (Ladung angefangen)
"HANDLING_PAUSE" (Ladung Pause)
"HANDLING_STOP" (Ladung Fertig)
"VEHICLE_DEPARTURE" (Fahrzeug abgefahren)

Responses

Request samples

Content type
application/json
{
  • "transportEvent": "VEHICLE_ARRIVAL"
}

CH Zoll-status eines Cargos abfragen (Container-nummer)


Der /ch-customs-item-by-container-no -Endpunkt werden verwendet, um den Status eines Cargos zu abzufragen

Authorizations:
basicAuth
path Parameters
voyage-id
required
string
Value: ""
container-no
required
string
Value: ""

Responses

Response samples

Content type
application/json
{
  • "chCustomsStatus": "INITIAL_REGISTRATION_ACCEPTED",
  • "journeyReferenceNumber": null,
  • "goods": [
    ]
}

CH Zoll-status eines Cargos abfragen (Bulk ID)

Der /ch-customs-item-by-bulk-id -Endpunkte werden verwendet, um den Status eines Cargos zu abzufragen

Authorizations:
basicAuth
path Parameters
voyage-id
required
string
Value: ""
bulk-id
required
string
Value: ""

Responses

Response samples

Content type
application/json
{
  • "chCustomsStatus": "INITIAL_REGISTRATION_ACCEPTED",
  • "journeyReferenceNumber": null,
  • "goods": [
    ]
}