Business API

Integrate with our aramexConnect API to meet all your shipping needs

Get started

  1. The first step is to create an account or login to your existing aramexConnect.com.au account.
  2. Navigate to Administration > API Keys > Create Key.
  3. The Client ID and Secret will be shown on the screen and the customer should give them to their developers along with the link to our technical documentation
    https://github.com/mindfulsoftware/aramexConnect.ApiClient/wiki

Creating a consignment

  1. Authenticate (retrieve an access token using the OAuth2 method)
    https://github.com/mindfulsoftware/aramexConnect.ApiClient/wiki/Principles꞉-Authentication
  2. Get a Quote (it’s not mandatory but is useful)
    https://github.com/mindfulsoftware/aramexConnect.ApiClient/wiki/Endpoints꞉-Consignments#quote
  3. Create a consignment
    https://github.com/mindfulsoftware/aramexConnect.ApiClient/wiki/Endpoints꞉-Consignments#consign
    in this call you can use the JSON presented in this section:
    https://github.com/mindfulsoftware/aramexConnect.ApiClient/wiki/Endpoints꞉-Consignments#request-objects
  4. Download PDF Labels
    https://github.com/mindfulsoftware/aramexConnect.ApiClient/wiki/Endpoints꞉-Consignments#labels

 

 

 

© Aramex (Australia)