Provider API to Manage Gate Operations
As a shipper, you can use this inbound service to update the gate logbook details in your SAP Business Network for Logistics system based on the vehicle check-in and checkout information from your external systems such as a transportation system, warehouse management system, yard management system and so on.
You can perform the following using this API:
Scenario 1 – Without Vehicle License Plate Details
If the carrier has not updated the vehicle license plate details, the system uses the GenericAppointment_Out API to send the appointment details to the external systems. Once the vehicle arrives at the gate, the gate operations manager sends the reference appointments and check-in details to the SAP Business Network for Logistics system using this inbound API. The system creates a gate logbook in the SAP Business Network for Logistics system.
Scenario 2 – With Vehicle License Plate Details
If the carrier has updated the vehicle license plate details, the system creates a gate logbook in the SAP Business Network for Logistics system and notifies the external systems using the GenericGateProcess_Out API. The gate operations manager can directly begin the check-in process in the external system.
The gate operations manager updates the check-in details such as the check-in time, driver details, gate details, vehicle licence plate, weight and seal details, equipment details, notes, and attachments in the external system. You can use this inbound API to update your SAP Business Network for Logistics system with these details.
Once the vehicle checks out from the gate, the gate operations manager updates the checkout details such as the checkout time, driver details, gate details, vehicle license plate, weight and seal details, equipment details, notes, and attachments in the external system. When you specify a seal number, you can enter an alphanumeric value. Note that you must confirm the driver details before you can proceed with the checkout of the vehicle. You can use this inbound API to update your SAP Business Network for Logistics system with these details.
Request Documents from the External System
You can use this inbound API to send additional documents such as loading list and bill of lading from your external transportation system to your SAP Business Network for Logistics system.
The system sends one or more of the following statuses as applicable, during this process:
|Sends this status when the gate logbook is created
|Sends this status when the gate operations manager starts the check-in process
|Sends this status when the gate operations manager puts the check-in process on hold
|Sends this status when the gate operations manager completes the check-in process
|Sends this status when the gate operations manager starts the checkout process
|Sends this status when the gate operations manager puts the checkout process on hold
|Sends this status when the gate operations manager completes the checkout process
You can use this API to update your SAP Business Network for Logistics system with the events reported from your external systems.
Using this API, during the check-in and checkout processes at a gate, the system updates the gate logbook document in SAP Business Network for Logistics system with the events reported by one or more business partners.
You must send the following parameters in this API:
Contains one of the following event types:
|Event Reason Code
|Contains one of the event reason codes for the event type DELAYED given in the table below.
|Event Reason Description
|Contains the respective description of the event reason code as given in the table below.
|Actual Event Time
|Contains the actual event time
|Actual Event Time Zone
|Contains the time zone of the actual event
DELAYED event reason codes and descriptions:
|Event Reason Code
|Waiting at Location
|Cleanliness not fit
|Congestion of Bays
|Documents Missing/IT Failure
|Equipment Accident or Malfunction
|Force of Nature
|Incorrect or Not Conform
|Lack of Storage Capacity
|Previous loading or unloading Point
|Product Damaged/ Contaminated
|Terminal/ Rail/ Shipping Line