ChemPare Documentation - v0.0.0
    Preparing search index...

    Interface ATGResponse

    Response structure for ATG (Art Technology Group) product requests. Contains detailed product information including descriptions, display data, and metadata.

    interface ATGResponse {
        result: string;
        response: {
            breadCrumbSchemaJson: {
                breadCrumbSchemaJson: string;
                dataLayer_obj: Record<string, string>;
            };
            standardResult: {
                productName: string;
                productId: string;
                pdpOrderResult: Record<string, unknown>;
                tabsResult: {
                    pdpspecifications: { specificationList: SpecificationItem[] };
                };
            };
            longDescription: string;
            product: string;
            dataLayer: {
                productDetail: {
                    productImageUrl: string;
                    productId: string;
                    productUrl: string;
                    page_type: string;
                    productName: string;
                };
                productPrice: string[];
                dataLayerObject: { dataLayerJson: Record<string, string> };
            };
            canonicalUrl: string;
            isDLProduct: boolean;
            displayName: string;
            isDiscontinuedItem: boolean;
            isproductGrouping: boolean;
            shortDescription: string;
            prodType: string;
            familyVariyantProductDetails: {
                productId: string;
                variantUrl: string;
                schemaJson: {
                    schemaJson: {
                        offers: {
                            image?: string;
                            priceCurrency?: string;
                            price: number;
                            name: string;
                            description?: string;
                            availability: string;
                            sku: string;
                            url: string;
                            itemCondition?: string;
                        }[];
                    };
                };
            };
            familyVariyantDisplayName: string;
            organizationDetails: Record<string, unknown>;
        };
        status: string;
    }
    Index

    Properties

    result: string

    Status of the ATG request result

    response: {
        breadCrumbSchemaJson: {
            breadCrumbSchemaJson: string;
            dataLayer_obj: Record<string, string>;
        };
        standardResult: {
            productName: string;
            productId: string;
            pdpOrderResult: Record<string, unknown>;
            tabsResult: {
                pdpspecifications: { specificationList: SpecificationItem[] };
            };
        };
        longDescription: string;
        product: string;
        dataLayer: {
            productDetail: {
                productImageUrl: string;
                productId: string;
                productUrl: string;
                page_type: string;
                productName: string;
            };
            productPrice: string[];
            dataLayerObject: { dataLayerJson: Record<string, string> };
        };
        canonicalUrl: string;
        isDLProduct: boolean;
        displayName: string;
        isDiscontinuedItem: boolean;
        isproductGrouping: boolean;
        shortDescription: string;
        prodType: string;
        familyVariyantProductDetails: {
            productId: string;
            variantUrl: string;
            schemaJson: {
                schemaJson: {
                    offers: {
                        image?: string;
                        priceCurrency?: string;
                        price: number;
                        name: string;
                        description?: string;
                        availability: string;
                        sku: string;
                        url: string;
                        itemCondition?: string;
                    }[];
                };
            };
        };
        familyVariyantDisplayName: string;
        organizationDetails: Record<string, unknown>;
    }

    Container for the main response data

    Type declaration

    • breadCrumbSchemaJson: { breadCrumbSchemaJson: string; dataLayer_obj: Record<string, string> }

      Schema data for breadcrumb navigation including JSON structure and data layer information

      • breadCrumbSchemaJson: string

        JSON string containing the structured breadcrumb schema data

      • dataLayer_obj: Record<string, string>

        Analytics data layer object specific to breadcrumb navigation

    • standardResult: {
          productName: string;
          productId: string;
          pdpOrderResult: Record<string, unknown>;
          tabsResult: {
              pdpspecifications: { specificationList: SpecificationItem[] };
          };
      }

      Standard result object containing core product information

      • productName: string

        Name of the product

      • productId: string

        Unique identifier for the product

      • pdpOrderResult: Record<string, unknown>

        Order-related data for the product display page

      • tabsResult: { pdpspecifications: { specificationList: SpecificationItem[] } }

        Specifications for the product

    • longDescription: string

      Detailed description of the product

    • product: string

      Product data in string format

    • dataLayer: {
          productDetail: {
              productImageUrl: string;
              productId: string;
              productUrl: string;
              page_type: string;
              productName: string;
          };
          productPrice: string[];
          dataLayerObject: { dataLayerJson: Record<string, string> };
      }

      Analytics and tracking data container

      • productDetail: {
            productImageUrl: string;
            productId: string;
            productUrl: string;
            page_type: string;
            productName: string;
        }

        Detailed product information for analytics

        • productImageUrl: string

          URL of the product's primary image

        • productId: string

          Unique identifier for the product

        • productUrl: string

          URL to the product's detail page

        • page_type: string

          Type of page being displayed

        • productName: string

          Name of the product

      • productPrice: string[]

        Array of product price information

      • dataLayerObject: { dataLayerJson: Record<string, string> }

        Container for data layer information

        • dataLayerJson: Record<string, string>

          JSON object containing analytics data layer information

    • canonicalUrl: string

      Canonical URL for the product page

    • isDLProduct: boolean

      Indicates if the product is a digital learning product

    • displayName: string

      Display name shown for the product

    • isDiscontinuedItem: boolean

      Indicates if the product has been discontinued

    • isproductGrouping: boolean

      Indicates if this is a product grouping

    • shortDescription: string

      Brief description of the product

    • prodType: string

      Type or category of the product

    • familyVariyantProductDetails: {
          productId: string;
          variantUrl: string;
          schemaJson: {
              schemaJson: {
                  offers: {
                      image?: string;
                      priceCurrency?: string;
                      price: number;
                      name: string;
                      description?: string;
                      availability: string;
                      sku: string;
                      url: string;
                      itemCondition?: string;
                  }[];
              };
          };
      }

      Details about product variants within the same family

    • familyVariyantDisplayName: string

      Display name for the product family variant

    • organizationDetails: Record<string, unknown>

      Details about the organization

    status: string

    Status of the response