API

Sections

Theme switcher

/connected_stations

This endpoint can be used to retrieve all station pairs that are available in Distribusion’s database as bookable origin-destination combinations. Requests to this endpoint can be filtered to identify connected station pairs for one or multiple marketing carriers. This endpoint is paginated.

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.

page[size]integer

Set the max number of connected stations to appear in the response. Reference value: 1000 (max value supported 10000).

page[after]string

Set the station pair. If a response is over 10000 results long, it includes a links.next parameter which specifies the link that should be inserted in page[after] for the subsequent request to proceed to the next page. Reference value: ATGRZGPR-BEANREPQ.

filter[marketing_carrier_codes][]string

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

Response

200 (partial response)
Object
Successful partial response with 1 connected station

Response Attributes

idstring
typestring
relationshipsobject

Show child attributes

Successful response with link to next page

Response Attributes

dataarray

Show child attributes

jsonapiobject

Show child attributes

linksobject

Show child attributes

includedarray

Show child attributes

200 (no connected stations)
Object
Successful response with no connected stations

Response Attributes

dataarray
jsonapiobject

Show child attributes

includedarray
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