Notify the result of a cancel delivery event

Rate limit: 8 requests per minute.

post/v1/delivery/{deliveryReferenceId}/cancel

Request

Base URL
https://partners.tryotter.com
Auth
OAuth 2
Authorization code/v1/auth/oauth2/authorize
Client credentials
Token URL/v1/auth/token
Scopesdelivery.provider
TypeScript
https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/delivery/:deliveryReferenceId/cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

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

canceledAtstring date-time

The time that the request was cancelled.

Example request

{
  "canceledAt": "2007-12-03T09:15:30.000Z"
}

Response

The event callback was successfully accepted.

Changes

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