POST Create a New Appointment
POST Create a New Appointment
Introduction
Creates a new appointment in the Yard Management System (YMS) for scheduled equipment visits. This endpoint is used when carriers or customers need to book time slots for inbound deliveries, outbound pickups, or combined operations. Supports both single-action appointments (inbound only or outbound only) and dual-action appointments (drop-and-hook operations). The system validates appointment time availability, customer access, and carrier permissions before confirming the booking.
API Request
POST /public/appointment/create
Body Request Parameters
Request Parameters
Name | Location | Type | Required | Description |
|---|---|---|---|---|
X-Tenant-ID | header | string | No | none |
X-Yard-ID | header | string | No | none |
Item-Time-Zone | header | string | No | none |
Authorization | header | string | No | none |
Item-Bam-Client | header | string | No | none |
x-facility-id | header | string | No | none |
body | body | object | No | none |
» appointmentTime | body | string | Yes | Scheduled appointment time |
» carrierId | body | string | Yes | Carrier identifier |
» externalCarrierId | body | string | No | External carrier identifier from external systems |
» customerIds | body | [string] | No | List of customer identifiers |
» inboundAction | body | object | No | Inbound action details, only present when appointmentType is INBOUND or BOTH |
»» appointmentType | body | string | Yes | Type of appointment action |
»» serviceType | body | string | Yes | Service type for the action (Live Delivery \ Drop Off Delivery) |
»» appointmentTime | body | string | No | Scheduled time for the action |
»» referenceIds | body | [string] | No | List of receipts number |
»» customerIds | body | [string] | No | List of customer identifiers |
» outboundAction | body | object | No | Outbound action details, only present when appointmentType is OUTBOUND or BOTH |
»» appointmentType | body | string | Yes | Type of appointment action |
»» serviceType | body | string | Yes | Service type for the action (Live Load \ Pickup Preload) |
»» appointmentTime | body | string | No | Scheduled time for the action |
»» referenceIds | body | [string] | No | List of loads number |
»» customerIds | body | [string] | No | List of customer identifiers |
» appointmentType | body | string | Yes | Appointment type |
» notes | body | string | No | Note or remarks for the appointment |
» operator | body | string | No | Operator who creates the appointment (carrier, customer, or internal). Not persisted to database. |
Enum Values
Property | Value |
|---|---|
»» appointmentType | INBOUND |
»» appointmentType | OUTBOUND |
»» appointmentType | BOTH |
» appointmentType | INBOUND |
» appointmentType | OUTBOUND |
» appointmentType | BOTH |
» operator | CARRIER |
» operator | CUSTOMER |
» operator | INTERNAL |
Response Example
200 Response
Response
Status Code | Definition | Description | Data Model |
|---|---|---|---|
200 | OK | none | RAppointmentView |