Introduction
The Update Order Status API is used to modify the status of an order as it progresses through its lifecycle, specifically transitioning it from “Added to Cart” (or saved state) to its current status. After a product is customized in the Artifi editor and added to the cart, it is initially marked with the status “Added to Cart.” As the order moves through different stages in the purchase journey, its status is dynamically updated.
This API facilitates the synchronization of these status changes with Artifi by accepting the customized product ID and the associated website ID. It processes the request and returns a response object indicating the success or failure of the operation, along with an appropriate message in case of any errors.
Use Cases
The primary use case of the Update Order Status API is to keep the order status in sync between the e-commerce platform and the Artifi system throughout the order lifecycle.
When a user customizes a product in the Artifi editor and adds it to the cart, the product is initially marked as “Added to Cart.” As the user proceeds further - such as placing the order, making payment, or when the order moves to processing, shipping, or completion stages - the status of that customized product needs to be updated accordingly.
By calling this API at each stage, the system ensures that Artifi always has the latest order status, enabling accurate tracking, processing, and management of customized products.
API Details
Endpoint
PUT /api/4/Design/UpdateDesignStatus
Sample Request:
curl --location --request PUT 'https://api.artifi.net/api/4/Design/UpdateDesignStatus?designId=39294378&orderStatus=InProgress&userId=165' \
--header 'webApiClientKey: c961461a-b287-448c-b9ea-e1162bd80b8e' \
--header 'websiteId: 94'
Parameters
Header validation
Header Name | Type | Required | Description |
websiteId | int | Yes | Unique identifier of the website. |
webApiClientKey | string | Yes | API client key used for authentication. |
Query Parameters
Name | Type | Required | Description | ||||||||||||
userId | string | Yes | User identifier | ||||||||||||
DesignId | int | Yes | This is the ID of the designed product that gets added to cart. | ||||||||||||
orderStatus | string | Yes | 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
This is the string representing the order status to be updated in Artifi.
This value needs to be passed in the parameter. The status will be changed in the Artifi according to the value that is passed in this parameter.
Below are the statuses based on the order journey that are received in the API response with their corresponding parameter values:
|
Success Responses
{
"Response": "Success",
"Message": "Design status has been updated successfully.",
"Data": "",
"ErrorCode": ""
}
Error Code List (Click Here)
Q&A
1. What is the purpose of the Update Single Design Order Status API?
Answer:
This API is used to update the status of a customized product (design) as it progresses through different stages of the order lifecycle, such as from "Added to Cart" to "Placed", "Processing", or "Completed".
2. When should this API be called?
Answer:
This API should be called whenever there is a change in the order status, such as:
- When a user places an order
- When payment is completed
- When the order moves to processing or production
- When the order is shipped, completed, cancelled, or failed
3. What query parameters are required?
Answer:
The required query parameters are:
- userId – Identifier of the user
- designId – ID of the customized product
- orderStatus – Status to be updated
4. What does the orderStatus parameter represent?
Answer:
It represents the current stage of the order lifecycle. The value passed determines the updated status in the Artifi system.
5. What are the valid order status values?
Answer:
Parameter Value | Order Status |
InProgress | Add to Cart |
Placed | Checked Out |
Draft | Draft |
RequestQuote | Requested Quote |
6. How do I convert "Added to Cart" status to "Checked Out"?
Answer:
Pass the orderStatus parameter with the value "Placed".
7. What is the success response of the API?
Answer:
{
"Response": "Success",
"Message": "Design status has been updated successfully.",
"Data": "",
"ErrorCode": ""
}
8. What happens if an invalid order status is passed?
Answer:
The API returns an error response:
{
"Response": "Error",
"Message": "Order status is incorrect. Please provide proper order status.",
"Data": null,
"ErrorCode": "236"
}
9. Why is this API important in the order lifecycle?
Answer:
It ensures that the order status in the Artifi system stays synchronized with the e-commerce platform, enabling accurate tracking, processing, and management of customized products.
10. Can this API be used for multiple designs in a single request?
Answer:
No, this API is specifically designed to update the status of a single design per request using the designId.
11. What happens if required parameters are missing?
Answer:
The API will fail validation and return an error response indicating missing or invalid parameters.
12. Is authentication required for this API?
Answer:
Yes, authentication is required using:
- webApiClientKey
- websiteId