VODO ERP
  1. Category
VODO ERP
  • Accounts Module
    • Authentication
      • Register
        • Step 1
        • Step 2
        • Step 3
        • Step 4
      • Login
      • reset-password
      • forgot-password
      • logout
      • confirm_old_password
    • Permessions
      • user_permissions
      • user_permession_by_key_value
    • User
      • Profile
        • Show
        • Update
      • Show All Businessess of User
      • retrive-auth
    • Jobs
      • all_jobs
      • Jobs
      • one_job
      • new_job
      • delete_job
      • update_job
    • Business
      • Inventory Audit Process
        • Email
        • Verification
      • Email
        • Email To The Main Business
        • Email From Employee To Other Employees
      • Update
      • Update Expiration Date
      • Create Business
      • Show Business
      • Business With Ids
      • Show Business V2
      • business_details
    • Branches
      • Version 2
        • Show
      • reservation_branches
      • all branches by ids of branches
      • add_company_branch
      • All
      • Show
      • update_branch
    • Activities
      • All
    • Standard Catlog
      • Standard Products
        • All Standard Products
        • Category Of Product
        • one_product
      • categories
        • categories_list
    • Agents
      • Businesses Of Agent
    • Employees
      • All Employees
      • add_business_employee
      • business_employee_update
      • business_employee_show
      • business_employees
    • Payslips
      • get_payslip_status
      • get_payslip_status_by_role
      • payslip_items
    • get_user_from_token
    • get_cash_account
    • Notification Send Using Firebase
    • add_log
    • user_company
    • business_users
    • all_companies
    • Suppliers And Customers
    • New Request
    • add_store_keeper
    • currencies_list
    • get_one_customer
    • show_multi_jobs
    • one_service
    • get_cash_account
    • user_sub_modules
    • employee_password_update
  • Ecommerce Module
    • Catalog
      • Brands
        • All Brands
        • Add Brand
        • One Brand
        • Edit Brand
      • Category
        • All Categories
          GET
        • Add Category
          POST
        • One Category
          GET
        • Edit Category
          POST
      • Product
        • All Products
        • Add Product
        • Get Product Names By Ids
        • Get Product Name By Id
        • One Product
        • Edit Product
        • Delete Product Image
        • Delete Product Group
        • Display Product Type
        • Display Product Kind
        • Display Products By Ids
        • Get Product Type
        • Product Rating
        • Business Products
    • Product Prices
      • All Product Prices
      • All Number Product Prices
      • One Product Prices
      • One Product With Prices
      • Add Product Price
      • Add Product Main Price
      • Edit Product Main Price
      • Edit Product Price
      • Delete Product Build
      • Edit Product Main Price
      • Add Product Price Group
      • Product Price Groups
      • Edit Product Price Group
      • Check If Catalog Has Price
    • Units
      • Custom Units
        • Custom Units
        • Add Unit
        • Edit Unit
      • All Units
      • Default Units
      • One Unit
      • Product Child Units By Product Id
      • Child Units By Ids
      • Display Child Units Taken For The Product
      • Weight Height Unit Children
      • One Unit Child
    • Orders
      • Save Abandoned Order
      • Save Or Update to Abandoned Order
      • Change Abandoned Order Status
      • Change Payment Method And Status In Order
      • Change Item Qty Or Remove
      • Display Abandoned Order
      • Display Total Price Of The Order
      • Display User Order List
      • Display User Orders List V2
      • All Orders
      • All Orders Daily
      • Order Details
      • Unpaid Order List
      • Create New Order
      • Display One Order With Details If No sales_order_id
      • Update reservation_id In Order
      • Order Shipping Methods
      • Order Payment Methods
      • Order Status
      • Order Payment Status
      • Order Shipping Status
      • Post Or Update Order Fields
      • Add Items To Order
      • Edit Order Item Fields
      • Delete Order Item
      • Update Order And Item
      • Update Order Item Delivery Note
      • Update Payment Status
      • Create New Order V2
      • Update employee_id In Order
      • Check Order And Item
      • Update Order Status V2
      • Cancel Reservation And Employee In Order Item
      • Update Order Invoice Id
      • Get Order Status
    • Standard Products
      • All Standard Products
      • Import Standard Products
    • LFM
      • List Of Folders And Images
      • Create New Folder
      • Upload New Image
      • Move Image Or Folder
      • Rename Image Or Folder
      • Delete Image Or Folder
    • Reviews
      • All Reviews
      • Add Review
      • One Review
      • Edit Review
      • Delete Review
    • Barcodes
      • All Barcodes
      • Add Barcode
      • Edit Barcode
      • Display Product Details By Barcode
      • One Barcode Data
      • Delete Barcode
    • Attributes
      • All Attributes
      • Add Attributes
      • One Attribute
      • Edit Attribute
      • One Attribute Description
      • Change Attribute Status
      • Change Attribute Decription Status
      • Business Have Atrribute?
      • Display Child Units Taken For The Product
    • Distenations
      • Countries
        • All Countries
        • Add Country
        • One Country
        • Edit Country
      • States
        • All States
        • Add State
        • One State
        • Edit State
      • Cities
        • All Cities
        • Add City
        • One City
        • Edit City
      • Districts
        • All District
        • Add District
        • One District
        • Edit District
      • All Districts
      • All Countries
      • One District
      • All Cities
      • All Mosques
    • Inventory And Showroom
      • Inventories
        • All Inventories
        • Add New Inventory
        • Edit Inventory
        • All Inventory Item
        • Add New Inventory Item
        • Add New Inventory Trancfered Item
      • Inventories_v2
        • Inventories List
        • Add Inventory Item
        • Inventory Item List
        • Transfer Orders
        • Add Trancfered Order
        • Transfer Order And Items
        • Inventory Requests List
        • Inventory Transfers Transactions
        • One Transfers Transaction
        • Save Transfers Transaction
        • Available_Items
        • New Inventory Transfers
        • Transaction Items
        • Save Transaction Items
        • Inventory Item List_111
        • validate Inventory Or POS Session
      • Inventory Category
        • All Inventory Categories
        • Add Inventory Category
        • One Inventory Category
        • Edit Inventory Category
      • Showroom
        • Showroom List
        • Add New Showroom
        • Edit Showroom
        • All User Pos Sessions
        • Last POS Session
        • POSProductsList
        • POSProductsList V2
        • Add Pos Session Log
        • session_details
      • Showroom Category
        • All Showroom Categories
        • Add Showroom Category
        • One Showroom Category
        • Edit Showroom Category
    • Audit Sessions
      • Audit Session Items
        • All Audit Session Items
        • Add New Audit Item
        • Add New Audit Item
      • All Audit Sessions
      • Add New Audit Session
      • One Audit Session
      • Edit Audit Session
      • End Audit Session
    • Venues
      • Venues
        • All Venues
        • Active Venues
        • Add Venue
        • One Venue
        • Edit Venue
      • Venue Category
        • All Categories
        • Add Category
        • One Category
        • Edit Category
      • Tickets
        • All Tickets
        • Generate Ticket
        • One Ticket
    • Discounts
      • All Discounts
      • Add Discount
      • One Discount
      • Edit Discount
      • Apply Discount
    • Locations
      • All Locations
      • Add Location
      • One Location
      • Edit Location
    • Favourites
      • All Favourites
      • Add Or Remove Catalog From Favorites Copy
    • Galleries
      • All Galleries
      • Add Galleries
      • One Gallery
      • Edit Galleries
    • Banner
      • All Banners
      • Add Banner
      • One Banner
      • Edit Banner
    • News
      • All News
      • Add News
      • One News
      • Edit News
    • Pages
      • All Pages
      • Add Pages
      • One Page
      • Edit Pages
    • Catalog Comments
      • All Catalog Comments
      • Add Catalog Comment
      • One Catalog Comment
      • Edit Catalog Comment
      • Delete Catalog Comment
    • Artist
      • All Artist
      • Add Artist
      • One Artist
      • Edit Artist
  • HR Module
    • employees
      • employees
      • employee
      • employee By User Id
      • select employee
      • employees_have_same_skill
      • array_of_employees_have_same_skill
      • employees/reduce
      • trashed employees
      • POST/ add employee
      • employee_bulk
      • update_employee
      • delete employee
      • get user profile
      • get Reservation Count
      • get Trainer Employees
      • update Occupation Id
      • update Main Profile
      • employees Have Service Skills
      • employee Fingerprint Locations
      • employees bulk Activation
      • Add Accounts User
    • skills
      • GET/ skils
      • GET/ skill
      • POST/ add skill
      • PUT/ skill
      • DELETE/ skill
    • administration
      • GET/ administration
      • administration - trashed
      • POST/ administration
      • PUT/ administration
      • DELETE/ administration
      • restor Administration
    • sections
      • GET/ sections
      • GET/ section by id
      • sections_by_administration
      • POST/ add section
      • PUT/ section
      • delete - section
    • employee - vacation
      • GET/ vacations
      • POST/ vacation
      • PUT/ vacation
      • DELETE/ vacation
    • residence-status
      • residences
      • residences
      • residences Copy
      • residences
    • contracts
      • all contracts
      • show contract
      • business - all contracts
      • Contract Media
      • create contract
      • edit contract
    • departments
      • GET/ department
      • POST/ add department
      • PUT/ department
      • DELETE/ department
    • payslips
      • payslips
      • get payslip
      • employee_payslips
      • payslips - trashed
      • add payslips
      • restore - payslip
      • update
      • delete - payslip item
      • delete - payslip
      • get Scheduled Approved Payslips
      • edit Payslip Status
      • bulk Update Payslips Status
      • check in_review payslip status
    • settings
      • update settings
      • get Business Settings
    • setting - payrole
      • all payroles
      • settings - payroles - infractions
      • active_infractions
      • update setting - payrole
      • delete Payrol
      • settings - payroles - repetition
    • settings - schedule tiems
      • scheduletiems
      • insert - update schedule times
      • schedule times
    • settings - vacations
      • vacations
      • vacation
      • vacation
    • employee - measure
      • measures
      • measures
      • update measures
      • update Measure Status
      • delete measures
    • employee - measure - status
      • measures - status
      • add - measures - status
      • update measures - status
      • delete measures - status
    • penalties
      • GET/ penalties
      • POST/ penalte
      • DELETE/ penalte
    • loan
      • all loans
      • one Loan
      • add - loan
      • update Loan
      • loan
    • employees v2
      • employees
      • employee
      • employees/reduce
      • add employee
      • update
      • delete employee
    • payslip v2
      • payslips
      • payslip
      • update
    • will delete
      • skills type
        • GET/ skils typs
        • POST/ add skill type
        • PUT/ skill type
        • DELETE/ skill
      • Currencies
        • GET/ currencies
        • GET/ currencie
        • POST/ add currencies
        • POST/ edit currencie
        • DELETE/ delete currencie
      • nationalities
        • GET/ nationalities
        • GET/ nationalitie
        • POST/ add nationalitie
        • POST/ edit nationalitie
        • DELETE/ delete nationalitie
      • occupations
        • GET/ occupations
        • GET/ occupation
        • POST/ occupation
        • PUT/ occupation
        • DELETE/ occupation
      • companies
        • GET/ companies
        • GET/ company
        • POST/ company
        • PUT/ company
        • DELETE/ company
      • employers
        • GET/ employers
        • GET/ employer
        • POST/ employer
        • PUT/ employer
        • DELETE/ employer
      • activations
        • GET/ activations
        • get activation
        • POST/ add activations
        • PUT/ edit activations
        • DELETE/ delete activations
    • settings-infractions
      • all infractions
      • infraction repetitions
      • update setting infraction
      • active_infractions
    • Agreements
      • all agreements
      • get one agreement
      • add agreement
      • update agreement
      • update agreement status
      • available Employees To Work
    • Settings agreement status
      • all agreements status
      • add agreement status
      • update agreement status
      • delete agreement status
    • Settings agreement invoices status
      • all agreements status
      • add agreement status
      • update agreement status
      • delete agreement status
    • Entry and Exit
      • get all
      • employee Day Activity
      • employee Attendance Summary
      • export excel
      • employee finger print
    • Logs
      • get all
      • get one
    • Requests
      • All Requests
      • get Employee Requests
      • add New Request
      • update Request Status
    • Audits
      • All Audits
    • GET/business_id
    • test
  • Calendar Module
    • Calendars
      • new_calendar
      • add_new_calendars
      • update_calendars
      • show Calendars With Working hours
      • time_zone_list
      • calendars_list
      • edit_calendar
      • delete_calendar
      • show_calendar
      • all_business_calendars_list
      • all_calendars_list[my-other-standard]
    • Calendar Working Hours
      • show_working_hours
      • add_work_hours
      • edit_work_hours
      • all_week_days
      • calendar_working_hours
    • Calendar Vacations
      • calendar_vacation
      • add_Vacation
      • edit_vacation
      • show_vacation
      • get_week_vacation_days
    • Calendar Break
      • new_break
      • all_breaks
      • one_break
      • update_break
      • delete_break
    • Calendar Tours
      • add New Tour
      • update Tour
      • get Customer Categories Tours
      • get Tour Customer Categories Ids
      • get Tour Categories Ids
      • get Audience Statistics
      • get Category Type Statistics
      • get Attendance Statistics
      • get Array Of Tours Id
      • get Tours Reservations
      • get Customer Category Venue Id
    • Attendances
      • get Attendances
      • get One Attendance
      • get Customer Attendances
      • get Customer Bookings
      • get Customer Booked Bookings
      • get Tout Category Customer Ids
      • add New Attendance
      • update Attendance
      • update Multi Attendances
      • change Customer Tour Status
      • auto Mark Not Attended Tours
      • decrypt QR
      • show QR Code
      • get Attendances Dates and times
      • get Attendances Times By Dates
      • get Categories Attendance By Tour Copy
      • delete Attendance Item
    • Events
      • add_event
      • all_calendar_events
      • edit_event
      • show_event
      • destroy_event
      • get_employee_times
      • get_available_employee_times
      • get_all_user_calendars_events
      • drag Drop Update Event
      • get Employees Events
      • get Employee Slots
      • get Employee Today And Tomorrow Slots
      • get Slot Details
    • Services
      • services_list
      • service_details
      • service_employees
      • add_service
    • Default Calendar
      • add_default_calendar
      • get_default_calendar
    • Reservtions
      • reservation_status_list
      • chang_reservation_status
      • update Reservations Status
      • employee_reservations_count
      • Employees_reservation_num
      • get_reservations_daily
      • get_reservations_monthly_yearly
      • get One Reservation
      • get Today-Tomorrow Reservations
      • add Delivery Note Id
      • update service ecomm_id
      • get Reservations By Order Id
    • BI
      • get Tables
      • get Table Columns
    • Customers
    • company_branches
    • business_employees
    • get available_specialists
    • get pos_available_specialists
  • Accounting Module
    • payslips
      • approve_payslip
    • business_v4
      • update_business
    • Production Orders
      • Average cost
      • store-production-acc-total
    • Divisions
      • divisions_list
      • get_division
    • Gateways
      • Telr
        • checkout
    • Branches
      • create_branch
      • nearest_customers
    • Countries
    • Add invoice
      • income_accounts_list
      • add_invoice
      • get_customers_list
    • Employees_invoice_paymanet
      • Apis_v4
        • customers
          • Get_Customers
          • Get_customer_invoices_list
          • Get_customer_wallet_list
          • Get_customer_receivable_list
          • add_one_customer
          • update_one_customer
          • show_one_customer
        • customers_categories
          • Get_customers_categories
          • add_one_customers_category
          • show_one_customers_category
          • update_one_customers_category
        • customers_branches
          • get_customers_branches
          • get__one_customer_branch
          • add_one_customer_branch
          • update_one_customer_branch
      • add_new_payment
      • bank_cash_list
      • AllCurrencies
    • Payslip items
      • ItemsList
      • add_item
      • edit_item
      • delete_item
      • get by id
      • add_invoice Copy
    • Authentication
      • Redirect Auth
      • Show User By Token
    • Accounts Totals
      • All Accounts Totals
    • Journal Totals
      • All Journals
      • daily_year_month
    • Account logs
      • Create Log
      • Create Log Copy
    • Modules
      • All Modules
      • Show Module
      • Sub Sub Modules
    • Taxes
      • Show Tax
      • All Taxes
      • get_one_tax
    • Inventory items
      • all inventory items
    • Cash And Bank Accounts
      • All Cash And Banks Accounts
      • Add Account
      • Get Cash Account
    • Customers And Suppliers
      • Authentication
        • v4
          • update_one_customer
          • get_customer_from_token
          • reset_password
          • add_one_customer
        • v3
          • add_one_customer
          • customer_login
          • reset_password
          • forgot_password
          • send_otp
          • confirm_otp
          • send_email_otp
          • confirm_email_otp
          • reset_password_by_mail
          • forgot_password_by_mail
          • phone_exist
          • add_pos_customer
      • Home
        • GetCustomer/Supplier Wallet total
        • Get_Customers
        • Get_customer_invoices_list
        • Get_customer_wallet_list
        • Get_customer_receivable_list
        • show_one_customer
        • show_one_customer_by_id
        • show_multi_customers_by_id
        • get_customer_by_phone
      • Charts
        • Charts Suppliers And Customers
        • Charts Count Suppliers And Customers Copy
      • Categories
        • Get_customers_categories
        • add_one_customers_category
        • show_one_customers_category
        • update_one_customers_category
      • Branches
        • get_customers_branches
        • get__one_customer_branch
        • add_one_customer_branch
        • update_one_customer_branch
    • Payments Recipts
      • All Payments Receipts
      • Create Payment Receipt
      • Create Payment Receipt Ecommerce
      • New Payment Checkout
      • Create Advance Receipt
    • Accounts
      • All Accounts
    • Journal entries
      • Create Journal
      • All Journal Entries
    • Inventory Locations
      • All Inventory Locations
      • Inventory Location from driver
    • Good Receipts
      • Create Good Receipts
    • Delivery Notes
      • All Delivery Notes
      • Create delivery note
    • Purchase invoices
      • All Purchase Invoices
    • Sales invoices
      • v4
        • Sales invoices
          • All Sales Invoices
          • AddOneInvoice
          • ShowOneInvoice
      • Add POS Invoice
      • All Sales Invoices
      • Customer Invoices
      • Create Invoice
      • Create Invoice For VODO APP
    • Special Accounts
      • Special Accounts
    • Capital Accounts
      • All Capital Accounts
    • Fixed Assets
      • All Fixed Assets
    • Businesses
      • Show business
      • All Business
      • Show business secure
    • Accounting_APIs_v4
      • Sales invoices
        • All Sales Invoices
        • AddOneInvoice
        • ShowOneInvoice
      • SalesQuotes
        • GetSalesQuotes
        • AddOneSalesQuote
        • ShowOneSalesQuote
        • UpdateOneSalesQuote
        • DeleteOneSalesQuote
      • SalesQuotes Copy
        • GetSalesQuotes
        • AddOneSalesQuote
        • ShowOneSalesQuote
        • UpdateOneSalesQuote
        • DeleteOneSalesQuote
      • SalesOrders
        • Get_Sales_orders
        • Add_one_Sales_order
        • Show_one_Sales_order
        • Update_one_Sales_order
        • Deleate_one_Sales_order
        • add_update_order_due
      • CustomersAPis
        • customers
          • customers Copy
            • Get_Customers
            • Get_customer_invoices_list
            • Get_customer_wallet_list
            • Get_customer_receivable_list
            • add_one_customer
            • update_one_customer
            • show_one_customer
            • show_one_customer_by_id
            • update_customer_phone
            • show_multi_customers_by_id
            • get_customer_by_phone
          • Get_Customers
          • Get_customer_invoices_list
          • Get_customer_wallet_list
          • Get_customer_receivable_list
          • add_one_customer
          • update_one_customer
          • show_one_customer
          • show_one_customer_by_id
          • update_customer_phone
          • show_multi_customers_by_id
          • get_customer_by_phone
        • customers_branches
          • get_customers_branches
          • get__one_customer_branch
          • add_one_customer_branch
          • update_one_customer_branch
      • Currencies
        • GetAllCurrencies
        • Get_currency_with_exchage
        • Get_base_currency
      • BankCashAccounts
        • get_acutal_balance
      • Refund
        • refund_invoice
        • All Refund Sales Invoices
        • Refund Sales Invoices Items
    • v5
      • Customers Or Suppliers
        • Categories
          • Create Category
          • All Categories
          • Update Category
          • Delete Category
        • Branches
          • All Branches
          • Create Branch
          • Update Branch
          • Show Branch
          • Delete Branch
        • Create Customer Or Supplier
        • Get All Customers Or Suppliers
        • Update Customer Or Supplier
        • Show Customer Or Supplier
        • Show Accounts Receivable
        • Show Wallet Transactions
      • Bank And Cash Accounts
        • Get All Cash And Bank Accounts
        • Create Cash Or Bank Account
        • Update Cash Or Bank Account
        • Show Cash Or Bank Account
      • Inter Account Transfers
        • Update Transfer
        • Get All Inter Account Transfers
        • Create Transfer
        • Show Transfer
      • Payment And Receipt
        • Update Payment Or Receipt
        • All Payment Or Receipt
        • Show Payment Or Receipt
        • Delete Payment Or Receipt
        • Create Payment Or Receipt
      • Sales Invoices
        • Update Invoice
        • All Sales Invoices
        • Show invoice
        • Create Invoice
      • Chart Accounts
        • Get All Chart Accounts
      • Currency
        • Add Currency To The Business
        • Get All Currencies Symbols
        • Get All Foreign Currencies
    • Send Mails
    • get_customer_cat_by_id
    • check_business_tax_required
  • CRM Module
    • Support Tickets
      • All Support Tickets
      • Add Support Ticket
      • One Ticket
      • Edit Support Ticket
      • Reply To Support Ticket
      • Download Ticket Attachment
    • Whatsapp Integration
      • Send Message
      • Send Template Message
  • Managment Module
    • WorkSpaces
      • Boards
        • get Boards
        • get Board
        • add Board
        • update Board
        • Archive Board
        • Delete Board
      • Attachments
        • Get Attachments
        • Get Attachment
        • add Attachment
        • Delete Attachment
      • Projects
        • Get Projects
        • Get Project
        • Add Project
        • Update Project
        • Delete Project
      • Tasks
        • Get Tasks
        • Get Task
        • Add New Task
        • Update Task
        • Delete Task
        • Force Delete Task
        • Assign Users To Task
      • get WorkSpaces
      • get Workspace
      • add Workspace
      • update Workspace
      • delete Workspace
      • Add Team To Workspace
  1. Category

All Categories

Testing Env
https://www.testecommerce.vodoerp.com
Testing Env
https://www.testecommerce.vodoerp.com
GET
/{{categories}}
Last modified:2025-04-14 11:55:56
Description: Retrieves a list of product categories with optional filters for pagination, search, and product inclusion. Supports sorting and filtering by status, product types, and mobile visibility. Authentication headers (apikey, secure-business-key, apiconnection) are required. Fetch a list of categories with optional product data and filters.
Headers
KeyValueDescriptionType
apikey5f28583f26a1aAPI key for authentication; contact support to obtain. Requiredstring
langarLanguage preference: ar for Arabic, en for English.string
apiconnectionappmobileConnection type; contact support to obtain. Requiredstring
secure-business-key140356399db2b2c32f0.25237063Business-specific key; contact support for valid values. Requiredstring
Query Parameters
KeyValueDescriptionType
page3Page number for pagination.string
keywordCategory Name ESearch by category name or keyword.string
viewlistShow all data without pagination if set to list.string
sort_ordertitle__ascSort by: id__desc, id__asc, title__desc, etc.string
per_page10Number of categories per page.string
status0Filter by category status (0 or 1).string
has_product_ids22367,709,708,701Show categories containing these product IDs.string
list_category_titles_and_ids(empty)Display only category titles and IDs.string
category_ids78,6Filter by specific category IDs. (Get from api request {{APP_URL}}/api/v1/ecomm_categories)string
catalog_typeservice,purchasesFilter by catalog type.string
get_products(empty)Include products within each category with pagination.string
product_per_page10Number of products per page.string
product_page_392Navigate product pages for category ID 39.string
product_page_373Navigate product pages for category ID 37.string
not_emptyyesShow only categories with products.string
has_no_service_productsyesShow categories without service-type products.string
product_show_in_mobile1Show categories with mobile-visible products.string
has_product_typeservice,manufacturingShow categories with these product types.string
not_has_product_typeserviceExclude categories with these product types.string
product_status0Filter by product status (0 or 1).string

Response#

The response will include a JSON object with the following structure:
{
    "status": true,
    "message": "",
    "data": {
        "current_page": 0,
        "data": [
            {
                "id": 0,
                "parent": "",
                "sort": 0,
                "top": 0,
                "status": 0,
                "type": "",
                "image": "",
                "title": "",
                "descriptions": [
                    {
                        "title": ""
                    }
                ],
                "products": {
                    "current_page": 0,
                    "data": [],
                    "first_page_url": "",
                    "from": null,
                    "last_page": 0,
                    "last_page_url": "",
                    "links": [
                        {
                            "url": null,
                            "label": "",
                            "active": true
                        }
                    ],
                    "next_page_url": null,
                    "path": "",
                    "per_page": 0,
                    "prev_page_url": null,
                    "to": null,
                    "total": 0
                }
            }
        ],
        "first_page_url": "",
        "from": 0,
        "last_page": 0,
        "last_page_url": "",
        "links": [
            {
                "url": null,
                "label": "",
                "active": true
            }
        ],
        "next_page_url": null,
        "path": "",
        "per_page": 0,
        "prev_page_url": null,
        "to": 0,
        "total": 0
    }
}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://www.testecommerce.vodoerp.com/{{categories}}?page=3&keyword=Category Name E&view=list&sort_order=title__asc&per_page=10&status=0&has_product_ids=22367,709,708,701&list_category_titles_and_ids=&category_ids=78,6&catalog_type=service,purchases&get_products=&product_per_page=10&product_page_39=2&product_page_37=3&not_empty=yes&has_no_service_products=yes&product_show_in_mobile=1&has_product_type=service,manufacturing&not_has_product_type=service&product_status=0' \
--header 'apikey: 5f28583f26a1a' \
--header 'lang: ar' \
--header 'apiconnection: appmobile' \
--header 'secure-business-key: 140356399db2b2c32f0.25237063' \
--header 'Content-Type: application/json' \
--data-raw '{}'
Response Response Example
{
    "status": true,
    "message": "Categories Data",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 78,
                "parent": "",
                "sort": 0,
                "top": 1,
                "status": 1,
                "type": "Custom",
                "image": "https://ecommerce.vodoglobal.com/data/47/category/1606468643181.jpg",
                "title": "تصينع",
                "descriptions": [
                    {
                        "title": "تصينع"
                    }
                ],
                "products": {
                    "current_page": 1,
                    "data": [],
                    "first_page_url": "http://localhost:8000/api/v1/ecomm_categories?product_page_78=1",
                    "from": null,
                    "last_page": 1,
                    "last_page_url": "http://localhost:8000/api/v1/ecomm_categories?product_page_78=1",
                    "links": [
                        {
                            "url": null,
                            "label": "« Previous",
                            "active": false
                        },
                        {
                            "url": "http://localhost:8000/api/v1/ecomm_categories?product_page_78=1",
                            "label": "1",
                            "active": true
                        },
                        {
                            "url": null,
                            "label": "Next »",
                            "active": false
                        }
                    ],
                    "next_page_url": null,
                    "path": "http://localhost:8000/api/v1/ecomm_categories",
                    "per_page": 10,
                    "prev_page_url": null,
                    "to": null,
                    "total": 0
                }
            }
        ],
        "first_page_url": "http://localhost:8000/api/v1/ecomm_categories?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://localhost:8000/api/v1/ecomm_categories?page=1",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://localhost:8000/api/v1/ecomm_categories?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "http://localhost:8000/api/v1/ecomm_categories",
        "per_page": 10,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
}

Request

Query Params
page
string 
optional
The page number you want to go to
Example:
3
keyword
string 
optional
Search by keyword
Example:
Category Name E
view
string 
optional
Show all data without pagination
Example:
list
sort_order
string 
optional
Sort data by:
'id__desc',
'id__asc',
'title__desc',
'title__asc',
'sort__desc',
'sort__asc',
'parent__desc',
'parent__asc',
'status__desc',
'status__asc'
Example:
title__asc
per_page
string 
optional
Display the required number on one page
Example:
10
status
string 
optional
Search by category keyword
Example:
0
has_product_ids
string 
optional
Show the categories in which these catalogs are located
Example:
22367,709,708,701
list_category_titles_and_ids
string 
optional
Display only category titles and IDs
category_ids
string 
optional
Search by category ids
Example:
78,6
catalog_type
string 
optional
Search by catalog type
Example:
service,purchases
get_products
string 
required
Display catalogs within each category with pagination
product_per_page
string 
optional
Number of catalogs displayed on one page
Example:
10
product_page_39
string 
optional
Navigate catalog pages by category
Example:
2
product_page_37
string 
optional
Navigate catalog pages by category
Example:
3
not_empty
string 
required
Show only categories that have catalogs.
Example:
yes
has_no_service_products
string 
optional
Display categories that contain catalog types other than the service type.
Example:
yes
product_show_in_mobile
string 
required
Display the categories and catalogs that are activated for display in online stores or not.
Example:
1
has_product_type
string 
required
Show categories that contain these types of catalog
Example:
service,manufacturing
not_has_product_type
string 
optional
Show categories that do not have these types of catalog
Example:
service
product_status
string 
required
Display the categories and catalogs that are activated or not.
Example:
0
Header Params
apikey
string 
required
You must contact support to get the apikey.
Example:
5f28583f26a1a
lang
string 
required
ar => Arabic or en => English
Example:
ar
apiconnection
string 
required
You must contact support to get the apiconnection.
Example:
appmobile
secure-business-key
string 
required
You must contact support to get the secure-business-key like: 4765066450c0bd66325.48403130
728106399db2b289783.89154521
2680667168f2f8a68f6.12561200
140356399db2b2c32f0.25237063
96701678e330f31f768.22400604
14807664478836358b0.31329842
Example:
140356399db2b2c32f0.25237063
Body Params application/json
object {0}
Examples

Responses

🟢200All Categories
application/json
Body
status
boolean 
required
message
string 
required
data
object 
required
current_page
integer 
required
data
array [object {10}] 
required
first_page_url
string 
required
from
integer 
required
last_page
integer 
required
last_page_url
string 
required
links
array [object {3}] 
required
next_page_url
null 
required
path
string 
required
per_page
integer 
required
prev_page_url
null 
required
to
integer 
required
total
integer 
required
Previous
Edit Brand
Next
Add Category
Built with