Salla Docs
Setup App
After successfully creating a Shipping App the App is ready to have few tweaks to become a fully functioning Shipping App to be used in Salla platform.
📙 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
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.
The App Details page is where the developer can manage the App's Scopes, Webhooks/Notifications and Shipping Setting.
:::caution[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.
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
The developer can enable and disable the relevant events then click on Save to save the changes.
All of the App Webhook events can be monitored using the Webhook events log.
:::info [A thing to know!]
As best practices the developer should enable both Shipment Creating and Shipment Cancelled for 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.
On the App details page, scroll down to the Shipping Settings section and click on View Rates to display the rates.
Then click on Add a New Rate to start adding rates of the Shipping by completing the form.
Form details are explained in the following table.
| Item | Description |
|---|---|
| Country | The country that the Shipping App offers its services in. |
| City | The city in the country the Shipping App offers its services. |
| Excluded Cities(Optional) | The cities excluded from the rate being set. |
| Rate Type | The developer can choose either Fixed or Rate. |
| Cost | Cost of the shipping for fixed Rate Type. |
| Delivery Duration | The time required to deliver the parcel. |
| Cash on Delivery | The 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.
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.
Another example of a completed Rate form with Rate Type of Rate.
The shipping rate is for the Country Saudi Arabia with Dammam, and Al Khobar Cities, Rate type of Rate where the initial cost is 10 SAR for the first 1 kg and an additional cost of 5 SAR for each 1 kg. At this rate, Cash on Delivery is not enabled and the delivery duration is 4 days.
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.
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.
Moreover, you can add shippong policy options straight from the Partners Portal by selecting from the drop down menu list
Finally, customize the shipment features with what accomplies with your shipping service
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.