Inbound endpoints

Competitor data endpoints

9min

Quick reference

Verb

Path

Method

POST

/api/v1/competitor_prices/schema/create_schema/

Create competitors schema

POST

/api/v1/competitor_prices/bulk_create_or_update/

Bulk update competitors entries

Define Competitors Schema

Description

With our API, you can easily create or update entries in our Competitor table. This table keeps track of all your competitors data. Before that you need to define the competitors schema.

Shell


Parameters

attributes_config type: list[string], Required



is_dated type: boolean, default: false,Optional

Allow to defined the granularity of competitors data. It corresponds to a subset of the product catalog fields (code, product_attribute_1, product_attribute_X, extension_name_1, extension_name_Y.....). ⚠️ Note that if the product code is specified, then it is not necessary to add any product attributes (product_attribute_1, product_attribute_X, …).

For rental users, this allows to specify a date at which the corresponding item would be rented.



Example

Upon success, the response is 201 and returns

JSON




Loading competitor prices into Pricemoov

Description

With our API, you can easily create or update entries in your competitors table. This table keeps track of all your the prices of your competitors.

Shell


Parameters

code, product_attribute_1, product_attribute_2, product_attribute_X, extension_name_1,extension_name_2, extension_name_Y. type: string, Optional|Required competitor_price type: float, Required competitor_name type: string, Required

departure_date type: date, Optional latest_update type: date|datetime, default: ingestion_date, Optional

Field from Product Catalog defined by competitors schema. Corresponds to the price of the item for the competitor Name of your competitor. For rental users: date at which the item is rented. Format should be yyyy-mm-dd Optional date or datetime at which you recorded this competitor price. If not given, it will be set to the date at which you call this API. Format should be ISO 8601 (e.g. 2023-01-06T09:32:02.788611Z).



Example

Upon success, the response is 201 and returns

JSON