Tracking Files

List all tracking files

get
Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
Query parameters
pageintegerOptional

A page number within the paginated result set.

date__instringOptional

A date range to filter the tracking files.

Example: 2024-10-11T23:00:00Z,2024-10-15T23:00:00Z
status__instring ยท enumOptional

A comma separated list of statuses to filter the tracking files.

Example: open,closedPossible values:
transport_uid__instringOptional

A comma separated list of transport uids to filter the tracking files.

Example: 4443d4b6-e165-11ea-a488-0242ac110007,4443d4b6-e165-11ea-a488-0242ac110008
Responses
200

Get successful

application/json
get
/tracking-files/
200

Get successful

Create a tracking file

post
Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
Body
namestringRequired

Name of the tracking file

Example: My tracking file name
shipper_idinteger | nullableRequired

ID of the shipper

Example: 123
start_datestring ยท date-time | nullableOptional

Start date of the tracking file

Example: 2023-10-01T00:00:00Z
end_datestring ยท date-time | nullableOptional

End date of the tracking file

Example: 2023-10-10T00:00:00Z
loading_address_idinteger | nullableOptional

ID of the loading address.

Example: 456
unloading_address_idinteger | nullableOptional

ID of the unloading address

Example: 789
quantity_per_transportnumber ยท float | nullableOptional

Quantity per transport

Example: 100
unitstring ยท enum | nullableOptional

Unit of measurement

Example: kilogramPossible values:
requires_washingbooleanOptional

Indicates if washing is required by default for transports that will be created in this tracking file

Default: falseExample: false
is_multiple_compartmentsbooleanOptional

Indicates if there are multiple compartments by default for transports that will be created in this tracking file

Default: falseExample: false
Responses
post
/tracking-files/
201

Create successful

Delete a given tracking file

delete
Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
Path parameters
uidstringRequired

Unique identifier of the tracking file

Responses
delete
/tracking-files/{uid}/
204

Delete successful

No content

Read a tracking file

get
Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
Path parameters
uidstringRequired

Unique identifier of the tracking file

Responses
200

Get successful

application/json
get
/tracking-files/{uid}/
200

Get successful

Update a given tracking file

patch
Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
Path parameters
uidstringRequired

Unique identifier of the tracking file

Body
namestringRequired

Name of the tracking file

Example: My tracking file name
shipper_idinteger | nullableRequired

ID of the shipper

Example: 123
start_datestring ยท date-time | nullableOptional

Start date of the tracking file

Example: 2023-10-01T00:00:00Z
end_datestring ยท date-time | nullableOptional

End date of the tracking file

Example: 2023-10-10T00:00:00Z
loading_address_idinteger | nullableOptional

ID of the loading address.

Example: 456
unloading_address_idinteger | nullableOptional

ID of the unloading address

Example: 789
quantity_per_transportnumber ยท float | nullableOptional

Quantity per transport

Example: 100
unitstring ยท enum | nullableOptional

Unit of measurement

Example: kilogramPossible values:
requires_washingbooleanOptional

Indicates if washing is required by default for transports that will be created in this tracking file

Default: falseExample: false
is_multiple_compartmentsbooleanOptional

Indicates if there are multiple compartments by default for transports that will be created in this tracking file

Default: falseExample: false
Responses
200

Update successful

application/json
patch
/tracking-files/{uid}/
200

Update successful

Last updated

Was this helpful?