Add a delivery provider

Add the company that carries your parcels, with a tracking link built from {trackingNumber} so customers can follow their order.

Last updated

Add the delivery company that carries your parcels, such as the one you use in Amman. Give it a tracking link with {trackingNumber} in it, and every shipment you create with that provider gets its own link that your customer can follow.

Delivery providers are on every plan. To add or change them, your role needs the Manage shipping rates and delivery providers permission, which the Store owner and Store manager roles have. Sales staff can open the page and read your providers, which they need to ship orders, but a provider they try to add or change is refused, and nothing is saved. They see You do not have permission to do this. See Staff roles: what each one can see and do.

What providers are for: rates and shipments

A delivery provider is used in two places:

  • Shipping rates. A rate can name the provider that delivers it. Checkout then shows the provider's name under the option, such as 1–2 days · Rawabi Express. See Add shipping rates and free shipping.
  • Shipments. Every shipment you create on an order needs an active provider. Without one, the order's Fulfilment tab says Add an active delivery provider before creating shipments. See Ship an order with a tracking number.

Customers see the provider's name, at checkout, on their order page and in the email that says their order has shipped. They never see the provider's phone, email or notes: those are for your team.

Adding at least one active provider is also a setup task on your Dashboard, Add a delivery provider. A store that has never published cannot open the Storefront Studio until it is done. See The setup list before your first publish.

Add a provider

Adding Barq Express: its name, its tracking link with {trackingNumber}, a contact phone and email, and its pickup times
  1. In the sidebar, under Operations, open Delivery providers.
Before your first provider the page is empty. Both Add provider buttons open the same form.
  1. Select Add provider at the top right of the page.
The form opens with Active ticked. Only Name is required.
  1. In Name, type the provider's name as your customers know it, for example Barq Express.
  2. In Tracking URL template, type the provider's tracking link with {trackingNumber} where the number goes. See The tracking link and {trackingNumber}.
  3. In Contact phone, type the provider's number. Choose its country first if it is not Jordan.
  4. In Contact email, type the provider's email address.
  5. In Notes, write anything your team needs, such as pickup times.
  6. To make this your default provider, tick Use as the default delivery provider.
  7. Select Save.
A complete provider. The green preview shows the link a shipment will get.

The form closes, Delivery provider added. appears at the bottom of the screen, and the provider's card joins the page.

FieldRequiredWhat it is
NameYesThe name customers see at checkout and on their order, up to 100 characters. Each provider in your store needs its own name.
Tracking URL templateNoThe provider's tracking link, with {trackingNumber} where the number goes. Empty means shipments with this provider get no tracking link.
Contact phoneNoA number for your team to call. The card shows it as a link you can tap to call.
Contact emailNoAn address for your team to write to. The card shows it as a link.
NotesNoAnything your team should know, up to 1,000 characters: pickup times, cash-on-delivery handover, who to ask for.
ActiveTicked at the startUnticked, the provider is saved but cannot be used for new shipments, and its rates leave checkout.
Use as the default delivery providerNoMakes this the provider a new shipment starts with when the customer's shipping rate names no provider. Only one provider is the default; ticking it here moves the default from the one you had. It only works on an active provider. See Set the default delivery provider.

The contact phone and its country

The phone box starts on Jordan, +962. Type the number the way you would dial it in Jordan, such as 0795550142, or without its first 0. The 0 drops away as you type, because the +962 in front takes its place, and the box reads 795550142. It is saved as +962795550142, and the provider's card shows it as +962 79 555 0142.

  • A pasted number with its code, such as +962 79 555 0142 or 00962 79 555 0142, is saved once, never with the code twice. If the code is another country's, the flag switches to that country by itself.
  • A number typed with its code but no + or 00, such as 962795550142, is saved once as +962795550142.
  • A number from another country: select the flag first. The menu lists Jordan, the Gulf countries, Egypt and Palestine first, and Search countries finds any other by its name, its 2-letter code or its dialling code.
Choose the phone's country first. The search finds any country.

Every provider's website has a page that shows where one parcel is. Its address holds that parcel's tracking number, for example https://barqexpress.example/track/BRQ4821907. The tracking URL template is that address with the number replaced by {trackingNumber}:

https://barqexpress.example/track/{trackingNumber}

When you create a shipment with this provider and leave its Tracking URL empty, we put the shipment's tracking number in place of {trackingNumber} and save the link with the shipment. Your customer finds it on their order page, and in the shipped email as a button to track the parcel.

Some providers put the number at the end of the path, others after a question mark. Both work, as long as {trackingNumber} sits where the number goes:

ProviderTracking URL template
Rawabi Expresshttps://rawabiexpress.example/track/{trackingNumber}
Nujoom Cargohttps://nujoomcargo.example/tracking?awb={trackingNumber}
Sahm Deliveryhttps://sahm.example/t/{trackingNumber}

Type {trackingNumber} exactly like that: curly brackets, a capital N, no spaces.

Tip

To find your provider's template, track any parcel of theirs on their website. Copy the address from your browser, then replace the tracking number in it with {trackingNumber}.

The link is built when the shipment is created. If you change a provider's template later, shipments you have already created keep the link they got.

Let the form add {trackingNumber} for you, and the preview

The line under Tracking URL template follows what you type:

What you seeWhen
We build each shipment’s tracking link from it. Include {trackingNumber}.The field is empty.
Tip: include {trackingNumber} where the tracking number should go., in orangeYou typed a link without {trackingNumber}.
Preview: and a sample link, in greenThe link has {trackingNumber}. The preview puts TRK123456789 in its place, so you can check where the number lands.

Insert {trackingNumber}, above the field on the right, adds the placeholder for you:

  • With a link in the field, it adds /{trackingNumber} at the end. https://barqexpress.example/track becomes https://barqexpress.example/track/{trackingNumber}.
  • With the field empty, it writes https://{trackingNumber}, for you to complete.
  • Once the link has {trackingNumber}, the button is greyed out.
No placeholder yet: the orange tip asks for one, and Insert {trackingNumber} adds it.

The button always adds the placeholder at the end, after a slash. For a provider whose number goes after a question mark, like Nujoom Cargo's ?awb=, type {trackingNumber} yourself, then check the preview.

Saving a link without {trackingNumber}

A link without {trackingNumber} would send every customer to the same page, whatever their parcel. So the form does not save it: when you select Save, the field turns red and Add {trackingNumber} so we can build tracking links. appears under it.

A tracking link must have {trackingNumber}. Add it, or clear the field.

Either add {trackingNumber}, or clear the field to save the provider without a tracking link. A provider without one is allowed: its card warns No tracking URL — shipments will not get tracking links., and its shipments carry the tracking number only. You can still paste a link into a single shipment's Tracking URL. To add the template later, see A provider with no tracking link.

What the form flags

The form stays open on a refusal and keeps what you typed. The field turns red with the reason under it, and Fill in every required field. appears at the bottom of the screen.

Three refusals at once: no name, a link without https://, and an email without its ending.
MessageWhyWhat to do
Enter a provider name.Name is empty.Type a name.
Enter a full URL starting with http:// or https://.The tracking link does not start with http:// or https://.Add https:// at the start.
Add {trackingNumber} so we can build tracking links.The tracking link has no {trackingNumber}.Add it, or clear the field. See Saving a link without {trackingNumber}.
Enter a valid email address.The email is not a full address, such as ops@barqexpress with no ending.Type the whole address, such as ops@barqexpress.example.
Enter a valid phone number.The number is only a digit or two long, after a one-digit country code such as +1.Type the whole number. The form does not check the number further, so read it back before you save.

Two refusals come as a message at the bottom of the screen after you select Save:

  • A delivery provider with this name already exists. Another provider in your store has this name. Choose a different one, or edit the provider you have.
  • Tracking URL template must produce an http or https URL. The link is not a web address even with a number in it, for example because the site's name, such as barqexpress.example, has a space in it. Copy it again from the provider's website.

If Our server could not complete the request. Try again. appears, the name is probably longer than 100 characters or the notes longer than 1,000. The form stays open: shorten them and select Save again. If the connection drops, Could not reach the server. Check your connection and try again. appears; save again once you are back online.

Next, choose your default provider and manage the ones you have, or use your provider in a shipping rate.