# Mircate ## Docs - [Introduction](https://docs.mircate.com/doc-667078.md): - [Authentication](https://docs.mircate.com/doc-667083.md): - [Errors](https://docs.mircate.com/doc-667640.md): - [Change Logs](https://docs.mircate.com/doc-667085.md): - [Wallet](https://docs.mircate.com/folder-2067500.md): In scenarios where loyalty and wallet are used together, the wallet ID should be created as follows: - How to [Creating a Promotion Template](https://docs.mircate.com/doc-667646.md): - How to [Promotion Transaction Flow](https://docs.mircate.com/doc-667649.md): - How to [Understanding PIM Product Statuses](https://docs.mircate.com/doc-667653.md): ## API Docs - Promotion [Calculate](https://docs.mircate.com/api-10147488.md): This API endpoint allows you to calculate promotions based on the cart information of an order. The **calculate** method calculates and returns the promotions that are applicable to the given order's cart. - Promotion [Start Transaction](https://docs.mircate.com/api-10147489.md): **Start Transaction** method indicates the commencement of the promotional transaction. - Promotion [Commit Transaction](https://docs.mircate.com/api-10147490.md): **Commit transaction** indicates that a transaction or a set of transactions has been completed and changes have been saved. - Promotion [Revert Transaction](https://docs.mircate.com/api-10147491.md): **Revert Transaction** is a process that involves the return of a used coupon, making it reusable again. - Promotion [Cancel Transaction](https://docs.mircate.com/api-10147492.md): The **cancel transaction** method is used to cancel a transaction. - Promotion [Get Active Promotions](https://docs.mircate.com/api-10147487.md): The method **Get Active Promotions** is used to fetch active promotions. - Loyalty [Receive Event](https://docs.mircate.com/api-10147507.md): **ReceiveEvent** method initially records events in the database and subsequently triggers the loyalty rule actions related to the respective event, if such actions exist. - Loyalty [Calculate](https://docs.mircate.com/api-10147509.md): The calculate method calculates loyalty points that can be spent according to Loyalty spending rules and returns the calculated points. - Loyalty [Start Transaction](https://docs.mircate.com/api-10147510.md): **Start Transaction** method specifies the initiation of the loyalty transaction. - Loyalty [Commit Transaction](https://docs.mircate.com/api-10147511.md): **Commit transaction** indicates that a transaction or a set of transactions has been completed and changes have been saved. - Loyalty [Cancel Transaction](https://docs.mircate.com/api-10147512.md): The **cancel transaction** method is used to cancel a transaction. - Loyalty [List Measurements](https://docs.mircate.com/api-10147508.md): The **List Measurements** method lists events and returns the measurements associated with these events. - Wallet [Get Wallet](https://docs.mircate.com/api-10147513.md): The **getWallet** method is used to retrieve wallet information. - Wallet [Create Account](https://docs.mircate.com/api-10147514.md): The **Create Account** method is used to create a new account. - Wallet [Get Account](https://docs.mircate.com/api-10147515.md): The **get account** method displays the account information. - Wallet [Get Accounts](https://docs.mircate.com/api-10147516.md): The **Get Accounts **method is used to retrieve Wallet Account information along with their balances. - Wallet [List Accounts](https://docs.mircate.com/api-10147517.md): The **list accounts** method is used to retrieve and display information about Wallet Account(s). - Wallet [List Transactions](https://docs.mircate.com/api-10147518.md): The **list transactions** method is used to retrieve and display a list of transactional activities made within the wallet. - Wallet [Add Account](https://docs.mircate.com/api-10147519.md): The **Add Account** method is used to add a new account to an existing wallet. - Wallet [Remove Account](https://docs.mircate.com/api-10147520.md): The **Remove Account** method is used to delete an account from an existing wallet. - Wallet [Fix](https://docs.mircate.com/api-10147521.md): The **fix** method is used to increment or decrement the balance value. If 10 is passed, the balance increases by 10; if -10 is passed, the balance decreases by 10. - Wallet [Load](https://docs.mircate.com/api-10147522.md): The **load** method is used for the process of loading money into the wallet. - Wallet [Spend](https://docs.mircate.com/api-10147523.md): The **spend** method is used when making a payment from the wallet. - Wallet [Refund](https://docs.mircate.com/api-10147524.md): The **refund** method is used when processing a refund transaction from the wallet. - Wallet [Cancel](https://docs.mircate.com/api-10147525.md): The **cancel** method is used to perform a cancellation transaction from the wallet. - PIM [Get Products](https://docs.mircate.com/api-10147468.md): You can access this API using an API key. - PIM [Get Product Settings](https://docs.mircate.com/api-10147469.md): You can access this API using an API key. - PIM [Get Catalog Settings](https://docs.mircate.com/api-10147470.md): You can access this API using an API key. - PIM [Upsert Product](https://docs.mircate.com/api-10147471.md): You can access this API using an API key. - PIM [Upsert Category](https://docs.mircate.com/api-10147472.md): The **upsertCategory** method is used to update, delete, and add visuals to a category tree. If the specified category code already exists, the method updates the category; otherwise, it adds a new category. - PIM [Bulk Product Upsert](https://docs.mircate.com/api-10147473.md): The **"bulkProductUpsert"** method is used for batch product insertion, updating, and modification. - PIM [Check Batch Status](https://docs.mircate.com/api-10147474.md): The batchId returned from bulk product addition, update, and modification operations is used to check the batch operation status. - PIM [Delete Product](https://docs.mircate.com/api-10147475.md): This method operates both internally and externally. You can access it using an API key. With this method, you can delete a registered product in the system. - PIM [Attach Product Attribute Image](https://docs.mircate.com/api-10147476.md): This method is used to manage product feature images. Through the relevant API method, it enables adding feature images to a specific product. The suitability of the request is verified with the model and authorization is confirmed. A response is obtained, and in the case of a temporary image upload error, the error is processed. - PIM [Attach Category Image](https://docs.mircate.com/api-10147477.md): The **Attach Category Image** function enables adding, associating, and storing images to a category. - PIM [Get Image](https://docs.mircate.com/api-10147478.md): This method works both internally and externally. You can access it with an API key. With this method, you can retrieve a registered image from the system by reformatting it with your desired parameters. The response is provided with caching. - PIM [Upsert Attributes](https://docs.mircate.com/api-10147479.md): The **Upsert Attribute **method is used to update an existing record or to add a new record if it doesn't exist. - PIM [Delete Attribute](https://docs.mircate.com/api-10147480.md): The **Delete Attribute** method is used to delete an existing record. - PIM [Upsert Attribute Options](https://docs.mircate.com/api-10147481.md): The **Upsert Attribute Options** method serves the purpose of updating existing attribute options or adding new attribute options if they do not already exist. - PIM [Upsert Attribute Option](https://docs.mircate.com/api-10147482.md): The **Upsert Attribute Option** method is used to either update an existing attribute option or add a new attribute option if it does not already exist. - PIM [Delete Attribute Option](https://docs.mircate.com/api-10147483.md): The **Delete Attribute Option** method is used to delete one of the options of an existing attribute. - Merchant > Sales Channel [Reserve Stock](https://docs.mircate.com/api-10147502.md): The **Reserve Stock** method aims to temporarily allocate or reserve a product in stock. - Merchant > Sales Channel [Cancel Stock](https://docs.mircate.com/api-10147503.md): You can cancel stock operations using the** Cancel Stock** method. - Merchant > Sales Channel [Commit Stock](https://docs.mircate.com/api-10147504.md): The **Commit Stock** method confirms the stock updates by indicating the successful completion of your payment transaction, making the stock updates permanent. - Merchant > Sales Channel [Refund Stock](https://docs.mircate.com/api-10147505.md): The **Refund Stock** method allows for the return of the respective product's stock when an order is canceled or returned. - Merchant > Sales Channel [Get Current Stock](https://docs.mircate.com/api-10147506.md): The **Get Current Stock** method is used to query the current stock quantity. - Merchant > Product Supplier [Receive Stock](https://docs.mircate.com/api-10147493.md): This function is responsible for receiving incoming stock updates for a merchant's products. It conveys the products to MerchantStockPriceImporter, which checks if the received channels are valid for the merchant and process the stock updates in its unique state. - Merchant > Product Supplier [Receive Price](https://docs.mircate.com/api-10147494.md): This function is responsible for receiving incoming price updates for a merchant's products. It conveys the products to MerchantStockPriceImporter, which checks if the received channels are valid for the merchant and process the stock updates in its unique state. - Merchant > Product Supplier [Get Stock/Price History](https://docs.mircate.com/api-10147495.md): The **Get Merchant Product History **method enables you to retrieve stock and price information through the API for a specific merchant's products. - Merchant > Product Supplier [Check Batch Status](https://docs.mircate.com/api-10147496.md): The batchIds returned from **receive stock **and **receive price** operations are used to check the batchOperation status. - Merchant > Product Supplier [Remove My Products](https://docs.mircate.com/api-10147497.md): You can use the **Remove My Products **method to delete your individual productIDs one by one or in bulk with quantities ranging from 1 to 100. - Merchant > Product Supplier [Clean My Products](https://docs.mircate.com/api-10147498.md): The **Clean My Products **method allows for the deletion of all products in 'My Products'. - Merchant > Product Supplier [Export Stock/Price](https://docs.mircate.com/api-10147499.md): The ** exportProducts** method is used to retrieve the stock quantities and price information of products in an Excel file. - Merchant > Product Supplier [List Exports](https://docs.mircate.com/api-10147500.md): The **listExport** method is used for exporting operations in list format. - Merchant > Product Supplier [Get Exported Files](https://docs.mircate.com/api-10147501.md): The **Get Exported Files **method is used to access exported files. - Merchant > Global Products [Receive Products](https://docs.mircate.com/api-10147484.md): **Receive Products **is a method where stocks are updated, and inventory is managed. - Merchant > Global Products [Get Global Products](https://docs.mircate.com/api-10147485.md): This method is used for getting global products. - Merchant > Global Products [Remove Global Products](https://docs.mircate.com/api-10147486.md): With the **Remove Global Products** method, you can delete global products one by one or in bulk by sending them individually or with a productId between 1 and 100.