CLcloudkitchens
delivery_endpoints

Update delivery status

Rate limit: 8 requests per minute.

put/v1/delivery/{deliveryReferenceId}/status

Request

Path parameters

deliveryReferenceIdstring required

A unique identifier of the delivery in a UUID format.

Example:295f76b4-5725-4bf5-a8ab-97943dbdc3b4

Request body

deliveryStatus'REQUESTED' | 'ALLOCATED' | 'PICKED_UP' | 'COMPLETED' | 'CANCELED' | 'ARRIVED_AT_PICKUP' | 'ARRIVED_AT_DROP_OFF'

The status of the delivery.

estimatedDeliveryTimestring date-time nullable

The expected delivery time.

estimatedPickupTimestring date-time nullable

The expected pickup time.

createdAtstring date-time

The time that the update was created.

currencyCodestring nullable

The 3-letter currency code (ISO 4217) to use for all monetary values.

providerDeliveryIdstring nullable

The provider's internal identifier for the delivery used for tracking purposes.

deliveryTrackingUrlstring nullable

Delivery tracking url.

Example request

{
  "estimatedDeliveryTime": "2007-12-03T09:15:30.000Z",
  "estimatedPickupTime": "2007-12-03T09:15:30.000Z",
  "courier": {
    "name": "Jane Doe",
    "phone": "+1-555-555-5555",
    "phoneCode": "111 11 111",
    "email": "email@email.com",
    "personalIdentifiers": {
      "serviceProviderId": "12345ba6-789e-123f-4e56-d78db90d123b"
    }
  },
  "location": {
    "latitude": 38.8977,
    "longitude": 77.0365
  },
  "createdAt": "2007-12-03T09:15:30.000Z",
  "vehicleInformation": {
    "licensePlate": "ABCD 123",
    "makeModel": "Honda Civic"
  },
  "currencyCode": "EUR",
  "cost": {
    "baseCost": 4.99,
    "extraCost": 0.99
  }
}

Response

The event callback was successfully accepted.

Changes

No recorded changes to this operation across all 1 revision of this API.