Otter · JSON Structure

Public Api Upsert Storelink Event Result Request Structure

UpsertStorelinkEventResultRequest schema from Public API (Otter Public API).

Type: object Properties: 3 Required: 1
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

UpsertStorelinkEventResultRequest is a JSON Structure definition published by Otter, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

success storeId errorMessage

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-structure/public-api-upsert-storelink-event-result-request-structure.json",
  "name": "UpsertStorelinkEventResultRequest",
  "description": "UpsertStorelinkEventResultRequest schema from Public API (Otter Public API).",
  "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"
  ]
}