Otter · Schema

UpsertStorelinkEventResultRequest

UpsertStorelinkEventResultRequest schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
success boolean Indicates if the partner application successfully created and validated the credential provided through the `Upsert Store Webhook`.
storeId string The unique identifier of the store in the partner application. This ID, along with the `Application ID`, will be used to match the correct store when performing operations. It cannot be longer than 25
errorMessage object The error response object.
View JSON Schema on GitHub

JSON Schema

public-api-upsert-storelink-event-result-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "UpsertStorelinkEventResultRequest",
  "description": "UpsertStorelinkEventResultRequest schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-upsert-storelink-event-result-request-schema.json",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Indicates if the partner application successfully created and validated the credential provided through the `Upsert Store Webhook`.",
      "example": true
    },
    "storeId": {
      "nullable": true,
      "type": "string",
      "description": "The unique identifier of the store in the partner application. 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.",
      "example": "partner-store-unique-identifier"
    },
    "errorMessage": {
      "nullable": true,
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "The error description.",
          "example": "The request body is invalid."
        },
        "details": {
          "type": "array",
          "description": "The error details.",
          "items": {
            "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-error-detail-schema.json"
          }
        }
      },
      "description": "The error response object."
    }
  },
  "required": [
    "success"
  ]
}