Error
A valid request URL is required to generate request examples{
"deleted": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}API Reference
Delete a recommendation surface and its pins
Deletes the surface named in the path. Side effects: deletes its Shopify metaobject, removes it from the recommendations config, deletes all its pins, and replicates the deletion to linked stores; other surfaces are unaffected and no recompute is queued. Returns {deleted: <name>}. Irreversible.
DELETE
/
recommendations
/
surfaces
/
{surface_name}
Error
A valid request URL is required to generate request examples{
"deleted": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.
Path Parameters
The surface's URL-safe name.
Pattern:
^[a-z0-9_-]+$Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
Response
The deleted surface's name.
Was this page helpful?