Overview
- Integrate your Aramex account using the legacy FastLabel API, or the new aramexConnect API.
- If you are unsure which API you have set up, please check with your Aramex account manager.
Set up aramexConnect
1. Before you begin
If you are setting up aramexConnect, you need to generate an API Key, Client ID and Secret. To do this:
- Log in to aramexConnect .
- Go to Administration> API Keys > Create Key.
- Click Save.
- Copy your Client IDand Secret.
2. Set up aramexConnect
Once you have your API Key, Client ID and Secret, you can set up aramexConnect in Starshipit.
- In you Starshipit account, select the Settings tabs, then select Couriers.
- Click Add New Courier, then select Aramex.
- Select Use aramexConnect .
- Enter the Client ID and Client Secret copied from Aramex.
- Click Save.
3. Add the product codes
You need to add your product codes to complete the integration. The available product codes are:
- Package/Parcel = P
- Satchel A2 = A2
- Satchel A3 = A3
- Satchel A4 = A4
- Satchel A5 = A5
- DL (only available in New Zealand) = DL
Troubleshooting
"Area Off Limit" error
You might be getting an "Area Off Limit" error because your account does not have the correct user privileges activated.
To resolve this, send an email to [email protected] (Australia) or it.support@aramex.co.nz (New Zealand) and request access to your account. Once you receive a reply from Aramex, go back to the integration page and click Lookup.