Pricefy API API Reference
Pricefy API
API Endpoint
https://api.pricefy.io/v1/
Schemes: https
Version: 1.3.1
Authentication
Bearer
Ex. Authorization: Bearer xxxx
Catalog Management
Catalog management
importProducts
Import a list of products
Request Example
{
"append_only": "integer",
"products": [
{
"name": "Test",
"price": 10,
"sku": "test1234",
"ean": "1234567812",
"status": "ready"
}
]
}
Import summary
Response Content-Types: application/json
Response Example (200 OK)
{
"total": 1,
"skipped": 1,
"imported": 0,
"missing_barcode": 1,
"invalid_barcode": 0
}
Product Import
Import a product in user catalog
Products data
Request Example
{
"name": "Test",
"price": 10,
"sku": "test1234",
"ean": "1234567812",
"status": "ready"
}
Generic success response
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "integer",
"message": "string"
}
Catalog List
Catalog products
Page number
It allows to search specific product in the catalog by its Composte ID
Catalog products
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"composite_id": "EAN:8015654212114",
"code_type": "EAN",
"code": "8015654212114",
"name": "HIGIENIC*MUT INC 1(EROS)C/F*****",
"picture_url": "",
"cost": 14.02,
"price": 21,
"status": "ready"
}
]
}
Delete a list of Products
Delete a list of products from catalog. Note: the product will be set as deleted
and not physically removed.
Request Example
{
"composite_ids": [
"string"
]
}
Generic success response
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "integer",
"message": "string"
}
Account
Account management
getAccount
Provides the account details together with enabled countries and sources
Account information together with allowed sources and countries
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1,
"email": "accountemail@domain.com",
"picture_path": "https://s3.amazonaws.com/img.pricefy.io/avatar/default_profile_img.png",
"firstname": "Fabrizio",
"lastname": "D'Ammassa",
"country": "",
"currency": "EUR",
"tax_value": 0,
"country_code": "",
"zip": "",
"address": "",
"city": "",
"company_name": "",
"website_name": "",
"website_type": "",
"phone_prefix": "+39",
"phone": "",
"created_at": "2016-11-28T20:59:19.000Z"
}
Common
Common API
Amazon Bestseller Categories
Provides the list of Amazon bestesellers categories for a specific country
Country ISO Code
List of Amazon Bestseller Categories
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": "string",
"name": "string"
}
]
Query
Prices query
Catalog Analysis
Provides the analysis result for the entire catalog
Country ISO Code
Result page to return
Product code (EAN:123456789 or UPC:1231313). If you don't specify EAN or UPC prefix, the system will interpret as EAN
Catalog Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "BENDA ELASTOMULL 4X400CM",
"pricefy_id": "EAN:4042809022421",
"code_type": "EAN",
"code": "4042809022421",
"competitors": 4,
"demand": "Low",
"competition": "Medium",
"rating": 0,
"cost": 1.91,
"min_price": 0.59,
"avg_price": 10.44,
"max_price": 21,
"min_markup": -69.11,
"avg_markup": 446.73,
"max_markup": 999.48
}
]
}
Single Product Analysis
Provides the offer details of a single product
Country ISO Code
Product composite ID, e.g. EAN:123123123
Product Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "Frauenland Apotheke",
"competitor_id": 175,
"type": "Amazon",
"competitor_price": 16.77,
"my_price": 2.64,
"price_diff": 535
}
Price Analysis
Provides the price analysis for the entire catalog
Country ISO Code
Price Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "BENDA ELASTOMULL 4X400CM",
"code_type": "EAN",
"code": "4042809022421",
"price": 2.64,
"amazon_price": 0.59,
"ebay_price": 0,
"min_price": 0.59,
"avg_price": 10.44,
"max_price": 21,
"min_diff": -77.65,
"avg_diff": 295.55,
"max_diff": 695.45
}
]
}
Marketplace Catalog Analysis
Provides the catalog analysis restricted to a single marketplace
Country ISO Code
Marketplace code (ebay or amazon)
Marketplace Catalog Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "APROTEN ANELLINI 500G",
"pricefy_id": "EAN:8001040079034",
"code_type": "EAN",
"code": "8001040079034",
"cost": 8.6,
"min_price": 9.57,
"avg_price": 9.57,
"max_price": 9.57,
"min_markup": 11.28,
"avg_markup": 11.28,
"max_markup": 11.28
}
]
}
Competitor Catalog Analysis
Provides the catalog analysis of a specific competitor
Country ISO Code
Competitor ID
Competitor Catalog Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "Plasmon Stelline Pasta (340g)",
"pricefy_id": "EAN:8001040012352",
"code_type": "EAN",
"code": "8001040012352",
"price": 4.35,
"my_price": 2.39,
"price_diff": 82.01
}
]
}
Competitors Analysis
Provides the analysis of all competitors
Country ISO Code
Competitors Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"name": "Farmacosmo",
"competitor_id": 11,
"type": "Amazon",
"rating": 0,
"products_match": 31,
"catalog_similarity": 46
}
]
}
Discovered Competitor Analysis
Provides the discovered competitor's urls in a specific country
Country ISO Code
Competitor domain (e.g. test.com)
Discovered Competitor Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"keyword": "KERN e figlio conteggio, 1 pezzi, CPB 15 K0.2 N",
"url": "http://www.022.org/abeplusplus/gm/archives/00000109.html",
"last_check": "2018-03-13",
"serp": 16
}
]
}
Discovered Competitors Analysis
Provides the list of discovered competitor in a specific country
Country ISO Code
Discovered Competitors Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"domain": "022.org",
"urls": 1,
"monitoring": 0,
"date_found": "2018-03-13",
"fraud": 0
}
]
}
Opportunities analysis
Provides the list of Amazon bestesellers
Country ISO code
Category ID to restrict the bestesellers list to; you can obtain the categories list from /v1/common/categories
Bestsellers List
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"asin": "B0744CM8CP",
"title": "Batman batarang Spinner, the dark knight spinner, Justice league collectible, Fidget Spinner, plastic, Anti Stress Toys",
"demand": "High",
"rating": 0,
"price": 13.07,
"position": 92,
"last_position": 0,
"woc": 0
}
]
}
Catalog Analysis
Catalog analysis query
Catalog Analysis
Provides the analysis result for the entire catalog
Country ISO Code
Result page to return
Product code (EAN:123456789 or UPC:1231313). If you don't specify EAN or UPC prefix, the system will interpret as EAN
Catalog Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "BENDA ELASTOMULL 4X400CM",
"pricefy_id": "EAN:4042809022421",
"code_type": "EAN",
"code": "4042809022421",
"competitors": 4,
"demand": "Low",
"competition": "Medium",
"rating": 0,
"cost": 1.91,
"min_price": 0.59,
"avg_price": 10.44,
"max_price": 21,
"min_markup": -69.11,
"avg_markup": 446.73,
"max_markup": 999.48
}
]
}
Single Product Analysis
Provides the offer details of a single product
Country ISO Code
Product composite ID, e.g. EAN:123123123
Product Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "Frauenland Apotheke",
"competitor_id": 175,
"type": "Amazon",
"competitor_price": 16.77,
"my_price": 2.64,
"price_diff": 535
}
Competitor Catalog Analysis
Provides the catalog analysis of a specific competitor
Country ISO Code
Competitor ID
Competitor Catalog Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "Plasmon Stelline Pasta (340g)",
"pricefy_id": "EAN:8001040012352",
"code_type": "EAN",
"code": "8001040012352",
"price": 4.35,
"my_price": 2.39,
"price_diff": 82.01
}
]
}
Price Analysis
Price analysis query
Price Analysis
Provides the price analysis for the entire catalog
Country ISO Code
Price Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "BENDA ELASTOMULL 4X400CM",
"code_type": "EAN",
"code": "4042809022421",
"price": 2.64,
"amazon_price": 0.59,
"ebay_price": 0,
"min_price": 0.59,
"avg_price": 10.44,
"max_price": 21,
"min_diff": -77.65,
"avg_diff": 295.55,
"max_diff": 695.45
}
]
}
Opportunities Analysis
Opportunities analysis query
Opportunities analysis
Provides the list of Amazon bestesellers
Country ISO code
Category ID to restrict the bestesellers list to; you can obtain the categories list from /v1/common/categories
Bestsellers List
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"asin": "B0744CM8CP",
"title": "Batman batarang Spinner, the dark knight spinner, Justice league collectible, Fidget Spinner, plastic, Anti Stress Toys",
"demand": "High",
"rating": 0,
"price": 13.07,
"position": 92,
"last_position": 0,
"woc": 0
}
]
}
Marketplace Analysis
Marketplace Catalog Analysis
Provides the catalog analysis restricted to a single marketplace
Country ISO Code
Marketplace code (ebay or amazon)
Marketplace Catalog Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "APROTEN ANELLINI 500G",
"pricefy_id": "EAN:8001040079034",
"code_type": "EAN",
"code": "8001040079034",
"cost": 8.6,
"min_price": 9.57,
"avg_price": 9.57,
"max_price": 9.57,
"min_markup": 11.28,
"avg_markup": 11.28,
"max_markup": 11.28
}
]
}
Competitor Analysis
Competitor Catalog Analysis
Provides the catalog analysis of a specific competitor
Country ISO Code
Competitor ID
Competitor Catalog Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "Plasmon Stelline Pasta (340g)",
"pricefy_id": "EAN:8001040012352",
"code_type": "EAN",
"code": "8001040012352",
"price": 4.35,
"my_price": 2.39,
"price_diff": 82.01
}
]
}
Competitors Analysis
Competitors Analysis
Provides the analysis of all competitors
Country ISO Code
Competitors Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"name": "Farmacosmo",
"competitor_id": 11,
"type": "Amazon",
"rating": 0,
"products_match": 31,
"catalog_similarity": 46
}
]
}
Discovered Competitors Analysis
Discovered Competitor Analysis
Provides the discovered competitor's urls in a specific country
Country ISO Code
Competitor domain (e.g. test.com)
Discovered Competitor Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"keyword": "KERN e figlio conteggio, 1 pezzi, CPB 15 K0.2 N",
"url": "http://www.022.org/abeplusplus/gm/archives/00000109.html",
"last_check": "2018-03-13",
"serp": 16
}
]
}
Discovered Competitors Analysis
Provides the list of discovered competitor in a specific country
Country ISO Code
Discovered Competitors Analysis
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"domain": "022.org",
"urls": 1,
"monitoring": 0,
"date_found": "2018-03-13",
"fraud": 0
}
]
}
E-commerce Competitors Management
competitorsList
Provides the list of your e-commerce competitors
E-commerce Competitors List
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": 1,
"website_id": 399,
"domain": "https://www.my-competitor.com",
"url_count": 520856
}
]
competitorCatalog
Provides the list of your e-commerce competitor catalog
E-commerce competitor ID
Page number
E-commerce Competitor Catalog
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"pictureUrl": "https://www.mycompetitor.com/picture.org",
"title": "The competitor product title",
"brand": "The competitor product brand",
"url": "https://www.mycompetitor.com/test.html",
"price": 8.5,
"currency": "EUR",
"fetched_at": "2018-11-30 11:11:34",
"matching_type": "AUTO",
"matching_similarity": 2,
"account_product_title": "My Product Title",
"account_product_picture_url": "https://my-ecommerce.it/the-picture.png",
"composite_id": "EAN:123456789010"
}
]
}
competitorPrices
Provides the prices of the matched products for one of your e-commerce competitors
E-commerce competitor ID
Country Code
Page number
E-commerce Competitor Prices
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"name": "The competitor product title",
"url": "https://www.mycompetitor.com/test.html",
"competitor": "mycompetitor.com",
"competitor_id": 80,
"my_price": 7.8,
"price": 8.5,
"promo_price": 7.5,
"currency": "EUR",
"fetched_at": "2018-11-30 11:11:34",
"fetch_status": "FOUND",
"availability": "InStock",
"composite_id": "EAN:123456789010"
}
]
}
importMatchings
Import a list of matchings
Request Example
{
"append_only": "integer",
"matchings": [
{
"ecommerce_competitor_id": 1,
"url": "https://www.mycompetitor.com/test-1.html",
"title": "Test product 1",
"composite_id": "EAN:8001090013019"
}
]
}
Matchings import summary
Response Content-Types: application/json
Response Example (200 OK)
{
"matchings": 100,
"invalid_url": 1,
"invalid_competitor_id": 0,
"invalid_composite_id": 6
}
Catalog List
Matchings list
Page number
It allows to search specific matchings by the matched product's Composite ID
It allows to search matchings of a specific competitor by its ID
It allows to search matchings for a specific url
Matchings list
Response Content-Types: application/json
Response Example (200 OK)
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"matching_id": 30,
"name": "My product",
"status": "ready",
"composite_id": "EAN:12345678901234",
"competitor_url": "https://www.pricefy.io/my-product",
"matching_type": "AUTO",
"competitor_title": "Competitor Product Title",
"competitor_brand": "Competitor Product Brand",
"competitor_picture_url": "https://mycompetitor.com/product-picture.png",
"similarity\"": 99,
"ecommerce_competitor_id": 3
}
]
}
Delete a list of Matchings
Delete a list of matchings
It allows to delete matchings by the matched product's Composite ID
It allows to delete matchings of a specific competitor by its ID
It allows to delete matchings for a specific url
It allows to delete matchings by ID
Generic success response
Response Content-Types: application/json
Response Example (200 OK)
{
"deleted_rows": "integer"
}
Schema Definitions
OkResponse:
- status: integer
-
will be always 1
- message: string
-
Success message
Example
{
"status": "integer",
"message": "string"
}
DeleteResponse:
- deleted_rows: integer
-
the number of actually deleted rows
Example
{
"deleted_rows": "integer"
}
CatalogResponse:
- current_page: integer
-
current page
- from: integer
-
results start offset
- to: integer
-
results end offset
- next_page_url: string
-
next result page url
- prev_page_url: string
-
previous result page url
- path: string
-
page path
- per_page: integer
-
results per page
- data: Product
Example
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"composite_id": "EAN:8015654212114",
"code_type": "EAN",
"code": "8015654212114",
"name": "HIGIENIC*MUT INC 1(EROS)C/F*****",
"picture_url": "",
"cost": 14.02,
"price": 21,
"status": "ready"
}
]
}
CompetitorCatalogResponse:
- current_page: integer
-
current page
- from: integer
-
results start offset
- to: integer
-
results end offset
- next_page_url: string
-
next result page url
- prev_page_url: string
-
previous result page url
- path: string
-
page path
- per_page: integer
-
results per page
- data: CompetitorProduct
Example
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"pictureUrl": "https://www.mycompetitor.com/picture.org",
"title": "The competitor product title",
"brand": "The competitor product brand",
"url": "https://www.mycompetitor.com/test.html",
"price": 8.5,
"currency": "EUR",
"fetched_at": "2018-11-30 11:11:34",
"matching_type": "AUTO",
"matching_similarity": 2,
"account_product_title": "My Product Title",
"account_product_picture_url": "https://my-ecommerce.it/the-picture.png",
"composite_id": "EAN:123456789010"
}
]
}
CompetitorPricesResponse:
- current_page: integer
-
current page
- from: integer
-
results start offset
- to: integer
-
results end offset
- next_page_url: string
-
next result page url
- prev_page_url: string
-
previous result page url
- path: string
-
page path
- per_page: integer
-
results per page
- data: CompetitorPrice
Example
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"name": "The competitor product title",
"url": "https://www.mycompetitor.com/test.html",
"competitor": "mycompetitor.com",
"competitor_id": 80,
"my_price": 7.8,
"price": 8.5,
"promo_price": 7.5,
"currency": "EUR",
"fetched_at": "2018-11-30 11:11:34",
"fetch_status": "FOUND",
"availability": "InStock",
"composite_id": "EAN:123456789010"
}
]
}
MatchingsResponse:
- current_page: integer
-
current page
- from: integer
-
results start offset
- to: integer
-
results end offset
- next_page_url: string
-
next result page url
- prev_page_url: string
-
previous result page url
- path: string
-
page path
- per_page: integer
-
results per page
- data: Matching
Example
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"matching_id": 30,
"name": "My product",
"status": "ready",
"composite_id": "EAN:12345678901234",
"competitor_url": "https://www.pricefy.io/my-product",
"matching_type": "AUTO",
"competitor_title": "Competitor Product Title",
"competitor_brand": "Competitor Product Brand",
"competitor_picture_url": "https://mycompetitor.com/product-picture.png",
"similarity\"": 99,
"ecommerce_competitor_id": 3
}
]
}
DiscoveredCompetitorsAnalysisResponse:
- current_page: integer
-
current page
- from: integer
-
results start offset
- to: integer
-
results end offset
- next_page_url: string
-
next result page url
- prev_page_url: string
-
previous result page url
- path: string
-
page path
- per_page: integer
-
results per page
- data: DiscoveredCompetitorsAnalysisData
Example
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"domain": "022.org",
"urls": 1,
"monitoring": 0,
"date_found": "2018-03-13",
"fraud": 0
}
]
}
DiscoveredCompetitorAnalysisResponse:
- current_page: integer
-
current page
- from: integer
-
results start offset
- to: integer
-
results end offset
- next_page_url: string
-
next result page url
- prev_page_url: string
-
previous result page url
- path: string
-
page path
- per_page: integer
-
results per page
- data: DiscoveredCompetitorAnalysisData
Example
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"keyword": "KERN e figlio conteggio, 1 pezzi, CPB 15 K0.2 N",
"url": "http://www.022.org/abeplusplus/gm/archives/00000109.html",
"last_check": "2018-03-13",
"serp": 16
}
]
}
CompetitorsAnalysisResponse:
- current_page: integer
-
current page
- from: integer
-
results start offset
- to: integer
-
results end offset
- next_page_url: string
-
next result page url
- prev_page_url: string
-
previous result page url
- path: string
-
page path
- per_page: integer
-
results per page
- data: CompetitorsAnalysisData
Example
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"name": "Farmacosmo",
"competitor_id": 11,
"type": "Amazon",
"rating": 0,
"products_match": 31,
"catalog_similarity": 46
}
]
}
CompetitorAnalysisResponse:
- current_page: integer
-
current page
- from: integer
-
results start offset
- to: integer
-
results end offset
- next_page_url: string
-
next result page url
- prev_page_url: string
-
previous result page url
- path: string
-
page path
- per_page: integer
-
results per page
- data: CompetitorAnalysisData
Example
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "Plasmon Stelline Pasta (340g)",
"pricefy_id": "EAN:8001040012352",
"code_type": "EAN",
"code": "8001040012352",
"price": 4.35,
"my_price": 2.39,
"price_diff": 82.01
}
]
}
MarketplaceAnalysisResponse:
- current_page: integer
-
current page
- from: integer
-
results start offset
- to: integer
-
results end offset
- next_page_url: string
-
next result page url
- prev_page_url: string
-
previous result page url
- path: string
-
page path
- per_page: integer
-
results per page
- data: MarketplaceAnalysisData
Example
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "APROTEN ANELLINI 500G",
"pricefy_id": "EAN:8001040079034",
"code_type": "EAN",
"code": "8001040079034",
"cost": 8.6,
"min_price": 9.57,
"avg_price": 9.57,
"max_price": 9.57,
"min_markup": 11.28,
"avg_markup": 11.28,
"max_markup": 11.28
}
]
}
PriceAnalysisResponse:
- current_page: integer
-
current page
- from: integer
-
results start offset
- to: integer
-
results end offset
- next_page_url: string
-
next result page url
- prev_page_url: string
-
previous result page url
- path: string
-
page path
- per_page: integer
-
results per page
- data: PriceAnalysisData
Example
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "BENDA ELASTOMULL 4X400CM",
"code_type": "EAN",
"code": "4042809022421",
"price": 2.64,
"amazon_price": 0.59,
"ebay_price": 0,
"min_price": 0.59,
"avg_price": 10.44,
"max_price": 21,
"min_diff": -77.65,
"avg_diff": 295.55,
"max_diff": 695.45
}
]
}
ProductAnalysisResponse:
- name: string
-
Competitor name
- url: string
-
Competitor product url (available for ecommerce competitors only)
- competitor_id: integer
-
Competitor numerical ID
- type: string
-
competitor type: ebay, amazon or ecommerce
- competitor_price: number
-
competitor price
- competitor_base_price: number
-
competitor price without discount
- my_price: number
-
Account catalog price
- price_diff: number
-
Difference between catalog price and competitor price
- availability: string
-
Product availability (available for ecommerce competitors only)
- fetch_status: string
-
Status of url checking: FOUND, NOT_FOUND, ERROR (available for ecommerce competitors only)
- similarity: number
-
similarity with catalog's product (available for ecommerce competitors only)
Example
{
"name": "Frauenland Apotheke",
"competitor_id": 175,
"type": "Amazon",
"competitor_price": 16.77,
"my_price": 2.64,
"price_diff": 535
}
OpportunitiesAnalysisResponse:
- current_page: integer
-
current page
- from: integer
-
results start offset
- to: integer
-
results end offset
- next_page_url: string
-
next result page url
- prev_page_url: string
-
previous result page url
- path: string
-
page path
- per_page: integer
-
results per page
- data: OpportunitiesAnalysisData
Example
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"asin": "B0744CM8CP",
"title": "Batman batarang Spinner, the dark knight spinner, Justice league collectible, Fidget Spinner, plastic, Anti Stress Toys",
"demand": "High",
"rating": 0,
"price": 13.07,
"position": 92,
"last_position": 0,
"woc": 0
}
]
}
CatalogAnalysisResponse:
- current_page: integer
-
current page
- from: integer
-
results start offset
- to: integer
-
results end offset
- next_page_url: string
-
next result page url
- prev_page_url: string
-
previous result page url
- path: string
-
page path
- per_page: integer
-
results per page
- data: CatalogAnalysisData
Example
{
"current_page": "integer",
"from": "integer",
"to": "integer",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string",
"per_page": "integer",
"data": [
{
"product": "BENDA ELASTOMULL 4X400CM",
"pricefy_id": "EAN:4042809022421",
"code_type": "EAN",
"code": "4042809022421",
"competitors": 4,
"demand": "Low",
"competition": "Medium",
"rating": 0,
"cost": 1.91,
"min_price": 0.59,
"avg_price": 10.44,
"max_price": 21,
"min_markup": -69.11,
"avg_markup": 446.73,
"max_markup": 999.48
}
]
}
EcommerceCompetitor:
- id: integer
-
E-commerce competitor ID
- website_id: integer
-
E-commerce website ID
- domain: string
-
E-commerce website domain
- url_count: integer
-
E-commerce website detected urls (only for auto-detectings)
Example
{
"id": 1,
"website_id": 399,
"domain": "https://www.my-competitor.com",
"url_count": 520856
}
ImportSummary:
- imported: integer
-
imported products
- skipped: integer
-
skipped products (due to validation failure)
- missing_barcode: integer
-
skipped products due to missing EAN and UPC
- invalid_barcode: integer
-
skipped products due to invalid barcode (EAN or UPC)
Example
{
"total": 1,
"skipped": 1,
"imported": 0,
"missing_barcode": 1,
"invalid_barcode": 0
}
MatchingsImportSummary:
- matchings: integer
-
submitted matchings
- invalid_url: integer
-
number of skipped matchings for invalid url value
- invalid_competitor_id: integer
-
number of skipped matchings for invalid ecommerce_competitor_id value
- invalid_composite_id: integer
-
skipped products due to invalid composite_id
Example
{
"matchings": 100,
"invalid_url": 1,
"invalid_competitor_id": 0,
"invalid_composite_id": 6
}
AmazonCategory:
- id: string
-
Amazon Category ID
- name: string
-
Amazon Category Name
Example
{
"id": "string",
"name": "string"
}
ProductData:
- name: string
-
product name
- price: number
-
your price
- tax_value: integer
-
tax percentage
- map: number
-
minimum advertised price
- sku: string
-
product SKU
- brand: string
-
product Brand
- ean: string
-
product EAN.
- upc: string
-
product UPC.
- picture_url: string
-
product picture url
- status: string
-
any of ready, suspended, or deleted
Example
{
"name": "Test",
"price": 10,
"sku": "test1234",
"ean": "1234567812",
"status": "ready"
}
CompetitorProduct:
- title: string
-
competitor product title
- url: string
-
competitor product url
- brand: string
-
competitor product brand
- picture_url: string
-
competitor product picture url
- price: number
-
competitor product price
- currency: string
-
competitor product price currency
- fetched_at: string
-
datetime of the last url fetch
- matching_type: string
-
Type of matching (MANUAL or AUTO)
- matching_similarity: number
-
Matching similarity
- account_product_title: string
-
Matched account product title
- account_product_picture_url: string
-
Matched account product picture url
- composite_id: string
-
composite ID of the account product
Example
{
"pictureUrl": "https://www.mycompetitor.com/picture.org",
"title": "The competitor product title",
"brand": "The competitor product brand",
"url": "https://www.mycompetitor.com/test.html",
"price": 8.5,
"currency": "EUR",
"fetched_at": "2018-11-30 11:11:34",
"matching_type": "AUTO",
"matching_similarity": 2,
"account_product_title": "My Product Title",
"account_product_picture_url": "https://my-ecommerce.it/the-picture.png",
"composite_id": "EAN:123456789010"
}
CompetitorPrice:
- name: string
-
competitor product name
- url: string
-
competitor product url
- my_price: number
-
account product price
- price: number
-
competitor product price
- promo_price: number
-
competitor product promo price
- currency: string
-
competitor product price currency
- availability: string
-
competitor product availability (InStock, OutOfStock)
- fetched_at: string
-
datetime of the last url fetch
- fetch_status: string
-
status of last fetch (FOUND, NOT_FOUND or ERROR)
- composite_id: string
-
composite ID of the account product
Example
{
"name": "The competitor product title",
"url": "https://www.mycompetitor.com/test.html",
"competitor": "mycompetitor.com",
"competitor_id": 80,
"my_price": 7.8,
"price": 8.5,
"promo_price": 7.5,
"currency": "EUR",
"fetched_at": "2018-11-30 11:11:34",
"fetch_status": "FOUND",
"availability": "InStock",
"composite_id": "EAN:123456789010"
}
MatchingData:
- title: string
-
competitor product title
- url: string
-
competitor product url
- ecommerce_competitor_id: integer
-
Competitor ID
- composite_id: string
-
Composite ID of the product you want to match the url with
- brand: string
-
competitor product brand
- picture_url: string
-
competitor product picture url
Example
{
"ecommerce_competitor_id": 1,
"url": "https://www.mycompetitor.com/test-1.html",
"title": "Test product 1",
"composite_id": "EAN:8001090013019"
}
CatalogAnalysisData:
Example
{
"product": "BENDA ELASTOMULL 4X400CM",
"pricefy_id": "EAN:4042809022421",
"code_type": "EAN",
"code": "4042809022421",
"competitors": 4,
"demand": "Low",
"competition": "Medium",
"rating": 0,
"cost": 1.91,
"min_price": 0.59,
"avg_price": 10.44,
"max_price": 21,
"min_markup": -69.11,
"avg_markup": 446.73,
"max_markup": 999.48
}
ProductAnalysisData:
Example
{
"name": "Frauenland Apotheke",
"competitor_id": 175,
"type": "Amazon",
"competitor_price": 16.77,
"my_price": 2.64,
"price_diff": 535
}
PriceAnalysisData:
Example
{
"product": "BENDA ELASTOMULL 4X400CM",
"code_type": "EAN",
"code": "4042809022421",
"price": 2.64,
"amazon_price": 0.59,
"ebay_price": 0,
"min_price": 0.59,
"avg_price": 10.44,
"max_price": 21,
"min_diff": -77.65,
"avg_diff": 295.55,
"max_diff": 695.45
}
MarketplaceAnalysisData:
Example
{
"product": "APROTEN ANELLINI 500G",
"pricefy_id": "EAN:8001040079034",
"code_type": "EAN",
"code": "8001040079034",
"cost": 8.6,
"min_price": 9.57,
"avg_price": 9.57,
"max_price": 9.57,
"min_markup": 11.28,
"avg_markup": 11.28,
"max_markup": 11.28
}
CompetitorAnalysisData:
Example
{
"product": "Plasmon Stelline Pasta (340g)",
"pricefy_id": "EAN:8001040012352",
"code_type": "EAN",
"code": "8001040012352",
"price": 4.35,
"my_price": 2.39,
"price_diff": 82.01
}
CompetitorsAnalysisData:
Example
{
"name": "Farmacosmo",
"competitor_id": 11,
"type": "Amazon",
"rating": 0,
"products_match": 31,
"catalog_similarity": 46
}
DiscoveredCompetitorAnalysisData:
Example
{
"keyword": "KERN e figlio conteggio, 1 pezzi, CPB 15 K0.2 N",
"url": "http://www.022.org/abeplusplus/gm/archives/00000109.html",
"last_check": "2018-03-13",
"serp": 16
}
DiscoveredCompetitorsAnalysisData:
Example
{
"domain": "022.org",
"urls": 1,
"monitoring": 0,
"date_found": "2018-03-13",
"fraud": 0
}
OpportunitiesAnalysisData:
Example
{
"asin": "B0744CM8CP",
"title": "Batman batarang Spinner, the dark knight spinner, Justice league collectible, Fidget Spinner, plastic, Anti Stress Toys",
"demand": "High",
"rating": 0,
"price": 13.07,
"position": 92,
"last_position": 0,
"woc": 0
}
Me:
- id: integer
-
account id
- email: string
-
account email
- picture_path: string
-
account picture
- firstname: string
-
first name
- lastname: string
-
last name
- country: string
-
account country
- currency: string
-
currency code, e.g. USD or EUR
- tax_value: integer
-
tax percentage
- country_code: string
-
country ISO code
- zip: string
-
zip code
- address: string
-
street address
- city: string
-
city
- company_name: string
-
company name
- website_name: string
-
website name
- website_type: string
-
website type, e.g, magento, woocommerce, shopify
- phone_prefix: string
-
phone international prefix
- phone: string
-
phone number
- created_at: string
-
creation date
- sources: object[]
- countries: object[]
Example
{
"id": 1,
"email": "accountemail@domain.com",
"picture_path": "https://s3.amazonaws.com/img.pricefy.io/avatar/default_profile_img.png",
"firstname": "Fabrizio",
"lastname": "D'Ammassa",
"country": "",
"currency": "EUR",
"tax_value": 0,
"country_code": "",
"zip": "",
"address": "",
"city": "",
"company_name": "",
"website_name": "",
"website_type": "",
"phone_prefix": "+39",
"phone": "",
"created_at": "2016-11-28T20:59:19.000Z"
}
Product:
- composite_id: string
-
product Composite ID
- code_type: string
-
product code type (e.g. EAN, UPC)
- code: string
-
product code
- name: string
-
product name
- price: number
-
your price
- cost: number
-
your cost
- sku: string
-
product SKU
- brand: string
-
product brand
- picture_url: string
-
product picture url
- status: string
-
any of
ready
,suspended
, ordeleted
Example
{
"composite_id": "EAN:8015654212114",
"code_type": "EAN",
"code": "8015654212114",
"name": "HIGIENIC*MUT INC 1(EROS)C/F*****",
"picture_url": "",
"cost": 14.02,
"price": 21,
"status": "ready"
}
Matching:
- matching_id: integer
-
Matching ID
- name: string
-
product name
- composite_id: string
-
product Composite ID
- status: string
-
any of
ready
,suspended
, ordeleted
- competitor_url: string
-
Competitor product URL
- matching_type: string
-
any of
AUTO
orMANUAL
- competitor_title: string
-
Competitor product title
- competitor_brand: string
-
Competitor product brand
- competitor_picture_url: string
-
Competitor product picture url
- similarity: integer
-
Matching similarity (used by auto matchings only)
- ecommerce_competitor_id: integer
-
Competitor ID
Example
{
"matching_id": 30,
"name": "My product",
"status": "ready",
"composite_id": "EAN:12345678901234",
"competitor_url": "https://www.pricefy.io/my-product",
"matching_type": "AUTO",
"competitor_title": "Competitor Product Title",
"competitor_brand": "Competitor Product Brand",
"competitor_picture_url": "https://mycompetitor.com/product-picture.png",
"similarity\"": 99,
"ecommerce_competitor_id": 3
}