Post subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft.databoxjobsjobnamebookshipmentpickup

v3

latestSwagger 2.0raw.githubusercontent.com2021-02-221689122.1 KB

Jobs

Book shipment pick up.

post/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp

Path parameters

subscriptionIdstring required

The Subscription Id

resourceGroupNamestring required

The Resource Group Name

jobNamestring required

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

Query parameters

api-versionstring required

The API Version

Request body

startTimestring date-time required

Minimum date after which the pick up should commence, this must be in local time of pick up area.

endTimestring date-time required

Maximum date before which the pick up should commence, this must be in local time of pick up area.

shipmentLocationstring required

Shipment Location in the pickup place. Eg.front desk

Response

Booked shipment pick up successfully.

confirmationNumberstring

Confirmation number for the pick up request.

readyByTimestring date-time

Time by which shipment should be ready for pick up, this is in local time of pick up area.