Zid Docs
  1. Managing Products
Zid Docs
  • Merchant API
    • Start Here 🚀
    • Overview to Zid Apps
    • Authorization
    • Responses
    • Webhooks
    • Rate Limiting
    • APIs
      • Orders
        • Update Order by ID
        • Get Order Credit Notes
        • Get Order by ID
        • List of Orders
        • Order Notes
      • Reverse Orders
        • Reverse Order Reasons
        • Create Reverse Orders
        • Create Reverse Orders Waybill
        • Add Reverse Order Reasons
      • Carts
        • Get Abandoned Cart Details
        • List Abandoned Carts
      • Products
        • Managing Products
          • Get a Product by ID
            GET
          • Retrieve a list of products
            GET
          • Create a new product
            POST
          • Update an existing product.
            PATCH
          • Bulk update of products using their IDs or SKUs
            PATCH
          • Delete a product.
            DELETE
          • Product Setting
            GET
          • List Product Reviews
            GET
        • Digital Vouchers
          • Product Vouchers
          • Order Voucher
          • Add Product Voucher
          • Import Vouchers
          • Export Vouchers
          • Update Product Voucher
          • Remove Product Voucher
        • Product Categories
          • Get Single Category Details
          • Get all categories
          • Create Store Category
          • Update a Store Category
          • Add a product to a certain category
          • Publish/Unpublish a Category
          • Detach Category from All Products
          • Remove Category from Product
        • Product Badge
          • Product Badge
        • Product Attributes
          • Get Product Attributes
          • Get Product Attributes
          • Retrieve a product attribute
          • Add a New Product Attribute
          • Add a New Product Attribute
          • Update a product attribute
          • Delete a product attribute
        • Product Attribute Presets
          • Get attribute presets
          • Create Attribute Preset
          • Update Attribute Preset
          • Delete an attribute preset
        • Product Customizations
          • Add Product Variants
          • Insert Custom Options to a Product
          • Insert Custom User-Input Fields to a Product
        • Product Manual Sorting
          • Set Custom Product Order
          • Reset the manual sorting of all products
        • Product Images
          • Get List of images of a product.
          • Add an image to a product
          • Update a product Image Order
          • Delete a product image
        • Product Notifications
          • Availability Notification Stats
          • Availability Notifications Settings
          • List Availability Notifications
          • Add Availability Notification
          • Save Availability Notifications Settings
          • Manually Send Availability Notification Email
          • Export Availability Notifications
        • Product Import
          • Email All Products to Store Owner
          • Import Products via CSV or xlsx File
        • Product Stock (Multi-Inventory)
          • Get Product Stock by ID
          • List Product Stocks
          • Add Product Stock
          • Update Single Product Stock
          • Bulk Update Product Stocks
        • Product Questions & Answers
          • Get Question
          • Get Answer
          • Get All Questions
          • List Question Answers
          • Create Question
          • Create Answer
          • Update Question
          • Update Answer
          • Delete Question
          • Delete Answer
        • Product Reviews
          • List Reviews
          • New Reviews Total
          • Change Review Status
          • Bulk Change all Review Statuses
          • Delete Review
          • Import Product Reviews
          • Reply to Review
          • Delete Reply
          • Update Reply to Review
        • Digital Products
          • Create Downloadable Product
          • Generate an Upload URL
          • Upload File to S3
          • Create Product Downloadables
          • Get Product Downloadables
          • Delete Product Downloadables
          • Get Store Downloadables
          • Create Store Downloadables
          • Delete Store Downloadables
      • Inventories
        • Get Store Location by ID
        • List Store Locations
        • Add a New Location
        • Update a Location by ID
        • Update Products Stock by Location ID
      • Shipping
        • List Store Delivery Options
        • Add Shipping Option
      • Marketing
        • Gift Cards
          • Get Store Settings
          • Add gift card to the cart
          • Update Store Settings
          • Upload gift card designs
          • Remove gift card from the cart
        • Coupons
          • Create a New Coupon
          • List Coupons
          • Get Coupon Details
          • Update Coupon
          • Delete Coupon
        • Bundle Offers
          • Retrieve all Bundle Offers
        • Loyalty Program
          • Customer Wallet
          • Customer Points
          • Loyalty Program Points per Order
          • Store Loyalty Status
          • Redemption Methods
          • Cashback Rules
          • Add Redemption to Cart
          • Remove Redemption from Cart
          • Info Page
          • Loyalty Program Activation
          • Loyalty Status
          • Set Points Expiration
          • Cashback Rule Method Update
          • Cashback Rule Method Update Status
          • Add Points Redemption Method
          • Update Points Redemption Method
          • Delete Points Redemption Method
          • Toggle Redemption Method Status
          • Show Loyalty Points Info for Specific Customer
          • List Data
          • Customer Points History
          • Info Page - Managers
          • Update Info Page
          • Adjust Customer Points
      • Customers
        • Customer Profile
        • List of Customers
        • Get Customer by ID
      • Store Settings
        • 📄 User Roles and Permissions
        • Get Manager's Profile
        • Get VAT Settings
        • List of Payment Method
      • Countries and Cities
        • Retrieve Store Operating Countries
        • Retrieve Cities by Country ID
        • Countries List
      • Webhook
        • List of Webhooks
        • Create a Webhook
        • Delete a Webhook by OriginalId
        • Delete a Webhook by Subscriber
    • Store Events
      • Order
      • Product
      • Abandoned Cart
      • Customer
      • Product Category
  • Payment API
    • Overview
    • Merchant Activation
    • Payment
      • Overview
      • Embedded Payment
      • Gateway Error Codes
      • Direct Payment
      • Execute Payment Request
      • Get payment status
    • ApplePay
      • ApplePay Checkout
      • Register ApplePay Domain
      • Providing Merchant Validation
    • Refund
      • Request Refund
    • Webhooks
      • Overview
      • Link Merchant Event
      • Payment Paid Event
      • Refund Event
  • Apps
    • Create your First App
    • Embedded Apps
    • App Scripts
    • App Events
    • App Subscription
      • Get Subscription Details
      • Update Usage-Based Charges
  • Themes
    • 🚨 Important Update: Zid Themes
    • Adding Video URL Feature to Third-Party Themes
    • Landing Page Development
    • Getting Started with Zid Themes
      • Introduction to Theme Development
      • Manage your Themes
      • Building Themes in Zid
      • Theme File Structure
      • Twig Syntax and Features
      • Zid Theme Packager
    • Templates
      • Layout
      • Home Page
      • Products
      • Cart
      • Store Language and Currency
    • Settings Schema
      • Text
      • Number
      • Text-Area
      • Select
      • Radio Buttons
      • Checkbox
      • Range
      • Color
      • Image
      • Product
      • Category
      • List
      • Fieldset
    • Code Snippets
      • Apple Pay Quick Checkout
      • Custom CSS Injection
      • Displaying the Store's Business Center Logo
      • Customizing Copyright Text
      • Store's Main Navigation Menu
      • Customer Wishlist
      • Store Social Media
      • Products
        • Products Badges
        • Product Ratings
        • Remaining Product Stock
        • Sold Items Count
        • Product Filtration by Attributes
        • Grouped Products
        • Product Questions & Answers
        • Product Restock Notfication
      • SEO
        • Images alt text
        • Themes SEO Marketing Tags
      • Marketing
        • Metafields
        • Gift Feature
        • Loyalty Program
    • Zid Themes Library: API Integration
      • Products
      • Product Categories
      • Cart
      • Blog
      • Customer
      • Store Settings
    • Data Reference
      • Locals
      • Store
      • Cart
      • Product
      • Products List
      • Category
      • Categories List
      • Session
      • FAQs
      • Customer
      • Blogs
      • Page
      • Main Menu
      • Main Navigation Menu
      • Request
      • Orders
      • Addresses
      • Store Payment Methods
      • Store Shipping Methods
      • Store Banks
      • Asset URL
      • Header Meta Tags
      • Loyalty pogram Wallet
    • Themes CLI
      • CLI Authentication
      • Theme Create
      • Theme Package
      • Theme Update
      • Themes List
      • Theme Preview
  • MCP
    • Orders
    • Orders 1
  1. Managing Products

Retrieve a list of products

GET
https://api.zid.sa/v1v1/products/
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.
Additionally, products can be filtered by attribute values using the attribute_values parameter, which accepts comma-separated values applicable to any attribute (color, brand, size, etc.).
🔑Scopes
products.read - Products Read
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.zid.sa/v1v1/products/?page_size&page&attribute_values=nike,black,large' \
--header 'Accept-Language;' \
--header 'Access-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y' \
--header 'Store-Id: 37213' \
--header 'Role: Manager'
Response Response Example
{
    "next": "string",
    "previous": "string",
    "count": 0,
    "results": [
        {
            "is_external_product": false,
            "id": null,
            "parent_id": null,
            "product_class": "string",
            "sku": "string",
            "barcode": "string",
            "name": {
                "ar": "string",
                "en": "string"
            },
            "slug": "string",
            "price": 0,
            "short_description": null,
            "sale_price": 50,
            "formatted_price": "10$",
            "formatted_sale_price": "8$",
            "currency": "string",
            "currency_symbol": "string",
            "attributes": [
                {}
            ],
            "categories": [
                {}
            ],
            "display_order": null,
            "has_options": false,
            "has_fields": true,
            "images": [
                {}
            ],
            "is_draft": true,
            "quantity": null,
            "is_infinite": true,
            "html_url": "string",
            "weight": {
                "value": 100,
                "unit": "kg"
            },
            "keywords": [
                {}
            ],
            "requires_shipping": true,
            "is_taxable": false,
            "structure": "string",
            "seo": {
                "title": {
                    "ar": "string",
                    "en": "string"
                },
                "description": {}
            },
            "rating": {
                "average": 3.9,
                "total_count": 400,
                "1_ratings": {
                    "percentage": 0,
                    "count": 0
                },
                "2_ratings": {
                    "percentage": 0,
                    "count": 0
                },
                "3_ratings": {
                    "percentage": 0,
                    "count": 0
                },
                "4_ratings": {
                    "percentage": 0,
                    "count": 0
                },
                "5_ratings": {
                    "percentage": 0,
                    "count": 0
                }
            },
            "store_id": 0,
            "purchase_restrictions": {
                "min_quantity_per_cart": null,
                "max_quantity_per_cart": null,
                "availability_period_start": null,
                "availability_period_end": null,
                "sale_price_period_start": "2024-09-18T21:00:00.000000Z",
                "sale_price_period_end": "2024-09-19T20:59:59.000000Z"
            },
            "metafields": null,
            "meta": {},
            "badge": {
                "body": {
                    "ar": "string",
                    "en": "string"
                },
                "icon": {
                    "code": "string"
                }
            },
            "related_products_settings": "string",
            "related_products_title": null,
            "variants": [
                {}
            ],
            "options": [
                {}
            ],
            "cost": 0,
            "is_published": true,
            "waiting_customers_count": null,
            "description": {},
            "custom_user_input_fields": [
                {}
            ],
            "custom_option_fields": [
                {}
            ],
            "related_products": [
                {}
            ],
            "next_product": null,
            "previous_product": null,
            "group_products": [
                {
                    "id": "143",
                    "item": {
                        "id": "string",
                        "product_class": null,
                        "sku": "string",
                        "barcode": "string",
                        "parent_id": null,
                        "name": {
                            "ar": "string",
                            "en": "string"
                        },
                        "slug": "string",
                        "price": 0,
                        "short_description": null,
                        "sale_price": null,
                        "formatted_price": "string",
                        "formatted_sale_price": null,
                        "currency": "string",
                        "currency_symbol": "string",
                        "attributes": [
                            {}
                        ],
                        "categories": [
                            {}
                        ],
                        "display_order": null,
                        "has_options": true,
                        "has_fields": true,
                        "images": [
                            {}
                        ],
                        "is_draft": true,
                        "quantity": null,
                        "is_infinite": true,
                        "html_url": "string",
                        "weight": {
                            "value": null,
                            "unit": "string"
                        },
                        "keywords": [
                            {}
                        ],
                        "requires_shipping": true,
                        "is_taxable": true,
                        "structure": "string",
                        "seo": {
                            "title": {
                                "ar": "string",
                                "en": "string"
                            },
                            "description": {}
                        },
                        "rating": {
                            "average": 4.1,
                            "total_count": 50,
                            "1_ratings": {
                                "percentage": 0,
                                "count": 0
                            },
                            "2_ratings": {
                                "percentage": 0,
                                "count": 0
                            },
                            "3_ratings": {
                                "percentage": 0,
                                "count": 0
                            },
                            "4_ratings": {
                                "percentage": 0,
                                "count": 0
                            },
                            "5_ratings": {
                                "percentage": 0,
                                "count": 0
                            }
                        },
                        "store_id": 0,
                        "purchase_restrictions": {
                            "min_quantity_per_cart": null,
                            "max_quantity_per_cart": null,
                            "availability_period_start": null,
                            "availability_period_end": null
                        },
                        "metafields": null,
                        "meta": null,
                        "badge": null,
                        "related_products_settings": "string",
                        "related_products_title": null,
                        "created_at": "string",
                        "updated_at": "string",
                        "options": [
                            {}
                        ],
                        "group_products": null,
                        "stocks": [
                            {
                                "id": "string",
                                "location": {
                                    "id": "string",
                                    "name": {
                                        "ar": "string"
                                    },
                                    "type": "string"
                                },
                                "available_quantity": null,
                                "is_infinite": false
                            }
                        ]
                    },
                    "origin_product_id": "string",
                    "item_id": "string",
                    "item_quantity": 0,
                    "in_stock": true
                }
            ],
            "stocks": [
                {
                    "id": "string",
                    "location": {
                        "id": "string",
                        "name": {
                            "ar": "string"
                        },
                        "type": "string"
                    },
                    "available_quantity": null,
                    "is_infinite": true
                }
            ],
            "sold_products_count": null,
            "created_at": "string",
            "updated_at": "string"
        }
    ],
    "filters": {}
}

Request

Query Params

Header Params

Responses

🟢200List of products
application/json
Body

Modified at 2025-07-15 06:48:31
Previous
Get a Product by ID
Next
Create a new product
Built with