---
title: "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp"
method: POST
path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp"
tags: ["Jobs"]
---

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

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

## Request

- Base URL: `https://management.azure.com`
- URL: `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp`
- Auth: OAuth 2
  - Implicit: `https://login.microsoftonline.com/common/oauth2/authorize`
  - Scopes: `user_impersonation`

Book shipment pick up.

## Path parameters

- `subscriptionId` string, required
- `resourceGroupName` string, required
- `jobName` string, required

## Query parameters

- `api-version` string, required

## Request body

- ShipmentPickUpRequest: Shipment pick up request details.
  - `startTime` string, date-time, required: Minimum date after which the pick up should commence, this must be in local time of pick up area.
  - `endTime` string, date-time, required: Maximum date before which the pick up should commence, this must be in local time of pick up area.
  - `shipmentLocation` string, required: Shipment Location in the pickup place. Eg.front desk

## Response `200`

Booked shipment pick up successfully.

- ShipmentPickUpResponse: Shipment pick up response.
  - `confirmationNumber` string: Confirmation number for the pick up request.
  - `readyByTime` string, date-time: Time by which shipment should be ready for pick up, this is in local time of pick up area.

## Other responses

- `default`: Error response describing reason for operation failure.

## Changes

- **2026-07-13** (2018-01-01) `6e837c6ef46d`: 3 warning, 2 info
  - deleted the `path` request parameter `resourceGroupName`
  - deleted the `path` request parameter `subscriptionId`
  - deleted the `query` request parameter `api-version`
  - api tag `JobResources` added
  - …1 more

[Operation history](https://skmtc.dev/azure/apis/databox-microsoft-databox-databox/changes/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBox/jobs/:jobName/bookShipmentPickUp/post.md)

---

[API](https://skmtc.dev/azure/apis/databox-microsoft-databox-databox.md) - [All operations](https://skmtc.dev/azure/apis/databox-microsoft-databox-databox/llms.txt) - [OpenAPI document](https://skmtc.dev/azure/apis/databox-microsoft-databox-databox/revisions/39263cdb4fab?raw)
