> ## 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.

# Shop Keyword Model

> The shop keyword data model represents the mappings between shops and keywords in the Cobi system.

<Note>
  **Important**: The shop keyword model has dependencies on both the shop and
  keyword models. The `shop_id` field must reference an existing shop and the
  `keyword_id` field must reference an existing keyword. It's recommended to
  upload shop and keyword data before uploading shop keyword mappings.
</Note>

## Schema

```json theme={null}
{
  "type": "object",
  "required": ["shop_keyword_id", "shop_id", "keyword_id"],
  "properties": {
    "shop_keyword_id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the shop keyword mapping"
    },
    "shop_id": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the shop (must reference an existing shop)"
    },
    "keyword_id": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the keyword (must reference an existing keyword)"
    },
    "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

| Field             | Type   | Format | Description                                            |
| ----------------- | ------ | ------ | ------------------------------------------------------ |
| `shop_keyword_id` | string | UUID   | Unique identifier for the shop keyword mapping         |
| `shop_id`         | string | UUID   | ID of the shop (must reference an existing shop)       |
| `keyword_id`      | string | UUID   | ID of the keyword (must reference an existing keyword) |

### Optional Fields

| Field        | Type    | Format    | Description                                        |
| ------------ | ------- | --------- | -------------------------------------------------- |
| `created`    | string  | date-time | Timestamp when the record was created              |
| `updated`    | string  | date-time | Timestamp when the record was last updated         |
| `is_deleted` | boolean | -         | Flag indicating if the record is marked as deleted |

## Example

```json theme={null}
{
  "shop_keyword_id": "550e8400-e29b-41d4-a716-446655440000",
  "shop_id": "550e8400-e29b-41d4-a716-446655440001",
  "keyword_id": "550e8400-e29b-41d4-a716-446655440002",
  "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 all ID fields
2. **Data Dependencies**: Ensure shop\_id references an existing shop and keyword\_id references an existing keyword
3. **Data Consistency**: Ensure consistent data across all shop keyword mapping records

Need help? Contact our support team at [support@hellocobi.com](mailto:support@hellocobi.com)