Get optional additional services by service

Lists the optional additional services configured for one carrier service (services.id). Returns one catalog row per additional service, ordered by name. Mandatory add-ons are excluded. A private add-on is returned only when it is enabled for the company of the token. Price, currency, operator, and company custom-amount fields are not included. Requires a user Bearer token. The body is a JSON array, not an object wrapped in data.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

When to use this endpoint

Use GET /additional-services/service/{service_id} when you already know the carrier service (services.id) and need the optional add-ons a shipper can select for it.

Typical uses:

  • Build the add-on checklist (insurance, signature, cash on delivery, and so on) after the shipper picks a service.
  • Show translated names with translation_tag and tooltip_translation_tag.

The response is catalog data only. It does not include price, currency, operator, or company custom amounts.

Base URLs (Queries API)

EnvironmentBase URL
Sandboxhttps://queries.test.envia.com/
Productionhttps://queries.envia.com/

Authentication

Authorization: Bearer <user_token>

The route requires a user token (token_user). A missing or invalid token returns 401.

Request

curl --request GET \
  --url "https://queries.test.envia.com/additional-services/service/88" \
  --header "Authorization: Bearer $ENVIA_TOKEN"
ParameterInTypeRequiredDescription
service_idpathintegerYesCarrier service id (services.id). Integer of at least 1.

Response

200 returns a JSON array. It is not wrapped in { "data": ... }.

Rows are ordered by additional-service name. Several price tiers for the same add-on collapse into one catalog row.

FieldTypeDescription
service_idintegerCarrier service id from the path.
idintegerAdditional service id. Use it when quoting or creating a label.
namestringAdditional service name.
descriptionstringAdditional service description.
translation_tagstringTranslation key for the name.
tooltip_translation_tagstring or nullTranslation key for the tooltip. Null when the catalog has no tooltip.
[
  {
    "service_id": 88,
    "id": 4,
    "name": "insurance",
    "description": "Optional insurance",
    "translation_tag": "additional.insurance",
    "tooltip_translation_tag": "additional.insurance.tooltip"
  }
]

[] means that service has no optional add-ons this company can use. That includes an unknown or inactive service, and a service whose only add-ons are private and not enabled for the company of the token.

What is included

A row is returned only when all of the following are true:

  • The additional service is active and visible.
  • The carrier service is active.
  • There is an active price row linking that add-on to the service.
  • The price row is not mandatory (mandatory is false).
  • The price row is not private, or the add-on is private and enabled for the company of the token.

What is omitted

  • Mandatory add-ons.
  • Private add-ons that are not enabled for the company of the token.
  • amount, currency, operation_id, minimum_amount, and company custom amounts.

Errors

HTTPWhen
400service_id is missing, not a number, or less than 1.
401The Authorization header is missing or is not a valid user token.
{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "\"service_id\" must be greater than or equal to 1"
}

Related endpoints

EndpointUse it for
GET /additional-servicesThe full additional-service catalog.
GET /additional-services/{country_code}/{international}/{shipment_type_id}Additional services for a country, international flag, and shipment type.
Path Params
integer
required
≥ 1

Carrier service id (services.id). Must be an integer of at least 1.

Responses

401

Missing or invalid user Bearer token.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json