Cancelled Pickup Document

This operation generates a PDF receipt for pickup cancellations. It supports creating receipts for multiple cancelled pickups.

SecuritybearerAuth
Request
query Parameters
type
required
string

Specifies the type of document being retrieved. Use 'cancelled' to generate a receipt for cancelled pickups.

header Parameters
X-PB-Developer-Partner-Id
string

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

Request Body schema: application/json
pickupIds
Array of strings

The pickup Ids which are cancelled and for which receipt is required.

Responses
200

The pickup has been cancelled.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/pickups/document/cancelled
Request samples
application/json
{
  • "pickupIds": [
    ]
}
Response samples