API Reference
Log In
API Reference

/orders

post
https://api.dev.orbit.do/v5/orders
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to create an order, one or more shipments and optionally tours. Order can be priced automatically or pre-priced and can optinally need payment info to be processed.

string

Optional human-facing label for the order; the internal id is generated regardless.

string

The customer's own reference number for this order.

string

Customer-facing comment on the order.

string

Operator-only internal comment on the order.

payment
string

A voucher/discount code to apply to the order's pricing, if any.

shipments
array
required

The shipment groups (with their tour-creation layout) to create under this order.

shipments*
string
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.

string

Internal Product id (UUID) to price this order against.

number

Epoch-seconds timestamp at which to evaluate the product's pricing, pinning the pricing version.

lineItems
array of objects
lineItems
brickMessages
array of objects
brickMessages
metrics
array of objects
metrics
priceStrategy
required

How the order is priced: calculate-fare prices it from a Product, pre-priced accepts caller-supplied line items verbatim.

transactions
array of objects

Payments already captured outside Orbit, recorded against the order by provider transaction/payment-intent id.

transactions
string
enum
required

The initial order status to record (external callers set this explicitly rather than having it derived).

Allowed:
customer
object
required

The booking customer for the order.

invoiceRecipient
object
required

The party billed for the order; often the same as customer.

Responses

400

bad request

401

unauthorized

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?