Specify Appointment Calendar

3 min

When creating a load with the Create Load API, you can also set a specific attributes about the appointment which can help assign that shipment to a given calendar configuration. Please continue reading below to see how the matching is done when creating a load/appointment and how that data matches to a calendar.

POST

https://api.fourkites.com/api/v1/tracking

curl --location 'https://api.fourkites.com/api/v1/tracking' \
--header 'apikey: TEST_KEY' \
--data '{
    "load": {
        "carrier": "0010",
        "loadNumber": "NSH84757",
        "nonTrackable": true,
        "proNumber": "4638",
        "referenceNumbers": [
            "TU-2945",
            "94BC8",
            "Type: BLK DRY"
        ],
        "stops": [
            {
                "addressLine1": "300 S Riverside",
                "addressLine2": null,
                "city": "Chicago",
                "country": "US",
                "customer": {
                    "id": "789789",
                    "poNumbers": [
                        "00210123OF-203503"
                    ]
                },
                "earliestAppointmentTime": "",
                "latestAppointmentTime": "",
                "name": "FourKites HQ",
                "postalCode": "60661",
                "referenceNumbers": [
                    "1234567",
                    "2412422222"
                ],
                "shipTo": "1234",
                "state": "IL",
                "sequence": "1",
                "stopReferenceId": "123",
                "stopType": "pickup"
            },
            {
                "addressLine1": "425 South Palos Verdes Street",
                "addressLine2": "",
                "city": "Los Angeles",
                "country": "US",
                "customer": {
                    "id": "789789",
                    "poNumbers": [
                        "00210123OF-203503"
                    ]
                },
                "earliestAppointmentTime": "",
                "latestAppointmentTime": "",
                "name": "Port of Longbeach",
                "postalCode": "90731",
                "referenceNumbers": [
                    "1234567",
                    "2412422222"
                ],
                "state": "CA",
                "sequence": "2",
                "stopReferenceId": "9876",
                "stopType": "delivery"
            }
        ],
        "tags": [
            "temp",
            "field2",
            "Inbound"
        ]
    },
    "trackingInfo": {
        "trailerNumber": "643",
        "truckNumber": "1085"
    }
}'

Specify a Calendar in Appointment Manager

Before calendars can be specified on the API, different appointment "types" must be configured inside Appointment Manager. Please see the Appointment Manager product documentation for more information on configuring calendars.

Once a calendar(s) is configured, the following values are determined by the load you create:

Shipping Type: This is determined by whether the stop aligned with facility is a "pickup" or "delivery". These fields align with the stopType in the API

Product Type: This field can be passed inside the referenceNumbers array with a prefix of Type . Even if this field has been renamed in the UI, you can still send the prefix of Type and it will match the appropriate field. Below is an example:

Type: BLK DY

When setting the Product Type in the referenceNumbers, it can be listed alongside other references. In the example below, it is the 3rd reference number in the array:

"referenceNumbers": [
   "TU-2945",
   "94BC8",
   "Type: BLK DRY"
]

This will find a match to a configured Product Type and associate the appointment to an appropriate calendar. When editing an appointment, you can view the associated Product Type inherited from the API call:

The calendar which the appointment is eligible for will then be determined by the calendar's configuration. For more information on configuring Appointment Manager calendars, please reference the product documentation:

HEADERS

apikey	TEST_KEY API key generated on the FourKites developer portal