All Product Prices

Description: Retrieves a list of product prices with optional filters for title, price range, date range, product ID, country, and city. The city parameter is required. Supports pagination and returns detailed price information including product ID, value, and customer categories. Authentication headers (apikey, secure-business-key, apiconnection) are required. Fetch a list of product prices with optional filters.

Headers

Key	Value	Description	Type
`apikey`	`5f28583f26a1a`	API key for authentication; contact support to obtain. `Required`	`string`
`apiconnection`	`appmobile`	Connection type; contact support to obtain. `Required`	`string`
`secure-business-key`	`140356399db2b2c32f0.25237063`	Business-specific key; contact support for valid values. `Required`	`string`

Query Parameters

Key	Value	Description	Type
`title`	(empty)	Search by product title. Optional	`string`
`price_min`	(empty)	Minimum price filter. Optional	`string`
`price_max`	(empty)	Maximum price filter. Optional	`string`
`from_date`	(empty)	Start date for price validity (e.g., 2024-03-01). Optional	`string`
`to_date`	(empty)	End date for price validity (e.g., 2024-12-01). Optional	`string`
`product_id`	(empty)	Filter by product ID. Optional (Get from api request `{{APP_URL}}/api/products/business_products`)	`string`
`country`	(empty)	Filter by country. Optional (Get from api request `{{APP_URL}}/api/`)	`string`
`city`	(empty)	Filter by city. (Get from api request `{{APP_URL}}/api/`)	`string`

Response

Status: 200

Content-Type: application/json

Body:

{
  "status": true,
  "message": "",
  "data": {
    "current_page": 0,
    "data": [
      {
        "id": 0,
        "title": "",
        "description": "",
        "product_id": 0,
        "product_unit_id": 0,
        "business_id": 0,
        "value": "",
        "setup_fee": null,
        "price_group_id": 0,
        "is_primary_group": 0,
        "attributes": null,
        "from_date": "",
        "to_date": "",
        "type": 0,
        "country": "",
        "city": "",
        "branch": "",
        "customer_cat": "",
        "customer_status": 0,
        "customer_reg_from_date": "",
        "customer_reg_to_date": "",
        "cart_value": "",
        "acc_user_cat": "",
        "acc_user_id": "",
        "ecomm_user_cat": "",
        "ecomm_user_id": "",
        "platfrom": "",
        "status": 0,
        "created_at": "",
        "updated_at": "",
        "device": "",
        "jobs_ids": "",
        "employees_ids": "",
        "branch_ids": "",
        "catalog_type": null
      }
    ],
    "first_page_url": "",
    "from": 0,
    "last_page": 0,
    "last_page_url": "",
    "links": [
      {
        "url": null,
        "label": "",
        "active": true
      }
    ],
    "next_page_url": "",
    "path": "",
    "per_page": 0,
    "prev_page_url": null,
    "to": 0,
    "total": 0
  }
}

curl --location -g --request GET 'https://www.testecommerce.vodoerp.com/api/v1/ecomm_product_prices?title=&price_min=&price_max=&from_date=&to_date=&product_id=&country=&city=' \ --header 'apikey: 5f28583f26a1a' \ --header 'apiconnection: appmobile' \ --header 'secure-business-key: 140356399db2b2c32f0.25237063' \ --header 'Content-Type: application/json' \ --data-raw '{}'

{ "status": true, "message": "Product prices retrieved successfully", "data": { "current_page": 1, "data": [ { "id": 1, "title": "Sample Tiitle", "description": "Sample Description", "product_id": 34, "product_unit_id": 3, "business_id": 37, "value": "200", "setup_fee": null, "price_group_id": 1, "is_primary_group": 1, "attributes": null, "from_date": "2024-02-01", "to_date": "2027-02-21", "type": 1, "country": "7,5,10", "city": "9,2,3", "branch": "12,14", "customer_cat": "11,17", "customer_status": 1, "customer_reg_from_date": "2024-01-01", "customer_reg_to_date": "2024-12-31", "cart_value": "150", "acc_user_cat": "8,10", "acc_user_id": "1,4,2", "ecomm_user_cat": "3,5", "ecomm_user_id": "4,8", "platfrom": "5,7,8", "status": 1, "created_at": "2024-04-18 14:44:11", "updated_at": "2024-04-18 14:44:11", "device": "0,5", "jobs_ids": "3,5", "employees_ids": "9,55", "branch_ids": "4,8", "catalog_type": null }, { "id": 53, "title": "Sample Tiitle", "description": "Sample Description", "product_id": 1, "product_unit_id": 7, "business_id": 37, "value": "200", "setup_fee": null, "price_group_id": 1, "is_primary_group": 1, "attributes": null, "from_date": "2024-02-01", "to_date": "2027-02-21", "type": 1, "country": "7,5,10", "city": "9,2,3", "branch": "4,5", "customer_cat": "11,17", "customer_status": 1, "customer_reg_from_date": "2024-01-01", "customer_reg_to_date": "2024-12-31", "cart_value": "150", "acc_user_cat": "4,764", "acc_user_id": "2,82", "ecomm_user_cat": "372,549", "ecomm_user_id": "425,879", "platfrom": "5,7,8", "status": 1, "created_at": "2024-07-29 16:45:12", "updated_at": "2024-07-29 16:45:12", "device": "0,5", "jobs_ids": "", "employees_ids": "", "branch_ids": "", "catalog_type": null }, { "id": 54, "title": "Sample Tiitle", "description": "Sample Description", "product_id": 1, "product_unit_id": 7, "business_id": 37, "value": "200", "setup_fee": null, "price_group_id": 2, "is_primary_group": 0, "attributes": null, "from_date": "2024-02-01", "to_date": "2027-02-21", "type": 1, "country": "7,5,10", "city": "9,2,3", "branch": "4,5", "customer_cat": "11,17", "customer_status": 1, "customer_reg_from_date": "2024-01-01", "customer_reg_to_date": "2024-12-31", "cart_value": "150", "acc_user_cat": "4,764", "acc_user_id": "2,82", "ecomm_user_cat": "372,549", "ecomm_user_id": "425,879", "platfrom": "5,7,8", "status": 1, "created_at": "2024-07-29 16:45:48", "updated_at": "2024-07-29 16:45:48", "device": "0,5", "jobs_ids": "", "employees_ids": "", "branch_ids": "", "catalog_type": null }, { "id": 55, "title": "Sample Title", "description": "Sample Description", "product_id": 1, "product_unit_id": 7, "business_id": 37, "value": "150", "setup_fee": null, "price_group_id": 3, "is_primary_group": 0, "attributes": null, "from_date": "2024-03-01", "to_date": "2025-12-31", "type": 1, "country": "5487,4,6", "city": "4,7,45", "branch": "3,1", "customer_cat": "7,8", "customer_status": 1, "customer_reg_from_date": "2024-01-01", "customer_reg_to_date": "2024-12-31", "cart_value": "100.00", "acc_user_cat": "4,764", "acc_user_id": "2,82", "ecomm_user_cat": "372,549", "ecomm_user_id": "425,879", "platfrom": "52,75", "status": 1, "created_at": "2024-07-29 18:22:52", "updated_at": "2024-07-29 18:22:52", "device": null, "jobs_ids": null, "employees_ids": null, "branch_ids": null, "catalog_type": null }, { "id": 56, "title": "Sample Title", "description": "Sample Description", "product_id": 1, "product_unit_id": 7, "business_id": 37, "value": "150", "setup_fee": null, "price_group_id": 4, "is_primary_group": 0, "attributes": null, "from_date": "2024-04-01", "to_date": "2028-12-31", "type": 1, "country": "7,4,6", "city": "4,7,10", "branch": "12,14", "customer_cat": "11,13", "customer_status": 1, "customer_reg_from_date": "2024-01-01", "customer_reg_to_date": "2024-12-31", "cart_value": "100", "acc_user_cat": "8,10", "acc_user_id": "1,4,2", "ecomm_user_cat": "3,5", "ecomm_user_id": "4,8", "platfrom": "5,7", "status": 1, "created_at": "2024-07-29 18:28:33", "updated_at": "2024-07-29 18:28:33", "device": null, "jobs_ids": null, "employees_ids": null, "branch_ids": null, "catalog_type": null }, { "id": 57, "title": "Sample Title", "description": "Sample Description", "product_id": 1, "product_unit_id": 7, "business_id": 37, "value": "150", "setup_fee": null, "price_group_id": 5, "is_primary_group": 0, "attributes": null, "from_date": "2024-01-01", "to_date": "2027-12-31", "type": 1, "country": "7,4,6", "city": "4,7,10", "branch": "3,1", "customer_cat": "12,9", "customer_status": 1, "customer_reg_from_date": "2024-01-01", "customer_reg_to_date": "2024-12-31", "cart_value": "100", "acc_user_cat": "8,10", "acc_user_id": "1,4,2", "ecomm_user_cat": "3,5", "ecomm_user_id": "4,8", "platfrom": "5,7", "status": 1, "created_at": "2024-07-29 18:30:12", "updated_at": "2024-07-29 18:30:12", "device": null, "jobs_ids": null, "employees_ids": null, "branch_ids": null, "catalog_type": null }, { "id": 58, "title": "Sample Title", "description": "Sample Description", "product_id": 1, "product_unit_id": 7, "business_id": 37, "value": "150", "setup_fee": null, "price_group_id": 6, "is_primary_group": 0, "attributes": null, "from_date": "2024-01-01", "to_date": "2025-12-31", "type": 1, "country": "7,4,6", "city": "4,7,10", "branch": "3,1", "customer_cat": "11,17", "customer_status": 1, "customer_reg_from_date": "2024-01-01", "customer_reg_to_date": "2024-12-31", "cart_value": "100", "acc_user_cat": "8,10", "acc_user_id": "1,4,2", "ecomm_user_cat": "3,5", "ecomm_user_id": "4,8", "platfrom": "5,7", "status": 1, "created_at": "2024-07-29 19:11:22", "updated_at": "2024-07-29 19:11:22", "device": null, "jobs_ids": null, "employees_ids": null, "branch_ids": null, "catalog_type": null }, { "id": 59, "title": "Sample Title", "description": "Sample Description", "product_id": 1, "product_unit_id": 7, "business_id": 37, "value": "150", "setup_fee": null, "price_group_id": 7, "is_primary_group": 0, "attributes": null, "from_date": "2024-03-01", "to_date": "2026-01-20", "type": 1, "country": "7,4,6", "city": "4,7,10", "branch": "3,1", "customer_cat": "11,17", "customer_status": 1, "customer_reg_from_date": "2024-01-01", "customer_reg_to_date": "2024-12-31", "cart_value": "100", "acc_user_cat": "8,10", "acc_user_id": "1,4,2", "ecomm_user_cat": "3,5", "ecomm_user_id": "4,8", "platfrom": "5,7", "status": 1, "created_at": "2024-07-29 19:12:11", "updated_at": "2024-07-29 19:12:11", "device": null, "jobs_ids": null, "employees_ids": null, "branch_ids": null, "catalog_type": null }, { "id": 60, "title": "Sample Title", "description": "Sample Description", "product_id": 1, "product_unit_id": 7, "business_id": 37, "value": "150", "setup_fee": null, "price_group_id": 8, "is_primary_group": 0, "attributes": null, "from_date": "2024-03-01", "to_date": "2027-01-20", "type": 1, "country": "7,4,6", "city": "4,7,10", "branch": "3,1", "customer_cat": "11,17", "customer_status": 1, "customer_reg_from_date": "2024-01-01", "customer_reg_to_date": "2024-12-31", "cart_value": "100", "acc_user_cat": "8,10", "acc_user_id": "1,4,2", "ecomm_user_cat": "3,5", "ecomm_user_id": "4,8", "platfrom": "5,7", "status": 1, "created_at": "2024-07-29 19:53:08", "updated_at": "2024-07-29 19:53:08", "device": null, "jobs_ids": null, "employees_ids": null, "branch_ids": null, "catalog_type": null }, { "id": 61, "title": "Sample Title", "description": "Sample Description", "product_id": 1, "product_unit_id": 7, "business_id": 37, "value": "150", "setup_fee": null, "price_group_id": 9, "is_primary_group": 0, "attributes": null, "from_date": "2024-04-01", "to_date": "2028-12-31", "type": 1, "country": "7,4,6", "city": "4,7,10", "branch": "3,1", "customer_cat": "11,13", "customer_status": 1, "customer_reg_from_date": "2024-01-01", "customer_reg_to_date": "2024-12-31", "cart_value": "100", "acc_user_cat": "8,10", "acc_user_id": "1,4,2", "ecomm_user_cat": "3,5", "ecomm_user_id": "4,8", "platfrom": "5,7", "status": 1, "created_at": "2024-07-29 19:54:18", "updated_at": "2024-07-29 19:54:18", "device": null, "jobs_ids": null, "employees_ids": null, "branch_ids": null, "catalog_type": null } ], "first_page_url": "http://localhost:8000/api/v1/ecomm_product_prices?page=1", "from": 1, "last_page": 37, "last_page_url": "http://localhost:8000/api/v1/ecomm_product_prices?page=37", "links": [ { "url": null, "label": "« Previous", "active": false }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=1", "label": "1", "active": true }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=2", "label": "2", "active": false }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=3", "label": "3", "active": false }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=4", "label": "4", "active": false }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=5", "label": "5", "active": false }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=6", "label": "6", "active": false }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=7", "label": "7", "active": false }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=8", "label": "8", "active": false }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=9", "label": "9", "active": false }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=10", "label": "10", "active": false }, { "url": null, "label": "...", "active": false }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=36", "label": "36", "active": false }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=37", "label": "37", "active": false }, { "url": "http://localhost:8000/api/v1/ecomm_product_prices?page=2", "label": "Next »", "active": false } ], "next_page_url": "http://localhost:8000/api/v1/ecomm_product_prices?page=2", "path": "http://localhost:8000/api/v1/ecomm_product_prices", "per_page": 10, "prev_page_url": null, "to": 10, "total": 366 } }

Request

Query Params

title

string

required

Search by title

price_min

string

required

Search by price_min

price_max

string

required

Search by price_max

from_date

string

required

Search by from_date 2024-03-01

to_date

string

required

Search by to_date 2024-12-01

product_id

string

required

Search by product_id

country

string

required

Search by country

city

string

required

Search by city

Header Params

apikey

string

required

You must contact support to get the apikey.

Example:

5f28583f26a1a

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 Product Prices

application/json

Body

status

boolean

required

message

string

required

data

object

required

current_page

integer

required

data

array [object {35}]

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

string

required

path

string

required

per_page

integer

required

prev_page_url

null

required

integer

required

total

integer

required

All Product Prices

Response#

Request

Responses

Response