/sequences

Create a sequence, either in the simple form (way: assign the tour to one carrier, or offer it to the carriers matching a filter) or from three bricks (sequenceBricks: one select, one score and one distribute brick). Send exactly one of the two. The response is the stored sequence, with its summary; a simple one has sequenceBricks: [].

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

sequence to create

string
enum
required

Whether this sequence is available for dispatch.

Allowed:
sequenceBricks
array of strings

The advanced form: the three distinct SequenceBrick ids composing this sequence, a select brick (filters carriers), a score brick (ranks them) and a distribute brick (sends the offers). Omit it, or send an empty list, when the request has way.

sequenceBricks
name
object
required

Localized sequence name ({ en?, de? }); at least one language must be non-empty.

description
object

Optional localized explanation shown to operators.

properties
object

Custom sequence properties used by queries.

appliesTo
object

Optional tour rule group that must match before this sequence is considered. Omit it to apply to every tour; an empty group is treated as omitted.

way

The simple form of a Sequence: how the tour is handed out. 'assign' gives it to one carrier; 'marketplace' sends it to every active carrier matching a filter, as an Instant offer or an Auction. Orbit compiles it into the select, score and distribute bricks of the advanced form when the Sequence runs and never stores them, so a simple Sequence runs like the equivalent advanced one. A Sequence has either way or three sequenceBricks. The way type 'cheapest' is planned once ORB-3007 is done and is not accepted yet.

integer
1 to 9007199254740991

Positive integer that orders this sequence in automatic dispatch; sequences without a rank are not in the dispatch chain.

Responses

401

unauthorized

403

The role of the API key does not allow this action. The key needs a role with the matching permission, for example full access.

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