Aramex NZ Onboarding Requirements and Configuration Guides [Information]

Modified on Mon, 14 Sep at 7:22 AM

Article 1: Aramex NZ Onboarding Requirements and Configuration Guides [Information]Article 2: Reference Data: Aramex NZ Baseline Account Fields [Guide]Article 3: Reference Data: Aramex NZ Client (Billing) Account Fields [Guide]Article 4: Reference Data: Order-Level Aramex NZ Fields [Guide]
Onboarding and ConfigurationBaseline Account(Billing) AccountOrder-Level Fields
You are hereYou are here         

   

This article is the central hub for adding Aramex NZ with techSHIP. It summarizes onboarding requirements, links the related configuration guides, and lists confirmed carrier-specific constraints.

   

   
   

  

To review all supported carriers and their specific requirements, see: techSHIP supported Carriers - Master List [Guides List].

   

   

   

TABLE OF CONTENTS


Onboarding Requirements


Before configuring Aramex NZ in techSHIP, gather the required Aramex Connect credentials and verify the required account settings.


Information to be Provided


The following credentials and account information are mandatory to establish the carrier connection. Ensure you have these items available before starting the setup:

     

DATA ELEMENTSOURCE (HOW TO OBTAIN)
Client IDObtain the Client ID for the authorized Aramex Connect account.
Client secretObtain the Client secret for the authorized Aramex Connect account.
API region
Confirm whether the authorized Aramex Connect account is provisioned for Australia or New Zealand.

   

Settings to be Verified


The following account configurations must be validated to prevent errors during the connection setup or shipping process:

   

FEATURE/SETTINGVALIDATION ACTION
API regionVerify that the configured API region matches the region authorized for the Aramex Connect account.
UsageFor Australia, verify that the selected usage matches the authorized environment. New Zealand does not support Test usage for this integration.
Label configurationVerify that shipment labels use PDF with supported stock size 4x6 or A4.

   



For New Zealand accounts, use Production. Test usage is supported only for Australia.

 
   

   

Setup Articles


Use the setup articles below to complete the setup in order. Start with onboarding requirements, then configure the Baseline Account, Client (Billing) Account, and, when required, Order-Level Fields. Select an article number to open the corresponding guide:

   

   Article 1: Aramex NZ Onboarding Requirements and Configuration Guides [Information]Article 2: Reference Data: Aramex NZ Baseline Account Fields [Guide]Article 3: Reference Data: Aramex NZ Client (Billing) Account Fields [Guide]Article 4: Reference Data: Order-Level Aramex NZ Fields [Guide]
COMPONENT
ONBOARDING REQUIREMENTS
BASELINE ACCOUNT
(BILLING) ACCOUNT 
ORDER-LEVEL FIELDS
Mandatory
Mandatory
Mandatory
Mandatory
   
Scope
Requirements
Carrier
Client
Transaction
Description
Identifies the required onboarding information and organizes the related setup guides for this carrier.
Establishes the carrier connection. Must be created first.
Connects a specific client to the Baseline. At least one is required to ship.
Defines order-level fields and settings used when processing shipments for this carrier.

    

Carrier Specifications and Constraints


This section outlines confirmed operational behaviors, label support, and limitations specific to this carrier.


Labels


The following table summarizes confirmed label and reference support:

    

ITEMSUPPORTED
LabelPDF with 4x6 or A4 stock.
ReferencesReference 1 and Reference 2.

   

The table below specifies the confirmed limits for carrier references:

   

CONSTRAINT TYPELIMIT/REQUIREMENTNOTES
Reference 1100 charactersExpanded from the configured Reference 1 template.
Reference 2100 charactersExpanded from the configured Reference 2 template.

   


   

  

For a comprehensive guide on how to use label references, see: Using order References in your labels [Step-by-Step guide].

   

   

   

Operational Details


This section lists confirmed operational rules and limitations for this carrier:

  • Aramex NZ is configured as a Small Parcel carrier and supports domestic shipping for the configured Australia or New Zealand network.
  • Standard Service is the supported service and resolves to DELOPT.
  • Supported package mappings include parcel P and satchels A2, A3, A4, A5, and DL. The DL satchel is available only for New Zealand.
  • Leave at door and Signature required cannot be combined when processing a shipment. Use only one delivery option.


Next Steps


After reviewing the onboarding requirements, continue with the Reference Data: Aramex NZ Baseline Account Fields [Guide] article to configure the carrier connection in techSHIP.

   

   Go to Go to       
Article 1: Aramex NZ Onboarding Requirements and Configuration Guides [Information]Article 2: Reference Data: Aramex NZ Baseline Account Fields [Guide]Article 3: Reference Data: Aramex NZ Client (Billing) Account Fields [Guide]Article 4: Reference Data: Order-Level Aramex NZ Fields [Guide]
Onboarding and ConfigurationBaseline Account(Billing) AccountOrder-Level Fields

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article