> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.zippd.com/llms.txt.
> For full documentation content, see https://api-docs.zippd.com/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.zippd.com/_mcp/server.

# Cancel an Order

PATCH https://sandbox-api.deliveryapp.com/api/v1/orders/{orderId}/status
Content-Type: application/json

This endpoint can be used to cancel any type of order

Reference: https://api-docs.zippd.com/orders/post-orders-order-id-status

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /orders/{orderId}/status:
    patch:
      operationId: post-orders-order-id-status
      summary: Cancel an Order
      description: This endpoint can be used to cancel any type of order
      tags:
        - subpackage_orders
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: ''
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
        '404':
          description: The resource could not be found using the given request data.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Post-orders-orderId-statusRequestNotFoundError
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  $ref: >-
                    #/components/schemas/OrdersOrderIdStatusPatchRequestBodyContentApplicationJsonSchemaStatus
                  description: The new status for the order.
                description:
                  type: string
                  description: A reason for the change of status.
              required:
                - status
                - description
servers:
  - url: https://sandbox-api.deliveryapp.com/api/v1
components:
  schemas:
    OrdersOrderIdStatusPatchRequestBodyContentApplicationJsonSchemaStatus:
      type: string
      enum:
        - canceled
      description: The new status for the order.
      title: OrdersOrderIdStatusPatchRequestBodyContentApplicationJsonSchemaStatus
    CustomerOrderType:
      type: string
      enum:
        - delivery
        - hire-vehicle
        - request
      description: The order type.
      title: CustomerOrderType
    CustomerOrderStatus:
      type: string
      enum:
        - accepted
        - started
        - awaiting
        - in-progress
        - completed
        - draft
        - canceled
        - expired
      description: The current status of the order.
      title: CustomerOrderStatus
    VehicleTitle:
      type: string
      enum:
        - Small Van
        - Short Wheel Base
        - Long Wheel Base
        - Extra Long Wheel Base
        - Luton Van
        - 7.5 Tonne Lorry
      title: VehicleTitle
    Vehicle:
      type: object
      properties:
        id:
          type: integer
        title:
          $ref: '#/components/schemas/VehicleTitle'
      description: The details of a vehicle type.
      title: Vehicle
    PaymentCard:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The card's ID in the API.
        number:
          type: string
          description: The last four digits of the payment card.
        type:
          type: string
          description: The name of the card issuer.
      description: The details of a payment card used to place orders.
      title: PaymentCard
    CustomerOrderDriver:
      type: object
      properties:
        id:
          type: string
          description: The system ID of the driver.
        first_name:
          type: string
          description: The driver's first name.
        full_name:
          type: string
          description: The driver's full name.
        contact_number:
          type:
            - string
            - 'null'
          description: A contact phone number for the driver.
        profile_image:
          type:
            - string
            - 'null'
          description: An absolute URL to the driver's profile image.
        has_uploaded_profile_image:
          type: boolean
          description: Flags whether this driver account has a profile image available.
        total_deliveries:
          type: integer
          description: The total number of deliveries that this driver has undertaken.
        average_rating:
          type: number
          format: double
          description: The driver's rating on our platform.
      description: Details about the driver who will be fulfilling the order.
      title: CustomerOrderDriver
    OrderLocationAddress:
      type: object
      properties:
        address_line_1:
          type: string
          description: The first line of the location's address.
        address_line_2:
          type:
            - string
            - 'null'
          description: The second line of the location's address.
        city:
          type: string
          description: The city of the location's address.
        postcode:
          type: string
          description: The postal code of the location's address.
        latitude:
          type: number
          format: double
          description: The latitude coordinate of the location's address.
        longitude:
          type: number
          format: double
          description: The longitude coordinate of the location's address.
      title: OrderLocationAddress
    OrderLocationContactDetails:
      type: object
      properties:
        contact_name:
          type: string
          description: A contact name for the location.
        phone_number:
          type: string
          description: >-
            A contact number for this location that may be used by the delivery
            driver.
        email:
          type:
            - string
            - 'null'
          description: A contact email for this location.
        company_name:
          type:
            - string
            - 'null'
          description: The name of the company at this location.
      title: OrderLocationContactDetails
    OrderLocationInstruction:
      type: string
      enum:
        - address
        - safe-place
      description: A key that determines how the delivery should be flfilled.
      title: OrderLocationInstruction
    Barcode:
      type: object
      properties:
        code:
          type: string
          description: >-
            The code representation of the barcode. Barcode codes will always be
            20 characters in length.
        code_formatted:
          type: string
          description: The human-readable code representation of the barcode.
        order_location_id:
          type: integer
          description: The ID of the location that this barcode is linked to.
        pickup_latitude:
          type:
            - number
            - 'null'
          format: double
          description: >-
            The latitude coordinate of the location where this barcode was
            recorded as picked up by the delivery driver.
        pickup_longitude:
          type:
            - number
            - 'null'
          format: double
          description: >-
            The longitude coordinate of the location where this barcode was
            recorded as picked up by the delivery driver.
        pickup_datetime:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            The date/time at which the delivery driver recorded the barcode's
            pickup.
        drop_off_latitude:
          type:
            - number
            - 'null'
          format: double
          description: >-
            The latitude coordinate of the location where this barcode was
            recorded as dropped off by the delivery driver.
        drop_off_longitude:
          type:
            - number
            - 'null'
          format: double
          description: >-
            The longitude coordinate of the location where this barcode was
            recorded as dropped off by the delivery driver.
        drop_off_datetime:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            The date/time at which the delivery driver recorded the barcode's
            drop off.
        undeliverable:
          type:
            - boolean
            - 'null'
          description: >-
            Whether or not the parcel was successfully delivered. This will be
            `null` if delivery has not been attempted yet.
        undeliverable_reason:
          type:
            - string
            - 'null'
          description: A short description of why the parcel could not be delivered.
        printable_label_url:
          type: string
          description: An absolute URL to a PDF with the package label for this barcode.
        created_at:
          type: string
          format: date-time
          description: The date/time at which the barcode was generated by the API.
        updated_at:
          type: string
          format: date-time
          description: The date/time at which the barcode was last updated.
      description: Details about a barcode (parcel) delivery status.
      title: Barcode
    ProofOfDeliveryCoordinates:
      type: object
      properties:
        latitude:
          type: number
          format: double
          description: >-
            The latitude coordinate of the final location where the delivery was
            fulfilled.
        longitude:
          type: number
          format: double
          description: >-
            The longitude coordinate of the final location where the delivery
            was fulfilled.
      description: The coordinates of the final location where the delivery was fulfilled.
      title: ProofOfDeliveryCoordinates
    ProofOfDelivery:
      type: object
      properties:
        photo:
          type: string
          description: An absolute URL to the photo the driver took as proof of delivery.
        signature:
          type: string
          description: >-
            An absolute URL to the recipient's signature taken after delivery
            was fulfilled.
        signer_name:
          type: string
          description: The name of the delivery recipient.
        coordinates:
          oneOf:
            - $ref: '#/components/schemas/ProofOfDeliveryCoordinates'
            - type: 'null'
          description: >-
            The coordinates of the final location where the delivery was
            fulfilled.
      description: Data from the proof of delivery collected by the delivery driver.
      title: ProofOfDelivery
    OrderLocation:
      type: object
      properties:
        id:
          type: integer
        delivery_id:
          type:
            - integer
            - 'null'
          description: The ID of the delivery resource attributed to this location.
        time_from:
          type: string
          format: time
          description: >-
            The earliest time at which the driver should arrive at this
            location. Format 'H:i:s'.
        time_to:
          type: string
          format: time
          description: >-
            The latest time at which the driver should arrive at this location.
            Format 'H:i:s'.
        tracking_code:
          type:
            - string
            - 'null'
          description: The unique tracking code of the delivery for this location.
        web_tracking_url:
          type:
            - string
            - 'null'
          description: >-
            An absolute URL to a public web page that displays tracking
            information and options for the related delivery.
        address:
          $ref: '#/components/schemas/OrderLocationAddress'
        contact_details:
          $ref: '#/components/schemas/OrderLocationContactDetails'
        driver_arriving_time:
          type:
            - string
            - 'null'
          format: date-time
          description: The date/time at which the delivery driver arrived at the location.
        driver_leaving_time:
          type:
            - string
            - 'null'
          format: date-time
          description: The date/time at which the delivery driver left the location.
        requires_handballing:
          type: boolean
          description: >-
            Whether or not the delivery requires the driver to assist with
            loading/unloading items. This is only appropriate for `delivery`
            order types. Other order types will always be `false`.
        total_items:
          type: integer
          description: >-
            The total number of items (parcels) being delivered to this
            location.
        instruction:
          oneOf:
            - $ref: '#/components/schemas/OrderLocationInstruction'
            - type: 'null'
          description: A key that determines how the delivery should be flfilled.
        instruction_details:
          type:
            - string
            - 'null'
          description: >-
            Details relevant to the instruction. For example, for `safe-place`,
            you would provide the details of the safe place; for `address`, you
            might include a gate code for the driver.
        what3words:
          type:
            - string
            - 'null'
          description: The What3Words ID of the location's address.
        client_system_delivery_id:
          type:
            - string
            - 'null'
          description: An identifier for the client system that manages this delivery.
        barcodes:
          type: array
          items:
            $ref: '#/components/schemas/Barcode'
          description: >-
            A list of barcodes (parcels) that are to be delivered to this
            location.
        printable_label_url:
          type:
            - string
            - 'null'
          description: An absolute URL to a PDF with all package labels for this location.
        proof_of_delivery:
          $ref: '#/components/schemas/ProofOfDelivery'
      description: The data of a location that has been added as a point to an order.
      title: OrderLocation
    CustomerOrderPrices:
      type: object
      properties:
        total_price:
          type: integer
        total_price_formatted:
          type: string
        total_price_no_vat:
          type: integer
        total_price_no_vat_formatted:
          type: string
        order_price:
          type: integer
        order_price_formatted:
          type: string
        order_price_no_vat:
          type: integer
        order_price_no_vat_formatted:
          type: string
        extra_mileage_cost:
          type: integer
        extra_mileage_cost_formatted:
          type: string
        extra_mileage_cost_no_vat:
          type: integer
        extra_mileage_cost_no_vat_formatted:
          type: string
        extra_mileage_cost_vat_formatted:
          type: string
        extra_time_cost:
          type: integer
        extra_time_cost_formatted:
          type: string
        extra_time_cost_no_vat:
          type: integer
        extra_time_cost_no_vat_formatted:
          type: string
        extra_time_cost_vat_formatted:
          type: string
        surcharge_cost:
          type: integer
        surcharge_cost_formatted:
          type: string
        surcharge_cost_no_vat:
          type: integer
        surcharge_cost_no_vat_formatted:
          type: string
        surcharge_cost_vat_formatted:
          type: string
        total_vat:
          type: integer
        total_vat_formatted:
          type: string
      description: A breakdown of the costs involved with this delivery order.
      title: CustomerOrderPrices
    AllowedDistance:
      type: object
      properties:
        postcode:
          type: string
          description: >-
            The postal code of the point at which the allowed distance is in
            reference to.
        latitude:
          type: number
          format: double
          description: >-
            The latitude coordinate of the point at which the allowed distance
            is in reference to.
        longitude:
          type: number
          format: double
          description: >-
            The longitude coordinate of the point at which the allowed distance
            is in reference to.
        distance:
          type: integer
          description: The maximum distance allowed from the reference location.
      description: An object representing a maximum allowed distance from a set point.
      title: AllowedDistance
    CustomerOrderDuration:
      type: string
      enum:
        - half-day
        - full-day
      description: >-
        The duration within which the order is expected to be fulfilled. This
        will always be `null` for `delivery` type orders.
      title: CustomerOrderDuration
    CustomerOrderTotalTime:
      type: object
      properties:
        seconds:
          type: integer
        display:
          type: string
          format: time
      description: The total time it took for the delivery driver to fulfil the order.
      title: CustomerOrderTotalTime
    CustomerOrderAdditionalTime:
      type: object
      properties:
        seconds:
          type: integer
        display:
          type: string
          format: time
      description: >-
        If fulfilling the order took more time than set in `duration`, the
        additional time will be outlined here.
      title: CustomerOrderAdditionalTime
    Mileage:
      type: object
      properties:
        total_miles:
          type: integer
          description: The total miles travelled by the delivery driver.
      description: Information about the distance travelled by the delivery driver.
      title: Mileage
    CustomerOrder:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The ID of the order.
        code:
          type: string
          description: >-
            Zippd's short ID code for the order. Unique and always starts with
            "DA".
        type:
          $ref: '#/components/schemas/CustomerOrderType'
          description: The order type.
        order_date:
          type: string
          format: date
          description: Date on which the order was placed.
        fulfilment_date:
          type: string
          format: date
          description: The date on which the order will be fulfilled by the driver.
        internal_ref:
          type:
            - string
            - 'null'
          description: An order reference provided by your systems.
        status:
          $ref: '#/components/schemas/CustomerOrderStatus'
          description: The current status of the order.
        total_items:
          type: integer
          description: The total number of items (or parcels) attributed to this order.
        is_urgent:
          type: boolean
          description: Whether or not the order has been flagged as urgent.
        started_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Date/time when the delivery driver began fulfilling the order.
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Date/time when the delivery driver completed fulfilling the order.
        canceled_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Date/time when the order was cancelled.
        time_change_requests:
          type: integer
          description: Number of time change this order has received from drivers.
        vehicle:
          $ref: '#/components/schemas/Vehicle'
        payment_card:
          $ref: '#/components/schemas/PaymentCard'
        additional_notes:
          type: string
          description: >-
            Additional information that will be seen by the delivery driver
            before and during order fulfilment.
        co_loading:
          type: boolean
          description: Whether or not co-loading is allowed for this delivery.
        two_man_delivery:
          type: boolean
          description: Whether or not two-person delivery is required for this delivery.
        has_handballing:
          type: boolean
          description: >-
            Whether or not the delivery requires the driver to assist with
            loading/unloading items. This is only appropriate for `delivery`
            order types. Other order types will always be `false`.
        cost_of_goods:
          type: integer
          description: >-
            The total cost of goods being delivered. Must be in lowest unit of
            currency, e.g. in pence for GBP.
        cost_of_goods_formatted:
          type: string
          description: The total cost of goods being delivered in a human-readable format.
        driver:
          $ref: '#/components/schemas/CustomerOrderDriver'
          description: Details about the driver who will be fulfilling the order.
        time_zone:
          type: string
          description: The ID of the time zone in which the delivery job will take place.
        locations:
          type: array
          items:
            $ref: '#/components/schemas/OrderLocation'
          description: >-
            All locations relating to this order's deliveries. The first item is
            always the location where the driver will pickup the parcels to be
            delivered.
        prices:
          $ref: '#/components/schemas/CustomerOrderPrices'
          description: A breakdown of the costs involved with this delivery order.
        allowed_distance:
          $ref: '#/components/schemas/AllowedDistance'
        barcodes:
          type: array
          items:
            $ref: '#/components/schemas/Barcode'
          description: >-
            A list of barcodes (parcels) that are to be delivered on with this
            order.
        printable_label_url:
          type:
            - string
            - 'null'
          description: An absolute URL to a PDF with all package labels for this order.
        duration:
          oneOf:
            - $ref: '#/components/schemas/CustomerOrderDuration'
            - type: 'null'
          description: >-
            The duration within which the order is expected to be fulfilled.
            This will always be `null` for `delivery` type orders.
        total_time:
          oneOf:
            - $ref: '#/components/schemas/CustomerOrderTotalTime'
            - type: 'null'
          description: The total time it took for the delivery driver to fulfil the order.
        additional_time:
          oneOf:
            - $ref: '#/components/schemas/CustomerOrderAdditionalTime'
            - type: 'null'
          description: >-
            If fulfilling the order took more time than set in `duration`, the
            additional time will be outlined here.
        mileage:
          $ref: '#/components/schemas/Mileage'
      description: A single order's data for consumption by users who can place orders.
      title: CustomerOrder
    Post-orders-orderId-statusRequestNotFoundError:
      type: object
      properties:
        error:
          type: string
      title: Post-orders-orderId-statusRequestNotFoundError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: ''

```

## SDK Code Examples

```python
import requests

url = "https://sandbox-api.deliveryapp.com/api/v1/orders/orderId/status"

payload = {
    "status": "canceled",
    "description": "Customer requested cancellation due to change in delivery plans"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://sandbox-api.deliveryapp.com/api/v1/orders/orderId/status';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"status":"canceled","description":"Customer requested cancellation due to change in delivery plans"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.deliveryapp.com/api/v1/orders/orderId/status"

	payload := strings.NewReader("{\n  \"status\": \"canceled\",\n  \"description\": \"Customer requested cancellation due to change in delivery plans\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://sandbox-api.deliveryapp.com/api/v1/orders/orderId/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"canceled\",\n  \"description\": \"Customer requested cancellation due to change in delivery plans\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://sandbox-api.deliveryapp.com/api/v1/orders/orderId/status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"canceled\",\n  \"description\": \"Customer requested cancellation due to change in delivery plans\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://sandbox-api.deliveryapp.com/api/v1/orders/orderId/status', [
  'body' => '{
  "status": "canceled",
  "description": "Customer requested cancellation due to change in delivery plans"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://sandbox-api.deliveryapp.com/api/v1/orders/orderId/status");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"status\": \"canceled\",\n  \"description\": \"Customer requested cancellation due to change in delivery plans\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "status": "canceled",
  "description": "Customer requested cancellation due to change in delivery plans"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox-api.deliveryapp.com/api/v1/orders/orderId/status")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```