In order to create a Carrier Account with NZ Couriers in the system, you will need to obtain an API key. You can obtain the API keys by requesting them from your account manager in NZ Couriers.
Your email should be as follows:
Hi NZ Couriers Team,
I need to set up my account <insert account code> with NZ Couriers so that I may consign with my new FMS partner MachShip. Can you please advise what my client ID and secret should be?
Once the API keys are provided, you can then create the carrier account and fill out the following specific options:
Account Number - The account number would have been provided to you when your account was set up.
Client ID and Client Secret - API keys provided by the carrier
Consignment Prefix - this can be any 3-letter prefix you desire
Reference Pools - Reference pools are utilised by MachShip to maintain a count on connotes, manifests and item numbers. The reference pool will ensure that each of those numbers is unique from what we have sent to the carrier previously. More information can be obtained on reference pools here. NZ Couriers requires the creation of just 1 reference pool for the Connote number.
To create the reference pool, select the Create Carrier Reference Pool button at the bottom of the page.
If you are creating a new account, then the Reference Pools will be set to the following fields:
Pool Name - Set as NZ Couriers Connote Ref Pool <Account Code>
Minimum Value - 1
Maximum Value - 999999 (that is six 9's)
Next Value - 1
Cyclical - No
It will appear as below:
Once created, it will appear in the drop-down as below:
Ratecard:
Unlike other carriers, MachShip hits the NZ Couriers API in order to obtain pricing. As such, there is no need to upload your individual rate card; all you will need to do is upload the ratecard in the format below:
Notes:
- Set your Account Code in the Account(Ratecard) section/column.
- Add the services provided to you by the NZ Couriers team
| Carrier |
Ratecard |
Service |
From Zone |
To Zone |
Reciprocal |
Cubic Conversion |
Basic |
Minimum |
Break Type |
Item Type |
Break From |
Break To |
Price |
| NZ_COURIERS |
|
OVERNIGHT |
|
|
N |
200 |
0 |
0 |
WEIGHT |
|
0 |
|
0 |
| NZ_COURIERS |
|
RETURN |
|
|
N |
200 |
0 |
0 |
WEIGHT |
|
0 |
|
0 |
| NZ_COURIERS |
|
TWO DAY |
|
|
N |
200 |
0 |
0 |
WEIGHT |
|
0 |
|
0 |
Please note you can add in extra services as required.
Once this is completed, you will be able to create quotes, consignments, and generate jobs with NZ Couriers.