Zid Docs
Merchant APIApp APIThemes
Merchant APIApp APIThemes
Help Center
Slack
  1. Store Settings
  • 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
    • 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
        • Retrieve a list of products
        • Create a new product
        • Update an existing product.
        • Bulk update of products using their IDs or SKUs
        • Delete a product.
        • Product Setting
      • 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
      • 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
        • Loyalty Program Points per Order
        • Store Loyalty Status
        • 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
        • Customer Profile
        • List Data
        • Customer Points History
        • Info Page - Managers
        • Update Info Page
        • Adjust Customer Points
    • Customers
      • List of Customers
      • Get Customer by ID
    • Store Settings
      • πŸ“„ User Roles and Permissions
      • Get Manager's Profile
        GET
      • Get VAT Settings
        GET
      • List of Payment Method
        GET
    • 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
  1. Store Settings

Get Manager's Profile

GET
v1/managers/account/profile
Accounts
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.
This operation is exclusively for users with the Manager role (Store Owner, Store Moderator). Customer roles are not allowed to access this endpoint.
The system identifies the Manager and the related store via the X-Manager-Token. The Authorization token validates the user's access to the API.
For a detailed explanation of user roles and permissions, refer to our User Roles and Permissions guide.
πŸ”‘Scopes
account.read - Account Read

Request

Header Params
Accept-Language
enum<string>Β 
optional
Preferred language for the response. Defaults to en if not specified.
Allowed values:
enar
Example:
en
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
X-Manager-Token
stringΒ 
required
This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.
Example:
eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=
User-Agent
stringΒ 
optional
The User-Agent header contains information about the user agent (browser or app) making the request. It allows the server to provide a tailored response depending on the user agent's capabilities and preferences.
Example:
Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.zid.sa/v1/managers/account/profile' \
--header 'Accept-Language;' \
--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 'X-Manager-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'User-Agent;'

Responses

🟒200Successful retrieval of the Manager's profile with meta data
application/json
Body
The user profile of a store manager.
id
integerΒ 
optional
The unique identifier of the manager.
Example:
123456
old_id
integerΒ Β |Β nullΒ 
optional
The previous unique identifier of the manager, if any.
Example:
123455
uuid
stringΒ 
optional
The unique universally unique identifier (UUID) of the manager.
Example:
a1b2c3f4-5d6e-7f8g-9h10-i11j12k13l14
name
stringΒ 
optional
The full name of the manager.
Example:
Abdulaziz Al-Omari
username
stringΒ 
optional
The manager's username, usually an email address.
Example:
abdulaziz.zid@gmail.com
email
stringΒ 
optional
The manager's email address.
Example:
abdulaziz.zid@gmail.com
is_email_verified
booleanΒ 
optional
Indicates if the manager's email is verified. True if it is, otherwise false.
Example:
true
mobile
stringΒ 
optional
The manager's mobile number, including the country code.
Example:
0551234567
mobile_object
objectΒ (StoreMobileObject)Β 
optional
The mobile number information of the store.
country_code
stringΒ 
optional
The country calling code.
Example:
966
mobile
stringΒ 
optional
The local mobile number without the initial '0', as commonly used in some countries.
Example:
550427322
gender
stringΒ 
optional
The gender of the manager. 'm' for male, 'f' for female.
Example:
m
intercom_user_hash
stringΒ 
optional
The unique hash of the user in Intercom for customer communication and support.
Example:
a2f3b38ebe8a6a92d20967986c8b1e31e2926386235c60682a2c5dbb57910712
vloops_ref_code
stringΒ Β |Β nullΒ 
optional
The reference code of the manager in VLoops, if applicable.
Example:
null
user_profile_data
objectΒ (UserProfileData)Β 
optional
Contains additional data related to the user's personal and professional details.
birth_date
stringΒ <date>Β |Β nullΒ 
optional
The birth date of the user.
Example:
1992-08-14
country_id
integerΒ 
optional
The ID of the country where the user resides.
Example:
114
city_id
integerΒ 
optional
The ID of the city where the user resides.
Example:
1107
city
objectΒ (City)Β 
optional
country
objectΒ (Country)Β 
optional
is_organization_employee
booleanΒ 
optional
Indicates if the user is an employee of the organization. True if yes, otherwise false.
Example:
true
working_organization_name
stringΒ Β |Β nullΒ 
optional
The name of the organization where the user works. If the user isn't an employee of an organization, this is null.
Example:
Zid Business Solutions
job_title
stringΒ Β |Β nullΒ 
optional
The job title of the user within the organization. If the user isn't an employee of an organization, this is null.
Example:
Store Manager
business_location
objectΒ (BusinessLocation)Β 
optional
Contains the business location details of the user.
country
stringΒ Β |Β nullΒ 
optional
The country where the business is located.
Example:
Saudi Arabia
city
stringΒ Β |Β nullΒ 
optional
The city where the business is located.
Example:
Riyadh
district
stringΒ Β |Β nullΒ 
optional
The district where the business is located.
Example:
Al-Olaya
street
stringΒ Β |Β nullΒ 
optional
The street where the business is located.
Example:
King Fahd Road
building_no
stringΒ Β |Β nullΒ 
optional
The building number where the business is located.
Example:
1010
postal_code
stringΒ Β |Β nullΒ 
optional
The postal code of the business location.
Example:
12214
additional_postal_code
stringΒ Β |Β nullΒ 
optional
Any additional postal code related to the business location.
Example:
3765
lat
numberΒ <float>Β |Β nullΒ 
optional
The latitude of the business location.
Example:
24.7136
lng
numberΒ <float>Β |Β nullΒ 
optional
The longitude of the business location.
Example:
46.6753
show_location
booleanΒ 
optional
Indicates if the business location should be displayed. True if it should be displayed, otherwise false.
Example:
false
roles
array[string]
optional
An array of the roles assigned to the manager. Each item in the array is an object that includes the unique ID, slug, and name of the role.
Example:
[{"id":"9b91f2fe-a7c6-4791-8e3d-b6f860f452eb","slug":"store.owner","name":"Store Owner"}]
permissions
array[objectΒ (Permission) {5}]Β 
optional
An array of permissions assigned to the manager. Each permission is an object and includes the details of a specific permission.
Example:
[{"id":"abcd1234-ef56-gh78-ijkl9012","slug":"manage.products","name":"Manage Products"},{"id":"mnop3456-qr78-st90-uvwx2468","slug":"manage.orders","name":"Manage Orders"}]
id
stringΒ 
optional
A unique identifier associated with each permission, typically in the form of a UUID.
Example:
100f28ef-1c58-45cc-9bfd-feaf6bb64b1b
slug
stringΒ 
optional
A URL-friendly identifier that signifies the action or access level of the permission. Slugs are typically lowercase with words separated by periods (.) and provide a human-readable way to describe the permission in system logic.
Example:
manage.store.marketing
name
stringΒ 
optional
A user-friendly name for the permission. This is often displayed in user interfaces to help users understand the purpose of the permission.
Example:
Marketing
description
stringΒ 
optional
A brief explanation of what actions or access this permission grants to the manager. This helps in understanding the context of use for this permission.
Example:
Manage store marketing settings, accessible from the **Home -> Marketing** menu.
order
integerΒ 
optional
The precedence value for the permission. Higher values indicate a higher level of priority. Multiple permissions can have the same order value, reflecting equal precedence.
Example:
1
store
objectΒ (Store)Β 
optional
id
integerΒ 
optional
Unique identifier of the store.
Example:
251073
uuid
stringΒ 
optional
Universally unique identifier of the store.
Example:
4cbeba83-6ded-431b-a1ee-16ebfdbb8924
username
stringΒ 
optional
The username associated with the store, typically the manager's name followed by "store".
Example:
Abdullah Ahmed's store
title
stringΒ 
optional
The official name of the store.
Example:
Golden Oasis Electronics
phone
stringΒ 
optional
The contact phone number of the store.
Example:
0551234567
mobile_object
objectΒ (StoreMobileObject)Β 
optional
The mobile number information of the store.
store_business_data
objectΒ 
optional
Detailed business-related data associated with the store.
commercial_registration_number
stringΒ Β |Β nullΒ 
optional
The commercial registration number of the store.
Example:
1029384756
commercial_registration_number_activation
booleanΒ Β |Β nullΒ 
optional
Whether the commercial registration number is activated.
Example:
true
email
stringΒ 
optional
The email address associated with the store.
Example:
abdullah.store@zid.sa
url
stringΒ 
optional
The URL of the store's website.
Example:
https://abdullahstore.zid.store/
ssl
stringΒ 
optional
The SSL-enabled URL of the store's website.
Example:
https://abdullahstore.zid.store/
sitemap_url
stringΒ 
optional
The URL of the store's sitemap.
Example:
https://abdullahstore.zid.store/sitemap.xml
currency
objectΒ (StoreCurrency)Β 
optional
The currency information associated with the store.
currencies
array[objectΒ (StoreCurrency) {5}]Β 
optional
List of currencies supported by the store. This includes all currencies that the store can do transactions in.
language
objectΒ (StoreLanguage)Β 
optional
Information about the language used in the store.
languages
array[objectΒ (StoreLanguage) {3}]Β 
optional
List of languages supported by the store. This includes all languages that the store's website can be displayed in.
theme
objectΒ (StoreTheme)Β 
optional
Information about the store's theme.
logo
stringΒ Β |Β nullΒ 
optional
The URL of the store's logo.
Example:
https://media.zid.store/abdullahstore/logo.png
logos
array[string]
optional
An array of URLs of different versions of the store's logo. Empty array if the store doesn't have a logo.
Example:
[]
cover
stringΒ Β |Β nullΒ 
optional
The URL of the store's cover image.
Example:
https://media.zid.store/abdullahstore/cover.jpg
icon
stringΒ Β |Β nullΒ 
optional
The URL of the store's icon.
Example:
https://media.zid.store/abdullahstore/icon.png
maintenance_mode
booleanΒ 
optional
Indicates if the store is in maintenance mode. True if in maintenance mode, otherwise false.
Example:
false
has_new_products_service
booleanΒ 
optional
Indicates if the store has a new products service. True if it does, otherwise false.
Example:
true
facebook
stringΒ Β |Β nullΒ 
optional
The URL of the store's Facebook page.
Example:
https://www.facebook.com/abdullahstore
twitter
stringΒ Β |Β nullΒ 
optional
The URL of the store's Twitter profile.
Example:
https://twitter.com/abdullahstore
instagram
stringΒ Β |Β nullΒ 
optional
The URL of the store's Instagram profile.
Example:
https://instagram.com/abdullahstore
snapchat
stringΒ Β |Β nullΒ 
optional
The username of the store's Snapchat account.
Example:
abdullahstore
tiktok
stringΒ Β |Β nullΒ 
optional
The username of the store's TikTok account.
Example:
abdullahstore
business_center
stringΒ Β |Β nullΒ 
optional
The Authentication Number of the Business Platform as provided by the Saudi Business Center (Ψ§Ω„Ω…Ψ±ΩƒΨ² Ψ§Ω„Ψ³ΨΉΩˆΨ―ΩŠ Ω„Ω„Ψ£ΨΉΩ…Ψ§Ω„) which is the new governmental platform for verifying online stores, replacing the previously used Maroof service. For more details, visit Saudi Business Center FAQs.
In the Merchant Dashboard, this value can be found at Settings > Store Information in the text field labeled "Business Center" or "Ω…Ω†Ψ΅Ψ© Ψ§Ω„Ψ£ΨΉΩ…Ψ§Ω„".
Example:
0238004654
maroof
stringΒ Β |Β nullΒ 
deprecated
The URL of the store's Maroof page.
Note: The maroof field deprecated since
Maroof has been replaced by the
Saudi Business Center.
Example:
https://maroof.sa/abdullahstore
website
stringΒ Β |Β nullΒ 
optional
The URL of the store's official website. Null if the store doesn't have an official website apart from the Zid store.
Example:
https://www.abdullahstore.sa
one_signal_keys
array[string]
optional
Array of OneSignal keys used for push notifications.
Example:
[]
sms_campaigns_balance
integerΒ 
optional
The current balance of SMS campaigns.
Example:
100
sms_campaigns_sender_name
objectΒ (StoreSMSSenderName)Β 
optional
The sender name information for SMS campaigns.
acquisition_program
stringΒ Β |Β nullΒ 
optional
Information about the store's customer acquisition program.
Example:
Referral program
registration_discount_code
stringΒ Β |Β nullΒ 
optional
The discount code provided to new users upon registration.
Example:
WELCOME10
industry
objectΒ (StoreIndustry)Β 
optional
Information about the industry that the store belongs to.
category
objectΒ (ProductCategory)Β 
optional
category_other
stringΒ Β |Β nullΒ 
optional
Additional category information, if the store doesn't fit neatly into one category.
Example:
Gourmet Foods
show_store_selected_category_notification
booleanΒ 
optional
If set to true, a notification will be shown when the store category is selected.
Example:
false
malls
array[string]
optional
An array of malls where the store's products are available.
Example:
[]
is_customers_email_mandatory
booleanΒ 
optional
Indicates if customers are required to provide their email during checkout.
Example:
false
customers_login_by_email_status
booleanΒ Β |Β nullΒ 
optional
Indicates if customers can log in using their email. True if enabled, otherwise false.
Example:
true
is_gmaps_and_spl_in_address_enabled
booleanΒ Β |Β nullΒ 
optional
Indicates if Google Maps and SPL are enabled in the address input.
Example:
true
is_gmaps_in_address_enabled
booleanΒ Β |Β nullΒ 
optional
Indicates if Google Maps is enabled in the address input.
Example:
false
is_gmaps_in_address_mandatory
booleanΒ Β |Β nullΒ 
optional
Indicates if providing an address via Google Maps is mandatory.
Example:
false
is_spl_in_address_enabled
booleanΒ Β |Β nullΒ 
optional
Indicates if SPL is enabled in the address input.
Example:
false
is_restock_cancelled_orders_enabled
booleanΒ Β |Β nullΒ 
optional
Indicates if restocking of cancelled orders is enabled.
Example:
true
is_low_stock_label_enabled
booleanΒ Β |Β nullΒ 
optional
Indicates if a label for low stock is enabled.
Example:
false
is_product_reviews_enabled
booleanΒ Β |Β nullΒ 
optional
Indicates if product reviews are enabled.
Example:
false
low_stock_quantity_limit
integerΒ Β |Β nullΒ 
optional
Defines the quantity limit that triggers the low stock label.
Example:
10
is_different_consignee_allowed
booleanΒ Β |Β nullΒ 
optional
Indicates if a different consignee (receiver) is allowed for the orders.
Example:
false
meta_description
stringΒ Β |Β nullΒ 
optional
The meta description for the store's website for SEO.
Example:
Abdullah's store sells a variety of goods ranging from electronics to home appliances.
meta_title
stringΒ Β |Β nullΒ 
optional
The meta title for the store's website for SEO.
Example:
Abdullah's Store - Quality Electronics and Home Appliances
privacy_policy
array[string]Β |Β nullΒ 
optional
The privacy policy details of the store.
Example:
[]
terms_conditions
array[string]Β |Β nullΒ 
optional
The terms and conditions of the store.
Example:
[]
complaints_and_suggestions
array[string]Β |Β nullΒ 
optional
Complaints and suggestions contact details or methods.
Example:
[]
license
array[string]Β |Β nullΒ 
optional
The licensing details for the store.
Example:
[]
refund_exchange_policy
array[string]Β |Β nullΒ 
optional
The refund and exchange policy details of the store.
Example:
[]
is_vat_required_in_subscription
booleanΒ Β |Β nullΒ 
optional
Indicates if Value Added Tax (VAT) is required in the store's subscription.
Example:
true
subscription
objectΒ (StoreSubscription)Β 
optional
The subscription details of the store.
availability
objectΒ (StoreAvailability)Β 
optional
Information about the store's availability or operating status.
created_at
stringΒ 
optional
The timestamp when the store was created.
Example:
2022-12-14 11:35:23
is_mobile_verified
booleanΒ 
optional
Indicates if the mobile number associated with the store is verified.
Example:
true
is_readiness_completed
booleanΒ 
optional
Indicates if the readiness checks for the store are completed.
Example:
true
analytics_dashboard_token
stringΒ 
optional
The token for accessing the store's analytics dashboard.
Example:
9a125104-2b46-4c0b-99bf-71df1178f49d
storefront_theme
stringΒ Β |Β nullΒ 
optional
The theme of the storefront for the store.
Example:
null
is_zidpay_activated
booleanΒ 
optional
Indicates if ZidPay, a payment solution, is activated for the store.
Example:
true
is_zidship_activated
booleanΒ 
optional
Indicates if ZidShip, a shipping solution, is activated for the store.
Example:
false
is_apple_pay_enabled_in_all_browsers
booleanΒ 
optional
Indicates if Apple Pay is enabled for all browsers in the store.
Example:
false
is_buy_as_a_guest_enabled
booleanΒ 
optional
Indicates if the option for customers to buy as a guest is enabled in the store.
Example:
false
system_tags
array[string]
optional
A list of system tags associated with the store.
Example:
["ZAM Partner"]
has_new_shipping_module
booleanΒ 
optional
Indicates if the store has a new shipping module.
Example:
true
has_multi_product_inventory
booleanΒ 
optional
Indicates if the store supports the Multi-Inventory feature.
Example:
true
has_pos
booleanΒ 
optional
Indicates if the store has a point of sale (POS) system.
Example:
false
has_b2b_subscription
booleanΒ 
optional
Indicates if the store has a business-to-business (B2B) subscription.
Example:
true
has_new_themes_only
booleanΒ Β |Β nullΒ 
deprecated
Indicates whether the store exclusively uses and supports the latest theme format, restricting the use of older theme versions. This field is deprecated since the use of old themes has been discontinued, and existing old themes have been migrated to the new theme format.
Example:
null
created_at
stringΒ 
optional
The timestamp when the manager's profile was created, in YYYY-MM-DD HH:MM:SS format.
Example:
2023-05-22 11:35:24
tap_public_key
stringΒ 
optional
The manager's public key in TAP Payments for secure payment processing.
Example:
pk_live_BbpEVT0tZCXrndWqFOQeI5jY
Example
{
  "id": 123456,
  "old_id": 123455,
  "uuid": "a1b2c3f4-5d6e-7f8g-9h10-i11j12k13l14",
  "name": "Abdulaziz Al-Omari",
  "username": "abdulaziz.zid@gmail.com",
  "email": "abdulaziz.zid@gmail.com",
  "is_email_verified": true,
  "mobile": "0551234567",
  "mobile_object": {
    "country_code": "966",
    "mobile": "550427322"
  },
  "gender": "m",
  "intercom_user_hash": "a2f3b38ebe8a6a92d20967986c8b1e31e2926386235c60682a2c5dbb57910712",
  "vloops_ref_code": null,
  "user_profile_data": {
    "birth_date": "1992-08-14",
    "country_id": 114,
    "city_id": 1107,
    "city": {
      "name": "Other",
      "id": 1,
      "national_id": 3,
      "priority": 10,
      "country_id": 184,
      "country_name": "Ψ§Ω„Ψ³ΨΉΩˆΨ―ΩŠΨ©",
      "country_code": "SA",
      "ar_name": "Ψ§Ω„Ψ±ΩŠΨ§ΨΆ",
      "en_name": "Riyadh"
    },
    "country": {
      "id": 184,
      "name": "Ψ§Ω„Ψ³ΨΉΩˆΨ―ΩŠΨ©",
      "code": "SA",
      "country_code": "SAU",
      "flag": "https://media.zid.store/static/sa.svg"
    },
    "is_organization_employee": true,
    "working_organization_name": "Zid Business Solutions",
    "job_title": "Store Manager"
  },
  "business_location": {
    "country": "Saudi Arabia",
    "city": "Riyadh",
    "district": "Al-Olaya",
    "street": "King Fahd Road",
    "building_no": "1010",
    "postal_code": "12214",
    "additional_postal_code": "3765",
    "lat": 24.7136,
    "lng": 46.6753,
    "show_location": false
  },
  "roles": [
    {
      "id": "9b91f2fe-a7c6-4791-8e3d-b6f860f452eb",
      "slug": "store.owner",
      "name": "Store Owner"
    }
  ],
  "permissions": [
    {
      "id": "abcd1234-ef56-gh78-ijkl9012",
      "slug": "manage.products",
      "name": "Manage Products"
    },
    {
      "id": "mnop3456-qr78-st90-uvwx2468",
      "slug": "manage.orders",
      "name": "Manage Orders"
    }
  ],
  "store": {
    "id": 251073,
    "uuid": "4cbeba83-6ded-431b-a1ee-16ebfdbb8924",
    "username": "Abdullah Ahmed's store",
    "title": "Golden Oasis Electronics",
    "phone": "0551234567",
    "mobile_object": {
      "country_code": "966",
      "mobile": "550427322"
    },
    "store_business_data": {
      "civil_id": 123456789,
      "business_place_status": "rented",
      "has_branches": true,
      "branch_no": 3,
      "business_type": "electronics",
      "business_corporate_name": "ElectroHub Corp.",
      "employee_no": 50,
      "email": "info@electrohub.com",
      "commercial_name": "ElectroHub",
      "is_maroof_checked": true,
      "is_freelance_checked": false,
      "maroof_number": 987654
    },
    "commercial_registration_number": "1029384756",
    "commercial_registration_number_activation": true,
    "email": "abdullah.store@zid.sa",
    "url": "https://abdullahstore.zid.store/",
    "ssl": "https://abdullahstore.zid.store/",
    "sitemap_url": "https://abdullahstore.zid.store/sitemap.xml",
    "currency": {
      "id": 4,
      "name": "Ψ±ΩŠΨ§Ω„ سعودي",
      "code": "SAR",
      "symbol": " Ψ±.Ψ³ ",
      "country": {
        "id": 184,
        "name": "Ψ§Ω„Ψ³ΨΉΩˆΨ―ΩŠΨ©",
        "code": "SA",
        "country_code": "SAU",
        "flag": "https://media.zid.store/static/sa.svg"
      }
    },
    "currencies": [
      {
        "id": 4,
        "name": "Ψ±ΩŠΨ§Ω„ سعودي",
        "code": "SAR",
        "symbol": " Ψ±.Ψ³ ",
        "country": {
          "id": 184,
          "name": "Ψ§Ω„Ψ³ΨΉΩˆΨ―ΩŠΨ©",
          "code": "SA",
          "country_code": "SAU",
          "flag": "https://media.zid.store/static/sa.svg"
        }
      }
    ],
    "language": {
      "id": 2,
      "name": "Ψ§Ω„ΨΉΨ±Ψ¨ΩŠΨ©",
      "code": "ar"
    },
    "languages": [
      {
        "id": 2,
        "name": "Ψ§Ω„ΨΉΨ±Ψ¨ΩŠΨ©",
        "code": "ar"
      }
    ],
    "theme": {
      "id": 1,
      "code": "default_theme_code",
      "name": "The Default Theme",
      "main_image": "https://zid-platform.s3-accelerate.amazonaws.com/public/default/themes/default/1.png",
      "description": "The default theme is designed to be generic enough to get you started and to serve the purpose of most stores. It also acts as a skeleton for further customization.",
      "images": [
        "https://zid-platform.s3-accelerate.amazonaws.com/public/default/themes/unique_theme_code/1.png",
        "https://zid-platform.s3-accelerate.amazonaws.com/public/default/themes/unique_theme_code/2.png",
        "https://zid-platform.s3-accelerate.amazonaws.com/public/default/themes/unique_theme_code/3.png"
      ]
    },
    "logo": "https://media.zid.store/abdullahstore/logo.png",
    "logos": [],
    "cover": "https://media.zid.store/abdullahstore/cover.jpg",
    "icon": "https://media.zid.store/abdullahstore/icon.png",
    "maintenance_mode": false,
    "has_new_products_service": true,
    "facebook": "https://www.facebook.com/abdullahstore",
    "twitter": "https://twitter.com/abdullahstore",
    "instagram": "https://instagram.com/abdullahstore",
    "snapchat": "abdullahstore",
    "tiktok": "abdullahstore",
    "business_center": "0238004654",
    "maroof": "https://maroof.sa/abdullahstore",
    "website": "https://www.abdullahstore.sa",
    "one_signal_keys": [],
    "sms_campaigns_balance": 100,
    "sms_campaigns_sender_name": {
      "sender_name": "Abdullah's Store",
      "status": "active"
    },
    "acquisition_program": "Referral program",
    "registration_discount_code": "WELCOME10",
    "industry": {
      "id": 10,
      "name": "Foods",
      "slug": "foods",
      "display_order": 1
    },
    "category": {
      "id": 875210,
      "name": "Sport Shoes",
      "slug": "sport-shoes",
      "SEO_category_title": "Sport Shoes - Run with Comfort",
      "SEO_category_description": "Our selection of sport shoes offers the best in comfort and performance for your athletic needs.",
      "names": {
        "en": "Sport Shoes",
        "ar": "أحذية رياآية"
      },
      "description": {
        "en": "Featuring a range of sport shoes for every sport from running to football.",
        "ar": "Ω…Ψ¬Ω…ΩˆΨΉΨ© Ω…ΨͺΩ†ΩˆΨΉΨ© Ω…Ω† Ψ§Ω„Ψ£Ψ­Ψ°ΩŠΨ© Ψ§Ω„Ψ±ΩŠΨ§ΨΆΩŠΨ© Ω„ΩƒΩ„ Ψ§Ω„Ψ±ΩŠΨ§ΨΆΨ§Ψͺ Ω…Ω† Ψ§Ω„Ψ¬Ψ±ΩŠ Ψ₯Ω„Ω‰ ΩƒΨ±Ψ© Ψ§Ω„Ω‚Ψ―Ω…."
      },
      "url": "https://example.zid.store/categories/875210/sport-shoes",
      "image": "https://media.zid.store/example-store/75decdde-4e94-45fe-8eb1-1edf4ead3ff0-260x260.png",
      "image_full_size": "https://media.zid.store/example-store/75decdde-4e94-45fe-8eb1-1edf4ead3ff0.png",
      "img_alt_text": "Sport shoes collection",
      "cover_image": "https://media.zid.store/example-store/94b62e84-4ee3-4bfb-9833-6de53e2b8e1a.png",
      "image_full": "https://media.zid.store/example-store/75decdde-4e94-45fe-8eb1-1edf4ead3ff0.png",
      "products_count": 120,
      "sub_categories": [
        {}
      ],
      "parent_id": null,
      "flat_name": "Sport Shoes",
      "is_published": true
    },
    "category_other": "Gourmet Foods",
    "show_store_selected_category_notification": false,
    "malls": [],
    "is_customers_email_mandatory": false,
    "customers_login_by_email_status": true,
    "is_gmaps_and_spl_in_address_enabled": true,
    "is_gmaps_in_address_enabled": false,
    "is_gmaps_in_address_mandatory": false,
    "is_spl_in_address_enabled": false,
    "is_restock_cancelled_orders_enabled": true,
    "is_low_stock_label_enabled": false,
    "is_product_reviews_enabled": false,
    "low_stock_quantity_limit": 10,
    "is_different_consignee_allowed": false,
    "meta_description": "Abdullah's store sells a variety of goods ranging from electronics to home appliances.",
    "meta_title": "Abdullah's Store - Quality Electronics and Home Appliances",
    "privacy_policy": [],
    "terms_conditions": [],
    "complaints_and_suggestions": [],
    "license": [],
    "refund_exchange_policy": [],
    "is_vat_required_in_subscription": true,
    "subscription": {
      "id": "c122e13b-c627-4b43-a6cf-1ab5e8f0cc8c",
      "cycle_id": "33365cf5-1a16-4892-9cdc-426ed8d9370c",
      "is_warning": false,
      "is_suspended": false,
      "is_expired": false,
      "is_lifetime": true,
      "expired_at": "2023-04-20T00:00:00+00:00",
      "subscribed_at": "2023-04-20T00:00:00+00:00",
      "suspension_start_date": "2023-04-20T00:00:00+00:00",
      "original_fractional_balance": 0,
      "message": null,
      "package_code": "professional.lifetime",
      "package_key": "professional",
      "package_variant": "lifetime",
      "package_name": {
        "ar": "Ψ§Ω„Ψ§Ψ­Ψͺرافية",
        "en": "Professional"
      },
      "full_package_name": {
        "ar": "Ψ§Ω„Ψ§Ψ­Ψͺرافية",
        "en": "Professional"
      },
      "policies": {},
      "status": "ong",
      "is_trial": false,
      "recurring": true,
      "remaining_cycle": {
        "years": 0,
        "months": 1,
        "days": 5
      },
      "deprecated_keys": [
        "is_expired"
      ]
    },
    "availability": {
      "is_store_closed": false,
      "closing_type": null,
      "closing_time_type": null,
      "closed_now": false,
      "activating_data": null,
      "closing_data": null,
      "notify_customer": false,
      "is_time_counter_displayed": null,
      "is_available_hours_visible": null,
      "title": [],
      "message": [],
      "times": []
    },
    "created_at": "2022-12-14 11:35:23",
    "is_mobile_verified": true,
    "is_readiness_completed": true,
    "analytics_dashboard_token": "9a125104-2b46-4c0b-99bf-71df1178f49d",
    "storefront_theme": null,
    "is_zidpay_activated": true,
    "is_zidship_activated": false,
    "is_apple_pay_enabled_in_all_browsers": false,
    "is_buy_as_a_guest_enabled": false,
    "system_tags": [
      "ZAM Partner"
    ],
    "has_new_shipping_module": true,
    "has_multi_product_inventory": true,
    "has_pos": false,
    "has_b2b_subscription": true,
    "has_new_themes_only": null
  },
  "created_at": "2023-05-22 11:35:24",
  "tap_public_key": "pk_live_BbpEVT0tZCXrndWqFOQeI5jY"
}
🟠401Unauthorized
Modified atΒ 2025-02-04 05:37:35
Previous
πŸ“„ User Roles and Permissions
Next
Get VAT Settings
Built with