Addresses

Addresses list

get
Authorizations
Query parameters
pageintegerOptional

A page number within the paginated result set.

is_carrierbooleanOptional
is_shipperbooleanOptional
is_originbooleanOptional
is_destinationbooleanOptional
category__instringOptional

Comma separated values

Example: origin,destination
Responses
200
Get successful
application/json
get
GET /api/v4/addresses/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
200

Get successful

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 23498,
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "radius": 500,
      "coords_validated": false,
      "is_demo": true,
      "is_carrier": true,
      "is_shipper": true,
      "is_origin": true,
      "is_destination": true,
      "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": true,
        "invoicing_remote_id": "COMP_456",
        "name": "Transport Bouvet",
        "phone_number": "0601020304",
        "email": "[email protected]",
        "siren": "123456789",
        "trade_number": "text",
        "country": "FR",
        "comments": "text",
        "vat_number": "text",
        "is_verified": true,
        "settings_transport_order_observations": "text",
        "settings_constrain_reference_edition": true,
        "account_type": "text",
        "logo": "text",
        "subscription_access": {},
        "settings": {},
        "primary_address": {
          "pk": "text",
          "name": "Transport Bouvet",
          "address": "3 rue des champs",
          "city": "Nantes",
          "postcode": "44000",
          "country": "FR",
          "latitude": -52.5561625,
          "longitude": 92.896504,
          "radius": 500,
          "coords_validated": false,
          "is_demo": true,
          "is_carrier": true,
          "is_shipper": true,
          "is_origin": true,
          "is_destination": true,
          "created_by": 1,
          "created": "2020-07-30T21:10:06.44551Z",
          "instructions": "text",
          "remote_id": "text"
        },
        "managers": [
          {
            "pk": 928,
            "user": {
              "email": "[email protected]",
              "first_name": "Adèle",
              "last_name": "Bouvet"
            },
            "display_name": "text",
            "role": "text"
          }
        ],
        "has_loggable_managers": true
      }
    }
  ]
}

Create an address

post

Add the address to the requester's company contact book. The address belongs to a company that already exists or is created in the same time.

Authorizations
Body
namestring · max: 200Optional

Label for this address

Example: Transport Bouvet
remote_idstringOptional

The id of the address in your system.

Example: COMP_123_ADR_1
addressstring · max: 200Optional

Address not mandatory but strongly advised to fill

Example: 3 rue des champs
citystring · max: 100RequiredExample: Nantes
postcodestring · max: 100RequiredExample: 44000
countrystringOptional

Only the 2-character codification is accepted (ISO 3166-1 alpha-2). Country not mandatory but strongly advised to fill

Example: FR
latitudenumber · floatOptional

Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.

Example: -52.5561625
longitudenumber · floatOptional

Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.

Example: 92.896504
radiusintegerOptional

Radius around the GPS coordinates within which the address is located (in meters)

Default: 500
coords_validatedbooleanOptional

if true, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates

Default: false
is_demobooleanOptional

Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters

is_carrierbooleanOptional
is_shipperbooleanOptional
is_originbooleanOptional
is_destinationbooleanOptional
Responses
201
Create successful
application/json
post
POST /api/v4/addresses/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 410

{
  "name": "Transport Bouvet",
  "remote_id": "COMP_123_ADR_1",
  "address": "3 rue des champs",
  "city": "Nantes",
  "postcode": "44000",
  "country": "FR",
  "latitude": -52.5561625,
  "longitude": 92.896504,
  "radius": 500,
  "coords_validated": false,
  "is_demo": true,
  "is_carrier": true,
  "is_shipper": true,
  "is_origin": true,
  "is_destination": true,
  "company": {
    "pk": 928,
    "remote_id": "COMP_123",
    "trade_number": "12345678901234",
    "name": "Transport Bouvet"
  }
}
201

Create successful

{
  "pk": 23498,
  "name": "Transport Bouvet",
  "address": "3 rue des champs",
  "city": "Nantes",
  "postcode": "44000",
  "country": "FR",
  "latitude": -52.5561625,
  "longitude": 92.896504,
  "radius": 500,
  "coords_validated": false,
  "is_demo": true,
  "is_carrier": true,
  "is_shipper": true,
  "is_origin": true,
  "is_destination": true,
  "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": true,
    "invoicing_remote_id": "COMP_456",
    "name": "Transport Bouvet",
    "phone_number": "0601020304",
    "email": "[email protected]",
    "siren": "123456789",
    "trade_number": "text",
    "country": "FR",
    "comments": "text",
    "vat_number": "text",
    "is_verified": true,
    "settings_transport_order_observations": "text",
    "settings_constrain_reference_edition": true,
    "account_type": "text",
    "logo": "text",
    "subscription_access": {},
    "settings": {},
    "primary_address": {
      "pk": "text",
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "radius": 500,
      "coords_validated": false,
      "is_demo": true,
      "is_carrier": true,
      "is_shipper": true,
      "is_origin": true,
      "is_destination": true,
      "created_by": 1,
      "created": "2020-07-30T21:10:06.44551Z",
      "instructions": "text",
      "remote_id": "text"
    },
    "managers": [
      {
        "pk": 928,
        "user": {
          "email": "[email protected]",
          "first_name": "Adèle",
          "last_name": "Bouvet"
        },
        "display_name": "text",
        "role": "text"
      }
    ],
    "has_loggable_managers": true
  }
}

Delete an address

delete
Authorizations
Path parameters
pknumberRequired
remote_idstringOptional

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

  • replace the pk value with the remote_id value in the URL

  • specify lookup_field=remote_id in the query parameters

Query parameters
lookup_fieldstringOptional

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Responses
204
Empty body
delete
DELETE /api/v4/addresses/{pk}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
204

Empty body

No content

Read an address

get
Authorizations
Path parameters
pknumberRequired

Dashdoc's internal id

remote_idstringOptional

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

  • replace the pk value with the remote_id value in the URL

  • specify lookup_field=remote_id in the query parameters

Query parameters
lookup_fieldstringOptional

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Responses
200
Get successful
application/json
get
GET /api/v4/addresses/{pk}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
200

Get successful

{
  "pk": 23498,
  "name": "Transport Bouvet",
  "address": "3 rue des champs",
  "city": "Nantes",
  "postcode": "44000",
  "country": "FR",
  "latitude": -52.5561625,
  "longitude": 92.896504,
  "radius": 500,
  "coords_validated": false,
  "is_demo": true,
  "is_carrier": true,
  "is_shipper": true,
  "is_origin": true,
  "is_destination": true,
  "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": true,
    "invoicing_remote_id": "COMP_456",
    "name": "Transport Bouvet",
    "phone_number": "0601020304",
    "email": "[email protected]",
    "siren": "123456789",
    "trade_number": "text",
    "country": "FR",
    "comments": "text",
    "vat_number": "text",
    "is_verified": true,
    "settings_transport_order_observations": "text",
    "settings_constrain_reference_edition": true,
    "account_type": "text",
    "logo": "text",
    "subscription_access": {},
    "settings": {},
    "primary_address": {
      "pk": "text",
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "radius": 500,
      "coords_validated": false,
      "is_demo": true,
      "is_carrier": true,
      "is_shipper": true,
      "is_origin": true,
      "is_destination": true,
      "created_by": 1,
      "created": "2020-07-30T21:10:06.44551Z",
      "instructions": "text",
      "remote_id": "text"
    },
    "managers": [
      {
        "pk": 928,
        "user": {
          "email": "[email protected]",
          "first_name": "Adèle",
          "last_name": "Bouvet"
        },
        "display_name": "text",
        "role": "text"
      }
    ],
    "has_loggable_managers": true
  }
}

Partially update an address

patch
Authorizations
Path parameters
pknumberRequired
remote_idstringOptional

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

  • replace the pk value with the remote_id value in the URL

  • specify lookup_field=remote_id in the query parameters

Query parameters
lookup_fieldstringOptional

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Body
namestring · max: 200Optional

Label for this address

Example: Transport Bouvet
remote_idstringOptional

The id of the address in your system.

addressstring · max: 200OptionalExample: 3 rue des champs
citystring · max: 100OptionalExample: Nantes
postcodestring · max: 100OptionalExample: 44000
countrystringOptional

Only the 2-character codification is accepted (ISO 3166-1 alpha-2)

Example: FR
latitudenumber · floatOptional

Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.

Example: -52.5561625
longitudenumber · floatOptional

Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.

Example: 92.896504
radiusintegerOptional

Radius around the GPS coordinates within which the address is located (in meters)

Default: 500
coords_validatedbooleanOptional

if true, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates

Default: false
is_demobooleanOptional

Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters

is_carrierbooleanOptional
is_shipperbooleanOptional
is_originbooleanOptional
is_destinationbooleanOptional
Responses
200
Update successful
application/json
patch
PATCH /api/v4/addresses/{pk}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 368

{
  "name": "Transport Bouvet",
  "remote_id": "text",
  "address": "3 rue des champs",
  "city": "Nantes",
  "postcode": "44000",
  "country": "FR",
  "latitude": -52.5561625,
  "longitude": 92.896504,
  "radius": 500,
  "coords_validated": false,
  "is_demo": true,
  "is_carrier": true,
  "is_shipper": true,
  "is_origin": true,
  "is_destination": true,
  "company": {
    "pk": 928,
    "remote_id": "COMP_123",
    "name": "Transport Bouvet"
  }
}
200

Update successful

{
  "pk": 23498,
  "name": "Transport Bouvet",
  "address": "3 rue des champs",
  "city": "Nantes",
  "postcode": "44000",
  "country": "FR",
  "latitude": -52.5561625,
  "longitude": 92.896504,
  "radius": 500,
  "coords_validated": false,
  "is_demo": true,
  "is_carrier": true,
  "is_shipper": true,
  "is_origin": true,
  "is_destination": true,
  "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": true,
    "invoicing_remote_id": "COMP_456",
    "name": "Transport Bouvet",
    "phone_number": "0601020304",
    "email": "[email protected]",
    "siren": "123456789",
    "trade_number": "text",
    "country": "FR",
    "comments": "text",
    "vat_number": "text",
    "is_verified": true,
    "settings_transport_order_observations": "text",
    "settings_constrain_reference_edition": true,
    "account_type": "text",
    "logo": "text",
    "subscription_access": {},
    "settings": {},
    "primary_address": {
      "pk": "text",
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "radius": 500,
      "coords_validated": false,
      "is_demo": true,
      "is_carrier": true,
      "is_shipper": true,
      "is_origin": true,
      "is_destination": true,
      "created_by": 1,
      "created": "2020-07-30T21:10:06.44551Z",
      "instructions": "text",
      "remote_id": "text"
    },
    "managers": [
      {
        "pk": 928,
        "user": {
          "email": "[email protected]",
          "first_name": "Adèle",
          "last_name": "Bouvet"
        },
        "display_name": "text",
        "role": "text"
      }
    ],
    "has_loggable_managers": true
  }
}
PreviousList of all endpoints for v4NextSecurity Protocol

Last updated

Was this helpful?