Put
/api/3/Design/UpdateDesignsStatus?websiteId={websiteId}&webApiClientKey={webApiClientKey}&designIds={designIds}orderStatus={orderStatus}&userId={userId}
This API is used to update the status of the order from saved/added to cart products from "Add to cart" to "Checked out".
After customizing the product in the Artifi editor, one can save the product or add it to the cart. The cart lists products/items that have been selected for purchase during shopping, along with their prices and the total amount.
The order status of the products present in the cart will be "Added to cart."
If the user wants to place an order for "multiple" products/items in the cart, he/she will hit the related button to place an order. At this time, the order status of the products needs to be changed from "Add to cart" to "Checked out."
This operation changes the order status of saved/added to cart products from "Add to cart" to "Checked out."
This method requires customized product IDs whose order status is to be changed and the ID of the associated website. It returns the response object, which contains the status of the operation along with the message if any error occurs during this process.
Request Information
Parameters
| Name | Description |
WebsiteId (INT) | This is 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. |
DesignIds (STRING) | These are comma separated IDs of the design (saved/added to cart) products. The products that are customized/designed using Artifi (Product customization tool) and saved or added to the cart are called customized products. Designs product will be listed in the cart, and the order status of the products will be "Added to cart." These will be the products for which the user wants to place an order. The order status of these products will change to "Checked out" after this operation. |
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. |
OrderStatus (STRING) | This is the string representing the order status to be updated in Artifi. This value needs to be passed in the parameter. To convert the Added to Cart status into Checkout, provide the parameter with the value "Placed." |
UserId (STRING) | This will be the ID of the ecommerce website's user, whether registered or a guest user. If the user is registered, pass the user ID in this parameter. If the user is not registered with the e-commerce website, create a temporary ID for the user and pass that temporary ID in this parameter. The non-registered user will be referred to as a guest user, and this will be their unique user ID. The method will return the product customized by the user whose ID is specified in this parameter. |
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 following information.
On success, this method will call back the JavaScript method in the website which is specified in "successCallback" parameter with following information.
{
"Response": "Success",
"Message": "Order Status is/are updated successfully",
"Data": null,
"ErrorCode": null
}
On Error
On error, this method will call back the JavaScript method in the website which is specified in "errorCallback" parameter with error information.
On error, this method will call back the JavaScript method in the website which is specified in "errorCallback" parameter with error information.
{
"Response": "Success",
"Message": "Order Status is/are updated successfully.",
"Data": "Invalid Design Ids : 477727282",
"ErrorCode": ""
}