# Zid Docs

## Docs
- [Start Here 🚀](https://docs.zid.sa/apidoc/docs-site/613905/start-here.md): 
- [Overview to Zid Apps](https://docs.zid.sa/apidoc/docs-site/613905/zid-apps-overview.md): 
- [Authorization](https://docs.zid.sa/apidoc/docs-site/613905/authorization.md): 
- [Responses](https://docs.zid.sa/apidoc/docs-site/613905/responses.md): 
- [Webhooks](https://docs.zid.sa/apidoc/docs-site/613905/webhooks.md): 
- [Rate Limiting](https://docs.zid.sa/apidoc/docs-site/613905/doc-644369.md): 
- APIs [Orders](https://docs.zid.sa/apidoc/docs-site/613905/folder-1934403.md): 
- APIs [Reverse Orders](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810994.md): 
- APIs [Carts](https://docs.zid.sa/apidoc/docs-site/613905/folder-3037527.md): 
- APIs [Products](https://docs.zid.sa/apidoc/docs-site/613905/folder-1934287.md): 
- APIs > Products [Managing Products](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810975.md): 
- APIs > Products [Digital Vouchers](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810993.md): 
- APIs > Products [Product Categories](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810983.md): 
- APIs > Products [Product Badge](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810992.md): 
- APIs > Products [Product Attributes](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810973.md): 
- APIs > Products [Product Attribute Presets](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810974.md): 
- APIs > Products [Product Customizations](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810980.md): 
- APIs > Products [Product Manual Sorting](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810978.md): 
- APIs > Products [Product Images](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810976.md): 
- APIs > Products [Product Notifications](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810996.md): 
- APIs > Products [Product Import](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810979.md): 
- APIs > Products [Product Stock (Multi-Inventory)](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810977.md): 
- APIs > Products [Product Questions & Answers](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810995.md): 
- APIs > Products [Product Reviews](https://docs.zid.sa/apidoc/docs-site/613905/folder-2179631.md): 
- APIs > Products [Digital Products](https://docs.zid.sa/apidoc/docs-site/613905/folder-2390702.md): 
- APIs [Inventories](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810981.md): 
- APIs [Shipping](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810986.md): 
- APIs > Marketing [Gift Cards](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810972.md): 
- APIs > Marketing [Coupons](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810985.md): 
- APIs > Marketing [Bundle Offers](https://docs.zid.sa/apidoc/docs-site/613905/folder-1934530.md): 
- APIs > Marketing [Loyalty Program](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810991.md): 
- APIs [Customers](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810970.md): 
- APIs [Store Settings](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810968.md): 
- APIs > Store Settings [📄 User Roles and Permissions](https://docs.zid.sa/apidoc/docs-site/613905/doc-604944.md): 
- APIs [Countries and Cities](https://docs.zid.sa/apidoc/docs-site/613905/folder-1810988.md): 
- Store Events [Order](https://docs.zid.sa/apidoc/docs-site/613905/webhook-events-order.md): 
- Store Events [Product](https://docs.zid.sa/apidoc/docs-site/613905/webhook-events-product.md): 
- Store Events [Abandoned Cart](https://docs.zid.sa/apidoc/docs-site/613905/webhook-events-abandoned-cart.md): 
- Store Events [Customer](https://docs.zid.sa/apidoc/docs-site/613905/webhook-events-customer.md): 
- Store Events [Product Category](https://docs.zid.sa/apidoc/docs-site/613905/webhook-events-product-category.md): 
- [Create your First App](https://docs.zid.sa/apidoc/docs-site/613905/create-first-app.md): 
- [Embedded Apps](https://docs.zid.sa/apidoc/docs-site/613905/embedded-apps.md): 
- [App Scripts](https://docs.zid.sa/apidoc/docs-site/613905/doc-649611.md): 
- [App Events](https://docs.zid.sa/apidoc/docs-site/613905/doc-878234.md): 
- [🚨 Important Update: Zid Themes](https://docs.zid.sa/apidoc/docs-site/613905/doc-769349.md): 
- [Landing Page Development](https://docs.zid.sa/apidoc/docs-site/613905/doc-808705.md): 
- Getting Started with Zid Themes [Introduction to Theme Development](https://docs.zid.sa/apidoc/docs-site/613905/introduction-to-theme-development.md): 
- Getting Started with Zid Themes [Manage your Themes](https://docs.zid.sa/apidoc/docs-site/613905/manage-your-themes.md): 
- Getting Started with Zid Themes [Building Themes in Zid](https://docs.zid.sa/apidoc/docs-site/613905/building-themes-in-zid.md): 
- Getting Started with Zid Themes [Theme File Structure](https://docs.zid.sa/apidoc/docs-site/613905/theme-file-structure.md): 
- Getting Started with Zid Themes [Twig Syntax and Features](https://docs.zid.sa/apidoc/docs-site/613905/twig-syntax-and-features.md): 
- Getting Started with Zid Themes [Zid Theme Packager](https://docs.zid.sa/apidoc/docs-site/613905/zid-theme-packager.md): 
- [Templates](https://docs.zid.sa/apidoc/docs-site/613905/folder-1756981.md): 
- Templates [Layout](https://docs.zid.sa/apidoc/docs-site/613905/layout.md): 
- Templates [Home Page](https://docs.zid.sa/apidoc/docs-site/613905/home-page.md): 
- Templates [Products](https://docs.zid.sa/apidoc/docs-site/613905/products.md): 
- Templates [Cart](https://docs.zid.sa/apidoc/docs-site/613905/cart.md): 
- Templates [Store Language and Currency](https://docs.zid.sa/apidoc/docs-site/613905/store-language-and-currency.md): 
- [Settings Schema](https://docs.zid.sa/apidoc/docs-site/613905/folder-1757054.md): 
- Settings Schema [Text](https://docs.zid.sa/apidoc/docs-site/613905/text.md): 
- Settings Schema [Number](https://docs.zid.sa/apidoc/docs-site/613905/number.md): 
- Settings Schema [Text-Area](https://docs.zid.sa/apidoc/docs-site/613905/text-area.md): 
- Settings Schema [Select](https://docs.zid.sa/apidoc/docs-site/613905/select.md): 
- Settings Schema [Radio Buttons](https://docs.zid.sa/apidoc/docs-site/613905/radio-buttons.md): 
- Settings Schema [Checkbox](https://docs.zid.sa/apidoc/docs-site/613905/checkbox.md): 
- Settings Schema [Range](https://docs.zid.sa/apidoc/docs-site/613905/range.md): 
- Settings Schema [Color](https://docs.zid.sa/apidoc/docs-site/613905/color.md): 
- Settings Schema [Image](https://docs.zid.sa/apidoc/docs-site/613905/image.md): 
- Settings Schema [Product](https://docs.zid.sa/apidoc/docs-site/613905/product.md): 
- Settings Schema [Category](https://docs.zid.sa/apidoc/docs-site/613905/category.md): 
- Settings Schema [List](https://docs.zid.sa/apidoc/docs-site/613905/list.md): 
- Settings Schema [Fieldset](https://docs.zid.sa/apidoc/docs-site/613905/fieldset.md): 
- [Code Snippets](https://docs.zid.sa/apidoc/docs-site/613905/folder-1757288.md): 
- Code Snippets [Apple Pay Quick Checkout](https://docs.zid.sa/apidoc/docs-site/613905/implementing-apple-pay-quick-checkout-in-themes.md): 
- Code Snippets [Custom CSS Injection](https://docs.zid.sa/apidoc/docs-site/613905/custom-css-injection.md): 
- Code Snippets [Displaying the Store's Business Center Logo](https://docs.zid.sa/apidoc/docs-site/613905/displaying-store-business-center-logo.md): 
- Code Snippets [Customizing Copyright Text](https://docs.zid.sa/apidoc/docs-site/613905/integrating-store-copyrights-text-into-themes.md): 
- Code Snippets [Store's Main Navigation Menu](https://docs.zid.sa/apidoc/docs-site/613905/store-main-navigation-menu.md): 
- Code Snippets [Customer Wishlist](https://docs.zid.sa/apidoc/docs-site/613905/doc-705254.md): 
- Code Snippets > Products [Products Badges](https://docs.zid.sa/apidoc/docs-site/613905/adding-product-badge.md): 
- Code Snippets > Products [Product Ratings](https://docs.zid.sa/apidoc/docs-site/613905/product-ratings/theme-integration.md): 
- Code Snippets > Products [Remaining Product Stock](https://docs.zid.sa/apidoc/docs-site/613905/displaying-remaining-product-items.md): 
- Code Snippets > Products [Sold Items Count](https://docs.zid.sa/apidoc/docs-site/613905/displaying-sold-items-count-in-themes.md): 
- Code Snippets > Products [Product Filtration by Attributes](https://docs.zid.sa/apidoc/docs-site/613905/product-filtration-by-attributes.md): 
- Code Snippets > Products [Grouped Products](https://docs.zid.sa/apidoc/docs-site/613905/adding-grouped-product.md): 
- Code Snippets > Products [Product Questions & Answers](https://docs.zid.sa/apidoc/docs-site/613905/product-questions-answers.md): 
- Code Snippets > Products [Product Restock Notfication](https://docs.zid.sa/apidoc/docs-site/613905/product-restock-notification.md): 
- Code Snippets > SEO [Images alt text](https://docs.zid.sa/apidoc/docs-site/613905/images-alt-text.md): 
- Code Snippets > SEO [Themes SEO Marketing Tags](https://docs.zid.sa/apidoc/docs-site/613905/themes-seo-marketing-tags.md): 
- Code Snippets > Marketing [Metafields](https://docs.zid.sa/apidoc/docs-site/613905/metafields.md): 
- Code Snippets > Marketing [Gift Feature](https://docs.zid.sa/apidoc/docs-site/613905/gift-feature.md): 
- Code Snippets > Marketing [Loyalty Program](https://docs.zid.sa/apidoc/docs-site/613905/loyalty-program.md): 
- [Zid Themes Library: API Integration](https://docs.zid.sa/apidoc/docs-site/613905/folder-2382436.md): 
- Zid Themes Library: API Integration [Products](https://docs.zid.sa/apidoc/docs-site/613905/doc-732848.md): 
- Zid Themes Library: API Integration [Product Categories ](https://docs.zid.sa/apidoc/docs-site/613905/doc-732836.md): 
- Zid Themes Library: API Integration [Cart](https://docs.zid.sa/apidoc/docs-site/613905/doc-732821.md): 
- Zid Themes Library: API Integration [Blog](https://docs.zid.sa/apidoc/docs-site/613905/doc-732817.md): 
- Zid Themes Library: API Integration [Customer](https://docs.zid.sa/apidoc/docs-site/613905/doc-732840.md): 
- Zid Themes Library: API Integration [Store Settings](https://docs.zid.sa/apidoc/docs-site/613905/doc-732852.md): 
- Data Reference [Locals](https://docs.zid.sa/apidoc/docs-site/613905/locals.md): 
- Data Reference [Store](https://docs.zid.sa/apidoc/docs-site/613905/store.md): 
- Data Reference [Cart](https://docs.zid.sa/apidoc/docs-site/613905/cart-data-reference.md): 
- Data Reference [Product](https://docs.zid.sa/apidoc/docs-site/613905/product-data-reference.md): 
- Data Reference [Products List](https://docs.zid.sa/apidoc/docs-site/613905/product-list.md): 
- Data Reference [Category](https://docs.zid.sa/apidoc/docs-site/613905/category-data-reference.md): 
- Data Reference [Categories List](https://docs.zid.sa/apidoc/docs-site/613905/category-list.md): 
- Data Reference [Session](https://docs.zid.sa/apidoc/docs-site/613905/session.md): 
- Data Reference [FAQs](https://docs.zid.sa/apidoc/docs-site/613905/faqs.md): 
- Data Reference [Customer](https://docs.zid.sa/apidoc/docs-site/613905/customer.md): 
- Data Reference [Blogs](https://docs.zid.sa/apidoc/docs-site/613905/blogs.md): 
- Data Reference [Page](https://docs.zid.sa/apidoc/docs-site/613905/page.md): 
- Data Reference [Main Menu](https://docs.zid.sa/apidoc/docs-site/613905/main-menu.md): 
- Data Reference [Main Navigation Menu](https://docs.zid.sa/apidoc/docs-site/613905/main-navigation-menu.md): 
- Data Reference [Request](https://docs.zid.sa/apidoc/docs-site/613905/request.md): 
- Data Reference [Orders](https://docs.zid.sa/apidoc/docs-site/613905/orders.md): 
- Data Reference [Addresses](https://docs.zid.sa/apidoc/docs-site/613905/addresses.md): 
- Data Reference [Store Payment Methods](https://docs.zid.sa/apidoc/docs-site/613905/store-payment-methods.md): 
- Data Reference [Store Shipping Methods](https://docs.zid.sa/apidoc/docs-site/613905/store-shipping-methods.md): 
- Data Reference [Store Banks](https://docs.zid.sa/apidoc/docs-site/613905/store-banks.md): 
- Data Reference [Asset URL](https://docs.zid.sa/apidoc/docs-site/613905/asset-url.md): 
- Data Reference [Header Meta Tags](https://docs.zid.sa/apidoc/docs-site/613905/header-meta-tags.md): 
- Data Reference [Loyalty pogram Wallet](https://docs.zid.sa/apidoc/docs-site/613905/doc-797663.md): 
- [Themes CLI](https://docs.zid.sa/apidoc/docs-site/613905/folder-2533148.md): 
- Themes CLI [CLI Authentication](https://docs.zid.sa/apidoc/docs-site/613905/doc-755549.md): 
- Themes CLI [Theme Create](https://docs.zid.sa/apidoc/docs-site/613905/doc-755543.md): 
- Themes CLI [Theme Package](https://docs.zid.sa/apidoc/docs-site/613905/doc-755531.md): 
- Themes CLI [Theme Update](https://docs.zid.sa/apidoc/docs-site/613905/doc-756635.md): 
- Themes CLI [Themes List](https://docs.zid.sa/apidoc/docs-site/613905/doc-756588.md): 
- Themes CLI [Theme Preview](https://docs.zid.sa/apidoc/docs-site/613905/doc-756594.md): 

## API Docs
- APIs > Orders [Update Order by ID](https://docs.zid.sa/apidoc/docs-site/613905/update-order-by-id.md): Please note that if the order is shipped through an integrated shipping company, then we cannot update the order status from "Ready" to "New".
- APIs > Orders [Get Order Credit Notes ](https://docs.zid.sa/apidoc/docs-site/613905/get-order-credit-notes.md): The GET Credit Notes endpoint allows you to retrieve a list of credit notes associated with an order from the system. Credit notes are issued for orders that have been cancelled or modified, and this endpoint provides detailed information about each credit note, including customer details, product information, and payment details.
- APIs > Orders [Get Order by ID](https://docs.zid.sa/apidoc/docs-site/613905/api-12479054.md): Get a specific order by its ID.
- APIs > Orders [List of Orders](https://docs.zid.sa/apidoc/docs-site/613905/list-of-orders.md): Orders can be created either by the customers from the storefronts or by the merchants from their dashboard. 
- APIs > Reverse Orders [Reverse Order Reasons](https://docs.zid.sa/apidoc/docs-site/613905/reverse-order-reasons.md): Retrieves a list of order reverse reasons for the store.
- APIs > Reverse Orders [Create Reverse Orders](https://docs.zid.sa/apidoc/docs-site/613905/create-reverse-orders.md): Creates an order reverse  request.
- APIs > Reverse Orders [Create Reverse Orders Waybill](https://docs.zid.sa/apidoc/docs-site/613905/create-reverse-orders-waybill.md): Creates a waybill for a reversed order.
- APIs > Reverse Orders [Add Reverse Order Reasons](https://docs.zid.sa/apidoc/docs-site/613905/add-reverse-order-reasons.md): Adds a new reverse order reason.
- APIs > Carts [Get Abandoned Cart Details](https://docs.zid.sa/apidoc/docs-site/613905/get-abandoned-cart-details.md): This endpoint fetches comprehensive details about an abandoned cart, identified
- APIs > Carts [List Abandoned Carts](https://docs.zid.sa/apidoc/docs-site/613905/list-abandoned-carts.md): Retrieves a list of abandoned carts for a given store. 
- APIs > Products > Managing Products [Get a Product by ID](https://docs.zid.sa/apidoc/docs-site/613905/get-a-product-by-id.md): Get product by ID as *Manager* or as *Customer*. 
- APIs > Products > Managing Products [Retrieve a list of products](https://docs.zid.sa/apidoc/docs-site/613905/retrieve-a-list-of-products.md): This endpoint retrieves a list of products associated with a given Store ID. The results are paginated and can be controlled with the parameters `page_size` and `page`. 
- APIs > Products > Managing Products [Create a new product](https://docs.zid.sa/apidoc/docs-site/613905/create-a-new-product.md): This endpoint allows you to create a new product, including support for:
- APIs > Products > Managing Products [Update an existing product.](https://docs.zid.sa/apidoc/docs-site/613905/update-an-existing-product.md): This endpoint lets you modify an existing product. You can update various aspects of the product, including:
- APIs > Products > Managing Products [Bulk update of products using their IDs or SKUs](https://docs.zid.sa/apidoc/docs-site/613905/bulk-update-product.md): This endpoint allows you to update multiple products at once by specifying their IDs or SKUs along with the new data. This makes managing large inventory updates more efficient.
- APIs > Products > Managing Products [Delete a product.](https://docs.zid.sa/apidoc/docs-site/613905/delete-a-product.md): Delete a product by its ID.
- APIs > Products > Managing Products [Product Setting](https://docs.zid.sa/apidoc/docs-site/613905/product-setting.md): The product setting endpoint allows merchants to retrieve the current product settings status from their dashboard. These settings control various aspects of how products are displayed, including search features, related products, and sold product counts. The endpoint helps merchants manage and fine-tune the visibility and order of products in their stores.
- APIs > Products > Digital Vouchers [Product Vouchers](https://docs.zid.sa/apidoc/docs-site/613905/product-vouchers.md): Retrieves all vouchers for a specified product.
- APIs > Products > Digital Vouchers [Order Voucher](https://docs.zid.sa/apidoc/docs-site/613905/order-voucher.md): Retrieves the voucher details for a specified order.
- APIs > Products > Digital Vouchers [Add Product Voucher](https://docs.zid.sa/apidoc/docs-site/613905/add-product-voucher.md): Adds a new voucher for a specified product.
- APIs > Products > Digital Vouchers [Import Vouchers](https://docs.zid.sa/apidoc/docs-site/613905/import-vouchers.md): Imports multiple vouchers for a specified product from an Excel file.
- APIs > Products > Digital Vouchers [Export Vouchers](https://docs.zid.sa/apidoc/docs-site/613905/export-vouchers.md): Exports vouchers for a specified product to an Excel file.
- APIs > Products > Digital Vouchers [Update Product Voucher](https://docs.zid.sa/apidoc/docs-site/613905/update-product-voucher.md): Updates an existing voucher for a specified product.
- APIs > Products > Digital Vouchers [Remove Product Voucher](https://docs.zid.sa/apidoc/docs-site/613905/remove-product-voucher.md): Deletes a specified voucher for a product.
- APIs > Products > Product Categories [Get Single Category Details](https://docs.zid.sa/apidoc/docs-site/613905/get-single-category-details.md): Retrieves detailed information about a specific category, including its attributes, status, and associated products or subcategories, based on the provided category ID.
- APIs > Products > Product Categories [Get all categories](https://docs.zid.sa/apidoc/docs-site/613905/get-all-categories.md): Fetches all the available categories for a certain store, including details such as their names, status, SEO information, and the number of products they contain. It supports returning both detailed and minimal category information depending on the request parameters.
- APIs > Products > Product Categories [Create Store Category](https://docs.zid.sa/apidoc/docs-site/613905/create-store-category.md): Use this endpoint to add a new store category.
- APIs > Products > Product Categories [Update a Store Category](https://docs.zid.sa/apidoc/docs-site/613905/update-a-store-category.md): Use this endpoint to update only one store category
- APIs > Products > Product Categories [Add a product to a certain category](https://docs.zid.sa/apidoc/docs-site/613905/add-a-product-to-a-certain-category.md): Use this endpoint to add a new product to a certain category by specifying the product id and providing the category id in the request body.
- APIs > Products > Product Categories [Publish/Unpublish a Category](https://docs.zid.sa/apidoc/docs-site/613905/publish/unpublish-a-category.md): Use this endpoint to either publish or unpublish a certain category.
- APIs > Products > Product Categories [Detach Category from All Products](https://docs.zid.sa/apidoc/docs-site/613905/detach-category-from-all-products.md): Detach a specified category from all products in the store. This essentially 
- APIs > Products > Product Categories [Remove Category from Product](https://docs.zid.sa/apidoc/docs-site/613905/remove-category-from-product.md): This endpoint removes a specified category from a particular product. This action 
- APIs > Products > Product Badge [Product Badge](https://docs.zid.sa/apidoc/docs-site/613905/product-badge.md): This endpoint retrieves a list of all predefined store badges available to the merchant.
- APIs > Products > Product Attributes [Get Product Attributes](https://docs.zid.sa/apidoc/docs-site/613905/get-product-attributes.md): Use this endpoint to retrieve the Product Attributes of a certain store.
- APIs > Products > Product Attributes [Get Product Attributes](https://docs.zid.sa/apidoc/docs-site/613905/get-product-attributes-metafields.md): Use this endpoint to retrieve the Product Attributes of a certain store.
- APIs > Products > Product Attributes [Retrieve a product attribute](https://docs.zid.sa/apidoc/docs-site/613905/retrieve-a-product-attribute.md): Use this endpoint to retrieve a specific product attribute using its id.
- APIs > Products > Product Attributes [Add a New Product Attribute](https://docs.zid.sa/apidoc/docs-site/613905/add-a-new-product-attribute.md): Add new product attributes for a certain Role.
- APIs > Products > Product Attributes [Add a New Product Attribute](https://docs.zid.sa/apidoc/docs-site/613905/add-a-new-product-attribute-metafields.md): Add new product attributes for a certain Role.
- APIs > Products > Product Attributes [Update a product attribute](https://docs.zid.sa/apidoc/docs-site/613905/update-a-product-attribute.md): Use to update the value of a single attribute for a certain Role.
- APIs > Products > Product Attributes [Delete a product attribute](https://docs.zid.sa/apidoc/docs-site/613905/delete-a-product-attribute.md): Delete a certain ID using its id.
- APIs > Products > Product Attribute Presets [Get attribute presets](https://docs.zid.sa/apidoc/docs-site/613905/get-attribute-presets.md): This endpoint retrieves all attribute presets, allowing users to quickly and easily add attributes in a specified language. It provides a list of available presets, each containing attribute values in both Arabic and English.
- APIs > Products > Product Attribute Presets [Create Attribute Preset](https://docs.zid.sa/apidoc/docs-site/613905/create-attribute-preset.md): Use this endpoint to add a new attribute preset, allowing for quick and easy creation of attributes with localized values in both Arabic and English.
- APIs > Products > Product Attribute Presets [Update Attribute Preset](https://docs.zid.sa/apidoc/docs-site/613905/update-attribute-preset.md): Use this endpoint to update an existing attribute preset by specifying both the preset ID and the attribute ID. The request allows you to update the preset values in different languages.
- APIs > Products > Product Attribute Presets [Delete an attribute preset](https://docs.zid.sa/apidoc/docs-site/613905/delete-an-attribute-preset.md): Delete a defined attribute preset.
- APIs > Products > Product Customizations [Add Product Variants](https://docs.zid.sa/apidoc/docs-site/613905/add-product-variants.md): This endpoint creates child variants for a given product by defining choices for its attributes. If the product in question is a stand-alone product (neither a parent nor having any children), this operation will transform it into a parent product.
- APIs > Products > Product Customizations [Insert Custom Options to a Product](https://docs.zid.sa/apidoc/docs-site/613905/insert-custom-options-to-a-product.md): Adds custom options to a product, allowing customers to choose from a predefined set of options while making a purchase. Custom options can be used to offer choices such as gift wrapping, warranty options, or other additional services.
- APIs > Products > Product Customizations [Insert Custom User-Input Fields to a Product](https://docs.zid.sa/apidoc/docs-site/613905/insert-custom-user-input-fields-to-a-product.md): Adds custom user-input fields to a product, allowing customers to provide additional information while making a purchase. Custom user input fields can be used to collect data such as personalization details, gift messages, or special instructions.
- APIs > Products > Product Manual Sorting [Set Custom Product Order](https://docs.zid.sa/apidoc/docs-site/613905/set-custom-product-order.md): Sets a custom ordering of products by accepting an ordered list of product IDs. This manual sorting can also be applied to a specific category when the category ID is passed in the body.
- APIs > Products > Product Manual Sorting [Reset the manual sorting of all products](https://docs.zid.sa/apidoc/docs-site/613905/reset-manual-sorting-of-all-products.md): Delete any manual sorting that was done on any of the store products.
- APIs > Products > Product Images [Get List of images of a product.](https://docs.zid.sa/apidoc/docs-site/613905/get-list-of-images-of-a-product.md): Retrieve a list with all images available for a certain product using product id.
- APIs > Products > Product Images [Add an image to a product](https://docs.zid.sa/apidoc/docs-site/613905/add-image-to-a-product.md): Use this endpoint to add a single image to a product.
- APIs > Products > Product Images [Update a product Image Order](https://docs.zid.sa/apidoc/docs-site/613905/update-a-product-image-order.md): use this endpoint to reorder an image's appearance for a product.
- APIs > Products > Product Images [Delete a product image](https://docs.zid.sa/apidoc/docs-site/613905/delete-a-product-image.md): Delete a specific product image by using the image id and product id.
- APIs > Products > Product Notifications [Availability Notification Stats](https://docs.zid.sa/apidoc/docs-site/613905/availability-notification-stats.md): Retrieve statistics on availability notifications.
- APIs > Products > Product Notifications [Availability Notifications Settings](https://docs.zid.sa/apidoc/docs-site/613905/availability-notifications-settings.md): Retrieve current settings for availability notifications.
- APIs > Products > Product Notifications [List Availability Notifications](https://docs.zid.sa/apidoc/docs-site/613905/list-availability-notifications.md): Retrieve a list of availability notifications.
- APIs > Products > Product Notifications [Add Availability Notification](https://docs.zid.sa/apidoc/docs-site/613905/add-availability-notification.md): Sign up to receive a notification by email when the specified product becomes available again in the store.
- APIs > Products > Product Notifications [Save Availability Notifications Settings](https://docs.zid.sa/apidoc/docs-site/613905/save-availability-notifications-settings.md): Save settings for availability notifications.
- APIs > Products > Product Notifications [Manually Send Availability Notification Email](https://docs.zid.sa/apidoc/docs-site/613905/manually-send-availability-notification-email.md): Manually send an availability notification email.
- APIs > Products > Product Notifications [Export Availability Notifications](https://docs.zid.sa/apidoc/docs-site/613905/export-availability-notifications.md): Export availability notifications data.
- APIs > Products > Product Import [Email All Products to Store Owner](https://docs.zid.sa/apidoc/docs-site/613905/email-all-products-to-store-owner.md): Sends an email to the store owner containing all the store's products in CSV format.
- APIs > Products > Product Import [Import Products via CSV or xlsx File](https://docs.zid.sa/apidoc/docs-site/613905/import-products-via-csv/xlsx-file.md): Imports products to the store using a CSV or xlsx file. The endpoint accepts a file, a Dropbox folder link for images, and an optional `delete_old_products` parameter to delete all previous store products upon successful import.
- APIs > Products > Product Stock (Multi-Inventory) [Get Product Stock by ID](https://docs.zid.sa/apidoc/docs-site/613905/get-product-stock-by-id.md): Retrieve specific product stock data by its unique ID.
- APIs > Products > Product Stock (Multi-Inventory) [List Product Stocks](https://docs.zid.sa/apidoc/docs-site/613905/list-product-stocks.md): Retrieve a list of all product stocks for a specific product.
- APIs > Products > Product Stock (Multi-Inventory) [Add Product Stock](https://docs.zid.sa/apidoc/docs-site/613905/add-product-stock.md): Add a new product stock for a specific product.
- APIs > Products > Product Stock (Multi-Inventory) [Update Single Product Stock](https://docs.zid.sa/apidoc/docs-site/613905/update-single-product-stock.md): Update a single product stock by its unique ID. It is not recommended when handling lots of stocks.
- APIs > Products > Product Stock (Multi-Inventory) [Bulk Update Product Stocks](https://docs.zid.sa/apidoc/docs-site/613905/bulk-update-product-stocks.md): Bulk update product stocks through locations. It is recommended when updating multiple stocks.
- APIs > Products > Product Questions & Answers [Get Question](https://docs.zid.sa/apidoc/docs-site/613905/get-questions.md): Retrieve details of a specific question for a product.
- APIs > Products > Product Questions & Answers [Get Answer](https://docs.zid.sa/apidoc/docs-site/613905/get-answer.md): Retrieve details of a specific answer to a question.
- APIs > Products > Product Questions & Answers [Get All Questions](https://docs.zid.sa/apidoc/docs-site/613905/get-all-questions.md): Retrieve a list of all questions for a product.
- APIs > Products > Product Questions & Answers [List Question Answers](https://docs.zid.sa/apidoc/docs-site/613905/list-question-answers.md): Retrieve a list of all answers for a specific question of a product.
- APIs > Products > Product Questions & Answers [Create Question](https://docs.zid.sa/apidoc/docs-site/613905/create-question.md): Create a new question for a specified product.
- APIs > Products > Product Questions & Answers [Create Answer](https://docs.zid.sa/apidoc/docs-site/613905/create-answer.md): Create a new answer for a specific question of a product.
- APIs > Products > Product Questions & Answers [Update Question](https://docs.zid.sa/apidoc/docs-site/613905/update-question.md): Update details of a specific question for a product.
- APIs > Products > Product Questions & Answers [Update Answer](https://docs.zid.sa/apidoc/docs-site/613905/update-answer.md): Update details of a specific answer to a question.
- APIs > Products > Product Questions & Answers [Delete Question](https://docs.zid.sa/apidoc/docs-site/613905/delete-question.md): Delete a specific question for a product.
- APIs > Products > Product Questions & Answers [Delete Answer](https://docs.zid.sa/apidoc/docs-site/613905/delete-answer.md): Delete a specific answer for a question.
- APIs > Products > Product Reviews [List Reviews](https://docs.zid.sa/apidoc/docs-site/613905/list-reviews.md): This API endpoint retrieves a list of product reviews. It allows you to filter and paginate through reviews based on various query parameters such as the review status, date range, and customer ID.
- APIs > Products > Product Reviews [New Reviews Total](https://docs.zid.sa/apidoc/docs-site/613905/new-reviews-total.md): This API endpoint retrieves the total number of new reviews. It allows you to filter the results based on specific query parameters like search terms, date ranges, or customer IDs.
- APIs > Products > Digital Products [Create Downloadable Product](https://docs.zid.sa/apidoc/docs-site/613905/api-11395331.md): Here’s the updated description with the additional clarification:
- APIs > Products > Digital Products [Generate an Upload URL](https://docs.zid.sa/apidoc/docs-site/613905/api-11396021.md): The "Generate an Upload URL" endpoint allows users to generate a pre-signed URL for uploading a digital file directly to cloud storage. This URL enables secure, temporary access for uploading files associated with a digital product.
- APIs > Products > Digital Products [Upload File to S3](https://docs.zid.sa/apidoc/docs-site/613905/api-11396102.md): The "Upload File to S3" endpoint provides a pre-signed URL for secure, temporary access to upload files directly to Amazon S3 storage. This enables clients to upload files without needing direct S3 credentials, ensuring secure and efficient file handling for digital assets.
- APIs > Products > Digital Products [Create Product Downloadables](https://docs.zid.sa/apidoc/docs-site/613905/api-11447610.md): This endpoint creates downloadable content for a digital product, associating a file with the specified product. The download link is generated and returned, allowing users to access or download the content directly. The response provides information on the uploaded file, including its metadata, access link, and display details.
- APIs > Products > Digital Products [Get Product Downloadables](https://docs.zid.sa/apidoc/docs-site/613905/api-11448025.md): This endpoint retrieves a list of downloadable files associated with a specific product, providing details about each downloadable file, including access URLs, display names, and status. The response includes pagination information and metadata about the files, allowing the client to manage multiple files for a product.
- APIs > Products > Digital Products [Delete Product Downloadables](https://docs.zid.sa/apidoc/docs-site/613905/api-11448608.md): This endpoint deletes a specific downloadable file associated with a product. Upon successful deletion, the response returns the details of the deleted file, confirming the operation. This response helps the client verify the removal of the file and provides relevant metadata for record-keeping.
- APIs > Products > Digital Products [Get Store Downloadables](https://docs.zid.sa/apidoc/docs-site/613905/api-11768448.md): This endpoint retrieves a list of downloadable files associated with a specific store. It supports searching by file name and ordering the results by file size or creation date. The response provides details about each downloadable file, including its ID, name, file size, and associated store.
- APIs > Products > Digital Products [Create Store Downloadables](https://docs.zid.sa/apidoc/docs-site/613905/api-11830245.md): This endpoint allows the creation of downloadable files associated with a specific store. The client uploads a file, and the endpoint returns details about the newly created downloadable item, including its identifier, file name, and size.
- APIs > Products > Digital Products [Delete Store Downloadables](https://docs.zid.sa/apidoc/docs-site/613905/api-11830637.md): This endpoint deletes a specific downloadable file associated with a store. It requires the unique ID of the downloadable file to be specified in the URL. Upon successful deletion, the server responds with an HTTP status code indicating the operation's success.
- APIs > Inventories [Get Store Location by ID](https://docs.zid.sa/apidoc/docs-site/613905/get-store-location-by-id.md): Retrieves details about a specified location.
- APIs > Inventories [List Store Locations](https://docs.zid.sa/apidoc/docs-site/613905/list-store-locations.md): Retrieves a list of locations associated with the store.
- APIs > Inventories [Add a New Location](https://docs.zid.sa/apidoc/docs-site/613905/add-a-new-location.md): Adds a new location to the store.
- APIs > Inventories [Update a Location by ID](https://docs.zid.sa/apidoc/docs-site/613905/update-a-location-by-id.md): Updates the details of a specified location.
- APIs > Inventories [Update Products Stock by Location ID](https://docs.zid.sa/apidoc/docs-site/613905/api-14477202.md): This endpoint allows store managers to update stock quantities for products at a specific location. Managers can specify the available quantity and whether the stock is infinite or limited.
- APIs > Shipping [List Store Delivery Options](https://docs.zid.sa/apidoc/docs-site/613905/list-store-delivery-options.md): This endpoint provides the list of all delivery options configured for the store,  including custom shipping names, associated cities, and status of each shipping method.  It's useful for managing delivery settings and understanding available shipping methods.
- APIs > Shipping [Add Shipping Option](https://docs.zid.sa/apidoc/docs-site/613905/add-shipping-option.md): To Add Shipping Option To Store.
- APIs > Marketing > Gift Cards [Get Store Settings](https://docs.zid.sa/apidoc/docs-site/613905/get-store-settings.md): Retrieve the settings of the store.
- APIs > Marketing > Gift Cards [Add gift card to the cart](https://docs.zid.sa/apidoc/docs-site/613905/add-gift-card-to-the-cart.md): Adds a new gift card to the cart.
- APIs > Marketing > Gift Cards [Update Store Settings](https://docs.zid.sa/apidoc/docs-site/613905/update-store-settings.md): Update the settings of the store.
- APIs > Marketing > Gift Cards [Upload gift card designs](https://docs.zid.sa/apidoc/docs-site/613905/upload-gift-card-designs.md): Upload new designs for gift cards.
- APIs > Marketing > Gift Cards [Remove gift card from the cart](https://docs.zid.sa/apidoc/docs-site/613905/remove-gift-card-from-the-cart.md): Removes a gift card from the cart.
- APIs > Marketing > Coupons [Create a New Coupon](https://docs.zid.sa/apidoc/docs-site/613905/create-a-new-coupon.md): Create a new coupon with various options such as discount type, validity period, usage limits, and application conditions.
- APIs > Marketing > Coupons [List Coupons](https://docs.zid.sa/apidoc/docs-site/613905/api-13955120.md): Retrieves a list of all available coupons from the system. The response includes active, inactive, and expired coupons along with relevant metadata such as store details, discount type, and validity period.
- APIs > Marketing > Coupons [Get Coupon Details](https://docs.zid.sa/apidoc/docs-site/613905/api-13955212.md): Fetches detailed information about a specific coupon using its unique coupon_id. This endpoint provides all attributes of a coupon, including usage statistics, conditions, and status.
- APIs > Marketing > Coupons [Update Coupon](https://docs.zid.sa/apidoc/docs-site/613905/api-13940921.md): This endpoint allows merchants to update details of an existing coupon. Merchants can modify attributes such as discount value, expiration date, and usage limits.
- APIs > Marketing > Coupons [Delete Coupon](https://docs.zid.sa/apidoc/docs-site/613905/api-13941160.md): This endpoint allows merchants to delete an existing coupon. Once deleted, the coupon will no longer be valid for any transactions.
- APIs > Marketing > Bundle Offers [Retrieve all Bundle Offers](https://docs.zid.sa/apidoc/docs-site/613905/retrieve-all-bundle-offers.md): This endpoint retrieves all available bundle offers for the store. Bundle offers are special promotions where customers can get a discount if they buy a specific bundle of products.
- APIs > Marketing > Loyalty Program [Loyalty Program Points per Order](https://docs.zid.sa/apidoc/docs-site/613905/loyalty-program-points-per-order.md): Calculates the number of points awarded based on a specific order total for a particular store's loyalty program.
- APIs > Marketing > Loyalty Program [Store Loyalty Status](https://docs.zid.sa/apidoc/docs-site/613905/store-loyalty-status.md): Retrieves information about the overall status (active/inactive) and program name of a store's loyalty program.
- APIs > Marketing > Loyalty Program [Info Page](https://docs.zid.sa/apidoc/docs-site/613905/info-page.md): Retrieves information about the store's loyalty program info page content.
- APIs > Marketing > Loyalty Program [Loyalty Program Activation](https://docs.zid.sa/apidoc/docs-site/613905/loyalty-program-activation.md): Activates a loyalty program for a store.
- APIs > Marketing > Loyalty Program [Loyalty Status](https://docs.zid.sa/apidoc/docs-site/613905/loyalty-status.md): Retrieves information about the overall status (active/inactive) of a store's loyalty program.
- APIs > Marketing > Loyalty Program [Set Points Expiration](https://docs.zid.sa/apidoc/docs-site/613905/set-points-expiration.md): Sets the expiration period for loyalty points within a store's program.
- APIs > Marketing > Loyalty Program [Cashback Rule Method Update](https://docs.zid.sa/apidoc/docs-site/613905/cashback-rule-method-update.md): Updates the configuration of a cashback rule within a store's loyalty program.
- APIs > Marketing > Loyalty Program [Cashback Rule Method Update Status](https://docs.zid.sa/apidoc/docs-site/613905/cashback-rule-method-update-status.md): Enables or disables a specific cashback rule method within a store's loyalty program.
- APIs > Marketing > Loyalty Program [Add Points Redemption Method](https://docs.zid.sa/apidoc/docs-site/613905/add-points-redemption-method.md): Creates a new redemption method (e.g., gift certificate) for a store's loyalty program.
- APIs > Marketing > Loyalty Program [Update Points Redemption Method](https://docs.zid.sa/apidoc/docs-site/613905/update-points-redemption-method.md): Updates the details of an existing redemption method within a store's loyalty program.
- APIs > Marketing > Loyalty Program [Delete Points Redemption Method](https://docs.zid.sa/apidoc/docs-site/613905/delete-points-redemption-method.md): Deletes a specific redemption method from a store's loyalty program.
- APIs > Marketing > Loyalty Program [Toggle Redemption Method Status](https://docs.zid.sa/apidoc/docs-site/613905/toggle-redemption-method-status.md): Enables or disables a specific redemption method within a store's loyalty program.
- APIs > Marketing > Loyalty Program [Show Loyalty Points Info for Specific Customer](https://docs.zid.sa/apidoc/docs-site/613905/show-loyalty-points-infor-for-specific-customer.md): Retrieves detailed information about a specific customer's loyalty points, including balance and transaction history.
- APIs > Marketing > Loyalty Program [Customer Profile](https://docs.zid.sa/apidoc/docs-site/613905/customer-profile.md): Retrieves detailed information about a specific customer, including their loyalty program data.
- APIs > Marketing > Loyalty Program [List Data](https://docs.zid.sa/apidoc/docs-site/613905/list-data.md): Retrieves list data relevant to the loyalty program configuration.
- APIs > Marketing > Loyalty Program [Customer Points History](https://docs.zid.sa/apidoc/docs-site/613905/customer-points-history.md): Retrieves the transaction history of a specific customer's loyalty points activity.
- APIs > Marketing > Loyalty Program [Info Page - Managers](https://docs.zid.sa/apidoc/docs-site/613905/info-page-managers.md): Retrieves information about the store's loyalty program info page content.
- APIs > Marketing > Loyalty Program [Update Info Page](https://docs.zid.sa/apidoc/docs-site/613905/update-info-page.md): Updates the content of the store's loyalty program info page.
- APIs > Marketing > Loyalty Program [Adjust Customer Points](https://docs.zid.sa/apidoc/docs-site/613905/adjust-customer-points.md): Allows manual adjustments to a customer's loyalty points balance.
- APIs > Customers [List of Customers](https://docs.zid.sa/apidoc/docs-site/613905/list-of-customers.md): This endpoint will return a list of the store customers along with other metadata such as the total number of customers and the total number of orders for each customer.
- APIs > Customers [Get Customer by ID](https://docs.zid.sa/apidoc/docs-site/613905/get-customer-by-id.md): This endpoint retrieves the details of a certain customer using the Customer's ID.
- APIs > Store Settings [Get Manager's Profile](https://docs.zid.sa/apidoc/docs-site/613905/get-manager-profile.md): Retrieves the profile data of the authenticated Manager. This includes detailed information about the Manager, their role, associated store, and the set of permissions they hold. 
- APIs > Store Settings [Get VAT Settings](https://docs.zid.sa/apidoc/docs-site/613905/get-vat-settings.md): Return a list of the VAT settings configured on this store. For example, to indicate whether the store VAT is applied on shipping fees or not.
- APIs > Store Settings [List of Payment Method](https://docs.zid.sa/apidoc/docs-site/613905/list-of-payment-method.md): <Accordion title="🔑Scopes" defaultOpen>
- APIs > Countries and Cities [Retrieve Store Operating Countries](https://docs.zid.sa/apidoc/docs-site/613905/retrieve-store-operating-countries.md): Retrieve a list of countries where the store operates. This list includes the country's unique ID, name, ISO codes, and flag image URL.
- APIs > Countries and Cities [Retrieve Cities by Country ID](https://docs.zid.sa/apidoc/docs-site/613905/retrieve-cities-by-country-id.md): Retrieve a list of cities for a specific country where the store operates or delivers. The list includes each city's unique ID, name, and country details. Note that a city can be labeled as 'Other', represented by an 'أخرى' or 'Other' in the 'name' field, which typically signifies a location outside of the predefined list of cities.
- APIs > Countries and Cities [Countries List](https://docs.zid.sa/apidoc/docs-site/613905/countries-list.md): The endpoint returns all countries' names, codes, and IDs, and is not specific to any particular store's operations or merchant's activated countries.
- APIs > Webhook [List of Webhooks](https://docs.zid.sa/apidoc/docs-site/613905/list-of-webhooks.md): Webhooks allow you to receive real-time data updates about various events. 
- APIs > Webhook [Create a Webhook](https://docs.zid.sa/apidoc/docs-site/613905/create-a-webhook.md): Webhooks allow you to receive real-time data updates about various events. 
- APIs > Webhook [Delete a Webhook by OriginalId](https://docs.zid.sa/apidoc/docs-site/613905/delete-a-webhook-by-original-id.md): This endpoint allows you to delete a specific webhook using originalID . The original ID refers to the unique identifier assigned by the user upon creation.
- APIs > Webhook [Delete a Webhook by Subscriber](https://docs.zid.sa/apidoc/docs-site/613905/delete-a-webhook-by-subscriber.md): This endpoint allows you to delete all the webhooks associated with a subscriberID. The subscriberID refers to the unique identifier assigned to the user upon creation.
- App Subscription [Get Subscription Details](https://docs.zid.sa/apidoc/docs-site/613905/api-13896876.md): This endpoint enables app partners to fetch details about a merchant's app subscription, including plan, status, and billing information.
- App Subscription [Update Usage-Based Charges](https://docs.zid.sa/apidoc/docs-site/613905/api-13896680.md): This endpoint allows app partners to update the outstanding balance for their app's usage-based plan, ensuring flexible billing adjustments to align with merchants' pay-as-you-go consumption.