API Documentation
Endpoint Examples
- GETClient Information
- GETAll Client Categories
- GETAll Client References
- POSTCreate Client Reference
- GETGet Specific Client Reference
- GETCP: Fast Product Search
- GETCP: Extended Product Search
- GETRP: Replacement Products
- GETAll Appraisals In Specific Client Reference
- POSTCreate Appraisal
- DELDelete All Appraisals In Specific Client Reference
- GETGet Specific Appraisal
- PUTModify Specific Appraisal
- DELDelete Specific Appraisal
- PUTPerform ACV Calculation
- DELDelete ACV Calculation
- POSTCreate Report For Client Reference
- POSTCreate Report For Appraisal
- POSTCreate Customer Portal Link
- GETGet a Customer Portal Link
- PATCHManage Customer Portal Link
- POSTSend appraisals from Cart to Portal
- GETLoad Inventory from Portal to Cart
Endpoint Examples
RP: Replacement Products
GET
/
prices
curl --request GET \
--url https://api.valuechecker.net/prices \
--header 'Authorization: <api-key>'
{
"claimed_product": {
"pid": 1262828314,
"master_name": "",
"product_name": "Apple iPhone 14 Pro Max 1TB",
"vcid": 1417514,
"cid": 4364,
"pic_url": "https://img.valuechecker.net/,---.jpg",
"product_pic_url": "https://img.valuechecker.net/200x,---.jpg",
"product_url": "https://www.pricerunner.com/pl/1-3202448228/Mobile-Phones/Apple-iPhone-14-Pro-Max-1TB-Compare-Prices",
"specs": [
{
"spec_id": 888,
"spec_value": "Pro",
"spec_value_display": "Pro",
"spec_value_numeric": 2,
"spec_name_display": "Model Family"
},
{
"spec_id": 999,
"spec_value": "36",
"spec_value_display": "Apple",
"spec_value_numeric": 3,
"spec_name_display": "Brand"
},
{
"spec_id": 8300,
"spec_value": "2022-07-01",
"spec_value_display": "2022",
"spec_value_numeric": 1656633600,
"spec_name_display": "Release Year"
},
{
"spec_id": 8000,
"spec_value": "1000000",
"spec_value_display": "1024 GB",
"spec_value_numeric": 1000000,
"spec_name_display": "Storage Capacity"
},
{
"spec_id": 5000,
"spec_value": "17.018",
"spec_value_display": "6.7\"",
"spec_value_numeric": 17.02,
"spec_name_display": "Screen Size"
}
],
"in_stock": true,
"query_at_limit": false,
"client_category_id": 4364,
"client_category": "Mobile Phones"
},
"grouped_prices": [
[
{
"shop_product_name": "Apple iPhone 14 Pro Max (1 TB) - Gold",
"currency": "GBP",
"total_price": 1684.99,
"base_price": 1684.99,
"price_date": "2023-07-25 11:07:41",
"offer_id": 228246862,
"offer_url": "https://offer.valuechecker.net/abc---123",
"international": false,
"is_refurbished": false,
"in_stock": true,
"blocked": false,
"country_code": "uk",
"product": {
"pid": 1263096838,
"sid": 44001,
"vcid": 1417514,
"source_internal_id": "3202448228",
"master_name": "Apple iPhone 14 Pro Max 1024GB (2022)",
"product_name": "Apple iPhone 14 Pro Max 1024GB (2022)",
"master_pic_url": "https://img.valuechecker.net/200x,---.jpg",
"pic_url": "https://img.valuechecker.net/,---.jpg",
"product_pic_url": "https://img.valuechecker.net/200x,---.jpg",
"product_url": "https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf",
"brand": "Apple",
"price": {
"price_url": "https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf"
},
"rp_first_choice": true,
"specs": [
{
"spec_id": 888,
"spec_value_display": "Pro",
"spec_value_numeric": 2,
"spec_name_display": "Model Family"
},
{
"spec_id": 999,
"spec_value_display": "Apple",
"spec_value_numeric": 3,
"spec_name_display": "Brand"
},
{
"spec_id": 8300,
"spec_value_display": "2022",
"spec_value_numeric": 1656633600,
"spec_name_display": "Release Year"
},
{
"spec_id": 8000,
"spec_value_display": "1024 GB",
"spec_value_numeric": 1000000,
"spec_name_display": "Storage Capacity"
},
{
"spec_id": 5000,
"spec_value_display": "6.7\"",
"spec_value_numeric": 17.02,
"spec_name_display": "Screen Size"
}
],
"same_alid_as_cp": true,
"score_perfect": true,
"score": 12459,
"is_user_defined_claim": false
},
"shop": {
"shop_name": "Amazon UK",
"shop_status": 1,
"shop_score": 0
},
"filtered_price": false,
"outside_price_range": false
},
{
"shop_product_name": "Apple iPhone 14 Pro Max (1 TB) - Deep Purple",
"currency": "GBP",
"total_price": 1684.99,
"base_price": 1684.99,
"price_date": "2023-07-25 11:07:41",
"offer_id": 228246863,
"offer_url": "https://offer.valuechecker.net/abc---123",
"international": false,
"is_refurbished": false,
"in_stock": true,
"blocked": false,
"country_code": "uk",
"product": {
"pid": 1263096838,
"sid": 44001,
"vcid": 1417514,
"source_internal_id": "3202448228",
"master_name": "Apple iPhone 14 Pro Max 1024GB (2022)",
"product_name": "Apple iPhone 14 Pro Max 1024GB (2022)",
"master_pic_url": "https://img.valuechecker.net/200x,---.jpg",
"pic_url": "https://img.valuechecker.net/,---.jpg",
"product_pic_url": "https://img.valuechecker.net/200x,---.jpg",
"product_url": "https://offer-staging.valuechecker.net/dAkKadvB66xaQJoaQF5BrG",
"brand": "Apple",
"price": {
"price_url": "https://offer-staging.valuechecker.net/dAkKadvB66xaQJoaQF5BrG"
},
"rp_first_choice": true,
"specs": [
{
"spec_id": 888,
"spec_value_display": "Pro",
"spec_value_numeric": 2,
"spec_name_display": "Model Family"
},
{
"spec_id": 999,
"spec_value_display": "Apple",
"spec_value_numeric": 3,
"spec_name_display": "Brand"
},
{
"spec_id": 8300,
"spec_value_display": "2022",
"spec_value_numeric": 1656633600,
"spec_name_display": "Release Year"
},
{
"spec_id": 8000,
"spec_value_display": "1024 GB",
"spec_value_numeric": 1000000,
"spec_name_display": "Storage Capacity"
},
{
"spec_id": 5000,
"spec_value_display": "6.7\"",
"spec_value_numeric": 17.02,
"spec_name_display": "Screen Size"
}
],
"same_alid_as_cp": true,
"score_perfect": true,
"score": 12459,
"is_user_defined_claim": false
},
"shop": {
"shop_name": "Amazon UK",
"shop_status": 1,
"shop_score": 0
},
"filtered_price": false,
"outside_price_range": false
}
]
]
}
Authorizations
Note! Prefix your <api-key> with apiKey
. Note the space after "apiKey ".
Query Parameters
The product identifier (usually selected from the product search response).
The country in where prices will be searched.
The client ID for the request. It's required if you have access to multiple clients with your API key. Otherwise, it's optional.
Optional session identifier of the user.
Response
200
application/json
OK
The response is of type object
.
curl --request GET \
--url https://api.valuechecker.net/prices \
--header 'Authorization: <api-key>'
{
"claimed_product": {
"pid": 1262828314,
"master_name": "",
"product_name": "Apple iPhone 14 Pro Max 1TB",
"vcid": 1417514,
"cid": 4364,
"pic_url": "https://img.valuechecker.net/,---.jpg",
"product_pic_url": "https://img.valuechecker.net/200x,---.jpg",
"product_url": "https://www.pricerunner.com/pl/1-3202448228/Mobile-Phones/Apple-iPhone-14-Pro-Max-1TB-Compare-Prices",
"specs": [
{
"spec_id": 888,
"spec_value": "Pro",
"spec_value_display": "Pro",
"spec_value_numeric": 2,
"spec_name_display": "Model Family"
},
{
"spec_id": 999,
"spec_value": "36",
"spec_value_display": "Apple",
"spec_value_numeric": 3,
"spec_name_display": "Brand"
},
{
"spec_id": 8300,
"spec_value": "2022-07-01",
"spec_value_display": "2022",
"spec_value_numeric": 1656633600,
"spec_name_display": "Release Year"
},
{
"spec_id": 8000,
"spec_value": "1000000",
"spec_value_display": "1024 GB",
"spec_value_numeric": 1000000,
"spec_name_display": "Storage Capacity"
},
{
"spec_id": 5000,
"spec_value": "17.018",
"spec_value_display": "6.7\"",
"spec_value_numeric": 17.02,
"spec_name_display": "Screen Size"
}
],
"in_stock": true,
"query_at_limit": false,
"client_category_id": 4364,
"client_category": "Mobile Phones"
},
"grouped_prices": [
[
{
"shop_product_name": "Apple iPhone 14 Pro Max (1 TB) - Gold",
"currency": "GBP",
"total_price": 1684.99,
"base_price": 1684.99,
"price_date": "2023-07-25 11:07:41",
"offer_id": 228246862,
"offer_url": "https://offer.valuechecker.net/abc---123",
"international": false,
"is_refurbished": false,
"in_stock": true,
"blocked": false,
"country_code": "uk",
"product": {
"pid": 1263096838,
"sid": 44001,
"vcid": 1417514,
"source_internal_id": "3202448228",
"master_name": "Apple iPhone 14 Pro Max 1024GB (2022)",
"product_name": "Apple iPhone 14 Pro Max 1024GB (2022)",
"master_pic_url": "https://img.valuechecker.net/200x,---.jpg",
"pic_url": "https://img.valuechecker.net/,---.jpg",
"product_pic_url": "https://img.valuechecker.net/200x,---.jpg",
"product_url": "https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf",
"brand": "Apple",
"price": {
"price_url": "https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf"
},
"rp_first_choice": true,
"specs": [
{
"spec_id": 888,
"spec_value_display": "Pro",
"spec_value_numeric": 2,
"spec_name_display": "Model Family"
},
{
"spec_id": 999,
"spec_value_display": "Apple",
"spec_value_numeric": 3,
"spec_name_display": "Brand"
},
{
"spec_id": 8300,
"spec_value_display": "2022",
"spec_value_numeric": 1656633600,
"spec_name_display": "Release Year"
},
{
"spec_id": 8000,
"spec_value_display": "1024 GB",
"spec_value_numeric": 1000000,
"spec_name_display": "Storage Capacity"
},
{
"spec_id": 5000,
"spec_value_display": "6.7\"",
"spec_value_numeric": 17.02,
"spec_name_display": "Screen Size"
}
],
"same_alid_as_cp": true,
"score_perfect": true,
"score": 12459,
"is_user_defined_claim": false
},
"shop": {
"shop_name": "Amazon UK",
"shop_status": 1,
"shop_score": 0
},
"filtered_price": false,
"outside_price_range": false
},
{
"shop_product_name": "Apple iPhone 14 Pro Max (1 TB) - Deep Purple",
"currency": "GBP",
"total_price": 1684.99,
"base_price": 1684.99,
"price_date": "2023-07-25 11:07:41",
"offer_id": 228246863,
"offer_url": "https://offer.valuechecker.net/abc---123",
"international": false,
"is_refurbished": false,
"in_stock": true,
"blocked": false,
"country_code": "uk",
"product": {
"pid": 1263096838,
"sid": 44001,
"vcid": 1417514,
"source_internal_id": "3202448228",
"master_name": "Apple iPhone 14 Pro Max 1024GB (2022)",
"product_name": "Apple iPhone 14 Pro Max 1024GB (2022)",
"master_pic_url": "https://img.valuechecker.net/200x,---.jpg",
"pic_url": "https://img.valuechecker.net/,---.jpg",
"product_pic_url": "https://img.valuechecker.net/200x,---.jpg",
"product_url": "https://offer-staging.valuechecker.net/dAkKadvB66xaQJoaQF5BrG",
"brand": "Apple",
"price": {
"price_url": "https://offer-staging.valuechecker.net/dAkKadvB66xaQJoaQF5BrG"
},
"rp_first_choice": true,
"specs": [
{
"spec_id": 888,
"spec_value_display": "Pro",
"spec_value_numeric": 2,
"spec_name_display": "Model Family"
},
{
"spec_id": 999,
"spec_value_display": "Apple",
"spec_value_numeric": 3,
"spec_name_display": "Brand"
},
{
"spec_id": 8300,
"spec_value_display": "2022",
"spec_value_numeric": 1656633600,
"spec_name_display": "Release Year"
},
{
"spec_id": 8000,
"spec_value_display": "1024 GB",
"spec_value_numeric": 1000000,
"spec_name_display": "Storage Capacity"
},
{
"spec_id": 5000,
"spec_value_display": "6.7\"",
"spec_value_numeric": 17.02,
"spec_name_display": "Screen Size"
}
],
"same_alid_as_cp": true,
"score_perfect": true,
"score": 12459,
"is_user_defined_claim": false
},
"shop": {
"shop_name": "Amazon UK",
"shop_status": 1,
"shop_score": 0
},
"filtered_price": false,
"outside_price_range": false
}
]
]
}
Assistant
Responses are generated using AI and may contain mistakes.