Add a Customer to a Tracking Request

This guide covers the customer role. For shipper, consignee, freight forwarder, notify party, customs broker, and dray carrier, see Assign Shipper, Consignee, and Other Parties.

Why add a party to a tracking request?

Adding a party to a tracking request associates customer information with the request. The customer is assigned to the shipment when it is created, just like reference numbers and tags. This helps you organize and manage your shipments more effectively.

How to get the party ID

You can either find an existing party or create a new one.

To find an existing party, jump to Listing all parties section.
To create a new party, jump to Adding party for a customer section.

List all parties

You can list all parties associated with your account through the API. Endpoint: GET - https://api.terminal49.com/v2/parties

Response

{
  "data": [
    {
      "id": "PARTY_ID_1",
      "type": "party",
      "attributes": {
        "company_name": "COMPANY NAME 1",
      }
    },
    {
      "id": "PARTY_ID_2",
      "type": "party",
      "attributes": {
        "company_name": "COMPANY NAME 2",
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 2,
    "total": 2
  }
}

After you get all the parties you would filter the parties by company_name to find the correct ID, either by looking through the list manually or using code to automate the process.

Add a party to a tracking request

To add a customer to a tracking request, include the party as a customer relationship when creating the request. Shipper, consignee, and the other roles are passed the same way, as relationships named after the role. To change roles on an existing shipment, use party roles. Endpoint: POST - https://api.terminal49.com/v2/tracking_requests

Request

{
  "data": {
    "type": "tracking_request",
    "attributes": {
      "request_type": "bill_of_lading",
      "request_number": "MEDUFR030802",
      "ref_numbers": [
        "PO12345",
        "HBL12345",
        "CUSREF1234"
      ],
      "shipment_tags": [
        "camembert"
      ],
      "scac": "MSCU"
    },
    "relationships": {
      "customer": {
        "data": {
          "id": "PARTY_ID",
          "type": "party"
        }
      }
    }
  }
}

The response carries the tracking request ID. Its customer relationship references the party’s linked account and is null when the party has none, which is the case for parties created through this API. Once the shipment exists, read the assigned party with GET /v2/shipments/SHIPMENT_ID/party_roles.

Response

{
  "data": {
    "id": "TRACKING_REQUEST_ID",
    "type": "tracking_request",
    "attributes": {
      "request_type": "bill_of_lading",
      "request_number": "MEDUFR030802",
      "ref_numbers": [
        "PO12345",
        "HBL12345",
        "CUSREF1234"
      ],
      "shipment_tags": [
        "camembert"
      ],
      "scac": "MSCU"
    },
    "relationships": {
      "tracked_object": {
        "data": null
      },
      "customer": {
        "data": null
      }
    },
    "links": {
      "self": "/v2/tracking_requests/TRACKING_REQUEST_ID"
    }
  }
}

Create a party for a customer

To add a customer to a tracking request, you first need to create a party. You can create a party through the API. Endpoint: POST - https://api.terminal49.com/v2/parties

Request

{
  "data": {
    "type": "party",
    "attributes": {
      "company_name": "COMPANY NAME"
    }
  }
}

After you send a POST request to create a party, you will receive a response with the Party ID. You can use this Party ID to add the customer to a tracking request.

Response

{
  "data": {
    "id": "PARTY_ID",
    "type": "party",
    "attributes": {
      "company_name": "COMPANY NAME"
    }
  }
}

Edit a party

You can update existing parties through the API. Endpoint: PATCH - https://api.terminal49.com/v2/parties/PARTY_ID

Read a party

You can retrieve the details of an existing party through the API. Endpoint: GET - https://api.terminal49.com/v2/parties/PARTY_ID

Getting Started

Tracking Fundamentals

Webhooks & Events

Integrations & Embeds

Platform & Reference

Add a Customer to a Tracking Request

Why add a party to a tracking request?

How to get the party ID

List all parties

Add a party to a tracking request

Create a party for a customer

Edit a party

Read a party

​Why add a party to a tracking request?

​How to get the party ID

​List all parties

​Add a party to a tracking request

​Create a party for a customer

​Edit a party

​Read a party

Why add a party to a tracking request?

How to get the party ID

List all parties

Add a party to a tracking request

Create a party for a customer

Edit a party

Read a party