BigCommerce · Schema

store/cart/created

This webhook fires on new cart creation when any of the following occur: * a storefront shopper adds their first product to a cart during a new session * an application makes a successful `POST` request to `/carts` using either the [REST Storefront](/docs/rest-storefront/carts#create-a-cart) API or the [REST Management](/docs/rest-management/carts/carts-single#create-a-cart) API * a storefront makes a successful call to create a cart using the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront) Cart creation also fires the `store/cart/updated` webhook. ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", "producer": "stores/{store_hash}", "scope": "store/cart/created", "hash": "352e4afc6dd3fc85ea26bfdf3f91852604d57528", "data": { "type": "cart", "id": "09346904-4175-44fd-be53-f7e598531b6c" } } ```

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/store_cart_created",
  "title": "store/cart/created",
  "description": "This webhook fires on new cart creation when any of the following occur:\n* a storefront shopper adds their first product to a cart during a new session\n* an application makes a successful `POST` request to `/carts` using either the [REST Storefront](/docs/rest-storefront/carts#create-a-cart) API or the [REST Management](/docs/rest-management/carts/carts-single#create-a-cart) API\n* a storefront makes a successful call to create a cart using the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront)\n\nCart creation also fires the `store/cart/updated` webhook.\n\n```json filename=\"Example callback object\" showLineNumbers\n{\n  \"created_at\": 1561482670,\n  \"store_id\": \"1025646\",\n  \"producer\": \"stores/{store_hash}\",\n  \"scope\": \"store/cart/created\",\n  \"hash\": \"352e4afc6dd3fc85ea26bfdf3f91852604d57528\",\n  \"data\": {\n    \"type\": \"cart\",\n    \"id\": \"09346904-4175-44fd-be53-f7e598531b6c\"\n  }\n}\n```",
  "x-examples": {},
  "allOf": [
    {
      "$ref": "#/components/schemas/webhook_callback_base"
    },
    {
      "description": "A lightweight description of the event that triggered the webhook. Will vary depending on the event registered.",
      "properties": {
        "data": {
          "type": "object",
          "description": "A lightweight description of the event that triggered the webhook.",
          "properties": {
            "type": {
              "type": "string",
              "description": "can be `cart` or `cart_line_item`",
              "example": "cart",
              "enum": [
                "cart",
                "cart_line_item"
              ]
            },
            "id": {
              "type": "string",
              "description": "ID of the cart",
              "example": "09346904-4175-44fd-be53-f7e598531b6c"
            }
          }
        }
      }
    }
  ],
  "x-tags": [
    "created"
  ],
  "type": "object",
  "x-internal": false
}