Skip to main content
Delivery driver endpoints let you list, retrieve, create, update, and delete the delivery drivers participating in a tender. All endpoints are served under the base path /paper-channel-bo/v1.
Authentication uses an API key passed in the x-api-key request header. Read operations require the tender-read permission; write operations require tender-write.

​
List delivery drivers for a tender

GET /paper-channel-bo/v1/deliveries-drivers/{tenderCode} Returns a paginated list of all delivery drivers participating in the specified tender. You can optionally filter by FSU status.

​
Path parameters

​
tenderCode
string
required
The unique code of the tender whose drivers you want to list.

​
Query parameters

​
page
integer
default:"0"
Zero-based page number to retrieve.
​
size
integer
default:"5"
Number of items per page.
​
fsu
boolean
When set, filters results to include only FSU drivers (true) or only non-FSU drivers (false). Omit to return all drivers.

​
Response

​
content
DeliveryDriverDTO[]
Array of delivery driver objects on the current page.
​
number
integer
required
Current page number.
​
numberOfElements
integer
required
Number of elements on the current page.
​
size
integer
required
Page size.
​
totalElements
integer
required
Total number of delivery drivers across all pages.
​
totalPages
integer
required
Total number of pages.

​
Response codes

CodeDescription
200OK
400Bad request
401Unauthorized
403Forbidden
404Tender not found
405Method not allowed
500Internal server error

​
Example

curl --request GET \
  --url 'https://<host>/paper-channel-bo/v1/deliveries-drivers/AGD-2024-TE?page=0&size=10' \
  --header 'x-api-key: <your-api-key>'

​
Get driver details

GET /paper-channel-bo/v1/deliveries-drivers/{tenderCode}/detail/{deliveryDriverId} Returns the details of a single delivery driver associated with a specific tender.

​
Path parameters

​
tenderCode
string
required
The unique code of the tender.
​
deliveryDriverId
string
required
The unique identifier of the delivery driver.

​
Response

​
result
boolean
true when the operation succeeded.
​
code
number
Return code. 0 = OK, 99 = KO.
​
driver
object
required
The requested delivery driver.

​
Response codes

CodeDescription
200OK
400Bad request
401Unauthorized
403Forbidden
404Driver or tender not found
405Method not allowed
500Internal server error

​
Example

curl --request GET \
  --url 'https://<host>/paper-channel-bo/v1/deliveries-drivers/AGD-2024-TE/detail/driver-001' \
  --header 'x-api-key: <your-api-key>'

​
Get FSU driver details

GET /paper-channel-bo/v1/deliveries-drivers/{tenderCode}/fsu Returns the details of the FSU (Fornitore Servizio Universale) driver for the specified tender.
Each tender has at most one FSU driver. Use this endpoint as a direct shortcut instead of listing all drivers and filtering by fsu: true.

​
Path parameters

​
tenderCode
string
required
The unique code of the tender.

​
Response

​
result
boolean
true when the operation succeeded.
​
code
number
Return code. 0 = OK, 99 = KO.
​
fsu
object
The FSU delivery driver for this tender.

​
Response codes

CodeDescription
200OK
400Bad request
401Unauthorized
403Forbidden
404FSU or tender not found
405Method not allowed
500Internal server error

​
Example

curl --request GET \
  --url 'https://<host>/paper-channel-bo/v1/deliveries-drivers/AGD-2024-TE/fsu' \
  --header 'x-api-key: <your-api-key>'

​
Create or update a delivery driver

POST /paper-channel-bo/v1/delivery-driver/{tenderCode} Creates a new delivery driver or updates an existing one for the specified tender. Requires the tender-write permission.

​
Path parameters

​
tenderCode
string
required
The unique code of the tender this driver belongs to.

​
Request body

​
businessName
string
required
Company business name (ragione sociale). Maximum 128 characters.
​
taxId
string
required
Company tax ID (Partita IVA), exactly 11 digits.
​
fsu
boolean
required
Set to true to designate this driver as the FSU for the tender.
​
denomination
string
Driver denomination. Maximum 128 characters.
​
registeredOffice
string
Registered office address. Maximum 128 characters.
​
pec
string
PEC (certified email) address. Maximum 64 characters.
​
fiscalCode
string
Italian fiscal code (codice fiscale), 16 characters.
​
phoneNumber
string
Phone number, e.g. +39012345678. Maximum 32 characters.
​
uniqueCode
string
Unique alphanumeric code for the driver. Maximum 32 characters.

​
Response codes

CodeDescription
200OK — driver created or updated
400Bad request
401Unauthorized
403Forbidden
404Tender not found
405Method not allowed
500Internal server error

​
Example

curl --request POST \
  --url 'https://<host>/paper-channel-bo/v1/delivery-driver/AGD-2024-TE' \
  --header 'x-api-key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "businessName": "Poste Italiane SpA",
    "taxId": "97103880585",
    "fsu": true,
    "denomination": "Poste Italiane",
    "registeredOffice": "Viale Europa 190, Roma",
    "pec": "[email protected]",
    "fiscalCode": "97103880585",
    "phoneNumber": "+390665851"
  }'

​
Delete a delivery driver

DELETE /paper-channel-bo/v1/{tenderCode}/delivery-driver/{deliveryDriverId} Permanently removes a delivery driver from a tender. Requires the tender-write permission.
Deletion is irreversible. All costs associated with this driver for the specified tender will also be removed.

​
Path parameters

​
tenderCode
string
required
The unique code of the tender.
​
deliveryDriverId
string
required
The unique identifier of the delivery driver to delete.

​
Response codes

CodeDescription
200Delivery driver deleted successfully

​
Example

curl --request DELETE \
  --url 'https://<host>/paper-channel-bo/v1/AGD-2024-TE/delivery-driver/driver-001' \
  --header 'x-api-key: <your-api-key>'

Build docs developers (and LLMs) love

Get started for freeTalk to us