Skip to main content
Skip table of contents

Detail of Carrier

Get Carrier

Retrieve details of a carrier using its unique ID.

To obtain a specific ID, use the POST /api/carrier/list endpoint with the appropriate filters.

 

Request structure

Endpoint:

GET /api/carrier/{id}

URL (prod):

https://app.mailship.eu/api/carrier/{id}

Headers:

CODE
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Request body:

None (this request does not require a body).

Request Example (cURL):

CODE
curl --location 'https://app.mailship.eu/api/carrier/de3475bd-b8f9-446b-8d00-8e75e1504665' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'

Path parameter:

Parameter

Type

Required

Description

id

string

The unique carrier identifier. Example: de3475bd-b8f9-446b-8d00-8e75e1504665

 

Response

If successful, the API returns the carrier entity matching the specified ID in JSON format.

See more details in the API Doc.


Get Carrier by Code

Retrieve details of a carrier using its code.

To obtain a specific code, use the previous endpoint.

Request structure

Endpoint:

GET /api/code/{code}

URL (prod):

https://app.mailship.eu/api/carrier/{id}

Headers:

CODE
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Request body:

None (this request does not require a body).

Request Example (cURL):

CODE
curl --location 'https://app.mailship.eu/api/carrier/code/859' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'

Path parameter:

Parameter

Type

Required

Description

id

string

The carrier code. Example: 859

 

Response

If successful, the API returns the carrier entity matching the specified ID in JSON format.

See more details in the API Doc.


Get Carrier Service

Retrieve details of a carrier service using its unique ID.

To obtain a specific ID of carrier service, use the GET /api/carrier/{id} - you will see the carrier service IDs in the response.

Request structure

Endpoint:

GET /api/carrier-service/{id}

URL (prod):

https://app.mailship.eu/api/carrier-service/{id}

Headers:

CODE
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Request body:

None (this request does not require a body).

Request Example (cURL):

CODE
curl --location 'https://app.mailship.eu/api/carrier-service/0ae68d68-6c87-4954-a2db-926d1743275a' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'

Path parameter:

Parameter

Type

Required

Description

id

string

The unique carrier service identifier. Example: 0ae68d68-6c87-4954-a2db-926d1743275a

 

Response

If successful, the API returns the carrier service entity matching the specified ID in JSON format.

See more details in the API Doc.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.