Skip to main content
GET
List shipping service groups

Authorizations

Authorization
string
header
required

Access token from POST /v2/oauth2/token, requested with an API credential. See https://api-docs.quivo.co/api-reference/authentication.

Query Parameters

showDeleted
boolean

If true, includes deleted items in the response. Default: false.

query
string

Elasticsearch query string: field:value, joined with AND by default; AND/OR/NOT in upper case; quotes around values with spaces, / or :; * wildcards; ranges like priority:[1 TO 5]; exists:field. A condition on a wrong field name matches nothing and gives no error, so OR still returns the other matches and NOT drops nothing, which widens the result. Guide: https://api-docs.quivo.co/docs/quivo-guides/using-queries. Fields include: shippingServiceGroupId, shippingServiceGroupName, sellerIds, pickupSupported, priority, shippingService.shippingServiceCarrierSlug, shippingService.shippingServiceMode. Examples: shippingService.shippingServiceMode:RETURN; shippingServiceGroupName:"DHL Return".

sort
string

Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').

page
integer<int64>

The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.

searchAfter
string

Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.

pageSize
integer<int64>

The maximum number of items to return per page. Used for both offset and cursor-based pagination.

Response

Returns an array of shipping service groups with service and coverage details.

name
string

The name of the item

pickupSupported
boolean

Boolean flag indicating pickup supported

id
integer<int64>

The unique identifier for the id

deletedAt
string<date-time>

The deleted at timestamp

carrierSlugs
string[]

Carrier identifier or information

shippingServices
string[]

Service identifier or information

shippingServiceIds
integer<int64>[]

The unique identifier for the shippingservices

shipmentContentTypes
enum<string>[]

The type or category of the shipment content s

Available options:
NON_DOCUMENT,
DOCUMENT
additionalParcelsSupported
boolean

Boolean flag indicating additional parcels supported

sort
object

The

serviceModes
enum<string>[]

Service identifier or information

Available options:
RETURN,
EXPORT,
IMPORT,
CROSS_TRADE