Fleet setup

Orders

Order management

Fetch a list of Orders

GET

https://demo.traccar.org/api/orders

Without params, it returns a list of Orders the user has access to

Fetch a list of Orders

curl -X GET 'https://demo.traccar.org/api/orders' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/orders', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/orders',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

[
  {
    "id": 0,
    "uniqueId": "string",
    "description": "string",
    "fromAddress": "string",
    "toAddress": "string",
    "attributes": {}
  }
]

Parameters

allbooleanquery

Can only be used by admins or managers to fetch all entities

userIdintegerquery

Standard users can use this only with their own userId

excludeAttributesbooleanquery

Skip returning the attributes map

limitintegerquery

Limit the number of returned results

offsetintegerquery

Offset for pagination

keywordstringquery

Search keyword filter

Response

200OKArray<Order>

Response fields application/json

Array<Order>

Show child attributes

idinteger<int64>

Unique order identifier

uniqueIdstring

External order identifier used by clients

descriptionstring

Additional details about the order assignment

fromAddressstring

Pickup location address

toAddressstring

Destination address

attributesobject

Custom order attributes

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Create an Order

POST

https://demo.traccar.org/api/orders

Create an Order

curl -X POST 'https://demo.traccar.org/api/orders' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "uniqueId": "string",
  "description": "string",
  "fromAddress": "string",
  "toAddress": "string",
  "attributes": {}
}'

const body = `{
  "id": 0,
  "uniqueId": "string",
  "description": "string",
  "fromAddress": "string",
  "toAddress": "string",
  "attributes": {}
}`;

const response = await fetch('https://demo.traccar.org/api/orders', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "uniqueId": "string",
  "description": "string",
  "fromAddress": "string",
  "toAddress": "string",
  "attributes": {}
}'''

response = requests.post(
    'https://demo.traccar.org/api/orders',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "uniqueId": "string",
  "description": "string",
  "fromAddress": "string",
  "toAddress": "string",
  "attributes": {}
}

200

{
  "id": 0,
  "uniqueId": "string",
  "description": "string",
  "fromAddress": "string",
  "toAddress": "string",
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique order identifier

uniqueIdstring

External order identifier used by clients

descriptionstring

Additional details about the order assignment

fromAddressstring

Pickup location address

toAddressstring

Destination address

attributesobject

Custom order attributes

Response

200OKOrder

Response fields application/json

idinteger<int64>

Unique order identifier

uniqueIdstring

External order identifier used by clients

descriptionstring

Additional details about the order assignment

fromAddressstring

Pickup location address

toAddressstring

Destination address

attributesobject

Custom order attributes

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch an Order

GET

https://demo.traccar.org/api/orders/{id}

Fetch an Order

curl -X GET 'https://demo.traccar.org/api/orders/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/orders/0', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/orders/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

{
  "id": 0,
  "uniqueId": "string",
  "description": "string",
  "fromAddress": "string",
  "toAddress": "string",
  "attributes": {}
}

Parameters

idintegerrequiredpath

Response

200OKOrder

Response fields application/json

idinteger<int64>

Unique order identifier

uniqueIdstring

External order identifier used by clients

descriptionstring

Additional details about the order assignment

fromAddressstring

Pickup location address

toAddressstring

Destination address

attributesobject

Custom order attributes

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Update an Order

PUT

https://demo.traccar.org/api/orders/{id}

Update an Order

curl -X PUT 'https://demo.traccar.org/api/orders/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "uniqueId": "string",
  "description": "string",
  "fromAddress": "string",
  "toAddress": "string",
  "attributes": {}
}'

const body = `{
  "id": 0,
  "uniqueId": "string",
  "description": "string",
  "fromAddress": "string",
  "toAddress": "string",
  "attributes": {}
}`;

const response = await fetch('https://demo.traccar.org/api/orders/0', {
  method: 'PUT',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "uniqueId": "string",
  "description": "string",
  "fromAddress": "string",
  "toAddress": "string",
  "attributes": {}
}'''

response = requests.put(
    'https://demo.traccar.org/api/orders/0',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "uniqueId": "string",
  "description": "string",
  "fromAddress": "string",
  "toAddress": "string",
  "attributes": {}
}

200

{
  "id": 0,
  "uniqueId": "string",
  "description": "string",
  "fromAddress": "string",
  "toAddress": "string",
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique order identifier

uniqueIdstring

External order identifier used by clients

descriptionstring

Additional details about the order assignment

fromAddressstring

Pickup location address

toAddressstring

Destination address

attributesobject

Custom order attributes

Parameters

idintegerrequiredpath

Response

200OKOrder

Response fields application/json

idinteger<int64>

Unique order identifier

uniqueIdstring

External order identifier used by clients

descriptionstring

Additional details about the order assignment

fromAddressstring

Pickup location address

toAddressstring

Destination address

attributesobject

Custom order attributes

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Delete an Order

DELETE

https://demo.traccar.org/api/orders/{id}

Delete an Order

curl -X DELETE 'https://demo.traccar.org/api/orders/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/orders/0', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://demo.traccar.org/api/orders/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Parameters

idintegerrequiredpath

Response

204No Content

No Content

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Docs by Sourcey