Zid Docs
Merchant APIs
Theme Docs
Zid Docs
  • Start Here 🚀
  • Overview to Zid Apps
  • Create your First App
  • Authorization
  • Responses
  • Embedded Apps
  • Webhooks
  • App Scripts
  • Rate Limiting
  • APIs
    • Orders
    • Products
      • Managing Products
        • Get a Product by IDGET
        • Retrieve a list of productsGET
        • Create a new productPOST
        • Update an existing product.PATCH
        • Bulk update of products using their IDs or SKUsPATCH
        • Delete a product.DELETE
        • Product SettingGET
      • Digital Vouchers
      • Product Categories
      • Product Badge
      • Product Attributes
      • Product Attribute Presets
      • Product Customizations
      • Product Manual Sorting
      • Product Images
      • Product Notifications
      • Product Import
      • Product Stock (Multi-Inventory)
      • Product Questions & Answers
      • Product Reviews
      • Digital Products
    • Inventories
    • Shipping
    • Marketing
    • Customers
    • Store Settings
    • Countries and Cities
    • Webhooks
    • App Scripts
  • Webhook Events
logoPowered by Apidog

    Get a Product by ID

    GETv1/products/{product_id}/

    Get product by ID as Manager or as Customer.

    Managers need to provide the Authorization and X-Manager-Token headers, and the Role should be set to Manager.

    Customers don't need an authorization token, and the Role should be set to Customer.

    Both Customer and Manager get essentially the same object with two key differences for managers:

    1. In the Manager response, both the name field and the value field in the attributes array are objects containing "ar" (Arabic) and "en" (English) strings, while in the Customer response, they are just single strings.
    2. The Manager response contains two additional fields: created_at and updated_at, which provide timestamps for when the product was created and last updated.

    These are the main structural differences between the two responses. Other than that, they share the same structure, including the nested arrays and objects.

    Request

    Path Params
    product_id
    string 
    required
    Example:
    107c2ff5-5c70-4749-b9bd-56dc1793013b
    Header Params
    Store-Id
    number 
    required
    Example:
    37213
    Accept-Language
    enum<string> 
    optional

    Preferred language for the response (No effect for Managers; defaults to en for Customers if not provided).

    Allowed values:
    aren
    Role
    enum<string> 
    required

    Role of the user.

    Allowed values:
    ManagerCustomer
    Example:
    Manager
    Authorization
    string 
    required

    The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

    Example:
    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
    Access-Token
    string 
    required

    An Access Token is a unique string that represents the authorization granted to a client (Partner application) by a user (Merchant or Store Manager) to access their protected resources. It is part of the OAuth 2.0 standard and is used to authenticate API requests on behalf of the user. Access Tokens have a limited lifespan and must be used within their validity period. Once expired, a new Access Token can be obtained using a Refresh Token. Access Tokens should be treated as sensitive information and must be kept secure to prevent unauthorized access to the user's data. If you do not have an Access-Token, but have the older alternative instead, i.e., the X-Manager-Token, then see the instructions here on how to obtain the Access-Token.

    Example:
    eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

    Request samples

    Responses

    Successful operation(200)
    Successful operation
    HTTP Code: 200
    Content Type : JSONapplication/json
    Data Schema
    optional
    One of
    One of
    Could not resolve '#/definitions/2771485'
    Example
    Not configured
    Last modified: a month ago
    Next
    GETRetrieve a list of products