EcomPulse REST API
  1. Products
EcomPulse REST API
  • Admin API
    • Auth
      • POST Register
      • POST Login
      • POST Logout
    • Catalog
      • Main Categories
        • GET All Main Categories
        • GET Main Category
        • POST Main Category
        • PUT Main Category
        • GET Main Categories by Status
        • PUT Main Category Status
        • DELETE Main Category
      • Categories
        • GET All Categories
        • GET Category
        • POST Category
        • PUT Category
        • GET All Categories by Status
        • GET All Active Categories by Main Category
        • PUT Category Status
        • DELETE Category
      • Sub Categories
        • GET All Sub Categories
        • GET Sub Category
        • POST Sub Category
        • PUT Sub Category
        • GET All Sub Categories by Status
        • GET All Active Sub Categories by Category
        • PUT Sub Category Status
        • DELETE Sub Category
      • Units
        • GET All Units
        • GET Unit
        • POST Unit
        • PUT Unit
        • GET All Units by Status
        • PUT Unit Status
        • DELETE Unit
      • Brands
        • GET All Brands
        • GET Brand
        • POST Brand
        • PUT Brand
        • GET Brand by Status
        • PUT Brand Status
        • POST Brand Image
        • DELETE Brand
      • Attribute Groups
        • GET All Attribute Groups
        • GET Attribute Group
        • POST Attribute Group
        • PUT Attribute Group
        • GET All Attribute Groups by Status
        • PUT Attribute Group Status
        • DELETE Attribute Group
      • Attributes
        • GET All Attributes
        • GET Attribute
        • POST Attribute
        • PUT Attribute
        • GET All Attributes by Status
        • PUT Attribute Status
        • DELETE Attribute
      • Option Types
        • GET All Option Styles
        • GET All Option Types
        • GET Option Type
        • POST Option Type
        • PUT Option Type
        • GET All Option Type by Status
        • PUT Option Type Status
        • DELETE Option Type
      • Options
        • GET All Options
        • GET Option
        • POST Option
        • PUT Option
        • GET All Option by Status
        • PUT Option Status
        • DELETE Option
      • Products
        • GET All Products
        • GET Product
        • POST Product
        • PUT Product
        • GET All Products by Status
        • PUT Product Status
        • PUT Product Feature Status
        • PUT Product Banner Status
        • POST Product Image
        • GET All Products by Warehouse
        • GET Products Stock
        • GET Products Stock By Warehouse
        • DELETE Product
    • Sales
      • Customers
        • GET All Customers
        • GET Customers
        • POST Customers
        • PUT Customer
        • GET All Customers by Status
        • PUT Customer Status
        • DELETE Customer
      • Sales
        • GET All Sales
        • GET Sale
        • POST Sale
        • PUT Sale
        • GET All Sales by Status
        • PUT Sale Status
        • DELETE Sale
      • Sales Payments
        • GET Sales Payments by Sale ID
        • GET Sales Payment
        • POST Sales Payment
        • PUT Sales Payment
        • DELETE Sales Payment
      • POS
        • GET All POS Sales
        • GET POS Sale
        • POST POS Sale
        • PUT POS Sale
        • DELETE POS Sale
    • Purchases
      • Vendors
        • GET All Vendors
        • GET Vendor
        • POST Vendor
        • PUT Vendor
        • GET All Vendors by Status
        • PUT Vendor Status
        • DELETE Vendor
      • Purchases Orders
        • GET All Purchase Orders
        • GET Purchase Order
        • POST Purchase Order
        • PUT Purchase Order
        • GET All Purchase Orders by Status
        • PUT Purchase Order Status
        • DELETE Purchase Order
      • Purchases Orders Received
        • GET All Orders Received
        • GET Order Received
        • POST Order Received
      • Order Payments
        • GET Order Payment by PO
        • GET Order Payment
        • POST Order Payment
        • PUT Order Payment
        • DELETE Order Payment
    • CMS
      • Pagess
        • GET All Pages
        • GET Page
        • POST Page
        • PUT Page
        • GET All Pages by Status
        • PUT Page Status
        • DELETE Page
      • Subscribers
        • GET All Subscribers
        • GET Subscriber
        • POST Subscriber
        • PUT Subscriber
        • GET All Subscribers by Status
        • PUT Subscriber Status
        • DELETE Subscriber
      • Supports
        • GET All Supports
        • GET Support
        • POST Support
        • PUT Support
        • GET All Supports by Status
        • PUT Support Status
        • DELETE Support
    • User Management
      • Roles
        • GET All Roles
        • GET Role
        • POST Role
        • PUT Role
        • GET All Roles by Status
        • PUT Role Status
        • DELETE Role
      • Permissions
        • GET All Permissions
        • GET Role Permissions
        • PUT Role Permissions
      • Users
        • GET All Users
        • GET User
        • POST User
        • PUT User
        • GET All Users by Status
        • PUT User Status
        • PUT User Profile
        • PUT Change Password
        • DELETE User
      • GET All Features
    • Settings
      • Currency
        • GET All Currencies
        • GET Currency
        • POST Currency
        • PUT Currency
        • GET All Currencies by Status
        • PUT Currency Status
        • DELETE Currency
      • Coupons
        • GET All Coupons
        • GET Coupon
        • POST Coupon
        • PUT Coupon
        • GET All Coupons by Status
        • PUT Coupon Status
        • DELETE Coupon
      • Warehouses
        • GET All Warehouses
        • GET Warehouse
        • POST Warehouse
        • PUT Warehouse
        • GET All Warehouses by Status
        • PUT Warehouse Status
        • DELETE Warehouse
      • Taxes
        • GET Tax Methods
        • GET All Taxes
        • GET Tax
        • POST Tax
        • PUT Tax
        • GET All Taxes by Status
        • PUT Tax Status
        • DELETE Tax
      • Shippings
        • GET All Shippings
        • GET Shipping
        • POST Shipping
        • PUT Shipping
        • GET All Shippings by Status
        • PUT Shipping Status
        • DELETE Shipping
      • Company
        • GET Company
        • PUT Company
        • POST Update Logo
      • GET All Price Types
      • GET All Product Types
      • GET All Countries
      • GET All Packages
      • GET Package
  • Ecommerce API
    • Products
      • GET All Main Categories
        GET
      • GET All Categories by Main Category
        GET
      • GET All Sub Categories by Category
        GET
      • GET All Brands
        GET
      • GET All Products
        GET
      • GET Product
        GET
      • GET All Feature Products
        GET
      • GET All Banner Products
        GET
      • GET All Products by Main Category
        GET
      • GET All Products by Brand
        GET
    • Pages
      • GET All Pages
      • GET Page
      • GET All Supports
      • POST Subscriber
    • Shop
      • GET All Currencies
      • GET Default Currency
      • GET All Taxes
      • GET All Shippings
      • GET Shipping
      • GET All Discount Types
      • GET All Coupons
      • GET Coupon
      • POST Check Coupon
    • Account
      • POST Login
      • POST Register
      • Get Profile
      • POST Profile
      • POST Profile Billing Address
      • POST Profile Shipping Address
      • GET Customer's Wishlists
      • POST Customer's Wishlist
      • DELETE Customer's Wishlist
      • GET Customer All Orders
      • GET Customer Order
    • Cart
      • GET Cart
      • POST Cart
      • PUT Cart
      • POST Cart Shipping
      • POST Cart Discount
      • POST Checkout
      • DELETE Cart
      • DELETE Empty Cart
    • GET Company
      GET
    • GET Countries
      GET
  1. Products

GET All Products

Developing
GET
{{url}}api/v1/ecommerce/products
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'http://ecompulse.test/api/v1/ecommerce/products' \
--header 'Accept: application/json' \
--header 'X-API-Key: exzbLclGAzBCyL0k1Yv29Evu6mwoYOATBF0lWPyT'
Response Response Example
{
    "status": "success",
    "message": "Products retrieved successfully",
    "data": [
        {
            "id": 11,
            "sku": "P11",
            "name": "Freedom Body Corn Dress",
            "permalink": "freedom-body-corn-dress",
            "price": "66.00",
            "cost": "57.00",
            "product_net_cost": "57.00",
            "product_cost_tax": "0.00",
            "product_net_price": "66.00",
            "product_price_tax": "0.00",
            "short_description": "Donec sollicitudin molestie malesuada. Vestibulum ac diam sit amet quam vehicula elementum sed sit amet dui. Vivamus magna justo, lacinia eget consectetur s",
            "description": "Donec sollicitudin molestie malesuada. Vestibulum ac diam sit amet quam vehicula elementum sed sit amet dui. Vivamus magna justo, lacinia eget consectetur sed, convallis at tellus. Sed porttitor lectus nibh. Nulla quis lorem ut libero malesuada feugiat. Cras ultricies ligula sed magna dictum porta. Curabitur arcu erat, accumsan id imperdiet et, porttitor at sem. Vivamus magna justo, lacinia eget consectetur sed, convallis at tellus. Proin eget tortor risus. Donec rutrum congue leo eget malesuada.",
            "discount": null,
            "weight": null,
            "weight_based_price": "0.00",
            "meta_description": "Donec sollicitudin molestie malesuada. Vestibulum ac diam sit amet quam vehicula elementum sed sit amet dui. Vivamus magna justo, lacini",
            "meta_keywords": null,
            "product_tags": null,
            "warehouse": {
                "id": 1,
                "name": "Warehouse 1"
            },
            "product_type": {
                "id": 1,
                "name": "Physical Product"
            },
            "main_category": {
                "id": 2,
                "name": "Fashion"
            },
            "category": {
                "id": 4,
                "name": "Women's Clothing"
            },
            "sub_category": {
                "id": 1,
                "name": "Jeans"
            },
            "unit": {
                "id": 1,
                "name": "Piece"
            },
            "brand": null,
            "tax_method": null,
            "tax": null,
            "price_type": null,
            "attributes": null,
            "options": {
                "id": "",
                "values": []
            },
            "re_order_level": 15,
            "add_to_stock": 1,
            "open_stock": 80,
            "total_qty": 1,
            "image": "http://shopyx.test/images/products/1716520544.jpg",
            "video": null,
            "feature_status": 0,
            "banner_status": 1,
            "status": 1,
            "reviews": [
                {
                    "id": 4,
                    "review": "Proin eget tortor risus. Curabitur aliquet quam id dui posuere blandit. Pellentesque in ipsum id orci porta dapibus. Vivamus magna justo, lacinia eget consectetur sed, convallis at tellus.",
                    "rating": 5,
                    "date": "2024-05-05",
                    "customer": "Tom Bale"
                },
                ...
                ...
                ...
            ],
            "gallery": [
                {
                    "id": 11,
                    "image": "http://shopyx.test/images/gallery/1716521054_6650085eefc92_p14.jpg"
                },
                ...
                ...
                ...
            ]
        },
        ...
        ...
        ...
    ]
}

Request

Header Params
Accept
string 
required
Example:
application/json
X-API-Key
string 
required
Example:
{{key}}

Responses

🟢200Success
application/json
Body
object {0}
Modified at 2024-05-27 16:07:15
Previous
GET All Brands
Next
GET Product
Built with