Introduction​

Zitcha provides a Product Update Endpoint that allows retailers to push their product catalog information to Zitcha's product feed. This guide will walk you through the steps to use the endpoint to update and add products to the Zitcha product feed.

Prerequisites​

Before you start using the Product Update Endpoint, ensure you have the following:

• An API key or authentication credentials to access the Zitcha API.
• Familiarity with the data model
• The necessary libraries or tools to make HTTP requests to the API (e.g., Python with the requests library).

You'll find implementation examples in Bash, Python, Go, Node.js, Ruby, CSharp, PHP, Java and PowerShell at our Product Update API documentation. The examples use dummy data to demonstrate how to structure the request. You can use the examples as a reference to build your own request.

Sending a Product Update Request​

To update or add a product to the Zitcha product feed, you need to send a POST request to the Product Update Endpoint with the relevant product information.

Replace the dummy data in the payload variable with the actual information of the product you want to update or add. Let's break down the payload fields:

• event_name: The name of the event and corresponding schema, which should be set to "product_update".
• version: The version of the event and corresponding schema, which should be set to "1-0-0".
• id: A list containing a dictionary representing the product identifier, including its type, value, and system (e.g., product ID, SKU, etc.).
• parent_id: An optional field representing the parent product's identifier, useful for linking variants to their parent product.
• name: The name of the product.
• brand: The brand name of the product.
• list_price: The list price of the product. Set to None if not available.
• detail_url: The detail URL of the product.
• image_urls: A list of image URLs associated with the product.
• attributes: A list of dictionaries, each representing an attribute of the product, including its name, type, and value.
• category_paths: A list of lists, where each inner list represents the category path of the product.

Handling Responses​

Upon making a product update request, you will receive a response from the Zitcha API. The response will indicate whether the product update was successful or if there were any errors. It's essential to handle the response appropriately and handle any potential errors or retries if needed.

The response will likely contain an HTTP status code, such as 200 for a successful request, 400 for a bad request, or 500 for server errors. Additionally, the response may include a JSON payload with more detailed information about the request's outcome.

Conclusion​

By following this guide, you should now understand how to use the Zitcha Product Update Endpoint to push your product catalog information to the Zitcha product feed. If you encounter any issues, refer to the API documentation or reach out to Zitcha's support for further assistance.