Create Appointment

post

https://api.freight.fyi/api/v2/appointments

Create a DC appointment for the authenticated customer. Provide exactly one anchor (domestic_shipment_uuid, container_uuid, or import_drayage_uuid); each is validated to belong to the customer. distribution_center_uuid is required and must belong to the customer; an optional dc_dock_uuid must belong to that same distribution center. status and appointment_type default to proposed / inbound when omitted. scheduled_end_dt must be strictly after scheduled_start_dt. uuid and audit timestamps are server-managed. Datetimes are FC-local and naive.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create a DC appointment.

Optionally provide at most one anchor (domestic_shipment_uuid,
container_uuid, or import_drayage_uuid); an appointment may also be
created with no anchor, e.g. scheduled against a purchase order only.
The customer is derived from the API key, never the body. Datetimes are
FC-local and naive (any tz offset is dropped).

domestic_shipment_uuid

Domestic load anchor uuid.

container_uuid

Import container anchor uuid.

import_drayage_uuid

Drayage anchor uuid.

distribution_center_uuid

string

required

Distribution center uuid (required).

dc_dock_uuid

Dock uuid; must belong to the same DC.

carrier_uuid

Carrier uuid.

purchase_order_uuid

Purchase order uuid.

status

Defaults to 'proposed'. Seen: proposed, approved, canceled.

appointment_type

Defaults to 'inbound'.

scheduled_start_dt

scheduled_end_dt

requested_start_dt

requested_end_dt

carrier_contact_name

carrier_contact_phone

carrier_contact_email

notes

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

201Successful Response

422Validation Error