/sequences

post

https://api.dev.orbit.do/v5/sequences

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

sequence to create

status

string

enum

required

Allowed:

sequenceBricks

array of strings

required

length between 3 and 3

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).

sequenceBricks*

name

object

Localized text keyed by language code ('en', 'de'), e.g. { en: 'Euro Pallet', de: 'Europalette' }.

description

object

Optional localized text keyed by language code ('en', 'de'); resolves to undefined when omitted.

properties

object

Key-value pairs in the dictionary have property IDs as keys. Property keys and their values appear only when the property value is explicitly set. All property values are validated against their definitions - requests with unknown property IDs or invalid value types will be rejected with a 400 error.

Responses

400

bad request

401

unauthorized

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200created sequence