API

Sections

Theme switcher

/marketing_carriers/{marketing_carrier_id}

To view all the meta data for a specific carrier (e.g. when onboarding a new one), please use this endpoint and save the data in your system for display upon relevant user searches.

For details about how this endpoint fits into the flow, check the Preparing Metadata step.

Header Parameters

api-keystring Required

Set your API key. To request a demo API key please reach out to us at partner@distribusion.com. Reference value: ZW8FXhnBl53yTkrMvoqLp4Xq7mf9nEBGsxpTWrid.

Query Parameters

localestring Required

Set the language for the content of the response. The field accepts ISO 639 language codes. If the content in the specified language is unavailable, English will be returned. For more details check our Languages guide. Reference value: en.

currencystring Required

Set the currency of all monetary results in the response. The field accepts ISO 4217 currency codes. For more details check our Currencies guide. Reference value: EUR.

Path Parameters

marketing_carrier_idstring Required

Search for a specific carrier code. Use the value retrieved from /marketing_carriers response. Reference value: TREN.

Response

200 (carrier details)
Object
Successful response with marketing carrier details

Response Attributes

dataobject

Show child attributes

jsonapiobject

Show child attributes

metaobject

Show child attributes

includedarray

Show child attributes

400 (invalid carrier)
Object
Error response: carrier invalid or missing

Response Attributes

errorsarray

Show child attributes

jsonapiobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot