# Product Welcome to the Annex Cloud Products API Documentation! We're excited to have you here as you explore the powerful tools and capabilities our Loyalty Program offers through this API. At Annex Cloud, we understand the significance of fostering customer loyalty. Our mission is to help businesses like yours build lasting relationships with their customers by offering engaging and rewarding loyalty programs. Our Products API is a key component of this mission, allowing you to seamlessly integrate our loyalty features into your applications and systems. This documentation is designed to be your comprehensive guide to using our Products API effectively. Whether you're a seasoned developer looking to dive into the technical details or a business owner seeking to enhance customer engagement, you'll find valuable information here to help you get started and make the most of our loyalty solutions. To begin using our Products API, you'll need an API key and a clear understanding of how our endpoints work. We've organized this documentation into user-friendly sections, including: Authentication: Learn how to securely authenticate your requests. Endpoints: Explore the various API endpoints available and how to use them effectively. Examples: Find practical examples and use cases to inspire your integration. We're here to support you on your journey to building a more loyal customer base and boosting your business's success. If you have any questions or need assistance, please don't hesitate to reach out to our dedicated support team. Thank you for choosing Annex Cloud as your partner in loyalty. Let's work together to create rewarding experiences for your customers. ## Get Product Details, Create New Products, Calculate Product Points - [POST /products](https://annexcloud.redocly.app/loyalty/loyalty/product/productcreatenew.md): Use the POST:/products method to get details of the products in the loyalty program. All fields in the response body are listed below. Although this is a POST method, the method performs a GET action and returns details of the specified products. Note 1 - (Get Product Details) - To retrieve data using only the productId, input the product ID and leave the categoryId blank. Conversely, to obtain data based solely on categoryId, input only the categoryId and leave the productId blank. Note 2 - (Create New Product and Get Product Point Calculation for an Order) - You must provide either a Product ID or Category ID in your request. You do not have to provide both. If you provide a Product ID in the request without providing a Category ID, the API displays details of the specified product. If you provide a Category ID in the request, the API displays details for all products in the category. If you provide both a Product ID AND a Category ID, the API displays details for all products in the category. ## Add New Products in Bulk - [POST /bulkproducts](https://annexcloud.redocly.app/loyalty/loyalty/product/createbulkproducts.md): Use the POST:/bulkproducts method to efficiently add several new products into a loyalty program's product catalog in one operation. When making a bulk request it is required to include the parameters for each product within a numbered object. For each product in the bulk request, you must include the Product Award Type, Product ID, and Category ID. ## Retrieve product information for a specific product - [GET /products/{{prod_id}}](https://annexcloud.redocly.app/loyalty/loyalty/product/getproductinfo.md): This method retrieves product details for a specific product ID. User needs to use product ID as a key to fetch all the details of that particular product. ## Update Existing Product Information - [PATCH /products/{{prod_id}}](https://annexcloud.redocly.app/loyalty/loyalty/product/updateproduct.md): The PATCH method is used for updates of existing product information. The Point Award Type and Product ID must be specified to update product information. If you enter a different value for any of these fields, the database is updated with the new value. If you enter the existing value for any of these fields, the database is not changed. If you do not include certain fields in the request, or if you do not enter a value for these fields, the database is not updated. You must provide either a Product ID or Category ID in your request. You do not have to provide both. If you provide a Product ID in the request without providing a Category ID, the API displays details of the specified product. If you provide a Category ID in the request, the API displays details for all products in the category. If you provide both a Product ID and a Category ID, the API displays details for all products in the category. Note - The product's price must be included in the request body even if it is not being altered as part of the update. If the productPrice parameter is not included in the request, the price of the product will update to 0 in the Product Catalog. ## Update Products in Bulk - [POST /bulkpatchproducts](https://annexcloud.redocly.app/loyalty/loyalty/product/postbulkpatchproducts.md): To update a several products at once in the loyalty program, use this POST method. Points Award Type, Product ID must be specified when updating multiple products. All other additional fields in the request body are listed below. If you enter a different value for any of these fields, the database is updated with the new value. If you enter the existing value for any of these fields, the database is not changed. If you do not include certain fields in the request, or if you do not enter a value for these fields, the database is not updated. You must provide either a Product ID or Category ID in your request. You do not have to provide both. If you provide a Product ID in the request without providing a Category ID, the API displays details of the specified product. If you provide a Category ID in the request, the API displays details for all products in the category. If you provide both a Product ID and a Category ID, the API displays details for all products in the category.