APIs in SAP Business Network Freight Collaboration

Consumer API for Dock Appointment Scheduling

As a shipper, you can use this outbound service provided by SAP Business Network for Logistics to update your external systems with the appointment details. You can update your external systems such as a transportation system, warehouse management system, yard management system, and so on with the appointment details.

Technical Name

GenericAppointment_Out

Description

You can update a freight order, transportation unit, or yard order with the appointment ID and the appointment details created in your SAP Business Network for Logistics.

Structure

The system has different fields categorized under different nodes. Each node contains various fields. Below are some of the important fields displayed by the system:

Technical Name Field Description Node
OrderingPartyLbnId Ordering Party LBN ID* Contains the ordering party ID maintained in the SAP Business Network for Logistics system Appointments
CarrierLbnId Carrier LBN ID* Contains the carrier ID maintained in the SAP Business Network for Logistics system Appointments
SenderSystemId Sender System ID* Contains the ID of sender system Appointments
AppointmentStatusCode Appointment Status Code*

Passes one of the following status codes:

01 – Appointment Request Created

03 – Confirmed

04 – Rejected

05 – Freight Order Canceled

06 – Canceled by Operator

07 – Canceled by Carrier

09 - Canceled by Generic Appointment API

Appointments
LoadingActivityType Loading Activity Type

Contains one of the following activity types:

01 – Loading

02 – Unloading

03 – Loading/Unloading

Appointments
Text Text Contains the reason why the appointment is canceled by the carrier or warehouse operator. Appointment Note
CreatedAt Created At Contains the date and time at which the note was created Appointment Note
DocumentId Document ID Contains the document ID of the source business document from your external system (For example, freight order, transport unit, yard order). Appointment Reference Document
DocumentType Document Type

Contains one of the following types of reference document:

1311 –Transportation Unit Appointment (Extended Warehouse Management)

1122 –Transportation Order (Transportation Management)

YO –Yard Order (Yard Logistics)

Appointment Reference Document

Note that the fields marked with * are mandatory fields.

Notes and Attachments

You can use this outbound API to update the external systems with the notes from your SAP Business Network for Logistics.

You can use this outbound API to update the external systems with the attachments from your SAP Business Network for Logistics.

Share Appointments and Appointment Requests with Business Partners

You can share a docking location with your business partners in SAP Business Network for Logistics. When an appointment request is received or an appointment is booked with this docking location in the SAP Business Network for Logistics system, you can use this outbound API to update the appointment details in the external systems. Along with your external systems, the system also updates the appointment details in the external systems of business partners with whom you have shared this docking location.

Receive Error Messages in your External System

You can use this API to receive error messages in your external system in case of business validation errors that may occur while processing your request to SAP Business Network for Logistics. This API sends the following information:

  • Processing status

    Displays whether the status is blank (success), 1 (info), 2 (warning), or 3 (error)

  • Correlation ID

    You can use this ID to view or reprocess the message in Manage Integration Logs app

  • Log node

    Additional node in the API that contains the message code, message, and the severity code

When a business validation error occurs, the system fills the correlation ID in the message and sets the processing status as 3 (Error). This indicates that the message processing has failed. You can use this correlation ID to find this message in the Manage Integration Logs app and check for the issue. The system also fills the log node describing the issue that occurred while processing the request.

You can view below the severity codes and the error messages that can occur.

Severity Codes

  • Blank (success)

  • 1 (info)

  • 2 (warning)

  • 3 (error)

Message Codes and Message

Message Code Message
10001 The appointment type code is invalid
10003 The carrier/ordering party LBN ID is invalid
10004 The docking location is invalid
10005 The status of the appointment is invalid
10006 The appointment date/time is invalid
10007 The docking location or loading point is invalid
10008 The appointment duration is invalid
10009 The selected date is a non-working day.
10010 No time slots are available. Please contact the warehouse operator to check docking location settings.
10011 The time slot you are trying to book does not fit any period specified in business hours
10012 No time slots are available. The selected date is fully booked.
10013 Appointment does not exist
10014 Found multiple existing appointments