Attribuly API Docs
  • Introduction
  • Authentication
  • Endpoint
    • Google Looker Studio
  • API Reference
    • Event summary
    • Order: first and last touchpoint
    • Order: total conversion journey
    • The number of visitors who visited the landing page and then completed the event.
  • Common data structures
    • Customer
    • Order
    • Product
    • Event
      • Page viewed
      • Cart viewed
      • Product viewed
      • Collection viewed
      • Search submitted
      • Product added to cart
      • Product removed to cart
      • Lead form
      • Checkout started
      • Checkout address info submitted
      • Checkout contact info submitted
      • Checkout shipping info submitted
      • Payment info submitted
      • Checkout completed
Powered by GitBook
On this page

Was this helpful?

  1. Common data structures

Product

{
  "id": "Required, the unique identifier of the product, in the format of a GraphQL global ID",
  "title": "Required, the product title",
  "vendor": "Required, the name of the product supplier",
  "productType": "Required, the type of product",
  "createdAt": "Required, the creation time of the product, in ISO 8601 format",
  "updatedAt": "Required, the update time of the product, in ISO 8601 format",
  "publishedAt": "Required, the publication time of the product, in ISO 8601 format",
  "handle": "Required, the URL handle of the product (used to generate friendly URLs)",
  "status": "Required, the status of the product (e.g., ACTIVE)",
  "tags": "Required, a list of product tags; if none, it should be an empty array",
  "bodyHtml": "Required, the HTML description content of the product",
  "collections": {
    "edges": [
      {
        "node": {
          "id": "Required, the unique identifier of the collection, in the format of a GraphQL global ID",
          "title": "Required, the collection title",
          "templateSuffix": "Optional, the suffix of the collection template; if none, it should be an empty string"
        }
      }
    ]
  },
  "media": {
    "edges": [
      {
        "node": {
          "id": "Required, the unique identifier of the media resource, in the format of a GraphQL global ID",
          "preview": {
            "image": {
              "url": "Required, the preview image URL of the media resource"
            }
          }
        }
      }
    ]
  },
  "variants": {
    "edges": [
      {
        "node": {
          "id": "Required, the unique identifier of the product variant, in the format of a GraphQL global ID",
          "price": "Required, the price of the product variant, as a string",
          "compareAtPrice": "Required, the original price of the product variant (used to show discounts), as a string",
          "image": {
            "altText": "Optional, the alternative text for the image; if none, it should be null",
            "url": "Required, the image URL of the product variant"
          },
          "sku": "Required, the SKU (Stock Keeping Unit) of the product variant",
          "title": "Required, the title of the product variant (e.g., 450G, 1KG, etc.)",
          "createdAt": "Required, the creation time of the product variant, in ISO 8601 format",
          "updatedAt": "Required, the update time of the product variant, in ISO 8601 format",
          "barcode": "Required, the barcode of the product variant",
          "inventoryQuantity": "Required, the inventory quantity of the product variant, as a number",
          "position": "Required, the sorting position of the product variant, as a number",
          "inventoryItem": {
            "id": "Required, the unique identifier of the inventory item, in the format of a GraphQL global ID",
            "unitCost": {
              "currencyCode": "Required, the currency code (e.g., USD)",
              "amount": "Required, the unit cost amount, as a string"
            },
            "variant": {
              "id": "Required, the associated product variant ID, in the format of a GraphQL global ID"
            },
            "sku": "Required, the SKU (Stock Keeping Unit) of the inventory item",
            "createdAt": "Required, the creation time of the inventory item, in ISO 8601 format",
            "updatedAt": "Required, the update time of the inventory item, in ISO 8601 format"
          },
          "unitPriceMeasurement": {
            "measuredType": "Optional, the measurement type of the unit price; if none, it should be null",
            "referenceValue": "Optional, the reference value of the unit price, as a number"
          }
        }
      }
    ]
  }
}
{
    "id": "gid://shopify/Product/8000411762944",
    "title": "BROOKFARM MAPLE VANILLA NUTTY GRANOLA",
    "vendor": "Test-Dmap",
    "productType": "Insurance",
    "createdAt": "2022-10-14T10:06:41Z",
    "updatedAt": "2025-03-22T04:51:50Z",
    "publishedAt": "2022-10-14T10:06:35Z",
    "handle": "brookfarm-maple-vanilla-nutty-granola",
    "status": "ACTIVE",
    "tags": [
        "haha",
        "happle"
    ],
    "bodyHtml": "<ul data-mce-fragment=\"1\">\n<li data-mce-fragment=\"1\">Fruit free</li>\n<li data-mce-fragment=\"1\">Almonds, pecans, macadamias</li>\n<li data-mce-fragment=\"1\">Protein rich flaxseed</li>\n<li data-mce-fragment=\"1\">Roasted coconut</li>\n</ul>\n<p class=\"product_title entry-title\" data-mce-fragment=\"1\">A crunchy, nutty granola that is savoured from the first mouthful to the bottom of the bowl. This delicious medley of premium nuts, coconut, super grains and seeds is baked with a drizzle of maple syrup and a hint of vanilla. Sprinkle on yoghurt or serve with milk. Enjoy for breakfast or bake in cookies. They’ve created the perfect mix of natural and organic ingredients.</p>",
    "collections": {
        "edges": [
            {
                "node": {
                    "id": "gid://shopify/Collection/399041134848",
                    "title": "All",
                    "templateSuffix": ""
                }
            },
            {
                "node": {
                    "id": "gid://shopify/Collection/399041167616",
                    "title": "New",
                    "templateSuffix": ""
                }
            },
            {
                "node": {
                    "id": "gid://shopify/Collection/399041200384",
                    "title": "Furit",
                    "templateSuffix": ""
                }
            },
            {
                "node": {
                    "id": "gid://shopify/Collection/399041233152",
                    "title": "Groceries",
                    "templateSuffix": ""
                }
            },
            {
                "node": {
                    "id": "gid://shopify/Collection/408710578432",
                    "title": "Recommended products (Seguno)",
                    "templateSuffix": null
                }
            }
        ]
    },
    "media": {
        "edges": [
            {
                "node": {
                    "id": "gid://shopify/MediaImage/30522044055808",
                    "preview": {
                        "image": {
                            "url": "https://cdn.shopify.com/s/files/1/0659/9517/8240/products/BROOKFARMMAPLEVANILLANUTTYGRANOLA.jpg?v=1665742001"
                        }
                    }
                }
            },
            {
                "node": {
                    "id": "gid://shopify/MediaImage/30522044088576",
                    "preview": {
                        "image": {
                            "url": "https://cdn.shopify.com/s/files/1/0659/9517/8240/products/BROOKFARMMAPLEVANILLANUTTYGRANOLA-2.jpg?v=1665742001"
                        }
                    }
                }
            },
            {
                "node": {
                    "id": "gid://shopify/MediaImage/30522044121344",
                    "preview": {
                        "image": {
                            "url": "https://cdn.shopify.com/s/files/1/0659/9517/8240/products/BROOKFARMMAPLEVANILLANUTTYGRANOLA-3.jpg?v=1665742001"
                        }
                    }
                }
            },
            {
                "node": {
                    "id": "gid://shopify/MediaImage/30522044154112",
                    "preview": {
                        "image": {
                            "url": "https://cdn.shopify.com/s/files/1/0659/9517/8240/products/BROOKFARMMAPLEVANILLANUTTYGRANOLA-4.jpg?v=1665742001"
                        }
                    }
                }
            },
            {
                "node": {
                    "id": "gid://shopify/MediaImage/30522044186880",
                    "preview": {
                        "image": {
                            "url": "https://cdn.shopify.com/s/files/1/0659/9517/8240/products/BROOKFARMMAPLEVANILLANUTTYGRANOLA450G.jpg?v=1665742001"
                        }
                    }
                }
            }
        ]
    },
    "variants": {
        "edges": [
            {
                "node": {
                    "id": "gid://shopify/ProductVariant/43323899117824",
                    "price": "20.00",
                    "compareAtPrice": "50.00",
                    "image": {
                        "altText": null,
                        "url": "https://cdn.shopify.com/s/files/1/0659/9517/8240/products/BROOKFARMMAPLEVANILLANUTTYGRANOLA-4.jpg?v=1665742001"
                    },
                    "sku": "450G SKU",
                    "title": "450G",
                    "createdAt": "2022-10-14T10:06:41Z",
                    "updatedAt": "2025-03-22T04:51:50Z",
                    "barcode": "1234",
                    "inventoryQuantity": 196,
                    "position": 1,
                    "inventoryItem": {
                        "id": "gid://shopify/InventoryItem/45419361861888",
                        "unitCost": {
                            "currencyCode": "USD",
                            "amount": "13.0"
                        },
                        "variant": {
                            "id": "gid://shopify/ProductVariant/43323899117824"
                        },
                        "sku": "450G SKU",
                        "createdAt": "2022-10-14T10:06:41Z",
                        "updatedAt": "2025-03-27T09:21:47Z"
                    },
                    "unitPriceMeasurement": {
                        "measuredType": null,
                        "referenceValue": 0
                    }
                }
            },
            {
                "node": {
                    "id": "gid://shopify/ProductVariant/43323899150592",
                    "price": "35.50",
                    "compareAtPrice": "60.00",
                    "image": {
                        "altText": null,
                        "url": "https://cdn.shopify.com/s/files/1/0659/9517/8240/products/BROOKFARMMAPLEVANILLANUTTYGRANOLA.jpg?v=1665742001"
                    },
                    "sku": "1KG SKU",
                    "title": "1KG",
                    "createdAt": "2022-10-14T10:06:41Z",
                    "updatedAt": "2024-12-31T02:27:59Z",
                    "barcode": "1234445",
                    "inventoryQuantity": 200,
                    "position": 2,
                    "inventoryItem": {
                        "id": "gid://shopify/InventoryItem/45419361894656",
                        "unitCost": {
                            "currencyCode": "USD",
                            "amount": "31.0"
                        },
                        "variant": {
                            "id": "gid://shopify/ProductVariant/43323899150592"
                        },
                        "sku": "1KG SKU",
                        "createdAt": "2022-10-14T10:06:41Z",
                        "updatedAt": "2024-12-31T02:27:59Z"
                    },
                    "unitPriceMeasurement": {
                        "measuredType": null,
                        "referenceValue": 0
                    }
                }
            }
        ]
    }
}
PreviousOrderNextEvent

Last updated 7 days ago

Was this helpful?