Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Return portals

List all return portals

Returns a list of return portals.

get/return_portals

Query parameters

idinteger

ID for the return portal.

activeboolean

Filters for whether or not the return portal is active

per_pageinteger

For pagination. Defines how many entries are returned per page.

pageinteger

For pagination. Defines which page the results are fetched from.

Response

Successful.

idinteger

ID of the return portal.

activeboolean

Whether the return portal is active and ready to use.

portal_namestring

Last part of the URL to access the return portal: https://return.shipmondo.com/{portal_name}

carrier_codestring

Carrier code for the carrier that is setup to the return portals.

Example response

[
  {
    "id": 43,
    "portal_name": "mitfirma",
    "carrier_code": "gls"
  }
]