Skip to content
/
Get Dock Appointment By I...

INSPIRE Public Rest API Documentation. Copyright 2025 Fulfillment WMS. All rights reserved. (1.0)

OpenAPI documentation for API and Auth Rest Services

Detailed API Documentation
Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Proprietary
Languages
Servers
Mock server
https://apidocs.fulfillmentwms.com/_mock/openapi

Dock Appointment Scheduling Service

Dock Appointment Scheduling Services

Operations

Get Dock Appointment By Id

Request

Get Dock Appointment By Id

Security
Authorization
Path
apptIdstring(uuid)required
curl -i -X GET \
  'https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/dock/appt/{apptId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ok

Bodyapplication/json
idstring(uuid)
createdbystring
createdonstring(date-time)
modifiedonstring(date-time)
statusstring
Enum"PENDING""COMPLETED""CANCELED"
facility_idstring(uuid)
dock_door_idstring(uuid)
appt_durationinteger(int32)
apptstart_rangedtstring(date-time)
apptend_rangedtstring(date-time)
apptstartdtstring(date-time)
apptenddtstring(date-time)
actualstartdtstring(date-time)
actualenddtstring(date-time)
driver_checkindtstring(date-time)
driver_namestring
driver_licensenumstring
driver_licenseststring
driver_licenseexpstring(date-time)
driver_licenseclassstring
driver_addr1string
driver_addr2string
driver_addr3string
driver_citystring
driver_stateprovincestring
driver_postalcodestring
driver_countrystring
driver_license_image_urlstring
appt_schedule_select_urlstring
appt_schedule_selectdtstring(date-time)
dock_doorobject(FacilityLocationSecureType)
facilityobject(FacilitySecureType)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "createdby": "string",
  "createdon": "2019-08-24T14:15:22Z",
  "modifiedon": "2019-08-24T14:15:22Z",
  "status": "PENDING",
  "facility_id": "82d24387-b696-4928-8926-f6f7f16d3353",
  "dock_door_id": "107cedae-aba2-40b2-be17-6d2613906e8c",
  "appt_duration": 0,
  "apptstart_rangedt": "2019-08-24T14:15:22Z",
  "apptend_rangedt": "2019-08-24T14:15:22Z",
  "apptstartdt": "2019-08-24T14:15:22Z",
  "apptenddt": "2019-08-24T14:15:22Z",
  "actualstartdt": "2019-08-24T14:15:22Z",
  "actualenddt": "2019-08-24T14:15:22Z",
  "driver_checkindt": "2019-08-24T14:15:22Z",
  "driver_name": "string",
  "driver_licensenum": "string",
  "driver_licensest": "string",
  "driver_licenseexp": "2019-08-24T14:15:22Z",
  "driver_licenseclass": "string",
  "driver_addr1": "string",
  "driver_addr2": "string",
  "driver_addr3": "string",
  "driver_city": "string",
  "driver_stateprovince": "string",
  "driver_postalcode": "string",
  "driver_country": "string",
  "driver_license_image_url": "string",
  "appt_schedule_select_url": "string",
  "appt_schedule_selectdt": "2019-08-24T14:15:22Z",
  "dock_door": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "ncode": 0,
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "locale": "pt_BR",
    "nodelete": true,
    "facility_id": "82d24387-b696-4928-8926-f6f7f16d3353",
    "tmplt_id": "0cf10b77-feef-4821-ab9d-66698af376f5",
    "aisle_details_id": "b297023c-5230-4ab1-9b5b-5662e5b8d2b5",
    "enabled": true,
    "notes": "string",
    "strid": "string",
    "strcd": "string",
    "aislesz": "string",
    "levelsz": "string",
    "slotsz": "string",
    "description": "string",
    "aisleint": 0,
    "levelint": 0,
    "slotint": 0,
    "belowloc": "string",
    "aboveloc": "string",
    "leftloc": "string",
    "rightloc": "string",
    "frontloc": "string",
    "backloc": "string",
    "coord_x": 0,
    "coord_y": 0,
    "coord_z": 0,
    "tmplt": { … },
    "subLocations": [ … ],
    "aisleDetails": { … },
    "facility": { … }
  },
  "facility": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "ncode": 0,
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "enabled": true,
    "type": "WAREHOUSE",
    "code": "string",
    "accounting_ref": "string",
    "cutoff_shipping_time": { … },
    "name": "string",
    "description": "string",
    "notes": "string",
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "address4": "string",
    "city": "string",
    "state_province": "string",
    "postal_code": "string",
    "country": "string",
    "contact_name": "string",
    "contact_phone": "string",
    "contact_email": "string",
    "locations": [ … ],
    "equipment": [ … ]
  }
}

Get All Dock Appointments

Request

Get All Dock Appointments

Security
Authorization
Body*/*
facilitiesArray of strings(uuid)
accountsArray of strings(uuid)
containersArray of strings(uuid)
orderNumberstring
poNumberstring
carriersArray of strings(uuid)
createdonFromstring(date-time)
createdonTostring(date-time)
scheduledFromstring(date-time)
scheduledTostring(date-time)
curl -i -X POST \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/dock/appt/query \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
createdbystring
createdonstring(date-time)
modifiedonstring(date-time)
statusstring
Enum"PENDING""COMPLETED""CANCELED"
facility_idstring(uuid)
dock_door_idstring(uuid)
appt_durationinteger(int32)
apptstart_rangedtstring(date-time)
apptend_rangedtstring(date-time)
apptstartdtstring(date-time)
apptenddtstring(date-time)
actualstartdtstring(date-time)
actualenddtstring(date-time)
driver_checkindtstring(date-time)
driver_namestring
driver_licensenumstring
driver_licenseststring
driver_licenseexpstring(date-time)
driver_licenseclassstring
driver_addr1string
driver_addr2string
driver_addr3string
driver_citystring
driver_stateprovincestring
driver_postalcodestring
driver_countrystring
driver_license_image_urlstring
appt_schedule_select_urlstring
appt_schedule_selectdtstring(date-time)
dock_doorobject(FacilityLocationSecureType)
facilityobject(FacilitySecureType)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "status": "PENDING",
    "facility_id": "82d24387-b696-4928-8926-f6f7f16d3353",
    "dock_door_id": "107cedae-aba2-40b2-be17-6d2613906e8c",
    "appt_duration": 0,
    "apptstart_rangedt": "2019-08-24T14:15:22Z",
    "apptend_rangedt": "2019-08-24T14:15:22Z",
    "apptstartdt": "2019-08-24T14:15:22Z",
    "apptenddt": "2019-08-24T14:15:22Z",
    "actualstartdt": "2019-08-24T14:15:22Z",
    "actualenddt": "2019-08-24T14:15:22Z",
    "driver_checkindt": "2019-08-24T14:15:22Z",
    "driver_name": "string",
    "driver_licensenum": "string",
    "driver_licensest": "string",
    "driver_licenseexp": "2019-08-24T14:15:22Z",
    "driver_licenseclass": "string",
    "driver_addr1": "string",
    "driver_addr2": "string",
    "driver_addr3": "string",
    "driver_city": "string",
    "driver_stateprovince": "string",
    "driver_postalcode": "string",
    "driver_country": "string",
    "driver_license_image_url": "string",
    "appt_schedule_select_url": "string",
    "appt_schedule_selectdt": "2019-08-24T14:15:22Z",
    "dock_door": { … },
    "facility": { … }
  }
]

Import Service

Services related to importing data

Operations

Reporting, Insights and Metrics Service

Services related to Reporting, Insights and Metrics

Operations

Inventory Service

Services related to Inventory

Operations

Invoice for 3PL Billing Service

Services related to viewing Invoices for 3PL Billing

Operations

Lists Service

Services related to Querying Lists of Objects

Operations

Mobile Tasks Service

Services related to Mobile Tasks

Operations

Receiving Order Service

Services related to Receiving Orders

Operations

Shipping Order Service

Services related to Shipping Orders

Operations

Work/Project Order Service

Services related to Work/Project Orders

Operations

Authentication Service

Services related to authentication

Operations