Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Return portals

Retrieve a return portal

Returns the details of a return portal.

get/return_portals/{id}

Path parameters

idinteger required

ID for the return portal to be included in the filter

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"
}