Pre-Advice

Version: 2.2, Date: 2025-09-01

Revision history

Purpose

Reserve trailer capacity at carriers for pallet shipments.

Integration touch points

The Pre-Advice is initiated by sending a request from SAP to Viya using an EDI/api message. Viya will create a Pre-Advice, indicating capacity needed to ship goods. After creation, Viya will message the carrier as defined in the Pre-Advice. The next step depends on the integration state of this carrier:

EDI/api Integrated Pre-Advice

The carrier has a Pre-Advice integration: an EDI/api message is send to the carrier. A direct response is expected. This response is then handled in Viya. Viya will sent to SAP with an EDI/api message containing the result.

E-mail Integrated Pre-Advice

The carrier has no Pre-Advice EDI/api integration, but accepts e-mail requests for the Pre-Advice: an e-mail with the request will be send to the defined e-mail address. This e-mail contains a link to secured Viya webpage that is specific for this Pre-Advice. On this page, the carrier can confirm or decline the Pre-Advice request. Viya will sent to SAP with an EDI/api message containing the result.

No integration configured

The carrier has no Pre-Advice integration and does not accept e-mail requests: as there is no Pre-Advice possibility, the SAP request will be followed by a direct decline of the request as there is no possiblity to fulfil the request.

State

• The endpoint will be available for testing latest 1-oct-2025.

Pre-Advice request

Payload

• The expected API documentation is available in the API documentation.

• SAP will request a Pre-Advice to Viya.

  • Information required:
    • SAP Pre-Advice reference
    • Carrier
    • Pickup address
    • Destination address (at least country, the more details the better)
    • Expected loadmeter
    • Expected pickup date/time
  • Information optional:
    • Expected delivery date/time
  • Alternatively users can enter Pre-Advice information in Viya, not requiring SAP to request the Pre-Advice.

• Viya will create the Pre-Advice and communicate it to the carrier in carrier desired format.

• Pre-Advice can be sent multiple times until dispatched. An updated Pre-Advice is sent again to the carrier, depending on carrier capabilities.

Pre-Advice confirmation

• At some point the carrier will confirm(or decline) the Pre-Advice.
  • At confirmation a booking reference is included.
• Viya feeds the confirmed Pre-Advice information back to SAP
  • Alternatively this can be skipped in case no SAP integration is required. but upon despatch advice this booking reference or Pre-Advice reference is needed to link the Pre-Advice to the despatch advice.
• Method: POST
• Endpoint: to be provided by SAP
• Headers:
  • Content-Type: application/json
  • Authorization or authentication indicated by SAP

Payload

Example payload of Pre-Advice confirmation:

{
    "reference": "As provided in the request",
    "state": "accepted",
    "carrierAssignedReference": "optional: PrebookingRef1"
}

Example payload of Pre-Advice rejection:

{
    "reference": "As provided in the request",
    "state": "rejected",
    "comments": "Do not have a available space for that lane. Maximum 5LM available."
}

Fields:

• reference: As provided in the request
• state: “accepted” or “rejected”
• carrierAssignedReference: optional value, if carrier has a reference for the Pre-Advice it will be included here. Can only be populated if state is “accepted”.
• comments: optional value, carrier can leave comments on why Pre-Advice was confirmed or rejected.