Shipment AWB

This guide walks you through how to test your Shipping App end-to-end and verify that it correctly generates the Shipment AWB label inside a Salla store.

What you'll learn:

In this article, you will learn how to test your Shipping App using a demo store and confirm that the App works behave as expected.

How to Test your Shipping App

App testing is important in order to discover defects/bugs before publishing, this guarantees that the App functions perfectly. Salla offers demo stores where developers can test their Apps.

Testing the Shipping App on demo stores provides a safe and controlled environment to evaluate App functionality and performance, helping the developer verify App behavior before publishing it.

App Testing Scenarios

In this testing scenario we will illustrate the merchant generating a shipping policy.

Open Orders in the Merchant dashboard

From the Merchant dashboard, hover over Orders in the sidebar, then click All Orders to open the list of orders.

Create a new order using your Shipping App

Click Create new order. Fill in the customer, products, and any other required order details.
In the Shipping / Courier section, choose your Shipping App as the AWB shipping app so that Salla will use it to generate the label.

Note

You can verify that your app is registered as one of Salla's AWB couriers from the Merchant dashboard under
Shipping page → Couriers.

Generate the shipping label for the order

After the order is created, return to All Orders, select the order you just created, then click Create shipping label from the available actions. Moreover, the generating of the shipping lable can also be triggered when the Order Status is changed to completed | تم التنفيذ

Fill shipping label details and apply

In the shipping label form, fill in all required shipment package details, then click Apply action.

Call to App Functions (Shipment Creation)

When you apply the action, Salla will make a call to the App Functions (Shipment Creation) you created. Find out more details as explained in the Shipment Creating article here.

Shipping App generates and returns AWB data

After receiving the call to App Functions, the Shipping App must call the shipping company's API to generate the shipment AWBs.
That API will respond with the relevant shipping details, such as :

PDF label

Tracking link

Tracking number

Your App Function then maps these values into Salla’s Shipment response, which will update the shipment details directly to Salla.

Response from App Functions

Success

Error

Once successful, you will be able to see a message on the screen indicating that the shipment is created.

Showcase Details

You may manually refresh the page and you will be able to see the shipping details, such as tracking number.

What you'll learn:#

How to Test your Shipping App#

App Testing Scenarios#

What you'll learn:

How to Test your Shipping App

App Testing Scenarios