Segments

PreviousSecurity Protocols NextAssign

Last updated 1 year ago

Partially update a segment

PATCHhttps://api.dashdoc.eu/api/v4/segments/{uid}/

Path parameters

uid*string

remote_idstring

If you choose to identify an object with its remote_id instead of its uid then

replace the uid value with the remote_id value in the URL
specify lookup_field=remote_id in the query parameters

Query parameters

Body

remote_idstring

The id of the segment in your system.

origin*CreateOrUpdateSite_1 (object)

destinationCreateOrUpdateSite_1 (object)

vehicleVehicleForSegment (object)

trailersarray of TrailerForSegment (object)

trucker_idUpdateSegment_trucker_id (object)

scheduled_start_rangeUpdateSegment_scheduled_start_range (object)

The scheduled date and time range of arrival at the origin (ISO 8601)

scheduled_end_rangeUpdateSegment_scheduled_end_range (object)

The scheduled date and time range of arrival at the destination (ISO 8601)

Response

Update successful

Body

uidstring

remote_idstring

originSite (object)

destinationSite (object)

truckerSegmentTrucker (object)

vehicleVehicle (object)

trailersarray of Trailer (object)

sort_ordernumber

The index of the segment in the transport

Example: 0

scheduled_start_rangeSegment_scheduled_start_range (object)

The datetime range at which the carrier scheduled the start of this segment

scheduled_end_rangeSegment_scheduled_end_range (object)

The datetime range at which the carrier scheduled the end of this segment

child_transportSegment_child_transport (object)

If the segment is chartered, will contain the child transport

telematic_distanceinteger

Automatically computed distance from telematic data (in kms).

distanceinteger

Manually entered distance. If null, it takes the value of telematic_distance (in kms).

origin_mileageinteger

Mileage at transport origin site (in kms).

destination_mileageinteger

Mileage at transport destination site (in kms).

Request

const response = await fetch('https://api.dashdoc.eu/api/v4/segments/{uid}/', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "origin": {}
    }),
});
const data = await response.json();

Response

{
  "uid": "text",
  "remote_id": "text",
  "origin": {
    "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
    "remote_id": "text",
    "address": {
      "pk": 23498,
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "created_by": {
        "pk": 25,
        "name": "Transport Bouvet"
      },
      "created_by_user": {
        "pk": 34,
        "display_name": "Jean Pierre Bouvet",
        "company": 25,
        "trucker_id": 95
      },
      "created": "2020-12-22T15:31:39.26167Z",
      "instructions": "text",
      "remote_id": "text",
      "company": {
        "pk": 928,
        "remote_id": "text",
        "created": "2020-07-30T21:10:06.445510Z",
        "updated": "2020-07-30T21:10:06.44551Z",
        "deleted": false,
        "invoicing_remote_id": "COMP_456",
        "name": "Transport Bouvet",
        "phone_number": "0601020304",
        "email": "i.love.dashdoc@gmail.com",
        "siren": "123456789",
        "trade_number": "text",
        "country": "FR",
        "comments": "text",
        "vat_number": "text",
        "is_verified": false,
        "settings_transport_order_observations": "text",
        "settings_constrain_reference_edition": false,
        "account_type": "text",
        "logo": "text",
        "primary_address": {
          "pk": "text",
          "name": "Transport Bouvet",
          "address": "3 rue des champs",
          "city": "Nantes",
          "postcode": "44000",
          "country": "FR",
          "latitude": -52.5561625,
          "longitude": 92.896504,
          "coords_validated": false,
          "is_demo": false,
          "is_carrier": false,
          "is_shipper": false,
          "is_origin": false,
          "is_destination": false,
          "created_by": 0,
          "created": "2020-07-30T21:10:06.44551Z",
          "instructions": "text",
          "remote_id": "text"
        },
        "managers": [
          {
            "pk": 928,
            "user": {
              "email": "adele.bouvet@gmail.com",
              "first_name": "Adèle",
              "last_name": "Bouvet"
            },
            "display_name": "text",
            "role": "text"
          }
        ],
        "has_loggable_managers": false
      }
    },
    "real_start": "2020-12-22T15:31:39.26167Z",
    "real_end": "2020-12-22T15:31:39.26167Z",
    "signature_process": "sign_on_glass",
    "instructions": "text",
    "reference": "text",
    "action": "text",
    "eta": "text",
    "eta_tracking": false,
    "punctuality_status": "untracked",
    "supports_exchanges": {
      "uid": "123e4567-e89b-12d3-a456-426614174000",
      "site": {
        "uid": "123e4567-e89b-12d3-a456-426614174000",
        "remote_id": "text"
      },
      "support_type": {
        "name": "Palettes",
        "created": "2020-12-22T15:31:39.26167Z",
        "uid": "c8e4cc62-446a-11eb-a759-0242ac130005",
        "remote_id": "text"
      },
      "expected_retrieved": 10,
      "actual_retrieved": 10,
      "expected_delivered": 10,
      "actual_delivered": 10,
      "observations": "1 broken",
      "remote_id": "text"
    },
    "category": "loading",
    "slots": [
      {
        "start": "2024-10-08T18:05:49.788Z",
        "end": "2024-10-08T18:05:49.788Z"
      }
    ],
    "trucker_instructions": "text"
  },
  "destination": {
    "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
    "remote_id": "text",
    "address": {
      "pk": 23498,
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "created_by": {
        "pk": 25,