---
title: "Update delivery status"
method: PUT
path: "/v1/delivery/{deliveryReferenceId}/status"
tags: ["delivery_endpoints"]
---

# Update delivery status

`PUT /v1/delivery/{deliveryReferenceId}/status`

## Request

- Base URL: `https://partners.tryotter.com`
- URL: `https://partners.tryotter.com/v1/delivery/{deliveryReferenceId}/status`
- Auth: OAuth 2
  - Authorization code: `/v1/auth/oauth2/authorize`
  - Client credentials
  - Token URL: `/v1/auth/token` scopes: `delivery.provider`
- TypeScript: <https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/delivery/:deliveryReferenceId/status/put.ts> (a function with typed inputs; its response is checked against the schema)

Rate limit: 8 requests per minute.

## Path parameters

- `deliveryReferenceId` string, required: A unique identifier of the delivery in a UUID format.

## Request body

- DeliveryStatusUpdateRequest: Update delivery status request.
  - `deliveryStatus` 'REQUESTED' | 'ALLOCATED' | 'PICKED_UP' | 'COMPLETED' | 'CANCELED' | 'ARRIVED_AT_PICKUP' | 'ARRIVED_AT_DROP_OFF': The status of the delivery.
  - `estimatedDeliveryTime` string, date-time, nullable: The expected delivery time.
  - `estimatedPickupTime` string, date-time, nullable: The expected pickup time.
  - `courier` Person, nullable: The recipient information.
    - `name` string, nullable: The person's name as it should be displayed.
    - `phone` string, nullable: The person's phone number.
    - `phoneCode` string, nullable: A code or extension of the phone number.
    - `email` string, nullable: The person's email address.
    - `personalIdentifiers` PersonalIdentifiers, nullable: The person's personal identifiers (e.g. tax identification number).
      - `taxIdentificationNumber` string, nullable: Person tax identification number.
      - `serviceProviderId` string, nullable: External service provider ID i.e. Courier Id.
  - `location` Location, nullable: Latitude and longitude of the address.
    - `latitude` number, double, required: The latitude of the location.
    - `longitude` number, double, required: The longitude of the location.
  - `createdAt` string, date-time: The time that the update was created.
  - `vehicleInformation` VehicleInformation, nullable
    - `vehicleType` 'WALKER' | 'MOTORCYCLE' | 'BICYCLE' | 'CAR' | 'VAN': The type of vehicle used to fulfill the delivery.
    - `licensePlate` string, nullable: The license plate of the vehicle used to fulfill the delivery.
    - `makeModel` string, nullable: The make and model of the vehicle used to fulfill the delivery.
  - `currencyCode` string, nullable: The 3-letter currency code (ISO 4217) to use for all monetary values.
  - `cost` DeliveryCost: Delivery cost details.
    - `baseCost` number, double: Base delivery cost value.
    - `extraCost` number, double: Extra delivery cost value.
  - `providerDeliveryId` string, nullable: The provider's internal identifier for the delivery used for tracking purposes.
  - `dropoffInfo` DropoffInfo, nullable: Delivery dropoff details.
    - `courierNote` string, nullable: Courier supplied dropoff note.
    - `proofOfDelivery` VerificationProof, nullable: Verification details.
      - `signatureProof` SignatureProof, nullable: Signature info captured.
        - `signatureImageUrl` string: Signature image url.
        - `signerName` string, nullable: The name of the signer.
        - `signerRelationship` string, nullable: The relationship of signer to the intended recipient.
      - `pictureProof` PictureProof, nullable: Picture info captured.
        - `pictureUrl` string: Image url.
  - `deliveryTrackingUrl` string, nullable: Delivery tracking url.

## Response `204`

The event callback was successfully accepted.

## Other responses

- `400`: The request is malformed.
- `401`: Invalid authorization.
- `403`: Authorization not valid for the requested resource.
- `404`: Resource not found.
- `422`: The request body is not valid.

---

[API](https://skmtc.dev/cloudkitchens/apis/otter-api.md) - [All operations](https://skmtc.dev/cloudkitchens/apis/otter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudkitchens/apis/otter-api/revisions/4c868194a467?raw)