CLcloudkitchens
delivery_endpoints

Notify the result of a request delivery quote event

Respond with availability: AVAILABLE plus pricing and pickup estimates when you can fulfill the delivery. Respond with availability: UNAVAILABLE and an optional unavailableReason when you cannot fulfill it. Rate limit: 8 requests per minute.

post/v1/delivery/{deliveryReferenceId}/quotes

Request

Path parameters

deliveryReferenceIdstring required

A unique identifier of the delivery in a UUID format.

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

Headers

X-Store-Idstring required

The unique identifier of the store in your app. This ID, along with the Application ID, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to onboarding:905bb725-b141-4a9b-832a-1f254f772c94 (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided internalStoreId (a.k.a. Sku-Sku ID).

Example:partner-store-unique-identifier
X-Event-Idstring required

Unique identifier of the event that this callback refers to.

Example:cf0ce51b-d74e-40d3-b177-1925ab4edc0c

Request body

availability'AVAILABLE' | 'UNAVAILABLE'

Whether you can fulfill the requested delivery. Defaults to AVAILABLE for backward compatibility. When UNAVAILABLE, omit pricing and pickup estimates and optionally provide unavailableReason.

unavailableReasonstring nullable

Optional provider-readable reason why the delivery is unavailable.

minPickupDurationinteger nullable

Required when availability is AVAILABLE. Estimated minimum courier arrival time in minutes.

maxPickupDurationinteger nullable

Maximum time that the courier's arrival at pick up location can be delayed. If not provided, it will default to 60 minutes or minPickUpDuration, whichever is greater. This value is an estimation and expressed in minutes.

currencyCodestring nullable

Required when availability is AVAILABLE. The 3-letter ISO 4217 currency code for monetary values.

providerstring nullable

Delivery Service Provider Slug.

createdAtstring date-time nullable

Required when availability is AVAILABLE. The time that the quote was created.

accountBalancenumber nullable

The remaining account balance of the requester for the delivery provider.

Example request

{
  "unavailableReason": "OUTSIDE_DELIVERY_AREA",
  "minPickupDuration": 5,
  "maxPickupDuration": 10,
  "currencyCode": "EUR",
  "cost": {
    "baseCost": 4.99,
    "extraCost": 0.99
  },
  "provider": "doordash",
  "fulfillmentPath": [
    {
      "name": "rappi"
    }
  ],
  "createdAt": "2007-12-03T09:15:30.000Z",
  "accountBalance": 1068.32
}

Response

The event callback was successfully accepted.

Changes

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