Claimlane connects to MachShip with one API token linked to a MachShip user. In most cases you only need to send Claimlane two things: the API token and, if you have more than one company in MachShip, the company ID. Everything else is set on your Claimlane shipping agreement.
Step 1: Create the API user and token
MachShip's guide Creating API users and tokens includes a short video that walks you through this. In summary:
In MachShip, go to Admin > Create User. We suggest the username
claimlane-api. Select the parent company so the token can access every child company.Set the role to Despatch. This lets the user create consignments without access to settings.
For the first token, set Test Mode to User is in test mode. Consignments from this user are never billed or sent to carriers, so the integration can be tested safely.
Save. Then open the user under View Users, scroll to API Tokens and click Create API Token. Copy the token straight away, as it is only shown once.
Before go-live, either switch the same user to Disabled from seeing test consignments, or create a second production user and send Claimlane its token.
Note: The token inherits the user's role, company access and test mode. A token created for a child company cannot ship for a sibling company.
Step 2: Find your company ID (only if you have several companies)
Go to Admin > View Companies. Open the company the consignments should belong to, click the cog icon and choose Edit Company. The number at the end of the URL is the company ID.
If the API user already belongs to the correct company, you can skip this step. See also MachShip's guide Finding your company IDs.
Step 3: Decide how the carrier is chosen
Each Claimlane shipping agreement uses one of two modes. Return labels and outbound labels are separate agreements, so they can use different modes.
Option A: Cheapest service
MachShip compares every carrier account linked to your company and books the cheapest service for each parcel and route. Nothing needs to be configured in MachShip. For return labels, the consumer is offered the nearest drop-off depot across all carriers.
Choose this option if it doesn't matter which carrier moves the parcel.
Option B: Your own carrier service
The agreement is locked to one carrier and one service, for example Australia Post Parcel Post for returns and StarTrack Express for replacements. For return labels, the consumer is offered the nearest depot of that carrier only.
Choose this option if you have a preferred carrier account or negotiated rates. To set it up:
In MachShip, go to Admin > Company Carrier Accounts and select the company.
Click the carrier name. The number in the URL is the carrier ID.
Click the carrier account name to see its services. Each service shows its service ID.
Send Claimlane the carrier ID and service ID for each agreement, for example carrier
576with service9001.
See also MachShip's guide Finding carrier and service IDs.
Step 4: Make sure returns are enabled in MachShip
Return labels work differently from outbound labels. Claimlane asks MachShip for drop-off depots near the consumer and books the parcel from the nearest one, so the consumer only has to hand it in. This requires two settings that only you or MachShip support can confirm:
The returns drop-off feature is enabled on your MachShip organisation. Without it, return labels cannot be created. If you are unsure, ask MachShip support or your MachShip account manager.
The carrier accounts you want to use for returns, such as Australia Post and StarTrack, have returns enabled, so that depots are returned when Claimlane requests them.
If you would prefer a courier to collect parcels from the consumer's home instead of a depot drop-off, let Claimlane know, as this requires a different setup.
Step 5: Add the details in Claimlane
Enter the following on your Claimlane shipping agreement:
Claimlane field | Value |
Client secret | The API token |
Client ID | The company ID, or leave empty |
Shipping identifier | Option B only: |
Use cheapest rate | Ticked for option A, unticked for option B |
Shipping type | Inbound for return labels, Outbound for replacement labels |
Base URL, Customer identifier, Customs data | Leave empty. These are not used by MachShip. |
Good to know
Return labels are announced to the carrier as soon as Claimlane creates them, so the consumer can drop off the parcel straight away.
Outbound labels are created but not announced. Your warehouse includes them in its normal daily manifest and pickup, just as it does today.
Dangerous goods are not declared by the integration. Products that need a dangerous goods declaration must be booked manually in MachShip.
Claimlane builds the integration at no charge. The MachShip account and its monthly fee are your own.