API docs by Redocly

Blitzo API Documentation (1.0.0)

Download OpenAPI specification:Download

API documentation for Blitzo services.

Check service availability

Returns whether Blitzo service is available for a given postcode.

query Parameters
postcode
required
string

Postcode to check service availability.

Responses

Service

Estimate collection time

Estimates the collection time for a given postcode location

query Parameters
postcode
required
string

UK postcode for collection time estimation

header Parameters
x-api-key
required
string

API key for authentication

Responses

Response samples

Content type
application/json
{
  • "isAvailable": true,
  • "estimatedCollectionTime": "string",
  • "message": "string"
}

Orders

Create a single drop delivery order

Creates a new delivery order with one pickup and one dropoff location

header Parameters
x-api-key
required
string

API key for authentication

x-api-user
required
string

User identifier

Request Body schema: application/json
required
required
object (Location)
required
object (Location)
packageType
required
string
specialInstructions
string
schedule
required
object
parcelSize
required
string
senderNumber
string
receiverNumber
string

Responses

Request samples

Content type
application/json
{
  • "pickupLocation": {
    },
  • "dropoffLocation": {
    },
  • "packageType": "string",
  • "specialInstructions": "string",
  • "schedule": { },
  • "parcelSize": "string",
  • "senderNumber": "string",
  • "receiverNumber": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "order": {
    },
  • "message": "string"
}

Get order information

Retrieves information about a specific order

path Parameters
orderId
required
string

ID of the order to retrieve

header Parameters
x-api-key
required
string

API key for authentication

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "order": {
    }
}

Cancel an order

Cancels a specific order by ID

path Parameters
orderId
required
string

ID of the order to cancel

header Parameters
x-api-key
required
string

API key for authentication

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Create a multi-drop delivery order

Creates a new delivery order with one pickup and multiple dropoff locations

header Parameters
x-api-key
required
string

API key for authentication

x-api-user
required
string

User identifier

Request Body schema: application/json
required
required
object (Location)
required
Array of objects (Location)
packageType
required
string
specialInstructions
string
schedule
required
object

Responses

Request samples

Content type
application/json
{
  • "pickupLocation": {
    },
  • "dropoffLocations": [
    ],
  • "packageType": "string",
  • "specialInstructions": "string",
  • "schedule": { }
}

Get all active orders

Retrieves all active orders for a specific user

header Parameters
x-api-key
required
string

API key for authentication

x-api-user
required
string

User identifier

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "orders": [
    ],
  • "message": "string"
}

Delete a multidrop order

Deletes a specific multidrop order by ID

path Parameters
orderId
required
string

ID of the multidrop order to delete

header Parameters
x-api-key
required
string

API key for authentication

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Create a multi-pickup delivery order

Creates a new delivery order with multiple pickup locations and one dropoff location

header Parameters
x-api-key
required
string

API key for authentication

x-api-user
required
string

User identifier

Request Body schema: application/json
required
required
Array of objects (Location)
required
object (Location)
packageType
required
string
specialInstructions
string
schedule
required
object

Responses

Request samples

Content type
application/json
{
  • "pickupLocations": [
    ],
  • "dropoffLocation": {
    },
  • "packageType": "string",
  • "specialInstructions": "string",
  • "schedule": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "order": {
    },
  • "message": "string"
}

Get multipickup order information

Retrieves information about a specific multipickup order

path Parameters
orderId
required
string

ID of the multipickup order to retrieve

header Parameters
x-api-key
required
string

API key for authentication

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "order": {
    }
}

Delete a multipickup order

Deletes a specific multipickup order by ID

path Parameters
orderId
required
string

ID of the multipickup order to delete

header Parameters
x-api-key
required
string

API key for authentication

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}