Skip to content
Courier docs

The merchant's own deliveries, newest first.

GET
/v1/jobs
curl --request GET \
  --url 'https://courierapi.itdlogisoft.co.uk/v1/jobs?page=1&size=50' \
  --header 'Authorization: Basic <credentials>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
status
string
from
string format: date-time
to
string format: date-time
page
integer | string format: int32
default: 1 /^-?(?:0|[1-9]\d*)$/
size
integer | string format: int32
default: 50 /^-?(?:0|[1-9]\d*)$/

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

A page of the merchant’s own deliveries.

Paged rather than “everything since we started”, because the answer to “what have I booked” grows without limit and a busy kitchen would be asking for a year of it every time.

object
items
required
Array<object>

A delivery as it appears in a merchant’s list.

Lighter than JobDetailResponse on purpose. The contact names and phone numbers a merchant sent belong on the one they asked for, not on fifty they are scrolling past — a list endpoint is the easiest place in an API to hand somebody a spreadsheet of their own customers’ telephone numbers without meaning to.

object
id
required
string
reference
required
string
status
required
string
currency
required
string
price_amount_minor
required
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
vehicle
required
string
pickup_address
required
string
dropoff_address
required
string
booked_at
required
string format: date-time
scheduled_for
required
null | string format: date-time
assigned_at
required
null | string format: date-time
completed_at
required
null | string format: date-time
total
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
page
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
size
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/

Example generated

{
  "items": [
    {
      "id": "example",
      "reference": "example",
      "status": "example",
      "currency": "example",
      "price_amount_minor": 1,
      "vehicle": "example",
      "pickup_address": "example",
      "dropoff_address": "example",
      "booked_at": "2026-04-15T12:00:00Z",
      "scheduled_for": "2026-04-15T12:00:00Z",
      "assigned_at": "2026-04-15T12:00:00Z",
      "completed_at": "2026-04-15T12:00:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "size": 1
}

401

Section titled “401”

Unauthorized

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json

The shape of every refusal from this API.

string ApiError.Code is stable and machine-readable; string ApiError.Message is for a human reading a log and may change without notice. Integrators are told to branch on the code.

object
code
required
string
message
required
string

Example generated

{
  "code": "example",
  "message": "example"
}