In Activate Views

Put


/api/3/ProductView/InActivateViews?websiteId={websiteId}&webApiClientKey={webApiClientKey}&sku={sku}&viewCodes={viewCodes}&userEmailId={userEmailId}


The Inactivate Views API is used to disable specific views in the system, making them inaccessible for customization, display, or interaction. This functionality is helpful when certain views should be temporarily hidden or restricted based on business logic, user permissions, or specific conditions.

Request Information

Parameters

Parameter Name

Description

WebsiteId (Int)

This param refers to the website associated with customized products.

The admin user of Artifi can create one or more websites and assign products to each of them. The ID of the website with which specified customized products are associated should be specified in this parameter.

WebApiClientKey (String)

When any company registers with Artifi, Artifi will generate a special and unique key for that company, which will be called the client key.

This client key can be found in the registered company's profile tab in the Artifi Account.

The client key will be used for client (company) authentication and will be referred to as WebApiClientKey.

skus

When a product is launched by SKU and isShowAllAttributeForSKU property is true at that time Clipart SP will return data based on product code else it will return data based on SKU. SKU is an optional parameter.

viewCodes

This is the ID of the view that is associated with the product.

View Code is created when the user creates a view for a product in the Artifi admin.

If the viewcode is not defined then the default view is fetched by the API.

userEmailId

This parameter value contains the artifi admin login users email address, who is making the request.

Response Information

Response body formats

On Success

On success, this method will call back the JavaScript method in the website which is specified in "successCallback" parameter with success Message.

Success Message:

{

  "Response": "Success",

  "Message": "View Code Front is inactivated successfully;",

  "Data": null,

  "ErrorCode": ""

}

On Error

On error, this method will call back the JavaScript method in the website which is specified in the "errorCallback" parameter with errorMessage.

Invalid Website id and User email

 {

  "Response": "Error",

  "Message": "Invalid website id. Invalid user email.",

  "Data": null,

  "ErrorCode": "221,234,273"

}

Invalid view code

{

  "Response": "Error",

  "Message": "Invalid view code.",

  "Data": null,

  "ErrorCode": ""

}

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.