Add to wishlist

Add a variant to a customer’s wishlist. Returns 201 Created on success. If the same (customer_id, product_id, variant_id) already exists, returns 409 Conflict instead of duplicating the entry.

POST /v1/wishlist

Add to wishlist

cURL

curl --request POST \
  --url https://api.tybritelabs.com/v1/wishlist \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <x-auth-token>' \
  --data '
{
  "variant_id": "83b6a47e-4f5c-4090-b8d3-4b606b78f1b4",
  "customer_id": "650e8400-e29b-41d4-a716-446655440000",
  "product_id": "770e8400-e29b-41d4-a716-446655440000"
}
'

201

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "product_name": "Sony WH-1000XM4",
      "variant_name": "Blue",
      "variant_attributes": {
        "color": "Blue"
      },
      "product_sku": "SNY-WH1001",
      "product_price": 36999,
      "thumbnail_url": "https://pub-41977a...r2.dev/.../primary-image.jpg",
      "media": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "url": "<string>",
          "position": 123,
          "alt_text": "<string>",
          "is_primary": true
        }
      ],
      "stock_available": 35,
      "has_variants": true,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_items": 123,
  "customer_id": "<string>"
}

Authorizations

Authorization · string · header · required

API Key Authentication

Use your API key in the Authorization header:

Authorization: Bearer tybrite_sk_live_YOUR_KEY

Key Types:

Secret Keys (Server-Side Only):

• Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
• Full read/write access to all endpoints
• ⚠️ NEVER expose in client-side code or public repositories
• Required for: write operations, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

• Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
• Read-only access (GET requests only, plus POST semantic search)
• ✅ Safe for client-side JavaScript, mobile apps, and public code
• Allowed for: browsing products, search, CMS content, pricing queries

Endpoint-Specific Requirements:

• Authentication endpoints (/v1/auth/*): Secret key required
• Payment verification (POST /v1/payments/verify): Secret key required
• AI Recommendations (POST /v1/recommendations): Secret key required
• Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
• All write operations: Secret key required
• All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Headers

x-auth-token · string · required

Customer session access_token from /v1/auth/login or /v1/auth/verify-otp. The resolved customer must match the customer_id in the request.

Body

application/json

variant_id · string<uuid> · required

Specific product variant UUID

Example:

"83b6a47e-4f5c-4090-b8d3-4b606b78f1b4"

customer_id · string<uuid> · required

Customer UUID

Example:

"650e8400-e29b-41d4-a716-446655440000"

product_id · string<uuid>

Legacy/optional online product UUID. Ignored when variant_id is provided; included for backwards compatibility.

Example:

"770e8400-e29b-41d4-a716-446655440000"

Response

201

application/json

Item added (returns refreshed wishlist)

items · object[]

Show child attributes

total_items · integer

customer_id · string