Enabling and Disabling Entities

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

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

const integrator = new Integrator(RELEWISE_DATASET_ID, RELEWISE_API_KEY, {
    serverUrl: RELEWISE_SERVER_URL,
});

Disable a Product

const action = new ProductAdministrativeActionBuilder({
    language: null,
    currency: null,
    filters(filterBuilder) {
        filterBuilder.addProductIdFilter('product-id');
    },
    productUpdateKind: 'Disable',
});

await integrator.batch([action.build()]);

To enable the Product again, use productUpdateKind: 'Enable'.

Disable a Variant

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

const action = new ProductAdministrativeActionBuilder({
    language: null,
    currency: null,
    filters(filterBuilder) {
        filterBuilder
            .addProductIdFilter('product-id')
            .addVariantIdFilter('variant-id');
    },
    productUpdateKind: 'None',
    variantUpdateKind: 'Disable',
});

await integrator.batch([action.build()]);