Shipment Creating

The Shipment Creation function is triggered whenever a new shipment or a return shipment is created. The following app function allows the shipping company to call its API to generate the AWB label, return the tracking link, and provide tracking information. The returned data is then used to update the shipment details inside Salla.

Step By Step Guide

On Salla Partners Portal, click on "+ Add New Function"

Select the App Function you want to add, which is in this case the Shipment Cancelled Function. After selecting, add a name to the function.

Code Details

Salla auto-generates starter code, which you can overwrite with the following implementation. This gives a clear place to plug in your shipping logic and connect Salla with the shipping company’s API.

This flow handles both shipments and return shipments. Shipments use the payload type "shipment", while returns follow the same process with the payload type "return".

Explanation

Full Code

Function definition

This function is autogenerated by Salla. It runs when Salla triggers Shipment Creation, receives the context data, and must return a Shipment object.

Shipment Company API call

Declares the supported shipment types: a forward shipment or a return shipment. This makes it easier to branch logic later.

Build and return final Shipment object

This part is autogenerated by Salla. It builds the final response using Salla’s Shipment builder. All fields are taken from the updated shipmentResponse object and returned to Salla.

Sequence Diagram

The following diagram shows visually how the shipment creating app function works within Salla Partners Portal:

Step By Step Guide#

Code Details#

Sequence Diagram#

Step By Step Guide

Code Details

Sequence Diagram