1. WMS REST API Guide
  2. Appointment Input Interface

Appointment Input Interface

Appointment Input Interface supports JSON format. This API is used to interface the Appointment Input Interface in JSON format.

URL

POST .../wms/lgfapi/v10/stage/appointment/

Request Parameters

Parameter/Field Name Type Required Description
async_flg Boolean (True/False)

By default, the value will be considered as false.

If the value is true, then interface will run in async mode.

If the value is false, then interface will run synchronously.
appt_nbr String Yes Appointment Number
load_nbr String Yes Load Number
dock_type String Yes Grouping of Dock Doors
action_code String Yes CREATE/UPDATE/DELETE
preferred_dock_nbr String No Preferred Dock Number
planned_start_ts Datetime Yes

Planned Start Date. The format is “YYYY-MM-DDTHH:MM:SS”.

Additional Note: Time information provided will also be accepted.
duration Number Yes Duration
estimated_units Number Yes

Set to zero if not needed

Release 9.0 Note (Field present prior to release 9.0):

Field supports upto 38 digits regardless of decimal position. Maximum number of digits after decimals is stipulated by company setting related to quantity. Interfaced value will be rounded if the number of decimal digits is more than the corresponding company setting.
carrier_info String No Carrier Information
trailer_nbr String No Trailer Number
load_type String No Load Type (I-Inbound Loads Default: O-Outbound Load)
cust_field_1 String No Appointment Custom Field 1
cust_field_2 String No Appointment Custom Field 2
cust_field_3 String No Appointment Custom Field 3
cust_field_4 String No Appointment Custom Field 4
cust_field_5 String No Appointment Custom Field 5

Request Body 

{
    "async_flg":false,
    "header": {
	  "document_version": "25D",
                 "origin_system": "ENV1",
                 "client_env_code": "ENV1",
                 "parent_company_code": "COMP01",
                 "entity": "appointment",
                 "timestamp": "2025-01-14 12:12:12",
                 "messageid": "appointment",
                 "facility_code": "FAC01",
                 "company_code": "COMP01"       
              }, 
    "stage_appointment_list": [
                                    {    
                                          "appt_nbr": "APNBR13102018",
                                          "load_nbr": "LIBSHP101220183",
                                          "dock_type": "INBOUND",
                                          "action_code": "CREATE",
                                          "preferred_dock_nbr": "",
                                          "planned_start_ts": "2025-01-14 12:12:12",
                                          "duration": 15,
                                          "estimated_units": 100,
                                          "carrier_info": "",
                                          "trailer_nbr": "",
                                          "load_type": "",
                                          "cust_field_1": "",
                                          "cust_field_2": "",
                                          "cust_field_3": "",
                                          "cust_field_4": "",
                                          "cust_field_5": ""          
                                     }
                              ]
}

Sample Response

200 OK