Enabling and Disabling Entities

Looking for setup prerequisites, authentication details, and package references? Start with the PHP SDK landing page.

Disabling an entity removes it from search results and recommendations without deleting the entity or its behavioral data immediately.

$tracker = new Tracker(
    "00000000-0000-0000-0000-000000000001",
    "your API Key"
);
$tracker->serverUrl = "the server URL for the dataset";

Disable a Product

$tracker->trackProductAdministrativeAction(
    TrackProductAdministrativeActionRequest::create(
        ProductAdministrativeAction::create(
            Language::UNDEFINED,
            Currency::UNDEFINED,
            FilterCollection::create(
                ProductIdFilter::create()
                    ->setProductIds("product-id")
            ),
            ProductAdministrativeActionUpdateKind::Disable,
            ProductAdministrativeActionUpdateKind::None
        )
    )
);

To enable the Product again, use ProductAdministrativeActionUpdateKind::Enable.

Disable a Variant

Variant IDs are only unique on Product level, so specify both the Product ID and Variant ID.

$tracker->trackProductAdministrativeAction(
    TrackProductAdministrativeActionRequest::create(
        ProductAdministrativeAction::create(
            Language::UNDEFINED,
            Currency::UNDEFINED,
            FilterCollection::create(
                ProductIdFilter::create()
                    ->setProductIds("product-id"),
                VariantIdFilter::create()
                    ->setVariantIds("variant-id")
            ),
            ProductAdministrativeActionUpdateKind::None,
            ProductAdministrativeActionUpdateKind::Disable
        )
    )
);