getProductBySlug( )

Retrieves a product by slug.

Note: To retrieve a non-visible product (visible: false), your app must have the 'Product v3 read admin' (SCOPE.STORES.PRODUCT_READ_ADMIN) permission scope.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Read products in v3 catalog
Product v3 read admin
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
slugstringRequired

Product slug.

optionsGetProductBySlugOptions
Returns
Return Type:Promise<V3GetProductBySlugResponse>
Errors
403Permission Denied

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?