Get transporter collection

GET

/rest/v1/transporter

Parameters

Query Parameters

filter[id]

Filter by transporter IDs

Type

string

filter[slug]

Filter by slug (partial)

Type

string

filter[active]

Filter by active status

Type

string

filter[hasVouchers]

Filter by voucher support

Type

string

filter[sendWeight]

Filter by weight sending

Type

string

filter[eshopCalculatedCost]

Filter by eshop calculated cost

Type

string

filter[name.{locale}]

Filter by translated name (partial)

Type

string

sort

Sort order

Type

string

page

Page number

Type

integer

limit

Pagination limit

Type

integer

with

Comma-separated relations: translations, settings, pricing, optionPricing, postAvailabilities, postPricing, countyAvailabilities, publicMappings. Reads are guest-accessible, but every relation except translations is backend-only — for a guest or customer caller it is silently stripped and the request still returns 200. settings in particular carries courier integration credentials. Per-relation language scoping is supported: translations[el], translations[el,en].

Type

string

Responses

Successful operation

Content-Type

application/json

"string"

GET

/rest/v1/transporter

Playground

Variables

Key

Value

filter[id]

filter[slug]

filter[active]

filter[hasVouchers]

filter[sendWeight]

filter[eshopCalculatedCost]

filter[name.{locale}]

sort

page

limit

with

Samples

Powered by VitePress OpenAPI