Jump to

• Request
• Response

Schedule an appointment for a shipment

post

/custom-actions/scheduleAppointment/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.
• locationResourceGroupGid: string
  Location Resource Group ID. For example when multiple doors are associated with a location resource group, and a user wants to find the best door. To use this parameter, Appointment Start Time and Appointment End Time must be specified. The resourceGidFromPrimaryResourceType parameter must not be set when using the locationResourceGroupGid parameter.
• resourceGidFromPrimaryResourceType: 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.
• resourceGidsFromSecondaryResourceTypes: array resourceGidsFromSecondaryResourceTypes
  List of Location Resource IDs for the secondary resource type. Appointment Start Time and Appointment End Time must be specified when using this parameter. The resourceGidFromPrimaryResourceType parameter must also be set when specifying secondary resources.
• 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"
        },
        "resourceGidFromPrimaryResourceType":{
            "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"
        },
        "resourceGidsFromSecondaryResourceTypes":{
            "description":"List of Location Resource IDs for the secondary resource type. Appointment Start Time and Appointment End Time must be specified when using this parameter. The resourceGidFromPrimaryResourceType parameter must also be set when specifying secondary resources.",
            "type":"array",
            "items":{
                "properties":{
                    "resourceGid":{
                        "description":"Location Resource ID.",
                        "type":"string"
                    }
                }
            }
        },
        "locationResourceGroupGid":{
            "description":"Location Resource Group ID. For example when multiple doors are associated with a location resource group, and a user wants to find the best door. To use this parameter, Appointment Start Time and Appointment End Time must be specified. The resourceGidFromPrimaryResourceType parameter must not be set when using the locationResourceGroupGid parameter.",
            "type":"string"
        }
    }
}

Nested Schema : resourceGidsFromSecondaryResourceTypes

Type: array

List of Location Resource IDs for the secondary resource type. Appointment Start Time and Appointment End Time must be specified when using this parameter. The resourceGidFromPrimaryResourceType parameter must also be set when specifying secondary resources.

Show Source

• Array of: object items

{
    "description":"List of Location Resource IDs for the secondary resource type. Appointment Start Time and Appointment End Time must be specified when using this parameter. The resourceGidFromPrimaryResourceType parameter must also be set when specifying secondary resources.",
    "type":"array",
    "items":{
        "properties":{
            "resourceGid":{
                "description":"Location Resource ID.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• resourceGid: string
  Location Resource ID.

{
    "properties":{
        "resourceGid":{
            "description":"Location Resource 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 : scheduleAppointmentResponse

Type: object

Response when scheduling an appointment for a shipment.

Show Source

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

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

Nested Schema : appointments

Type: array

List of appointments scheduled.

Show Source

• Array of: object scheduleAppointment
  Appointment details.

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

Nested Schema : responseStatus

Type: object

Show Source

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

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

Nested Schema : scheduleAppointment

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

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