Jump to

• Request
• Response

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

Request Body - 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.

{
    "description":"Request parameters to remove an appointment for a shipment.",
    "type":"object",
    "properties":{
        "appointmentGid":{
            "description":"Appointment ID - Appointment to be removed must be identified using either an Appointment ID OR Shipment ID OR Shipment Reference Number.",
            "type":"string"
        },
        "shipmentGid":{
            "description":"Shipment ID - Appointment to be removed must be identified using either an Appointment ID OR Shipment ID OR Shipment Reference Number.",
            "type":"string"
        },
        "shipmentRefnumQualGid":{
            "description":"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.",
            "type":"string"
        },
        "shipmentRefnumValue":{
            "description":"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.",
            "type":"string"
        },
        "stopNumber":{
            "description":"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.",
            "type":"integer"
        },
        "locationGid":{
            "description":"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.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success! A successful POST method returns a 200 status code.

Body ()

Root Schema : removeAppointmentResponse

Type: object

Response when removing an appointment for a shipment.

Show Source

• responseStatus: object responseStatus

{
    "description":"Response when removing an appointment for a shipment.",
    "type":"object",
    "properties":{
        "responseStatus":{
            "type":"object",
            "properties":{
                "isSuccess":{
                    "description":"Specifies if appointment removal was successful.",
                    "type":"boolean"
                },
                "statusMessage":{
                    "description":"Error message if appointment removal was unsuccessful.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : responseStatus

Type: object

Show Source

• isSuccess: boolean
  Specifies if appointment removal was successful.
• statusMessage: string
  Error message if appointment removal was unsuccessful.

{
    "type":"object",
    "properties":{
        "isSuccess":{
            "description":"Specifies if appointment removal was successful.",
            "type":"boolean"
        },
        "statusMessage":{
            "description":"Error message if appointment removal was unsuccessful.",
            "type":"string"
        }
    }
}

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

401 Response

Unauthorized, the request was not successful because it lacks valid authentication credentials for the requested resource.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

403 Response

Access to the specified resource has been forbidden.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

Back to Top