CLcloudkitchens
delivery_endpoints

Publish delivery callback error

Rate limit: 16 requests per minute.

post/v1/delivery/callback/error

Request

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

errorCode'CANCELLED' | 'UNKNOWN' | 'INVALID_ARGUMENT' | 'FAILED_PRECONDITION' | 'DEADLINE_EXCEEDED' | 'NOT_FOUND' | 'PERMISSION_DENIED' | 'ALREADY_EXISTS' | 'RESOURCE_EXHAUSTED' | 'ABORTED' | 'OUT_OF_RANGE' | 'UNIMPLEMENTED' | 'INTERNAL' | 'UNAVAILABLE' | 'DATA_LOSS' | 'UNAUTHENTICATED'

Errors that occur processing the webhook, modeled after Google's gRPC error codes. For callback errors responding to menu-related webhooks, any error with status code in: "INVALID_ARGUMENT", "FAILED_PRECONDITION", "NOT_FOUND", "PERMISSION_DENIED", "ALREADY_EXISTS", "UNIMPLEMENTED", "DATA_LOSS", "UNAUTHENTICATED" will be considered fatal and will fail the operation without retrying.

errorMessagestring nullable

Additional information about the error. This message will be displayed to the user, so ideally it should be friendly.

Example request

{
  "errorCode": "NOT_FOUND",
  "errorMessage": "The store was not found."
}

Response

The callback error was successfully accepted.

Changes

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