Wuilt E-Commerce API

https://store-docs.wuilt.com
Admin
Wuilt E-Commerce API allows seamless integration with powerful GraphQL APIs to manage products,...
Tokens:203,674
Snippets:1,214
Trust Score:9.5
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install ngrok and expose local server

Source: https://store-docs.wuilt.com/docs/webhooks

Commands to install ngrok globally and expose a local server on port 3000. The generated URL (e.g., https://abc123.ngrok.io/webhooks/wuilt) is used for webhook registration in the Wuilt Dashboard.

```bash
# Install ngrok
npm install -g ngrok

# Expose your local server
ngrok http 3000

# Use the generated URL for webhook registration
# https://abc123.ngrok.io/webhooks/wuilt
```

--------------------------------

### CHECKOUT_INITIATED webhook payload JSON example

Source: https://store-docs.wuilt.com/docs/webhooks

Example payload for the CHECKOUT_INITIATED webhook, triggered when a customer navigates to the checkout page. The payload includes storeId and a CartDocument with cart items, contact info, store details, and receipt totals. Delivered in real-time once per checkout navigation.

```json
{
  "event": "CHECKOUT_INITIATED",
  "payload": {
    "storeId": "store-uuid",
    "cart": {
      "id": "uuid",
      "status": "ACTIVE",
      "cartSimpleItems": [
        {
          "id": "uuid",
          "quantity": 2,
          "productId": "uuid",
          "variantId": "uuid",
          "price": { "amount": 150, "currencyCode": "EGP" }
        }
      ],
      "cartCustomItems": [],
      "contactInfo": {
        "email": "customer@example.com",
        "firstName": "Sara",
        "lastName": "Ali"
      },
      "store": {
        "id": "store-uuid",
        "name": "My Store",
        "currencyCode": "EGP"
      },
      "receipt": {
        "subtotal": { "amount": 300, "currencyCode": "EGP" },
        "total": { "amount": 350, "currencyCode": "EGP" }
      },
      "createdAt": "2026-06-13T14:00:00.000Z",
      "updatedAt": "2026-06-13T14:05:00.000Z"
    }
  },
  "metaData": {
    "webhookId": "webhook-uuid",
    "storeId": "store-uuid",
    "timestamp": "2026-06-13T14:05:01.000Z",
    "apiVersion": "V1"
  }
}
```

--------------------------------

### Example checkout URL with Wuilt Pay

Source: https://store-docs.wuilt.com/docs/guides/build-custom-landing-page

Example of a checkout URL with Wuilt Pay using a sample store handle and cart ID.

```text
https://pay.wuiltstore.com/en/store/groceries-test-store/cart/Cart_b9a8ee66-5bf0-4cc0-9f78-7e8ac2403b87
```

--------------------------------

### PRODUCT_UPDATED payload example

Source: https://store-docs.wuilt.com/docs/webhooks

Example payload for the PRODUCT_UPDATED webhook event, triggered when product details are modified. The payload type is ProductInfo.

```json
{
  "event": "PRODUCT_UPDATED",
  "payload": {
    "product": {
      "_id": "cmdzpoejh1mee01m2fctjd4dj",
      "type": "SIMPLE",
      "storeId": "cmdn0qc2s067k01kif865gtcy",
      "title": "Product Title",
      "descriptionHtml": "<p>Product Description</p>",
      "options": [],
      "media": [],
      "handle": "product-handle",
      "isArchived": false,
      "isVisible": true,
      "isDeleted": false,
      "seo": {
        "title": "Product Title",
        "description": "Product Description"
      },
      "locale": "en",
      "shortDescription": "Product Description",
      "collectionIds": [
        "cmdritvm3148r01m282gg74ek",
        "cmdr85b06160e01r5d8t24qwn"
      ],
      "status": "ACTIVE",
      "source": "MANUAL",
      "attributes": [
        {
          "attributeId": "cmdo7jnx30z4z01m2bk5ddue6",
          "valuesIds": ["cmdo7k1sg0z5001m2cu3ffo1k"],
          "_id": "689313698435803e6b6f98d5"
        },
        {
          "attributeId": "cmdo7la6h17gc01q7d66shgu8",
          "valuesIds": ["cmdzpcttz1j5m01r5eqp11qdh"],
          "_id": "689313698435803e6b6f98d6"
        },
        {
          "attributeId": "cmdtyrxtz1fy501q76v7m8gic",
          "valuesIds": ["cmdzpdfcn1me601m252059th1"],
          "_id": "689313698435803e6b6f98d7"
        },
        {
          "attributeId": "cmdtxb62800i301no82jg9mj2",
          "valuesIds": [
            "cmdy81c601gr801r5fq3b4oh6",
            "cmdzpefr71me701m26jyq74ra"
          ],
          "_id": "689313698435803e6b6f98d8"
        }
      ],
      "productVariants": [],
      "productTax": null,
      "taxable": false,
      "createdAt": "2025-08-06T08:33:45.641Z",
      "updatedAt": "2025-08-06T08:33:45.641Z",
      "variants": [
        {
          "_id": "cmdzpoek01mef01m28ohd7kzk",
          "type": "variant",
          "productId": "cmdzpoejh1mee01m2fctjd4dj",
          "storeId": "cmdn0qc2a067k01kif865gtcy",
          "sku": "",
          "trackQuantity": true,
          "quantity": 0,
          "price": {
            "amount": 220,
            "currencyCode": "EGP"
          },
          "compareAtPrice": {
            "amount": 250,
            "currencyCode": "EGP"
          },
          "selectedOptionsIds": [],
          "selectedOptionValuesIds": [],
          "isDeleted": false,
          "cost": null,
          "externalId": "",
          "cartLimitsEnabled": false,
          "minPerCart": 1,
          "maxPerCart": 100,
          "packageDetails": {
            "weight": null,
            "dimensions": {
              "length": null,
              "width": null,
              "height": null
            }
          },
          "reservations": [],
          "createdAt": "2025-08-06T08:33:45.651Z",
          "updatedAt": "2025-08-06T08:33:45.651Z"
        }
      ],
      "isTaxable": false
    }
  },
  "metadata": {
    "apiVersion": "2024-01",
    "timestamp": "2024-01-16T11:30:00Z",
    "storeId": "store_abc123def456"
  }
}
```

--------------------------------

### CUSTOMER_CREATED webhook payload example

Source: https://store-docs.wuilt.com/docs/webhooks

Example JSON payload for the CUSTOMER_CREATED webhook event, triggered when a new customer account is created. The payload contains a customer object with fields such as _id, name, email, phone, storeId, isGuest, preferredLocale, and addresses. Metadata includes apiVersion, timestamp, and storeId.

```json
{
  "event": "CUSTOMER_CREATED",
  "payload": {
    "customer": {
      "_id": "cmdyk6iy44alh017007yhblv4",
      "name": "John Doe",
      "email": "john.doe@gmail.com",
      "phone": "+201111111111",
      "storeId": "clvbieoia04o601j8886abo1h",
      "isGuest": true,
      "preferredLocale": "en",
      "addresses": [
        {
          "_id": "cmdyk6iy44alg01705vlvef5y",
          "area": {
            "stateId": "cl0pf3jxs02jtlwm1hs2u6g0z",
            "countryId": "cl0pf3jxc00m1lwm1hw3u66ri"
          },
          "notes": "test note",
          "secondPhone": "+201111111111",
          "addressLine1": "123 Main St",
          "addressLine2": "Apt 4B",
          "isDefault": true
        }
      ]
    }
  },
  "metadata": {
    "apiVersion": "2024-01",
    "timestamp": "2024-01-15T12:00:00Z",
    "storeId": "cmdyk6iy44alh017007yhblv4"
  }
}
```

--------------------------------

### Example variables for GetCart

Source: https://store-docs.wuilt.com/docs/guides/ai-landing-page-prompt

Example variables for the GetCart query. Uses a sample storeId and a cart id.

```json
{
  "storeId": "Store_cm84j35iy02m001i89iiu2cts",
  "id": "Cart_d8f8ce2f-681e-4554-93b7-230e0b34a151"
}
```

--------------------------------

### GetProductDetails Example Variables

Source: https://store-docs.wuilt.com/docs/guides/ai-landing-page-prompt

Example variables for the GetProductDetails query. Replace storeId and handle with actual values from the user's product URL.

```json
{
  "storeId": "Store_cm84j35iy02m001i89iiu2cts",
  "handle": "example-product",
  "locale": "en"
}
```

--------------------------------

### ORDER_PLACED payload example

Source: https://store-docs.wuilt.com/docs/webhooks

Example JSON payload for the ORDER_PLACED event, showing the structure of the order data included in the webhook notification.

```json
{
  "event": "ORDER_PLACED",
  "payload": {
    "order": {
      "_id": "cmdlpac7n000201pm3dgifkqu",
      "storeId": "cm4qwjv0e004s01k77o2f1f5e",
      "cartId": "d3f61199-b262-4deb-a42d-31a5b93952b0",
      "status": "SUCCESSFUL",
      "errors": [],
      "subtotal": {
        "amount": 3000,
        "currencyCode": "EGP"
      },
      "totalPrice": {
        "amount": 3200,
        "currencyCode": "EGP"
      },
      "shippingRateCost": {
        "amount": 75,
        "currencyCode": "EGP"
      },
      "fulfillmentStatus": "UNFULFILLED",
      "notes": "",
      "shippingRateId": "clzvqvezy0004017i4vwe4667",
      "shippingRateName": "Bosta",
      "promoCodeSnapshot": null,
      "isArchived": false,
      "isCanceled": false,
      "isViewed": false,
      "customerId": "cm4qwyzfv000g018y6mv39bnd",
      "itemsCount": 1,
      "fulfilledItems": 0,
      "shippingAddress": {
        "addressLine1": "11th Districtttt",
        "addressLine2": "12th apartment",
        "phone": "+201111111111",
        "secondPhone": null,
        "postalCode": "001",
        "notes": "",
        "countryCode2": "EG",
        "countryName": "Egypt",
        "stateName": "Alexandria",
        "cityName": "Borg Al Arab City",
        "area": {
          "countryId": "clzy5vtku0000kn9kagau94vi",
          "stateId": "clzy5vtl6004rkn9k8dx8gmml",
          "cityId": "clzy5vtl7004ukn9k1my75jhi"
        },
        "areaSnapshot": {
          "countryName": "Egypt",
          "stateName": "Alexandria",
          "cityName": "Borg Al Arab City"
        }
      },
      "billingAddress": {
        "addressLine1": "11th Districtttt",
        "addressLine2": "12th apartment",
        "phone": "+201111111111",
        "secondPhone": null,
        "postalCode": "001",
        "notes": "",
        "countryCode2": "EG",
        "countryName": "Egypt",
        "stateName": "Alexandria",
        "cityName": "Borg Al Arab City",
        "area": {
          "countryId": "clzy5vtku0000kn9kagau94vi",
          "stateId": "clzy5vtl6004rkn9k8dx8gmml",
          "cityId": "clzy5vtl7004ukn9k1my75jhi"
        },
        "areaSnapshot": {
          "countryName": "Egypt",
          "stateName": "Alexandria",
          "cityName": "Borg Al Arab City"
        }
      },
      "promoCode": null,
      "customer": {
        "name": "John Doe",
        "email": "john.doe@gmail.com",
        "phone": "+201111111111",
        "isSubscribedToNewsLetter": true
      },
      "storeData": {
        "name": "John Doe",
        "logo": null
      }
    }
  }
}
```

--------------------------------

### JavaScript/Node.js Example Request

Source: https://store-docs.wuilt.com/docs/generate-api-key

Example of making a GraphQL request to Wuilt using fetch in JavaScript/Node.js. Replace 'your_api_key_here' and 'your_store_id' with your actual credentials.

```javascript
const response = await fetch("https://graphql.wuilt.com/", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-KEY": "your_api_key_here",
  },
  body: JSON.stringify({
    query: `
      query GetStoreInfo($storeId: String!) {
        store(id: $storeId) {
          id
          name
          email
        }
      }
    `,
    variables: {
      storeId: "your_store_id",
    },
  }),
});

const data = await response.json();
console.log(data);
```

--------------------------------

### CreateCollection Query Variables Example

Source: https://store-docs.wuilt.com/docs/SampleAPIs/CreateCollection

Example query variables for the CreateCollection mutation, including storeId, collection details, SEO, products to add, and translations. Replace storeId with your own store ID.

```json
{
"input": {
  "storeId": "Store_cm84j35iy02m001i89iiu2cts",
  "title": "Electronics & Gadgets",
  "handle": "electronics-gadgets",
  "descriptionHtml": "<p>Discover our curated collection of cutting-edge electronics and innovative gadgets. From smartphones and laptops to smart home devices and wearables, find the latest technology to enhance your digital lifestyle.</p>",
  "shortDescription": "Cutting-edge electronics and innovative gadgets for the modern lifestyle",
  "isVisible": true,
  "isArchived": false,
  "isDeleted": false,
  "image": {
    "src": "https://example.com/collections/electronics-banner.jpg",
    "altText": "Electronics and Gadgets Collection Banner"
  },
  "seo": {
    "title": "Electronics & Gadgets - Latest Technology Products",
    "description": "Shop the latest electronics and gadgets including smartphones, laptops, smart home devices, and wearables. Free shipping on orders over $100."
  },
  "productsToAdd": [
    "Product_smartphone_001",
    "Product_laptop_002",
    "Product_headphones_003"
  ],
  "translations": [
    {
      "title": "الإلكترونيات والأجهزة",
      "descriptionHtml": "<p>اكتشف مجموعتنا المختارة من الإلكترونيات المتطورة والأجهزة المبتكرة.</p>",
      "shortDescription": "إلكترونيات متطورة وأجهزة مبتكرة لنمط الحياة العصري",
      "locale": "ar",
      "seo": {
        "title": "الإلكترونيات والأجهزة - أحدث منتجات التكنولوجيا",
        "description": "تسوق أحدث الإلكترونيات والأجهزة بما في ذلك الهواتف الذكية وأجهزة الكمبيوتر المحمولة."
      }
    }
  ]
},
"locale": "en"
}
```

--------------------------------

### CUSTOMER_UPDATED webhook payload example

Source: https://store-docs.wuilt.com/docs/webhooks

Example JSON payload for the CUSTOMER_UPDATED webhook event, triggered when customer information is modified. The payload contains a customer object with fields such as _id, name, email, phone, storeId, isGuest, preferredLocale, and addresses. Metadata includes apiVersion, timestamp, and storeId.

```json
{
  "event": "CUSTOMER_UPDATED",
  "payload": {
    "customer": {
      "_id": "cmdyk6iy44alh017007yhblv4",
      "name": "John Doe",
      "email": "john.doe@gmail.com",
      "phone": "+201111111111",
      "storeId": "clvbieoia04o601j8886abo1h",
      "isGuest": true,
      "preferredLocale": "en",
      "addresses": [
        {
          "_id": "cmdyk6iy44alg01705vlvef5y",
          "area": {
            "stateId": "cl0pf3jxs02jtlwm1hs2u6g0z",
            "countryId": "cl0pf3jxc00m1lwm1hw3u66ri"
          },
          "notes": "test note",
          "secondPhone": "+201111111111",
          "addressLine1": "123 Main St",
          "addressLine2": "Apt 4B",
          "isDefault": true
        }
      ]
    }
  },
  "metadata": {
    "apiVersion": "2024-01",
    "timestamp": "2024-01-20T09:30:00Z",
    "storeId": "store_abc123def456"
  }
}
```

--------------------------------

### PRODUCT_DELETED payload example

Source: https://store-docs.wuilt.com/docs/webhooks

Example payload for the PRODUCT_DELETED webhook event, triggered when a product is deleted from the store. The payload type is EntityDeletedEventPayload.

```json
{
  "event": "PRODUCT_DELETED",
  "payload": {
    "id": "689313698435803e6b6f98d8",
    "deletedAt": "2024-01-17T16:45:00Z"
  },
  "metadata": {
    "apiVersion": "2024-01",
    "timestamp": "2024-01-17T16:45:00Z",
    "storeId": "store_abc123def456"
  }
}
```

--------------------------------

### cURL Example Request

Source: https://store-docs.wuilt.com/docs/generate-api-key

Example of making a GraphQL request to Wuilt using cURL. Replace 'your_api_key_here' and 'your_store_id' with your actual credentials.

```bash
curl -X POST https://graphql.wuilt.com/ \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: your_api_key_here" \
  -d '{
    "query": "query GetStoreInfo($storeId: String!) { store(id: $storeId) { id name email } }",
    "variables": { "storeId": "your_store_id" }
  }'
```

--------------------------------

### Example checkout URL without Wuilt Pay

Source: https://store-docs.wuilt.com/docs/guides/build-custom-landing-page

Example of a checkout URL without Wuilt Pay using a sample store domain and cart ID.

```text
https://pharmacy.wuiltstore.com/en/checkout/Cart_d8f8ce2f-681e-4554-93b7-230e0b34a151
```

--------------------------------

### Respond Quickly to Webhooks

Source: https://store-docs.wuilt.com/docs/webhooks

Respond to webhooks within 10 seconds to avoid timeouts. Respond immediately with 200 OK and process asynchronously using setImmediate.

```javascript
app.post("/webhooks/wuilt", (req, res) => {
  // Respond immediately
  res.status(200).send("OK");

  // Process webhook asynchronously
  setImmediate(() => {
    processWebhookAsync(req.body);
  });
});
```

--------------------------------

### Install Context7 MCP server globally

Source: https://store-docs.wuilt.com/docs/ai-assistant-integration

Install the Context7 MCP server package globally via npm for use with AI code editors like Cursor or Windsurf.

```bash
npm install -g @upstash/context7-mcp
```

--------------------------------

### Example variables for ReplaceCartItems

Source: https://store-docs.wuilt.com/docs/guides/ai-landing-page-prompt

Example variables for the ReplaceCartItems mutation. Uses a sample storeId and a variantId with quantity 1.

```json
{
  "storeId": "Store_cm84j35iy02m001i89iiu2cts",
  "item": {
    "variantId": "ProductVariant_buy_now_001",
    "quantity": 1
  }
}
```

--------------------------------

### Example Store ID format

Source: https://store-docs.wuilt.com/docs/store-id

Example of an alphanumeric Store ID string that appears after /store/ in the URL.

```text
Store_clp157fecxxxq01j5g192gp09
```

--------------------------------

### Example variables for ApplyPromoCode

Source: https://store-docs.wuilt.com/docs/SampleAPIs/ApplyPromoCode

Provide the storeId, cartId, and promo code to apply. The storeId must be your own store ID; see the Store ID guide for details.

```json
{
  "storeId": "Store_cm84j35iy02m001i89iiu2cts",
  "cartId": "Cart_d8f8ce2f-681e-4554-93b7-230e0b34a151",
  "code": "SUMMER-2025"
}
```

--------------------------------

### UpdateSimpleItem example variables (update quantity to 3)

Source: https://store-docs.wuilt.com/docs/guides/ai-landing-page-prompt

Example variables for the UpdateSimpleItem mutation to update the quantity of a variant to 3.

```json
{
  "storeId": "Store_cm84j35iy02m001i89iiu2cts",
  "item": {
    "variantId": "ProductVariant_cmi3ooen020wf01yh5n7ef0ht",
    "quantity": 3
  }
}
```

--------------------------------

### Query Variables for AddProductsToCollection

Source: https://store-docs.wuilt.com/docs/SampleAPIs/AddProductsToCollection

Example variables for the AddProductsToCollection mutation. Replace storeId with your store ID.

```json
{
"storeId": "Store_cm84j35iy02m001i89iiu2cts",
"id": "Collection_electronics_001",
"productIds": [
  "Product_smartphone_galaxy_001",
  "Product_laptop_macbook_002",
  "Product_tablet_ipad_003",
  "Product_smartwatch_apple_004",
  "Product_earbuds_airpods_005"
]
}
```

--------------------------------

### Example prompt for using Context7 link with AI assistant

Source: https://store-docs.wuilt.com/docs/ai-assistant-integration

Use this prompt template to ask an AI assistant to write code using the Wuilt GraphQL API, with a Context7 link included as context.

```text
Using this context: [Context7 link]

Write a Node.js function to fetch all orders for my store using the Wuilt GraphQL API.
```

--------------------------------

### Test webhook handler with sample payload

Source: https://store-docs.wuilt.com/docs/webhooks

JavaScript function that simulates an ORDER_PLACED webhook event by constructing a sample payload and calling handleWebhook(samplePayload). Useful for testing your webhook handler without a real event.

```javascript
// Test webhook handler with sample data
function testOrderPlacedWebhook() {
  const samplePayload = {
    event: "ORDER_PLACED",
    payload: {
      id: "test_order_123",
      orderNumber: "TEST-001",
      status: "pending",
      // ... other order fields
    },
    metadata: {
      apiVersion: "2024-01",
      timestamp: new Date().toISOString(),
      storeId: "test_store_123",
    },
  };

  // Simulate webhook call
  handleWebhook(samplePayload);
}
```

--------------------------------

### Query Variables for CreateProductOptionValue

Source: https://store-docs.wuilt.com/docs/SampleAPIs/CreateProductOptionValue

Example input variables for the mutation. Replace the storeId with your own store ID.

```json
{
"input": {
  "name": "Large",
  "optionId": "ProductOption_ckx7luivs006u01qrfx8z1bcy",
  "locale": "en",
  "storeId": "Store_ckug02l8r01e601h1gr80e0x7"
}
}
```

--------------------------------

### New Product Launch - JSON payload

Source: https://store-docs.wuilt.com/docs/SampleAPIs/AddProductsToCollection

Example payload for adding new products to a collection during a product launch. Replace storeId, id, and productIds with actual values.

```json
{
  "storeId": "Store_example_001",
  "id": "Collection_new_arrivals",
  "productIds": [
    "Product_latest_smartphone_001",
    "Product_new_headphones_002"
  ]
}
```

--------------------------------

### Implement Retry Logic with Exponential Backoff

Source: https://store-docs.wuilt.com/docs/webhooks

Handle webhook failures gracefully with exponential backoff. Retries up to maxRetries (default 3) with delays of 2^attempt * 1000 ms. Logs to dead letter queue or alert system after max retries.

```javascript
async function processWebhookWithRetry(webhookData, maxRetries = 3) {
  for (let attempt = 1; attempt <= maxRetries; attempt++) {
    try {
      await processWebhook(webhookData);
      return; // Success
    } catch (error) {
      console.error(`Webhook processing failed (attempt ${attempt}):`, error);

      if (attempt === maxRetries) {
        // Log to dead letter queue or alert system
        console.error("Max retries exceeded for webhook:", webhookData);
        return;
      }

      // Exponential backoff
      const delay = Math.pow(2, attempt) * 1000;
      await new Promise((resolve) => setTimeout(resolve, delay));
    }
  }
}
```

--------------------------------

### Log Webhook Events

Source: https://store-docs.wuilt.com/docs/webhooks

Keep detailed logs for debugging and monitoring. Logs received webhook details, successful processing, and failures with error message and stack trace.

```javascript
app.post("/webhooks/wuilt", (req, res) => {
  const { event, payload, metadata } = req.body;

  console.log("Webhook received:", {
    event,
    resourceId: payload.id,
    storeId: metadata.storeId,
    timestamp: metadata.timestamp,
    apiVersion: metadata.apiVersion,
  });

  try {
    processWebhook(event, payload, metadata);
    console.log("Webhook processed successfully:", event, payload.id);
  } catch (error) {
    console.error("Webhook processing failed:", {
      event,
      resourceId: payload.id,
      error: error.message,
      stack: error.stack,
    });
  }

  res.status(200).send("OK");
});
```

--------------------------------

### Example CreateCustomer Response JSON

Source: https://store-docs.wuilt.com/docs/SampleAPIs/CreateCustomer

Shows the JSON structure returned by the createCustomer mutation, including customer details, addresses, orders, and tags. Use as a reference for expected response format.

```json
{
  "data": {
    "createCustomer": {
      "customer": {
        "id": "Customer_john_smith_001",
        "firstName": "John",
        "lastName": "Smith",
        "email": "john.smith@example.com",
        "phone": "+1-555-123-4567",
        "isActive": true,
        "isVerified": false,
        "locale": "en",
        "createdAt": "2024-01-15T10:30:00Z",
        "updatedAt": "2024-01-15T10:30:00Z",
        "addresses": [
          {
            "id": "Address_001",
            "addressLine1": "123 Main Street",
            "addressLine2": "Apt 4B",
            "phone": "+1-555-123-4567",
            "postalCode": "10001",
            "areaSnapshot": {
              "cityName": "New York",
              "stateName": "New York",
              "countryName": "United States"
            }
          }
        ],
        "orders": {
          "totalCount": 0,
          "nodes": []
        },
        "tags": [
          {
            "id": "Tag_vip_001",
            "name": "VIP",
            "color": "#FFD700"
          }
        ]
      }
    }
  }
}
```

--------------------------------

### Try It Out query variables (GetProductDetails)

Source: https://store-docs.wuilt.com/docs/SampleAPIs/GetProductDetails

Query variables for the Try It Out panel. Same as the example variables but formatted without indentation. Replace storeId with your own store ID.

```json
{
"storeId": "Store_cm84j35iy02m001i89iiu2cts",
"handle": "example-product",
"locale": "en"
}
```

--------------------------------

### Handle Webhooks Idempotently

Source: https://store-docs.wuilt.com/docs/webhooks

Wuilt may send the same webhook multiple times. Use a Set to track processed webhook IDs and return 200 OK for duplicates.

```javascript
const processedWebhooks = new Set();

app.post("/webhooks/wuilt", (req, res) => {
  const { event, payload, metadata } = req.body;
  const webhookId = `${event}-${payload.id}-${metadata.timestamp}`;

  // Check if we've already processed this webhook
  if (processedWebhooks.has(webhookId)) {
    console.log("Webhook already processed:", webhookId);
    return res.status(200).send("OK");
  }

  // Process the webhook
  processWebhook(event, payload, metadata);

  // Mark as processed
  processedWebhooks.add(webhookId);

  res.status(200).send("OK");
});
```

--------------------------------

### Query Variables for CreateProductAttributeValue

Source: https://store-docs.wuilt.com/docs/SampleAPIs/CreateProductAttributeValue

Example variables for the mutation. Replace the storeId with your own store ID.

```json
{
"input": {
  "name": "Cotton",
  "attributeId": "ProductAttribute_example_id_here",
  "locale": "en",
  "storeId": "Store_ckug02l8r01e601h1gr80e0x7"
}
}
```

--------------------------------

### CHECKOUT_INITIATED

Source: https://store-docs.wuilt.com/docs/webhooks

Triggered when a customer navigates to the checkout page. Delivered in real-time, fires once per checkout navigation. Use it to track checkout funnel conversion, trigger real-time support, or sync checkout intent with CRM tools.

```APIDOC
## CHECKOUT_INITIATED

### Description
Triggered when a customer navigates to the checkout page. Delivered in real-time, fires once per checkout navigation. Use it to track checkout funnel conversion, trigger real-time support, or sync checkout intent with CRM tools.

### Event
CHECKOUT_INITIATED

### Payload Type
`{ storeId: string, cart: CartDocument }`

### Payload Fields
- **storeId** (string) - The store where checkout was initiated
- **cart.id** (string) - Cart identifier
- **cart.status** (string) - Cart status (ACTIVE)
- **cart.cartSimpleItems** (array) - Array of simple product items in the cart
- **cart.cartCustomItems** (array) - Array of custom product items in the cart
- **cart.contactInfo** (object) - Customer contact information (email, name, phone)
- **cart.store** (object) - Store information
- **cart.receipt** (object) - Cart totals (subtotal, total, shipping)

### Delivery
Real-time. Fires once when the customer navigates to checkout.

### Use Cases
- Track checkout funnel conversion in external analytics
- Trigger real-time support chat for high-value carts
- Sync checkout intent with CRM tools

### Request Example
```json
{
  "event": "CHECKOUT_INITIATED",
  "payload": {
    "storeId": "store-uuid",
    "cart": {
      "id": "uuid",
      "status": "ACTIVE",
      "cartSimpleItems": [
        {
          "id": "uuid",
          "quantity": 2,
          "productId": "uuid",
          "variantId": "uuid",
          "price": { "amount": 150, "currencyCode": "EGP" }
        }
      ],
      "cartCustomItems": [],
      "contactInfo": {
        "email": "customer@example.com",
        "firstName": "Sara",
        "lastName": "Ali"
      },
      "store": {
        "id": "store-uuid",
        "name": "My Store",
        "currencyCode": "EGP"
      },
      "receipt": {
        "subtotal": { "amount": 300, "currencyCode": "EGP" },
        "total": { "amount": 350, "currencyCode": "EGP" }
      },
      "createdAt": "2026-06-13T14:00:00.000Z",
      "updatedAt": "2026-06-13T14:05:00.000Z"
    }
  },
  "metaData": {
    "webhookId": "webhook-uuid",
    "storeId": "store-uuid",
    "timestamp": "2026-06-13T14:05:01.000Z",
    "apiVersion": "V1"
  }
}
```
```

--------------------------------

### getAllProducts

Source: https://store-docs.wuilt.com/docs/operations/queries/get-all-products

GraphQL query to retrieve all dropshipping products for a given installation and store. It accepts connection, installation, locale, currency, and store identifiers as arguments.

```APIDOC
## getAllProducts

### Description
GraphQL query to retrieve all dropshipping products for a given installation and store. It accepts connection, installation, locale, currency, and store identifiers as arguments.

### Method
QUERY

### Endpoint
Not specified (GraphQL operation)

### Arguments
- **connection** (DropshippingProductConnectionInput!) - Required - Input for the connection.
- **installationId** (ID!) - Required - The installation identifier.
- **locale** (String) - Optional - The locale for the query.
- **storeCurrency** (CurrencyCode) - Optional - The store currency code.
- **storeId** (ID!) - Required - The store identifier.

### Response
#### Success Response
- **DropshippingProductConnection** (object) - The connection object containing the dropshipping products.
```

--------------------------------

### PRODUCT_UPDATED

Source: https://store-docs.wuilt.com/docs/webhooks

Triggered when product details are modified. The payload contains the updated product information.

```APIDOC
## PRODUCT_UPDATED

### Description
Triggered when product details are modified.

### Payload Type
`ProductInfo`

### Request Example
```json
{
  "event": "PRODUCT_UPDATED",
  "payload": {
    "product": {
      "_id": "cmdzpoejh1mee01m2fctjd4dj",
      "type": "SIMPLE",
      "storeId": "cmdn0qc2s067k01kif865gtcy",
      "title": "Product Title",
      "descriptionHtml": "<p>Product Description</p>",
      "options": [],
      "media": [],
      "handle": "product-handle",
      "isArchived": false,
      "isVisible": true,
      "isDeleted": false,
      "seo": {
        "title": "Product Title",
        "description": "Product Description"
      },
      "locale": "en",
      "shortDescription": "Product Description",
      "collectionIds": [
        "cmdritvm3148r01m282gg74ek",
        "cmdr85b06160e01r5d8t24qwn"
      ],
      "status": "ACTIVE",
      "source": "MANUAL",
      "attributes": [
        {
          "attributeId": "cmdo7jnx30z4z01m2bk5ddue6",
          "valuesIds": ["cmdo7k1sg0z5001m2cu3ffo1k"],
          "_id": "689313698435803e6b6f98d5"
        },
        {
          "attributeId": "cmdo7la6h17gc01q7d66shgu8",
          "valuesIds": ["cmdzpcttz1j5m01r5eqp11qdh"],
          "_id": "689313698435803e6b6f98d6"
        },
        {
          "attributeId": "cmdtyrxtz1fy501q76v7m8gic",
          "valuesIds": ["cmdzpdfcn1me601m252059th1"],
          "_id": "689313698435803e6b6f98d7"
        },
        {
          "attributeId": "cmdtxb62800i301no82jg9mj2",
          "valuesIds": [
            "cmdy81c601gr801r5fq3b4oh6",
            "cmdzpefr71me701m26jyq74ra"
          ],
          "_id": "689313698435803e6b6f98d8"
        }
      ],
      "productVariants": [],
      "productTax": null,
      "taxable": false,
      "createdAt": "2025-08-06T08:33:45.641Z",
      "updatedAt": "2025-08-06T08:33:45.641Z",
      "variants": [
        {
          "_id": "cmdzpoek01mef01m28ohd7kzk",
          "type": "variant",
          "productId": "cmdzpoejh1mee01m2fctjd4dj",
          "storeId": "cmdn0qc2a067k01kif865gtcy",
          "sku": "",
          "trackQuantity": true,
          "quantity": 0,
          "price": {
            "amount": 220,
            "currencyCode": "EGP"
          },
          "compareAtPrice": {
            "amount": 250,
            "currencyCode": "EGP"
          },
          "selectedOptionsIds": [],
          "selectedOptionValuesIds": [],
          "isDeleted": false,
          "cost": null,
          "externalId": "",
          "cartLimitsEnabled": false,
          "minPerCart": 1,
          "maxPerCart": 100,
          "packageDetails": {
            "weight": null,
            "dimensions": {
              "length": null,
              "width": null,
              "height": null
            }
          },
          "reservations": [],
          "createdAt": "2025-08-06T08:33:45.651Z",
          "updatedAt": "2025-08-06T08:33:45.651Z"
        }
      ],
      "isTaxable": false
    }
  },
  "metadata": {
    "apiVersion": "2024-01",
    "timestamp": "2024-01-16T11:30:00Z",
    "storeId": "store_abc123def456"
  }
}
```
```

--------------------------------

### PRODUCT_CREATED

Source: https://store-docs.wuilt.com/docs/webhooks

Triggered when a new product is added to the store. Note that bulk import will not trigger this event. The payload type is ProductInfo.

```APIDOC
## PRODUCT_CREATED

### Description
Triggered when a new product is added to the store. Note that bulk import will not trigger this event.

### Payload Type
`ProductInfo`

### Request Example
```json
{
  "event": "PRODUCT_CREATED",
  "payload": {
    "product": {
      "_id": "cmdzpoejh1mee01m2fctjd4dj",
      "type": "SIMPLE",
      "storeId": "cmdnsqc2a067k01kif865gtcy",
      "title": "Product Title",
      "descriptionHtml": "<p>Product Description</p>",
      "options": [],
      "media": [],
      "handle": "product-handle",
      "isArchived": false,
      "isVisible": true,
      "isDeleted": false,
      "seo": {
        "title": "Product Title",
        "description": "Product Description"
      },
      "locale": "en",
      "shortDescription": "Product Description",
      "collectionIds": [
        "cmdritvm3148r01m282gg74ek",
        "cmdr85b06160e01r5d8t24qwn"
      ],
      "status": "ACTIVE",
      "source": "MANUAL",
      "attributes": [
        {
          "attributeId": "cmdo7jnx30z4z01m2bk5ddue6",
          "valuesIds": ["cmdo7k1sg0z5001m2cu3ffo1k"],
          "_id": "689313698435803e6b6f98d5"
        },
        {
          "attributeId": "cmdo7la6h17gc01q7d66shgu8",
          "valuesIds": ["cmdzpcttz1j5m01r5eqp11qdh"],
          "_id": "689313698435803e6b6f98d6"
        },
        {
          "attributeId": "cmdtyrxtz1fy501q76v7m8gic",
          "valuesIds": ["cmdzpdfcn1me601m252059th1"],
          "_id": "689313698435803e6b6f98d7"
        },
        {
          "attributeId": "cmdtxb62800i301no82jg9mj2",
          "valuesIds": [
            "cmdy81c601gr801r5fq3b4oh6",
            "cmdzpefr71me701m26jyq74ra"
          ],
          "_id": "689313698435803e6b6f98d8"
        }
      ],
      "productVariants": [],
      "productTax": null,
      "taxable": false,
      "createdAt": "2025-08-06T08:33:45.641Z",
      "updatedAt": "2025-08-06T08:33:45.641Z",
      "variants": [
        {
          "_id": "cmdzpoek01mef01m28ohd7kzk",
          "type": "variant",
          "productId": "cmdzpoejh1mee01m2fctjd4dj",
          "storeId": "cmdn0qc2a067k01kif865gtcy",
          "sku": "",
          "trackQuantity": true,
          "quantity": 0,
          "price": {
            "amount": 220,
            "currencyCode": "EGP"
          },
          "compareAtPrice": {
            "amount": 250,
            "currencyCode": "EGP"
          },
          "selectedOptionsIds": [],
          "selectedOptionValuesIds": [],
          "isDeleted": false,
          "cost": null,
          "externalId": "",
          "cartLimitsEnabled": false,
          "minPerCart": 1,
          "maxPerCart": 100,
          "packageDetails": {
            "weight": null,
            "dimensions": {
              "length": null,
              "width": null,
              "height": null
            }
          },
          "reservations": [],
          "createdAt": "2025-08-06T08:33:45.651Z",
          "updatedAt": "2025-08-06T08:33:45.651Z"
        }
      ],
      "isTaxable": false
    }
  },
  "metadata": {
    "apiVersion": "2024-01",
    "timestamp": "2024-01-15T08:00:00Z",
    "storeId": "store_abc123def456"
  }
}
```
```

--------------------------------

### CUSTOMER_CREATED

Source: https://store-docs.wuilt.com/docs/webhooks

Triggered when a new customer account is created. The payload contains the customer document with details such as name, email, phone, and addresses.

```APIDOC
## CUSTOMER_CREATED

### Description
Triggered when a new customer account is created.

### Payload Type
`{ customer: CustomerDocument }`

### Payload Example
```json
{
  "event": "CUSTOMER_CREATED",
  "payload": {
    "customer": {
      "_id": "cmdyk6iy44alh017007yhblv4",
      "name": "John Doe",
      "email": "john.doe@gmail.com",
      "phone": "+201111111111",
      "storeId": "clvbieoia04o601j8886abo1h",
      "isGuest": true,
      "preferredLocale": "en",
      "addresses": [
        {
          "_id": "cmdyk6iy44alg01705vlvef5y",
          "area": {
            "stateId": "cl0pf3jxs02jtlwm1hs2u6g0z",
            "countryId": "cl0pf3jxc00m1lwm1hw3u66ri"
          },
          "notes": "test note",
          "secondPhone": "+201111111111",
          "addressLine1": "123 Main St",
          "addressLine2": "Apt 4B",
          "isDefault": true
        }
      ]
    }
  },
  "metadata": {
    "apiVersion": "2024-01",
    "timestamp": "2024-01-15T12:00:00Z",
    "storeId": "cmdyk6iy44alh017007yhblv4"
  }
}
```
```
Tokens:
Raw