/shipments

post https://api-dev.orbit.do/v5/shipments

Responses

Response body

object

shipments

array of objects

required

shipments*

object

string

required

tenant

string

required

region

string

required

pickup

object

required

dropoff

object

required

status

string

required

Unrouted Routed EnroutePickup EnrouteDropoff WaitingForReview Delivered Failed Cancelled

startTime

number

required

≥ 0

loads

array of objects

required

loads*

object

string

type

string

required

length

number

required

width

number

required

height

number

required

totalWeight

number

required

count

number

required

≥ 1

isStackable

boolean

loadReference

string

description

string

dangerousGood

object

extras

array

required

extras*

displayName

string | null

comment

string | null

internalComment

string | null

tour

string

required

tourDisplayName

string | null

tourDetails

object | null

formerTours

array of objects

required

formerTours*

object

tour

string

required

pickupStop

number

required

dropoffStop

number

required

order

string

createdAt

number

required

updatedAt

number

required

source

liveTrackingKey

string

netGoodsValue

number | null

properties

object | null

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. The dictionary doesn't have default values, so retrieved property values are always undefined by default. Note: Data is stored even if the property definition doesn't exist. If there's no property definition, values won't be displayed on the frontend but can still be present in the dictionary.

Has additional fields

shopId

string

shipperId

string

shipperTeamId

string

shipperUserId

string

tour

object

string

required

tenant

string

required

region

string

required

carrier

string

required

carrierTeamId

string

driver

string

vehicle

string

device

string

status

string

required

Unassigned Assigned Running WaitingForReview Completed Cancelled

substatus

object | null

carrierFilter

string

Upcoming Completed

latestStart

number

required

≥ 0

loads

array of objects

required

loads*

object

string

type

string

required

length

number

required

width

number

required

height

number

required

totalWeight

number

required

count

number

required

≥ 1

isStackable

boolean

loadReference

string

description

string

dangerousGood

object

shipmentId

string

pickupStop

number

required

dropoffStop

number

required

stops

array of objects

required

stops*

object

address

object

required

timeFrom

number

required

timeTo

number

required

expectedWaitingTime

number

required

loggedArrivalTime

number | null

loggedDepartureTime

number | null

note

string | null

pickupDocuments

array of objects

pickupDocuments

object

description

string

required

key

string

required

timestamp

number

required

proofDocuments

array of objects

proofDocuments

object

type

string

required

Document Photo Signature

key

string

required

timestamp

number

required

proofRequirements

array of strings

proofRequirements

carrierComments

array of objects

carrierComments

object

content

string

required

timestamp

number

required

author

string

required

loads

array of numbers

required

loads*

liveTrackingKey

string

failedReason

string | null

displayName

string

comment

string

internalComment

string

timingGuide

object

required

distance

number

required

extras

array of objects

required

extras*

object

type

required

calculationType

string

required

Constant Percent

amount

number

required

price

number

required

vehicleClass

string

required

vehicleClassName

string

required

createdAt

number

required

updatedAtMilliseconds

number

source

startedAt

number

finishedAt

number

liveTrackingKey

string

sequenceInvocation

string

properties

object

Has additional fields

loadPlan

object

carrierTerms

object

lineItems

array of objects

lineItems

object

type

string

required

base item discount

subtype

string

required

amount

number

required

amountType

string

percentage fixed

voucher

string

vatPercentage

number

required

name

string

required

count

number

required

productId

string

productValidAt

number

pricingInfo

object

400

bad request

401

unauthorized

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-dev.orbit.do/v5/shipments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200created shipments and optionally the created tour