Supported Formats

json

Errors

Code Description
404 Resource Not Found
422 Validation Error
500 Internal Server Error

Examples

curl 'https://app.octopi.co/api/v1/chargeable_events/bulk_update' \
  -X 'GET' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'
{
  "total_count": 29,
  "chargeable_events": [
    {
      "id": "06d22aa5-2563-4b28-91d6-4e9398dd7f5a",
      "occurred_at": "2024-11-26T12:33:15.000-05:00",
      "category": "unit",
      "event_type": "cargo_gated_in",
      "payload": {
        "gate": {
          "id": 893,
          "name": "CPS 8",
          "enabled": true,
          "internal": true,
          "client_identifier": ""
        },
        "genset": null,
        "booking": {
          "id": 840771,
          "usage": null,
          "status": null,
          "consignee": {
            "id": 263848,
            "name": "BRASSERIE NATIONALE D'HAITI S.A.",
            "email": "alix.jeanty@heineken.com, may.laviolette@heineken.com",
            "address": "ROUTE DE L   AEROPORTBOULEVARD  TOUSSAINT LOUVERTUREPORT AU  PRINCE  H"
          },
          "booking_number": "62487978/1",
          "number_of_units": 1,
          "port_of_loading": {
            "id": 2642,
            "name": "PORT-AU-PRINCE",
            "locode": "HTPAP",
            "country_code": "HT"
          },
          "port_of_delivery": {
            "id": 4213,
            "name": "VERACRUZ",
            "locode": "MXVER",
            "country_code": "MX"
          },
          "port_of_discharge": {
            "id": 1405,
            "name": "CARTAGENA",
            "locode": "COCTG",
            "country_code": "CO"
          }
        },
        "chassis": {
          "id": 18810,
          "size": 20,
          "active": true,
          "number": "#21",
          "damage_state": null,
          "discarded_at": null,
          "license_plate_number": null
        },
        "terminal": {
          "id": 420,
          "name": "CPS 8",
          "depot_code": "HTPAPCPSI"
        },
        "consignee": {
          "id": 263848,
          "name": "BRASSERIE NATIONALE D'HAITI S.A.",
          "email": "alix.jeanty@heineken.com, may.laviolette@heineken.com",
          "address": "ROUTE DE L   AEROPORTBOULEVARD  TOUSSAINT LOUVERTUREPORT AU  PRINCE  H"
        },
        "container": {
          "id": 2627675,
          "pin": null,
          "seal": "SL00012",
          "tags": [],
          "usage": "export",
          "number": "BCMU4473161",
          "reefer": false,
          "status": "full",
          "weight": 18143.6948,
          "hazardous": false,
          "net_weight": null,
          "flex_fields": {},
          "temperature": null,
          "weight_unit": "kg",
          "damage_state": "damaged",
          "hazmat_codes": [],
          "out_of_gauge": false,
          "container_type": {
            "id": 3,
            "label": "40DV",
            "iso_type": {
              "id": 50,
              "code": "42G1",
              "height": "8.6",
              "length": 40,
              "category": "Dry",
              "tare_weight": 3825
            },
            "force_reefer": false
          },
          "extra_attributes": null,
          "reference_number": "",
          "temperature_unit": "fahrenheit",
          "client_identifier": null,
          "reefer_ventilation": null,
          "set_point_temperature": "33.8"
        },
        "unit_type": "container",
        "event_type": "cargo_gated_in",
        "gated_in_at": "2023-06-19T20:28:00.000Z",
        "interchange": {
          "id": 2771032,
          "tir_number": 2771032,
          "action_type": "interchange_in",
          "completed_at": null
        },
        "movement_id": 16735176,
        "shipping_line": {
          "id": 31,
          "code": "HLC",
          "name": "Hapag Lloyd",
          "synonyms": [
            "HL",
            "HLC",
            "HLCU",
            "HLL"
          ],
          "carrier_type": "ocean"
        },
        "arrival_voyage": {
          "id": 225222,
          "ship": {
            "id": 411,
            "imo": "9266530",
            "loa": "134.44m x 22.5m",
            "name": "FALMOUTH",
            "call_sign": "5BMN2",
            "vessel_type": "container",
            "country_code": "CY",
            "gross_tonnage": 9990,
            "number_of_bays": 31,
            "number_of_rows": 9,
            "client_identifier": null,
            "number_of_tiers_above": 94,
            "number_of_tiers_below": 20
          },
          "number": "55E",
          "at_of_berth": "2021-04-19T18:24:00.000Z",
          "et_of_berth": null,
          "display_name": "FALMOUTH 55E",
          "at_of_anchorage": "2021-04-19T16:00:00.000Z",
          "at_of_departure": "2021-04-20T16:05:00.000Z",
          "et_of_anchorage": "2021-04-19T16:00:00.000Z",
          "et_of_departure": null,
          "at_berth_departure": "2021-04-20T15:48:00.000Z",
          "at_of_pilot_boarded": "2021-04-19T17:24:00.000Z",
          "et_of_pilot_boarded": null,
          "at_of_customs_clearance": "2021-04-19T19:00:00.000Z",
          "at_of_departure_pilot_boarded": "2021-04-20T15:36:00.000Z",
          "et_of_departure_pilot_boarded": null
        },
        "bill_of_lading": {
          "id": 730050,
          "usage": null,
          "weight": 25586.05,
          "remarks": null,
          "exporter": {
            "id": 50639,
            "name": "GEODIS FF BELGIUM NV"
          },
          "notifier": {
            "id": 4879,
            "name": "BRASSERIE NATIONALE D'HAITI S.A"
          },
          "bl_number": "HLCUANR210331463",
          "consignee": {
            "id": 263848,
            "name": "BRASSERIE NATIONALE D'HAITI S.A.",
            "email": "alix.jeanty@heineken.com, may.laviolette@heineken.com",
            "address": "ROUTE DE L   AEROPORTBOULEVARD  TOUSSAINT LOUVERTUREPORT AU  PRINCE  H"
          },
          "port_of_loading": {
            "id": 7569,
            "name": "Kingston (JMKST)",
            "locode": "JMKST",
            "country_code": "JM"
          },
          "port_of_delivery": {
            "id": 2642,
            "name": "PORT-AU-PRINCE",
            "locode": "HTPAP",
            "country_code": "HT"
          },
          "client_identifier": null,
          "port_of_discharge": {
            "id": 2642,
            "name": "PORT-AU-PRINCE",
            "locode": "HTPAP",
            "country_code": "HT"
          }
        },
        "export_release": null,
        "departure_voyage": null,
        "event_created_at": "2024-11-26 17:33:15 UTC",
        "trucking_company": {
          "id": 4087,
          "code": null,
          "name": "Caribbean Port Services SA",
          "email": ""
        }
      }
    },
    {
      "id": "5517ee97-52a9-4add-9a28-5963a8fb4629",
      "occurred_at": "2024-11-15T07:44:59.684-05:00",
      "category": "unit",
      "event_type": "cargo_delivered",
      "payload": {
        "truck": {
          "id": 26782,
          "number": "",
          "truck_driver": null,
          "license_plate": "CPSM2",
          "trucking_company": "Caribbean Port Services SA"
        },
        "cargos": [
          {
            "vehicle": {
              "id": 939050,
              "pin": null,
              "vin": "WBAKR0107J0X72930",
              "make": "BMW",
              "tags": [],
              "year": "2018",
              "color": null,
              "goods": "2018 BMW X5 NOIRE",
              "model": null,
              "usage": "unknown",
              "volume": null,
              "weight": 0,
              "originid": "c59aa26b-5b60-4373-b997-b38f1913c35f",
              "quantity": 1,
              "hazardous": false,
              "net_weight": null,
              "flex_fields": {},
              "weight_unit": "kg",
              "damage_state": "not_damaged",
              "hazmat_codes": [],
              "package_weight": null,
              "shipping_marks": null,
              "extra_attributes": null,
              "reference_number": null,
              "temperature_unit": "fahrenheit",
              "client_identifier": null,
              "package_type_code": null,
              "net_package_weight": null,
              "pieces_per_package": null,
              "package_type_description": null
            },
            "consignee": {
              "id": 269842,
              "name": "XAVIER JOB",
              "email": null,
              "address": "ADD SARTHE 55 RUE GERMAIN 67PORT AU PRINCEHAITITEL  43  6 49  "
            },
            "unit_type": "vehicle",
            "shipping_line": {
              "id": 20,
              "code": "CROW",
              "name": "CROWLEY LINER SERVICES,INC",
              "synonyms": [
                "CAT",
                "CLA",
                "CLAM",
                "CLS",
                "CRL",
                "CRLY",
                "CRO",
                "CROWLEY",
                "CRY"
              ],
              "carrier_type": "ocean"
            },
            "arrival_voyage": null,
            "bills_of_lading": [],
            "stripped_from_container": null
          },
          {
            "breakbulk": {
              "id": 2552946,
              "pin": null,
              "vin": "",
              "make": "",
              "tags": [],
              "year": "",
              "color": "pink",
              "goods": "",
              "model": "",
              "usage": "import",
              "volume": null,
              "weight": 4082.4,
              "originid": null,
              "quantity": 1,
              "hazardous": false,
              "net_weight": null,
              "flex_fields": {},
              "weight_unit": "kg",
              "damage_state": "not_damaged",
              "hazmat_codes": [],
              "package_weight": null,
              "shipping_marks": "",
              "extra_attributes": null,
              "reference_number": "",
              "temperature_unit": "fahrenheit",
              "client_identifier": null,
              "package_type_code": "",
              "net_package_weight": null,
              "pieces_per_package": null,
              "package_type_description": null
            },
            "consignee": {
              "id": 10488,
              "name": "CROWLEY LATIN AMERICA SERVICE",
              "email": null,
              "address": "TORRE PANAMERICANS AV ABRAHAM LINCOLN 504 PO"
            },
            "unit_type": "breakbulk",
            "shipping_line": {
              "id": 20,
              "code": "CROW",
              "name": "CROWLEY LINER SERVICES,INC",
              "synonyms": [
                "CAT",
                "CLA",
                "CLAM",
                "CLS",
                "CRL",
                "CRLY",
                "CRO",
                "CROWLEY",
                "CRY"
              ],
              "carrier_type": "ocean"
            },
            "arrival_voyage": {
              "id": 224916,
              "ship": {
                "id": 367,
                "imo": "9355472",
                "loa": "139.6 x 22.39",
                "name": "TUCANA J",
                "call_sign": "V2CX7",
                "vessel_type": "container",
                "country_code": "AG",
                "gross_tonnage": 8246,
                "number_of_bays": 35,
                "number_of_rows": 9,
                "client_identifier": null,
                "number_of_tiers_above": 94,
                "number_of_tiers_below": 8
              },
              "number": "1013N",
              "at_of_berth": "2021-04-06T17:30:00.000-04:00",
              "et_of_berth": null,
              "display_name": "TUCANA J 1013N",
              "at_of_anchorage": "2021-04-06T16:10:00.000-04:00",
              "at_of_departure": "2021-04-07T00:10:00.000-04:00",
              "et_of_anchorage": "2021-04-06T17:00:00.000-04:00",
              "et_of_departure": null,
              "at_berth_departure": "2021-04-07T00:00:00.000-04:00",
              "at_of_pilot_boarded": "2021-04-06T16:50:00.000-04:00",
              "et_of_pilot_boarded": null,
              "at_of_customs_clearance": "2021-04-06T18:14:00.000-04:00",
              "at_of_departure_pilot_boarded": "2021-04-06T23:50:00.000-04:00",
              "et_of_departure_pilot_boarded": null
            },
            "bills_of_lading": [
              {
                "id": 718208,
                "usage": null,
                "weight": 65318.4,
                "remarks": null,
                "exporter": {
                  "id": 5782,
                  "name": "CROWLEY LATIN AMERICA SERVICES"
                },
                "notifier": {
                  "id": 431,
                  "name": "CROWLEY LATIN AMERICA SERVICES"
                },
                "bl_number": "EMTS1M000228",
                "consignee": {
                  "id": 10488,
                  "name": "CROWLEY LATIN AMERICA SERVICE",
                  "email": null,
                  "address": "TORRE PANAMERICANS AV ABRAHAM LINCOLN 504 PO"
                },
                "port_of_loading": {
                  "id": 7205,
                  "name": "PORT EVERGLADES",
                  "locode": "USPEF",
                  "country_code": "US"
                },
                "port_of_delivery": {
                  "id": 2642,
                  "name": "PORT-AU-PRINCE",
                  "locode": "HTPAP",
                  "country_code": "HT"
                },
                "client_identifier": null,
                "port_of_discharge": {
                  "id": 2642,
                  "name": "PORT-AU-PRINCE",
                  "locode": "HTPAP",
                  "country_code": "HT"
                }
              }
            ],
            "stripped_from_container": null
          },
          {
            "vehicle": {
              "id": 2720103,
              "pin": null,
              "vin": "VF3221DA212063421",
              "make": null,
              "tags": [],
              "year": null,
              "color": null,
              "goods": "2002 PEUGEOT GRISE 9693",
              "model": null,
              "usage": "unknown",
              "volume": null,
              "weight": 0,
              "originid": "10cecd09-e20c-43e0-87b5-8752d9691345",
              "quantity": 1,
              "hazardous": false,
              "net_weight": null,
              "flex_fields": {},
              "weight_unit": "kg",
              "damage_state": "not_damaged",
              "hazmat_codes": [],
              "package_weight": null,
              "shipping_marks": null,
              "extra_attributes": null,
              "reference_number": null,
              "temperature_unit": "fahrenheit",
              "client_identifier": null,
              "package_type_code": null,
              "net_package_weight": null,
              "pieces_per_package": null,
              "package_type_description": null
            },
            "consignee": {
              "id": 19744,
              "name": "CHATELAIN CARGO SERVICES S.A.",
              "email": "pvc@chatelaincargo.com",
              "address": "SA42 AIRPORT ROADPORT AU PRINCE  HAITIPVC CHATELAINCARGO COMTEL   5 9 "
            },
            "unit_type": "vehicle",
            "shipping_line": {
              "id": 31,
              "code": "HLC",
              "name": "Hapag Lloyd",
              "synonyms": [
                "HL",
                "HLC",
                "HLCU",
                "HLL"
              ],
              "carrier_type": "ocean"
            },
            "arrival_voyage": null,
            "bills_of_lading": [
              {
                "id": 739582,
                "usage": null,
                "weight": 29960,
                "remarks": null,
                "exporter": {
                  "id": 39299,
                  "name": "IMPORT EXPORT STOCKAGE"
                },
                "notifier": {
                  "id": 2,
                  "name": "CHATELAIN CARGO SERVICES"
                },
                "bl_number": "HLCULE1210387346",
                "consignee": {
                  "id": 19744,
                  "name": "CHATELAIN CARGO SERVICES S.A.",
                  "email": "pvc@chatelaincargo.com",
                  "address": "SA42 AIRPORT ROADPORT AU PRINCE  HAITIPVC CHATELAINCARGO COMTEL   5 9 "
                },
                "port_of_loading": {
                  "id": 7569,
                  "name": "Kingston (JMKST)",
                  "locode": "JMKST",
                  "country_code": "JM"
                },
                "port_of_delivery": {
                  "id": 2642,
                  "name": "PORT-AU-PRINCE",
                  "locode": "HTPAP",
                  "country_code": "HT"
                },
                "client_identifier": null,
                "port_of_discharge": {
                  "id": 2642,
                  "name": "PORT-AU-PRINCE",
                  "locode": "HTPAP",
                  "country_code": "HT"
                }
              }
            ],
            "stripped_from_container": null
          },
          {
            "breakbulk": {
              "id": 4337788,
              "pin": null,
              "vin": null,
              "make": null,
              "tags": [],
              "year": null,
              "color": null,
              "goods": "qwerty",
              "model": null,
              "usage": "unknown",
              "volume": null,
              "weight": 0,
              "originid": "7dc57953-81e4-4fb1-9850-a75e9fcdfbd4",
              "quantity": 1,
              "hazardous": false,
              "net_weight": null,
              "flex_fields": {},
              "weight_unit": "kg",
              "damage_state": "not_damaged",
              "hazmat_codes": [],
              "package_weight": null,
              "shipping_marks": "qwerty",
              "extra_attributes": null,
              "reference_number": null,
              "temperature_unit": "fahrenheit",
              "client_identifier": null,
              "package_type_code": null,
              "net_package_weight": null,
              "pieces_per_package": null,
              "package_type_description": null
            },
            "consignee": {
              "id": 51486,
              "name": "XTRA MARKET",
              "email": "",
              "address": "PUBLIC'S PLAZA CANAPE VERT PORT AU PRINCE,   "
            },
            "unit_type": "breakbulk",
            "shipping_line": {
              "id": 116,
              "code": "XP",
              "name": "X-press Feeder",
              "synonyms": [],
              "carrier_type": "ocean"
            },
            "arrival_voyage": null,
            "bills_of_lading": [],
            "stripped_from_container": null
          }
        ],
        "remarks": "",
        "consignee": null,
        "event_type": "cargo_delivered",
        "delivery_id": 196228,
        "truck_visit": {
          "id": 2330683,
          "gate": {
            "id": 893,
            "name": "CPS 8",
            "client_identifier": ""
          },
          "truck": {
            "id": 26708,
            "make": "",
            "year": null,
            "color": "white",
            "model": "",
            "active": true,
            "number": "",
            "weight": null,
            "is_mule": false,
            "created_at": "2020-10-16T10:01:32.126-04:00",
            "updated_at": "2020-10-16T10:06:04.570-04:00",
            "discarded_at": null,
            "truck_driver": null,
            "allowed_until": null,
            "license_plate": "CPSM11",
            "organization_id": 1,
            "truck_driver_id": null,
            "trucking_company": "Caribbean Port Services SA",
            "trucking_company_id": 4087
          },
          "terminal": {
            "id": 420,
            "name": "CPS 8",
            "active": true,
            "edi_id": "",
            "boundaries": "[[-72.31342527176048,18.567334415556275],[-72.31237766973884,18.56832077717621],[-72.311889260692,18.567837661989557],[-72.31297225467164,18.566891557455108],[-72.31342527176048,18.567334415556275]]",
            "created_at": "2020-07-30T11:01:21.906-04:00",
            "depot_code": "HTPAPCPSI",
            "updated_at": "2023-07-28T06:26:17.539-04:00",
            "organization_id": 1,
            "client_identifier": "",
            "terminal_manager_id": null,
            "max_truck_visit_duration": 60,
            "appointment_end_tolerance_mins": null,
            "appointment_start_tolerance_mins": null
          },
          "gated_in_at": "2024-11-15T06:31:07.247-05:00",
          "gated_out_at": null,
          "truck_driver": {
            "id": 233604,
            "twic": null,
            "number": null,
            "lastname": "Kamal",
            "firstname": "Kamal",
            "license_number": "N/A"
          },
          "trucking_company": {
            "id": 4087,
            "code": null,
            "name": "Caribbean Port Services SA",
            "email": ""
          }
        },
        "delivered_at": "2024-11-15T07:44:59.045-05:00",
        "delivered_to": "",
        "truck_driver": {
          "id": 233604,
          "twic": null,
          "number": null,
          "lastname": "Kamal",
          "firstname": "Kamal",
          "license_number": "N/A"
        },
        "delivery_order": {
          "id": 49527,
          "number": "DO"
        },
        "total_quantity": 4,
        "event_created_at": "2024-11-15T07:44:59.684-05:00"
      }
    },
    {
      "id": "92f7f4a7-95d0-40f2-bfde-6c8dfe7be5b5",
      "occurred_at": "2024-11-14T08:12:21.000-05:00",
      "category": "unit",
      "event_type": "cargo_loaded",
      "payload": {
        "booking": null,
        "chassis": {
          "id": 48398,
          "size": 45,
          "active": true,
          "number": "160001CMCZ",
          "damage_state": "not_damaged",
          "discarded_at": null,
          "license_plate_number": null
        },
        "terminal": {
          "id": 31,
          "name": "CPS Yard",
          "depot_code": "HTPAPCPSG"
        },
        "container": {
          "id": 4284005,
          "pin": null,
          "seal": "2398169",
          "tags": [],
          "usage": "export",
          "number": "CSLU2314317",
          "reefer": false,
          "status": "empty",
          "weight": 0,
          "hazardous": false,
          "net_weight": null,
          "flex_fields": {},
          "temperature": null,
          "weight_unit": "kg",
          "damage_state": "not_damaged",
          "hazmat_codes": [],
          "out_of_gauge": false,
          "container_type": {
            "id": 2,
            "label": "20DV",
            "iso_type": {
              "id": 16,
              "code": "22G1",
              "height": "8.6",
              "length": 20,
              "category": "Dry",
              "tare_weight": 2000
            },
            "force_reefer": false
          },
          "extra_attributes": null,
          "reference_number": null,
          "temperature_unit": "fahrenheit",
          "client_identifier": null,
          "reefer_ventilation": null,
          "set_point_temperature": null
        },
        "loaded_at": "2024-11-14T08:12:21.516-05:00",
        "unit_type": "container",
        "event_type": "cargo_loaded",
        "movement_id": 16736016,
        "overshipped": false,
        "shipping_line": {
          "id": 96,
          "code": "COSCO",
          "name": "COSCO",
          "synonyms": [
            "COS",
            "COSCONA"
          ],
          "carrier_type": "ocean"
        },
        "departure_voyage": {
          "id": 341568,
          "ship": {
            "id": 16570,
            "imo": "9629419",
            "loa": "143 X 22.6",
            "name": "X - PRESS MOY",
            "call_sign": "9V7939",
            "vessel_type": "container",
            "country_code": "SG",
            "gross_tonnage": 9996,
            "number_of_bays": 31,
            "number_of_rows": 9,
            "client_identifier": null,
            "number_of_tiers_above": 92,
            "number_of_tiers_below": 8
          },
          "number": "22018N",
          "at_of_berth": null,
          "et_of_berth": null,
          "display_name": "X - PRESS MOY 22018N",
          "at_of_anchorage": null,
          "at_of_departure": null,
          "et_of_anchorage": "2023-01-12T07:30:00.000-05:00",
          "et_of_departure": null,
          "at_berth_departure": null,
          "at_of_pilot_boarded": null,
          "et_of_pilot_boarded": null,
          "at_of_customs_clearance": null,
          "at_of_departure_pilot_boarded": null,
          "et_of_departure_pilot_boarded": null
        },
        "event_created_at": "2024-11-14T08:12:21.000-05:00",
        "stowage_location": null
      }
    },
    {
      "id": "774cb1d1-322b-44ee-a304-b434144f1faf",
      "occurred_at": "2024-11-14T08:06:10.000-05:00",
      "category": "unit",
      "event_type": "cargo_unloaded",
      "payload": {
        "chassis": null,
        "terminal": {
          "id": 31,
          "name": "CPS Yard",
          "depot_code": "HTPAPCPSG"
        },
        "container": {
          "id": 4332670,
          "pin": null,
          "seal": "0091",
          "tags": [],
          "usage": "import",
          "number": "BEAU6109510",
          "reefer": false,
          "status": "full",
          "weight": 19477.22,
          "hazardous": false,
          "net_weight": null,
          "flex_fields": {},
          "temperature": null,
          "weight_unit": "kg",
          "damage_state": "not_damaged",
          "hazmat_codes": [],
          "out_of_gauge": false,
          "container_type": {
            "id": 3,
            "label": "40DV",
            "iso_type": {
              "id": 50,
              "code": "42G1",
              "height": "8.6",
              "length": 40,
              "category": "Dry",
              "tare_weight": 3825
            },
            "force_reefer": false
          },
          "extra_attributes": null,
          "reference_number": null,
          "temperature_unit": "fahrenheit",
          "client_identifier": null,
          "reefer_ventilation": null,
          "set_point_temperature": null
        },
        "unit_type": "container",
        "event_type": "cargo_unloaded",
        "movement_id": 16736013,
        "unloaded_at": "2024-11-14T08:06:09.757-05:00",
        "shipping_line": {
          "id": 49,
          "code": "CMACGM",
          "name": "CMA CGM",
          "synonyms": [
            "CMA"
          ],
          "carrier_type": "ocean"
        },
        "arrival_voyage": {
          "id": 341554,
          "ship": {
            "id": 16657,
            "imo": "9477347",
            "loa": "161.29 X 25.05",
            "name": "POLYNESIA",
            "call_sign": "A8RO9",
            "vessel_type": "other",
            "country_code": "LR",
            "gross_tonnage": 16137,
            "number_of_bays": null,
            "number_of_rows": null,
            "client_identifier": null,
            "number_of_tiers_above": null,
            "number_of_tiers_below": null
          },
          "number": "0AGB3S1MA",
          "at_of_berth": null,
          "et_of_berth": null,
          "display_name": "POLYNESIA 0AGB3S1MA",
          "at_of_anchorage": null,
          "at_of_departure": null,
          "et_of_anchorage": "2023-01-11T07:00:00.000-05:00",
          "et_of_departure": null,
          "at_berth_departure": null,
          "at_of_pilot_boarded": null,
          "et_of_pilot_boarded": null,
          "at_of_customs_clearance": null,
          "at_of_departure_pilot_boarded": null,
          "et_of_departure_pilot_boarded": null
        },
        "bills_of_lading": [
          {
            "id": 1301184,
            "usage": null,
            "weight": 19477.22,
            "remarks": null,
            "exporter": {
              "id": 56233,
              "name": "SODILAC"
            },
            "notifier": {
              "id": 26729,
              "name": "IMEDIS, S.A."
            },
            "bl_number": "LHV3035039",
            "consignee": {
              "id": 474603,
              "name": "IMEDIS, S.A.",
              "email": null,
              "address": "3 RUE LOUISSAINT PORT AU PRINCE OU"
            },
            "port_of_loading": {
              "id": 7569,
              "name": "Kingston (JMKST)",
              "locode": "JMKST",
              "country_code": "JM"
            },
            "port_of_delivery": {
              "id": 2642,
              "name": "PORT-AU-PRINCE",
              "locode": "HTPAP",
              "country_code": "HT"
            },
            "client_identifier": null,
            "port_of_discharge": {
              "id": 2642,
              "name": "PORT-AU-PRINCE",
              "locode": "HTPAP",
              "country_code": "HT"
            }
          }
        ],
        "event_created_at": "2024-11-14T08:06:10.000-05:00"
      }
    },
    {
      "id": "9766c315-ebb8-4134-90ea-2f7779ed644e",
      "occurred_at": "2024-12-03T04:55:41.000-05:00",
      "category": "unit",
      "event_type": "cargo_gated_out",
      "payload": {
        "gate": {
          "id": 33,
          "name": "Dispatch",
          "enabled": true,
          "internal": false,
          "client_identifier": null
        },
        "genset": null,
        "chassis": null,
        "terminal": {
          "id": 31,
          "name": "CPS Yard",
          "depot_code": "HTPAPCPSG"
        },
        "consignee": {
          "id": 382977,
          "name": "OCCEAN CHRISTINA",
          "email": "",
          "address": ""
        },
        "container": {
          "id": 4193253,
          "pin": null,
          "seal": "2396445",
          "tags": [],
          "usage": "export",
          "number": "AMFU3171607",
          "reefer": false,
          "status": "empty",
          "weight": 0,
          "hazardous": false,
          "net_weight": null,
          "flex_fields": {},
          "temperature": null,
          "weight_unit": "kg",
          "damage_state": "not_damaged",
          "hazmat_codes": [],
          "out_of_gauge": false,
          "container_type": {
            "id": 2,
            "label": "20DV",
            "iso_type": {
              "id": 16,
              "code": "22G1",
              "height": "8.6",
              "length": 20,
              "category": "Dry",
              "tare_weight": 2000
            },
            "force_reefer": false
          },
          "extra_attributes": null,
          "reference_number": "",
          "temperature_unit": "fahrenheit",
          "client_identifier": null,
          "reefer_ventilation": null,
          "set_point_temperature": null
        },
        "unit_type": "container",
        "event_type": "cargo_gated_out",
        "interchange": {
          "id": 2771021,
          "tir_number": 2771021,
          "action_type": "interchange_out",
          "completed_at": "2023-01-11T04:19:48.032Z"
        },
        "movement_id": 16735727,
        "gated_out_at": "2024-08-12T13:58:00.329Z",
        "shipping_line": {
          "id": 31,
          "code": "HLC",
          "name": "Hapag Lloyd",
          "synonyms": [
            "HL",
            "HLC",
            "HLCU",
            "HLL"
          ],
          "carrier_type": "ocean"
        },
        "arrival_voyage": {
          "id": 340439,
          "ship": {
            "id": 9041,
            "imo": "9812200",
            "loa": "123 x 16.7 m",
            "name": "TOPAZ NEVA",
            "call_sign": "V7IX3",
            "vessel_type": "container",
            "country_code": "MH",
            "gross_tonnage": 3188,
            "number_of_bays": 23,
            "number_of_rows": 5,
            "client_identifier": null,
            "number_of_tiers_above": 84,
            "number_of_tiers_below": 2
          },
          "number": "029A",
          "at_of_berth": "2022-11-23T15:40:00.000Z",
          "et_of_berth": null,
          "display_name": "TOPAZ NEVA 029A",
          "at_of_anchorage": "2022-11-23T10:00:00.000Z",
          "at_of_departure": "2022-11-24T04:50:00.000Z",
          "et_of_anchorage": "2022-11-23T12:00:00.000Z",
          "et_of_departure": null,
          "at_berth_departure": "2022-11-24T04:57:00.000Z",
          "at_of_pilot_boarded": null,
          "et_of_pilot_boarded": null,
          "at_of_customs_clearance": "2022-11-23T15:44:00.000Z",
          "at_of_departure_pilot_boarded": "2022-11-24T04:30:00.000Z",
          "et_of_departure_pilot_boarded": null
        },
        "delivery_order": null,
        "export_release": null,
        "event_created_at": "2024-12-03T09:55:41.000Z",
        "trucking_company": null
      }
    },
    {
      "id": "9c6bccee-add8-47c8-b603-4bb3302c6ca7",
      "occurred_at": "2024-12-04T02:32:09.000-05:00",
      "category": "unit",
      "event_type": "cargo_relocation",
      "payload": {
        "source": {
          "port": {
            "id": 21759,
            "name": "SANTO DOMINGO",
            "locode": "CLSDO",
            "country_code": null
          },
          "type": "port"
        },
        "chassis": null,
        "remarks": null,
        "moved_at": "2024-12-04T02:32:09.003-05:00",
        "container": {
          "id": 1332000,
          "pin": null,
          "seal": "",
          "tags": [],
          "usage": "export",
          "number": "CMCU4572838",
          "reefer": false,
          "status": "empty",
          "weight": 0,
          "hazardous": false,
          "net_weight": null,
          "flex_fields": {},
          "temperature": null,
          "weight_unit": "kg",
          "damage_state": "not_damaged",
          "hazmat_codes": [],
          "out_of_gauge": false,
          "container_type": {
            "id": 8,
            "label": "45HC",
            "iso_type": {
              "id": 82,
              "code": "L5G1",
              "height": "9.6",
              "length": 45,
              "category": "High Cube",
              "tare_weight": 4000
            },
            "force_reefer": false
          },
          "current_location": {
            "type": "terminal",
            "terminal": {
              "id": 420,
              "name": "CPS 8",
              "depot_code": "HTPAPCPSI"
            }
          },
          "extra_attributes": null,
          "reference_number": null,
          "temperature_unit": "fahrenheit",
          "client_identifier": null,
          "reefer_ventilation": null,
          "set_point_temperature": "33.8"
        },
        "equipment": null,
        "unit_type": "container",
        "event_type": "cargo_relocation",
        "destination": {
          "type": "yard_slot",
          "terminal": {
            "id": 420,
            "name": "CPS 8",
            "depot_code": "HTPAPCPSI"
          },
          "yard_area": {
            "id": 2848,
            "name": "CPS 8",
            "wheeled": false,
            "area_type": "warehouse",
            "client_identifier": ""
          },
          "yard_slot": {
            "id": 577255,
            "row": 0,
            "depth": 0,
            "height": 0,
            "custom_name": "HAZARDOUS MATRLS (ZONE D)"
          }
        },
        "movement_id": 16736045,
        "event_created_at": "2024-12-04T02:32:09.000-05:00"
      }
    }
  ]
}

Params

Param name Description
start_time
required

Filters events based on their created time. Represents the start of the timestamp window in ISO 8601 format (Eg. 2024-08-18T14:00:00Z) in UTC.

Validations:

  • Must be a String

end_time
required

Filters events based on their created time. Represents the end of the timestamp window in ISO 8601 format (Eg. 2024-08-18T15:00:00Z) in UTC.

Validations:

  • Must be a String

event_type
optional

Filters events based on their event type.

Validations:

  • Must be one of: cargo_delivered, cargo_loaded, cargo_unloaded, cargo_loading_canceled, cargo_unloading_canceled, rail_cargo_loaded, rail_cargo_unloaded, cargo_held, cargo_released, hold_applied, hold_lifted, cargo_overlanded, cargo_overshipped, cargo_relocation, cargo_gated_in, cargo_gated_out, genset_gated_in, genset_gated_out, cargo_transferred_in, cargo_transferred_out, cargo_sent_to_berth, cargo_received_from_berth, cargo_shifted_from_ship_to_ship, cargo_shifted_from_port_to_ship, cargo_shifted_from_ship_to_port, cargo_stock_transferred, container_damage_recorded, container_damage_repaired, chassis_damage_recorded, chassis_damage_repaired, container_cleaned, container_scanned, container_resealed, container_inspected, cargo_service_applied, container_weighted, chassis_mounted, chassis_dismounted, cargo_stuffed, container_stripped, reefer_plugged_in, reefer_plugged_out, reefer_pre_trip_inspected, movement_deleted, berth_request_approved, voyage_created, voyage_updated, voyage_canceled, voyage_event_created, voyage_event_updated, voyage_event_deleted, special_lift_operated, special_lift_deleted, train_visit_created, train_visit_updated, train_visit_canceled.

category
optional

Filters events based on their category.

Validations:

  • Must be one of: marine, unit, rail.

missing_general_ledger_id
optional

Filters events to include only those without a General Ledger ID. Defaults to false.

Validations:

  • Must be one of: true, false, 1, 0.

page
optional

Specify which page of results to fetch. This value defaults to 1.

Validations:

  • Must be a number.

per
optional

The number of chargeable events to be displayed. This value defaults to 10 and accepts a maximum of 20.

Validations:

  • Must be a number.