Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

Aramex from ShipStation

Aramex from ShipStation offers domestic services in certain metropolitan and regional locations across Australia.

This guide provides developers with the details needed to build Aramex from ShipStation shipping capabilities into your ShipStation API workflows.

ShipStation API also allows you to connect your own existing Aramex Australia account and the requirements and service details are different than those for Aramex from ShipStation. For details about connecting and using your own Aramex AU account with ShipStation API, see our Aramex Australia Guide.

Requirements

carrier_name: aramex_au_walleted

  • A ShipStation API account based in Australia.
  • ShipStation Carriers must be activated for the account and have a positive account balance to create labels. See our Using ShipStation Carriers page for details about activating in your account.

Rates

Aramex from ShipStation supports rate shopping with ShipStation API.

Service Details

Available Aramex from ShipStation services are provided below. Please note that carriers may update their available services at any time. To ensure you are always using valid services, you can use the list carrier services endpoint at any time.

Domestic Services

ServiceAPI Code
Standardaramex_au_walleted_standard
Leave at Dooraramex_au_walleted_leave_at_door
Signature Requiredaramex_au_walleted_signature_required
Priorityfastway_au_walleted_priority

Return Services

Aramex from ShipStation supports creating return labels for all domestic services.

Review the Return Shipping Labels page for details on creating return labels with ShipStation API.

Packages

The following carrier package types are available for Aramex from ShipStation services:

NameAPI Code
Packagearamex_au_walleted_package
Satchel-A2 (42.0 x 59.4cm, Max Weight 5kg)aramex_au_walleted_satchel_a2
Satchel-A3 (29.7 x 42.0cm, Max Weight 3kg)aramex_au_walleted_satchel_a3
Satchel-A4 (21.0 x 29.7cm, Max Weight 1kg)aramex_au_walleted_satchel_a4
Satchel-A5 (14.8 x 21.0cm, Max Weight 500g)aramex_au_walleted_satchel_a5

Adding Shipment Insurance

Aramex from ShipStation does not support adding carrier insurance to shipments created with ShipStation API.

Label Support

  • Label sizes: 4" x 6"
  • Label formats: PDF

Label Reference Fields

Aramex from ShipStation supports adding custom label messages.

  • Label message 1 supported only.

Multi-Package Labels

Aramex from ShipStation supports creating multi-package shipments for details about creating multi-package labels.

Label Branding

Aramex from ShipStation does not support label branding.

Voiding Labels

Aramex from ShipStation supports voiding labels with ShipStation API.

Paperless Labels

Aramex from ShipStation does not support paperless labels.

Delivery Confirmation

Confirmation TypeAPI CodeDescription
Authority to leavenoneNo confirmation required for delivery.
Standard deliverydeliveryDelivery confirmation is requested.
Signature deliverysignatureSignature is required for the shipment to be delivered. This signature may be a neighbor, building manager, or the recipient can authorize the release of the package (without being present).

See our Delivery Confirmation page for more details about using the confirmation property.

Advanced Options

Aramex from ShipStation does not currently support any advanced options.

To ensure you always have the most up-to-date information about a carrier's advanced options, use the list carrier options call.

Manifests

Aramex from ShipStation does not require manifesting your shipments.

Scheduling Pickups

Aramex from ShipStation supports scheduling pickups for shipments originating in the following cities only:

  • Brisbane
  • Melbourne
  • Sydney
  • Canberra
  • Adelaide
  • Geelong
  • Gold Coast
  • Sunshine Coast
  • Wollongong
  • Newcastle

Service Points (PUDO)

Aramex from ShipStation does not support shipping to service points.

Tracking

Aramex from ShipStation supports receiving tracking updates. Review our ​Track a Package guides​​ for details on tracking with the ShipStation API.