/api/postal-services/

get

https://headless-api.pre.reboundplatform.com/api/postal-services/

Retrieves the postal services applicable to a given return order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

returnOrderId

string

required

Identifier of the return order.

address

object

Address information to use for retrieving drop-off points; if not provided the contact information of the return order is used instead.

searchRadius

int32

Defaults to 2000

Search radius for drop-off points, in meters. Only applicable when the drop-off locator feature is enabled.

language

string

ISO 639-1 code of the language to use for the postal service descriptions; if not provided the contact information of the return order is used instead, or English if not available.

page

integer

≥ 0

Defaults to 0

Zero-based page index (0..N)

size

integer

≥ 1

Defaults to 50

The size of the page to be returned

sort

array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort

Responses

400

Invalid data supplied for postal service search request.

401

Invalid or missing authentication data.

403

Credentials provided are insufficient to access the resource or there is no portal associated.

404

Return order not found.

406

Requested media type is not supported.

415

Media type of the request is not supported.

200The postal services.