Finding Your Carrier ID and Carrier Service IDs

Overview Some MachShip API operations require Carrier IDs and Carrier Service IDs. This guide explains how to locate these values using either the MachShip User Interface (UI) or the API.

To retrieve these values via the API, you’ll also need your Company ID (see: Finding Your Company ID).

In The MachShip UI You can find Carrier and Carrier Service IDs directly from the URL in the MachShip interface.

  1. Login to MachShip.
  2. Impersonate the relevant company.
  3. Navigate to Admin > Company Carrier Accounts.
  4. Enter or select the company linked to the account. The grid will refresh to show the available services.

Finding the Carrier ID:

  • Click the carrier name in the Carrier column.
  • Example URL: https://admin.machship.com/#/admin/carriers/view/576
  • Here, 576 is the Carrier ID.

Finding the Carrier Service ID:

  • Click the carrier account name in the Carrier Account column.
  • Example URL: https://admin.machship.com/#/admin/carriers/accounts/view/29946
  • This page will list the services linked to the account.

Via The API Use the following endpoint, passing in your Company ID as a parameter:

GET https://live.machship.com/apiv2/companies/getAvailableCarriersAccountsAndServices

Example Response

{
  "object": [
    {
      "carrierAccounts": [
        {
          "companyCarrierAccountId": 216804,
          "companyCarrierAccountCompanyId": 48337,
          "companyCarrierAccountDisabled": false,
          "carrierServices": [
            {
              "id": 9001,
              "name": "Parcel",
              "abbreviation": "PAR",
              "displayName": "Parcel (PAR)"
            }
          ],
          "id": 29942,
          "name": "Dy-Mark_B-Link VIC PAR",
          "accountCode": "35301_DMV",
          "carrierId": 576,
          "displayName": "Dy-Mark_B-Link VIC PAR (35301_DMV)"
        },
        {
          "companyCarrierAccountId": 216905,
          "companyCarrierAccountCompanyId": 48337,
          "companyCarrierAccountDisabled": false,
          "carrierServices": [
            {
              "id": 13725,
              "name": "PALLET",
              "abbreviation": "PAL",
              "displayName": "PALLET (PAL)"
            }
          ],
          "id": 29946,
          "name": "Dy-Mark_B-Link VIC PAL",
          "accountCode": "35302_DMV",
          "carrierId": 576,
          "displayName": "Dy-Mark_B-Link VIC PAL (35302_DMV)"
        }
      ],
      "id": 576,
      "name": "Direct Freight Express",
      "abbreviation": "DFE",
      "displayName": "Direct Freight Express (DFE)"
    }
  ],
  "errors": null
}

How to Identify Carrier IDs

  • The top-level id represents the Carrier ID.
  • In the example above, "id": 576 → Direct Freight Express’s Carrier ID is 576.

How to Identify Carrier Service IDs

  • Each service listed under carrierServices has its own id.
  • In the example:
    • Parcel (PAR) → Carrier Service ID 9001
    • PALLET (PAL) → Carrier Service ID 13725