Jump to

• Request
• Response

Modify an appointment for a shipment.

post

/custom-actions/modifyAppointment/shipments/

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• appointmentEndTime: string
  Appointment End Time at the stop in yyyy-MM-dd HH:mm:ss format.
• appointmentStartTime: string
  Appointment Start Time at the stop in yyyy-MM-dd HH:mm:ss format.
• locationGid: string
  Location ID - Shipment appointment location must be specified using either a Stop Number OR a Stop Location ID.
• locationResourceGid: string
  Location Resource ID for the primary resource type. For example, the door at which a user wants to book an appointment. Appointment Start Time and Appointment End Time must be specified when using this parameter.
• shipmentGid: string
  Shipment ID - Shipment must be identified using one of Shipment ID OR Shipment Reference Number.
• shipmentRefnumQualGid: string
  Shipment Reference Number Qualified ID - In the absence of a Shipment ID, a shipment 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 a Shipment ID, a shipment can be identified using a combination of a Shipment Reference Qualifier ID AND Shipment Reference Number.
• stopNumber: integer
  Stop Number - Shipment appointment location must be specified using one of Stop Number OR Stop Location ID.

{
    "type":"object",
    "properties":{
        "shipmentGid":{
            "description":"Shipment ID - Shipment must be identified using one of Shipment ID OR Shipment Reference Number.",
            "type":"string"
        },
        "shipmentRefnumQualGid":{
            "description":"Shipment Reference Number Qualified ID - In the absence of a Shipment ID, a shipment 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 a Shipment ID, a shipment can be identified using a combination of a Shipment Reference Qualifier ID AND Shipment Reference Number.",
            "type":"string"
        },
        "stopNumber":{
            "description":"Stop Number - Shipment appointment location must be specified using one of Stop Number OR Stop Location ID.",
            "type":"integer"
        },
        "locationGid":{
            "description":"Location ID  - Shipment appointment location must be specified using either a Stop Number OR a Stop Location ID.",
            "type":"string"
        },
        "appointmentStartTime":{
            "description":"Appointment Start Time at the stop in yyyy-MM-dd HH:mm:ss format.",
            "type":"string"
        },
        "appointmentEndTime":{
            "description":"Appointment End Time at the stop in yyyy-MM-dd HH:mm:ss format.",
            "type":"string"
        },
        "locationResourceGid":{
            "description":"Location Resource ID for the primary resource type. For example, the door at which a user wants to book an appointment. Appointment Start Time and Appointment End Time must be specified when using this parameter.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Default Response.

Body ()

Root Schema : modifyAppointmentResponse

Type: object

Response when modify an appointment for a shipment.

Show Source

• appointments: array appointments
  List of appointments modified.
• responseStatus: object responseStatus

{
    "description":"Response when modify an appointment for a shipment.",
    "type":"object",
    "properties":{
        "responseStatus":{
            "type":"object",
            "properties":{
                "isSuccess":{
                    "description":"Specifies if modification of an appointment for a shipment was successful.",
                    "type":"boolean"
                },
                "statusMessage":{
                    "description":"Error message if modification of an appointment for a shipment was unsuccessful.",
                    "type":"string"
                }
            }
        },
        "appointments":{
            "description":"List of appointments modified.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/appointment"
            }
        }
    }
}

Nested Schema : appointments

Type: array

List of appointments modified.

Show Source

• Array of: object appointment
  Appointment details.

{
    "description":"List of appointments modified.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/appointment"
    }
}

Nested Schema : responseStatus

Type: object

Show Source

• isSuccess: boolean
  Specifies if modification of an appointment for a shipment was successful.
• statusMessage: string
  Error message if modification of an appointment for a shipment was unsuccessful.

{
    "type":"object",
    "properties":{
        "isSuccess":{
            "description":"Specifies if modification of an appointment for a shipment was successful.",
            "type":"boolean"
        },
        "statusMessage":{
            "description":"Error message if modification of an appointment for a shipment was unsuccessful.",
            "type":"string"
        }
    }
}

Nested Schema : appointment

Type: object

Appointment details.

Show Source

• appointmentDuration: integer
  Appointment Duration in seconds.
• appointmentEndTime: string
  Appointment End Time at the stop in yyyy-MM-dd HH:mm:ss format.
• appointmentGid: string
  Appointment ID.
• appointmentStartTime: string
  Appointment Start Time at the stop in yyyy-MM-dd HH:mm:ss format.
• confirmationNumber: string
  Confirmation Number.
• deliveryAppointment: string
  Delivery Appointment time in yyyy-MM-dd HH:mm:ss format.
• locationResourceGid: string
  Location Resource ID
• locationResourceName: string
  Location Resource Name
• pickupAppointment: string
  Pickup Appointment time in yyyy-MM-dd HH:mm:ss format.
• resourceTypeGid: string
  Resource Type ID.
• stopNumber: integer
  Stop number where appointment was scheduled.

{
    "description":"Appointment details.",
    "type":"object",
    "properties":{
        "appointmentGid":{
            "description":"Appointment ID.",
            "type":"string"
        },
        "confirmationNumber":{
            "description":"Confirmation Number.",
            "type":"string"
        },
        "pickupAppointment":{
            "description":"Pickup Appointment time in yyyy-MM-dd HH:mm:ss format.",
            "type":"string"
        },
        "deliveryAppointment":{
            "description":"Delivery Appointment time in yyyy-MM-dd HH:mm:ss format.",
            "type":"string"
        },
        "appointmentStartTime":{
            "description":"Appointment Start Time at the stop in yyyy-MM-dd HH:mm:ss format.",
            "type":"string"
        },
        "appointmentEndTime":{
            "description":"Appointment End Time at the stop in yyyy-MM-dd HH:mm:ss format.",
            "type":"string"
        },
        "appointmentDuration":{
            "description":"Appointment Duration in seconds.",
            "type":"integer"
        },
        "resourceTypeGid":{
            "description":"Resource Type ID.",
            "type":"string"
        },
        "locationResourceName":{
            "description":"Location Resource Name",
            "type":"string"
        },
        "locationResourceGid":{
            "description":"Location Resource ID",
            "type":"string"
        },
        "stopNumber":{
            "description":"Stop number where appointment was scheduled.",
            "type":"integer"
        }
    }
}

400 Response

Error Response.

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