Carrier Payloads

• Shipment Request Carrier Payload

• Shipment Carrier Payload

• Tracking Carrier Payload

• Document Carrier Payload

Shipment request

{
  "id": 0,
  "name": "string",
  "comment": "string",
  "internal_ref": null,
  "departure_date": "2023-02-15",
  "departure_time": "16:30:00",
  "arrival_date": "2023-02-17",
  "arrival_time": "18:00:00",
  "from_address": {
    "id": 0,
    "type": "head_office",
    "name": "Shiptify | Nantes",
    "country": "France",
    "city": "Nantes",
    "address_1": "string",
    "address_2": null,
    "recipient": "string",
    "zipcode": "string",
    "state": null,
    "phone_number": null,
    "email": null,
    "instructions": null,
    "country_code_alpha2": "FR",
    "internal_ref": null
  },
  "dest_address": {
    "id": 112762,
    "type": "other",
    "name": "string",
    "country": "France",
    "city": "Nantes",
    "address_1": "string",
    "address_2": null,
    "recipient": "string",
    "zipcode": "44000",
    "state": null,
    "phone_number": "string",
    "email": null,
    "instructions": null,
    "country_code_alpha2": "FR",
    "internal_ref": null
  },
  "pre_shipments": [
    {
      "id": 0,
      "name": "string",
      "shipping_date_from": "2023-02-15",
      "shipping_time_from": "16:30:00",
      "arrival_date_from": "2023-02-17",
      "arrival_time_from": "18:00:00",
      "total_volume": 0,
      "total_weight": 0,
      "total_linear_meters": 0,
      "from_address": {
        "id": 0,
        "type": "string",
        "name": "string",
        "country": "France",
        "city": "Nantes",
        "address_1": "string",
        "address_2": null,
        "recipient": "string",
        "zipcode": "44200",
        "state": null,
        "phone_number": null,
        "email": null,
        "instructions": null,
        "country_code_alpha2": "FR",
        "internal_ref": null
      },
      "dest_address": {
        "id": 0,
        "type": "other",
        "name": "string",
        "country": "France",
        "city": "Nantes",
        "address_1": "string",
        "address_2": null,
        "recipient": "string",
        "zipcode": "44000",
        "state": null,
        "phone_number": "string",
        "email": null,
        "instructions": null,
        "country_code_alpha2": "FR",
        "internal_ref": null
      },
      "purchase": "",
      "sales": ""
    }
  ],
  "quote_requests": [
    {
      "currency": "EUR",
      "mode": { "id": 3, "name": "Road" },
      "price_details": [
        { "name": "string", "price": 0 },
        { "name": "string", "price": 0 },
        { "name": "string", "price": 0 },
      ]
    }
  ],
  "shipper": { "id": 0, "name": "string" },
  "event_type": "create_shipment_request",
  "timestamp": 1676019951,
  "signature": "string",
  "token": "string"
}

Shipment

{
    "id": 0,
    "shipper_id": 0,
    "carrier_id": 0,
    "status": "planned",
    "tracking_code": null,
    "name": "string",
    "container_name": null,
    "quote_request_id": 0,
    "estimated_departure": "2022-01-27T02:00:00.000Z",
    "real_departure": null,
    "is_full_day_departure": false,
    "estimated_arrival": "2021-12-15T23:00:00.000Z",
    "real_arrival": null,
    "is_full_day_arrival": false,
    "total_volume": 0,
    "total_weight": 0,
    "total_linear_meters": 0,
    "from_address": {
        "id": 0,
        "type": "string",
        "name": "string",
        "country": "string",
        "city": "string",
        "address_1": "string",
        "address_2": null,
        "recipient": "string",
        "zipcode": "string",
        "state": null,
        "phone_number": "string",
        "email": null,
        "instructions": null,
        "country_code_alpha2": "FR",
        "internal_ref": null
    },
    "dest_address": {
        "id": 0,
        "type": "string",
        "name": "string",
        "country": "string",
        "city": "string",
        "address_1": "string",
        "address_2": null,
        "recipient": "string",
        "zipcode": "string",
        "state": null,
        "phone_number": "string",
        "email": null,
        "instructions": null,
        "country_code_alpha2": "FR",
        "internal_ref": null
    },
    "contents": [{
        "id": 0,
        "type_id": 0,
        "spec_id": 0,
        "product_type_id": 0,
        "quantity": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "comment": "string",
        "internal_ref": null,
        "is_dangerous": true,
        "is_stacked": true,
        "onu_code": null,
        "is_controlled_temperature": false,
        "from_address": {
            "id": 0,
            "type": "string",
            "name": "string",
            "country": "string",
            "city": "string",
            "address_1": null,
            "address_2": null,
            "recipient": "string",
            "zipcode": "string",
            "state": null,
            "phone_number": null,
            "email": null,
            "instructions": null,
            "country_code_alpha2": "FR",
            "internal_ref": null
        },
        "dest_address": {
            "id": 0,
            "type": "string",
            "name": "string",
            "country": "string",
            "city": "string",
            "address_1": "string",
            "address_2": "string",
            "recipient": "string",
            "zipcode": "string",
            "state": null,
            "phone_number": "string",
            "email": null,
            "instructions": null,
            "country_code_alpha2": "FR",
            "internal_ref": "string"
        },
        "type": {
            "id": 0,
            "name": "string",
            "is_container": false
        },
        "freight_unit_key": "string",
        "product_type_name": "string",
        "spec_name": "string"
    }],
    "incoterms": {
        "purchase": "",
        "sales": ""
    },
    "routing_details": [],
    "shipment_request": {
        "id": 0,
        "name": "string",
        "comment": "",
        "internal_ref": null,
        "departure_date": "2022-01-21",
        "departure_time": "12:30:00",
        "arrival_date": "2022-01-28",
        "arrival_time": "13:00:00",
        "from_address": {
            "id": 0,
            "type": "string",
            "name": "string",
            "country": "string",
            "city": "string",
            "address_1": "string",
            "address_2": null,
            "recipient": "string",
            "zipcode": "string",
            "state": null,
            "phone_number": "string",
            "email": null,
            "instructions": null,
            "country_code_alpha2": "FR",
            "internal_ref": null
        },
        "dest_address": {
            "id": 0,
            "type": "string",
            "name": "string",
            "country": "string",
            "city": "string",
            "address_1": "string",
            "address_2": null,
            "recipient": "string",
            "zipcode": "string",
            "state": null,
            "phone_number": "string",
            "email": null,
            "instructions": null,
            "country_code_alpha2": "FR",
            "internal_ref": null
        }
    },
    "shipment_mode": {
        "id": 3,
        "name": "Road"
    },
    "tracking_points": [{
        "id": 0,
        "position": 10000,
        "type": "arrival",
        "comment": null,
        "incident": null,
        "planned_date": "2021-12-15",
        "real_date": null,
        "planned_time": "23:00:00",
        "real_time": null,
        "code": "STY9999",
        "address": {
            "id": 0,
            "type": "string",
            "name": "string",
            "country": "string",
            "city": "string",
            "address_1": "string",
            "address_2": null,
            "recipient": "string",
            "zipcode": "string",
            "state": null,
            "phone_number": "string",
            "email": null,
            "instructions": null,
            "country_code_alpha2": "FR",
            "internal_ref": null
        }
    }, {
        "id": 0,
        "position": 0,
        "type": "departure",
        "comment": "",
        "incident": null,
        "planned_date": "2022-01-27",
        "real_date": null,
        "planned_time": "02:00:00",
        "real_time": "13:32:00",
        "code": "STY0000",
        "address": {
            "id": 0,
            "type": "string",
            "name": "string",
            "country": "string",
            "city": "string",
            "address_1": "string",
            "address_2": null,
            "recipient": "string",
            "zipcode": "string",
            "state": null,
            "phone_number": "string",
            "email": null,
            "instructions": null,
            "country_code_alpha2": "FR",
            "internal_ref": null
        }
    }],
    "shipper": {
        "id": 0,
        "name":  "string"
    },
    "event_type": "create_shipment",
    "timestamp": 1643117545594,
    "signature": "string",
    "token": "string"
}

Tracking

{
    "id": 0,
    "shipper_id": 0,
    "carrier_id": 0,
    "status": "planned",
    "tracking_code": null,
    "name": "string",
    "container_name": null,
    "quote_request_id": 0,
    "estimated_departure": "2022-01-27T02:00:00.000Z",
    "real_departure": null,
    "is_full_day_departure": false,
    "estimated_arrival": "2021-12-15T23:00:00.000Z",
    "real_arrival": null,
    "is_full_day_arrival": false,
    "shipment_mode": {
        "id": 3,
        "name": "Road"
    },
    "updated_tracking_point_id": 0,
    "tracking_points": [{
        "id": 0,
        "position": 10000,
        "type": "arrival",
        "comment": null,
        "incident": null,
        "planned_date": "2021-12-15",
        "real_date": null,
        "planned_time": "23:00:00",
        "real_time": null,
        "code": "STY9999",
        "address": {
            "id": 0,
            "type": "string",
            "name": "string",
            "country": "string",
            "city": "string",
            "address_1": "string",
            "address_2": null,
            "recipient": "string",
            "zipcode": "string",
            "state": null,
            "phone_number": "string",
            "email": null,
            "instructions": null,
            "country_code_alpha2": "FR",
            "internal_ref": null
        }
    }, {
        "id": 0,
        "position": 0,
        "type": "departure",
        "comment": "",
        "incident": null,
        "planned_date": "2022-01-27",
        "real_date": null,
        "planned_time": "02:00:00",
        "real_time": "13:32:00",
        "code": "STY0000",
        "address": {
            "id": 42920,
            "type": "string",
            "name": "string",
            "country": "string",
            "city": "string",
            "address_1": "string",
            "address_2": null,
            "recipient": "string",
            "zipcode": "string",
            "state": null,
            "phone_number": "string",
            "email": null,
            "instructions": null,
            "country_code_alpha2": "FR",
            "internal_ref": null
        }
    }],
    "shipper": {
        "id": 0,
        "name": "string"
    },
    "event_type": "update_tracking",
    "timestamp": 1643117544684,
    "signature": "string",
    "token": "string"
}

Documents

{
  "shipment_id": 123456,
  "sh_request_id": 45678,
  "attachment_id": 12345,
  "doc_type": "proof_of_delivery",
  "file_name": "XXXXXXXXXX",
  "status": "active",
  "event_type": "upload_shipment_attachment",
  "timestamp": 1694503397,
  "signature": "string",
  "token": "string"
}