Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Shipping Management
  • Publish App
  • Change Log
  • Getting Started
  • Migration to the New API
  • Shipping Management
    • Create App
    • App Cycle
    • Setup App
    • Test App
  • Order Fulfilment
    • Create App
    • App Cycle
    • Setup App
    • Test App
  • Shipments
    • Create Shipment
      POST
    • List Shipments
      GET
    • Update Shipment Details
      PUT
    • Shipment Details
      GET
    • Cancel Shipments
      POST
    • Return Shipments
      POST
    • Shipment Tracking
      GET
  • Shipping Companies
    • List Shipping Companies
      GET
    • Shipping Company Details
      GET
  1. Shipping Management

Setup App

After successfully creating a Shipping App it is now ready to have a few tweaks to become a fully functioning Shipping App and is able to be published in the Salla Apps Store.

📙 What you'll learn:#

In this article we will walk you through the steps of setting up the App for shipping service providers.
Setup the Shipping App

Setup the Shipping App#

The Shipping App settings done through the App details page. To get there, click on My Apps menu item on the left side of Partners Portal main page.
image
The App Details page is where the developer can manage the App's Scopes, Webhooks/Notifications and Shipping Setting.
image
Alert
We highly recommend selecting the Easy mode option when setting up the authorization mode for your shipping app, as it is not only easier to use, but also offers more features compared to the custom mode. By choosing the Easy mode, you can ensure optimal functionality and take advantage of the additional upcoming features and benefits.

App Scope#

App scope section allows the developer to determine the information needed by the App from the store in order to function correctly, by identifying and restricting accessibility to certain features and services.
The developer can simply enable or disable accessibility by clicking on the option to Read Only or Read and Write.
image
After assigning the scopes, click on Update the scopes to save the changes. Continue reading to set up Webhooks of the App.

Webhooks/Notifications#

Webhooks are used to exchange messages between Apps and the Salla store whereby they are also used to notify developers about store events.

Store Events#

For shipping Apps, the developer may need to know when an order shipment is created. This is
done using events, the developer can easily listen to those events that happen in the store on using Store Events. For instance, Shipping Apps can receive events such as Order Shipment Created.
The events are filtered based on the developer preference for the specific App.
The developer can edit store events by clicking on Added Events
image
The developer can enable and disable the relevant events then click on Save to save the changes.
image
All of the App Webhook events can be monitored using the Webhook events log.
A thing to know!
As best practices the developer should enable bothShipment CreatingandShipment Cancelledfor Salla Shipping Apps to enable minimal basic events.
By reaching here, the developer have finished setting up the Store Events in the Webhook Notifications section. Next is Shipping Settings.

Shipping Settings#

Shipping settings are what appear to the store customers when they finish placing their orders in the store and proceed the check out, a summary of the order will be displayed along with shipping details. The shipping details will be explained here.
1
First Step
On the App details page, scroll down to the Shipping Settings section and click on View Rates to display the rates.
image
2
Second Step
Then click on Add a New Rate to start adding rates of the Shipping by completing the form.
image
Form details are explained in the following table.
ItemDescription
CountryThe country that the Shipping App offers its services in.
CityThe city in the country the Shipping App offers its services.
Excluded Cities(Optional)The cities excluded from the rate being set.
Rate TypeThe developer can choose either Fixed or Rate.
CostCost of the shipping for fixed Rate Type.
Delivery DurationThe time required to deliver the parcel.
Cash on DeliveryThe developer can enable this option to offer COD payment type.

Examples#

Next we will be listing in detail two different examples where developers can gain real-world scenario experience while building and developing Shipping Rates for their Shipping Apps.
Example 1
Example 2
Following is an example of a completed form for a rate offered to Saudi Arabia Country, in two Cities; Riyadh and Jeddah, Fixed Rate Type, Cost of 50 SAR, Delivery Duration of 7 days, and option of Cash on Delivery enabled with zero fees.
image
The developer also has the option to add a rate for a country and exclude a few cities, like shown below.
This option will exclude the city Almuzaylif from the rate being set.
image
Click on Add after filling in the Rate details to save the rates. A notification will be displayed to confirm saving change and the newly added rate will be displayed.
image
Moreover, you can add shipping policy options straight from the Partners Portal by selecting from the drop down menu list
image
3
Third Step
Finally, customize the shipment features with what accomplies with your shipping service
image
Kudos!!🎉
Reaching here, the developer has successfully set up the Shipping App using Salla Partners Portal.
The App is now ready to go through Testing process.
Modified at 2025-03-06 07:31:57
Previous
App Cycle
Next
Test App