Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hellocobi.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Schema

{
  "type": "object",
  "required": ["shop_id", "name", "region"],
  "properties": {
    "shop_id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the shop"
    },
    "name": {
      "type": "string",
      "description": "Name of the shop"
    },
    "region": {
      "type": "string",
      "description": "Geographic region (2-letter country code, ISO 3166-1 alpha-2)"
    },
    "is_public": {
      "type": "boolean",
      "nullable": true,
      "description": "Flag indicating if the shop is public"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Timestamp when the record was created"
    },
    "updated": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Timestamp when the record was last updated"
    },
    "is_deleted": {
      "type": "boolean",
      "nullable": true,
      "description": "Flag indicating if the record is marked as deleted"
    }
  }
}

​
Field Descriptions

​
Required Fields

FieldTypeFormatDescription
shop_idstringUUIDUnique identifier for the shop
namestring-Name of the shop
regionstring-Geographic region (2-letter country code, e.g., “CA” for Canada)

​
Optional Fields

FieldTypeFormatDescription
is_publicboolean-Flag indicating if the shop is public
createdstringdate-timeTimestamp when the record was created
updatedstringdate-timeTimestamp when the record was last updated
is_deletedboolean-Flag indicating if the record is marked as deleted

​
Example

{
  "shop_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Campus Bookstore",
  "region": "CA",
  "is_public": true,
  "created": "2023-01-15T14:30:00Z",
  "updated": "2023-06-22T09:15:30Z",
  "is_deleted": false
}

​
Best Practices

  1. UUID Format: Use valid UUID v4 format for shop_id
  2. Region Codes: Use ISO 3166-1 alpha-2 country codes (e.g., “CA” for Canada, “US” for United States)
  3. Data Consistency: Ensure consistent data across all shop records
Need help? Contact our support team at [email protected]