Available Opendock APIs

Appointments

Retrieve multiple appointments

X

Create a single appointment

X

Retrieve a single appointment by ID

X

Delete a single appointment by ID

X

Update a single appointment by ID

X

Get public appointment by ID

X

Update appointment ETA by ID

X

Undo latest appointment status

X

Create appointment reserve

X

Create recurring appointments by ID

X

Get appointment notification email HTML

X

Add appointment tag

X

Delete appointment tag

X

Retrieve multiple appointments

X

Create a single appointment

X

Retrieve a single appointment by ID

X

Update a single appointment by ID

X

Get public appointment by ID

X

Update appointment ETA by ID

X

Asset container

Create a single asset container

X

Retrieve multiple asset containers

X

Update a single asset container

X

Retrieve a single asset container

X

Delete a single asset container

X

Retrieve a single asset container event

X

Retrieve asset container yard events

X

Create asset container event

X

Retrieve arrival containers for asset visit

X

Asset visit

Create a single asset visit

X

Retrieve multiple asset visits

X

Update a single asset visit

X

Retrieve a single asset visit

X

Delete a single asset visit

X

Create asset visit event

X

Retrieve asset visit yard events

X

Acknowledge asset visit check-in

X

Attach asset container to asset visit

X

Detach asset container from asset visit

X

Link unplanned check-in to appointment

X

Unlink check-in from appointment

X

Audit log

Retrieve audit log by object ID

X

Carrier companies

Retrieve multiple companies

X

Create a single company

X

Retrieve a single company

X

Retrieve multiple companies

X

Create a single company

X

Retrieve a single company

X

Carrier users

Retrieve multiple users

X

Create a single user

X

Carrier booked

X

Carrier preview

X

Retrieve a single user

X

Get carrier settings

X

Get favorite warehouses for carrier

X

Add favorite warehouse for carrier

X

Remove favorite warehouse for carrier

X

Retrieve a single user

X

Custom forms: Data

Create multiple customformdata

X

Update a single customformdata

X

Retrieve a single customform data

X

Delete a single custom form data

X

Create a single custom form data

X

Retrieve multiple custom form data

X

Custom forms: Fields

Create a single field

X

Retrieve multiple fields

X

Update a single field

X

Retrieve a single field

X

Delete a single field

X

Custom forms: Flows

Create a single flow

X

Retrieve multiple flows

X

Update a single flow

X

Retrieve a single flow

X

Delete a single flow

X

Custom forms: Form fields

Create a single form field

X

Retrieve multiple form fields

X

Update a single form field

X

Retrieve a single form field

X

Delete a single form field

X

Custom forms: Forms

Create form

X

List forms

X

Update form

X

Retrieve form

X

Delete form

X

Sort form fields

X

Custom forms: Triggers

Update custom forms for load types

X

Create custom forms for load types

X

Create a single trigger

X

Retrieve multiple triggers

X

Update a single trigger

X

Delete a single trigger

X

Retrieve a single trigger

X

Docks

Create a single dock

X

Retrieve multiple docks

X

Update a single dock

X

Delete a single dock

X

Sort docks

X

Compute dock availability

X

Get dock availability

X

Compute dock open dates

X

Creates a child capacity dock linked to the docl

X

Unlink a child capacity dock from its parent dock

X

Retrieve multiple docks

X

Retrieve a single dock

X

Compute dock availability by ID

X

Get dock availability by ID

X

Compute dock open dates

X

Gates

Retrieve gates by warehouse

X

Load types

Create a single load type

X

Retrieve multiple load types

X

Delete a single load type

X

Retrieve a single load type

X

Update a single load type

X

Get load type availability

X

Get appointment count by warehouse

X

Retrieve multiple load types

X

Retrieve a single load type

X

Get load type availability by ID

X

Metrics

Appointment volume by load type and week day

X

Appointment volume by time of day

X

Appointment volume by date

X

Appointment volume by carrier

X

Appointment duration average by load type

X

Appointment duration average by dock and day of week

X

Appointment duration average by status

X

Appointment duration average by dock and status

X

Average time spent in each appointment status

X

Retrieve appointment list file link

X

Retrieve yard data file link

X

Retrieve warehouse dock capacity usage

X

Retrieve warehouse insights

X

Carrier status percentages

X

Dock dwell time by day of week

X

Appointment count per dock

X

Appointment count per carrier

X

Appointment count by status for current carrier

X

Reserve count for user

X

Next available appointment times by load type

X

Retrieve appointment list v2

X

Observations

Retrieve multiple observations

X

Retrieve a single observation

X

Create asset visit for observation

X

Orgs

Retrieve a single org

X

Update a single org

X

Create report search

X

Retrieve report search

X

Update report search

X

Delete report search

X

Update favorite carriers

X

Update custom tags

X

Retrieve a single org

X

SAML

Retrieve SAML config

X

Update SAML config

X

Delete SAML config

X

Retrieve SAML metadata URL

X

SAML AC trigger

X

SAML login redirect

X

Retrieve SAML metadata by org

X

Search

Search appointments

X

Settings metadata

Retrieve settings metadata by entity type

X

Retrieve settings metadata by entity type and key

X

Validate settings metadata for entity type

X

Storage

Storage

X

Storage

X

Users

Invite a user

X

Retrieve a single user

X

Delete a single user

X

Update a single user

X

Retrieve multiple users

X

Check email availability

X

Change password

X

Accept TC

X

Change password

X

Accept terms and conditions

X

Warehouse groups

Retrieve a single warehouse group

X

Delete a single warehouse group

X

Update a single warehouse group

X

Retrieve multiple warehouse groups

X

Create a single warehouse group

X

Warehouses

Update custom forms for load types

X

Create custom forms for load types

X

Retrieve a single warehouse

X

Update a single warehouse

X

Retrieve multiple warehouses

X

Create a single warehouse

X

Get open hours for set of docks in the warehouse

X

Retrieve a single warehouse

X

Retrieve multiple warehouses

X

Get open hours for docks in warehouse

X

YMS: Spot

Retrieve multiple spots

X

Create a single spot

X

Generate multiple spots

X

Update a single spot

X

Delete a single spot

X

Retrieve a single spot

X

Close a spot

X

Open a spot

X

Toggle spot reserve

X

Get spot events

X

YMS: Spot area

Create a single spot area

X

Retrieve multiple spot areas

X

Update a single spot area

X

Delete a single spot area

X

Retrieve a single spot area

X

YMS: Spot assignment

Create a single spot assignment

X

Retrieve multiple spot assignments

X

Update a single spot assignment

X

Delete a single spot assignment

X

Retrieve a single spot assignment

X

Depart a spot assignment contents

X

Reassign a spot assignment

X