Remove an appointment for a shipment.
post
/custom-actions/removeAppointment/shipments/
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Request parameters to remove an appointment for a shipment.
Show Source
-
appointmentGid: string
Appointment ID - Appointment to be removed must be identified using either an Appointment ID OR Shipment ID OR Shipment Reference Number.
-
locationGid: string
Location ID - Location for the shipment at which the appointment should be removed must be specified using one of Stop Number OR Stop Location ID.
-
shipmentGid: string
Shipment ID - Appointment to be removed must be identified using either an Appointment ID OR Shipment ID OR Shipment Reference Number.
-
shipmentRefnumQualGid: string
Shipment Reference Number Qualifier ID - In the absence of an Appointment ID and a Shipment ID, the shipment associated with the appointment to be removed can be identified using a combination of a Shipment Reference Qualifier ID AND Shipment Reference Number.
-
shipmentRefnumValue: string
Shipment Reference Number - In the absence of an Appointment ID and a Shipment ID, the shipment associated with the appointment to be removed can be identified using a combination of a Shipment Reference Qualifier ID AND Shipment Reference Number.
-
stopNumber: integer
Stop Number - Location for the shipment at which the appointment should be removed must be specified using one of Stop Number OR Stop Location ID.
Response
Supported Media Types
- application/json
200 Response
Default Response.
Root Schema : removeAppointmentResponse
Type:
object
Response when removing an appointment for a shipment.
Show Source
Nested Schema : responseStatus
Type:
Show Source
object
-
isSuccess: boolean
Specifies if appointment removal was successful.
-
statusMessage: string
Error message if appointment removal was unsuccessful.
400 Response
Error Response.
Root Schema : errorResponse
Type:
Show Source
object
-
detail(required): string
Provides more information about the error.
-
status(required): number
HTTP status code.
-
title(required): string
Provides a short summary message.