Routes List



HTTP Method GET
URL {{window.location.origin}}/api/download-receipt/{hash}
Controller BillingController
Controller Method @downloadReceipt

Description


REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/countries
Controller HomeController
Controller Method @getCountries

Description


REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/markets
Controller HomeController
Controller Method @getMarkets

Description


REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/billing-plans
Controller HomeController
Controller Method @getBillingPlans

Description


REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/product-fba-calculation
Controller ProductController
Controller Method @getProductFbaCalculation

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin *required String
size:10
2 market *required String
size:2
3 user_id String Nullable
sometimes |

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/reports/{id}/download
Controller ReportController
Controller Method @downloadReport

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/user-profile
Controller UserController
Controller Method @getUserProfile

Description


REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/user-profile/channels
Controller UserController
Controller Method @getUserChannels

Description


REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/user-profile/available-marketplace-seller-ids
Controller UserController
Controller Method @getAvailableMarketplaceSellerIds

Description


REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/dashboard/filters
Controller DashboardController
Controller Method @getFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 user_store_id
StringOrArrayValidationRule
2 user_product_id
StringOrArrayValidationRule
3 brand
StringOrArrayValidationRule
4 market
StringOrArrayValidationRule
5 search String Nullable
6 page Numeric Nullable
7 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/dashboard/product-filter
Controller DashboardController
Controller Method @getProductFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 user_store_id
StringOrArrayValidationRule
2 user_product_id
StringOrArrayValidationRule
3 brand
StringOrArrayValidationRule
4 market
StringOrArrayValidationRule
5 search String Nullable
6 page Numeric Nullable
7 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/dashboard/running-issue-counts
Controller DashboardController
Controller Method @getRunningIssueCounts

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 from_date *required Date
date
2 to_date *required Date
date
3 user_store_id
StringOrArrayValidationRule
4 user_product_id
StringOrArrayValidationRule
5 brand
StringOrArrayValidationRule
6 market
StringOrArrayValidationRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/dashboard/notification-groups
Controller DashboardController
Controller Method @getNotificationGroups

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 from_date *required Date
date
2 to_date *required Date
date
3 user_store_id
StringOrArrayValidationRule
4 user_product_id
StringOrArrayValidationRule
5 brand
StringOrArrayValidationRule
6 market
StringOrArrayValidationRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/dashboard/product-notifications/{id}
Controller DashboardController
Controller Method @getProductNotifications

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 from_date *required Date
date
3 to_date *required Date
date
4 type *required String
5 user_store_id
StringOrArrayValidationRule
6 user_product_id
StringOrArrayValidationRule
7 brand
StringOrArrayValidationRule
8 market
StringOrArrayValidationRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/dashboard/reviews/top-products
Controller DashboardController
Controller Method @getTopProducts

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 from_date *required Date
date
2 to_date *required Date
date
3 user_store_id
StringOrArrayValidationRule
4 user_product_id
StringOrArrayValidationRule
5 brand
StringOrArrayValidationRule
6 market
StringOrArrayValidationRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/dashboard/reviews/chart
Controller DashboardController
Controller Method @getReviewChart

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 from_date *required Date
date
2 to_date *required Date
date
3 user_store_id
StringOrArrayValidationRule
4 user_product_id
StringOrArrayValidationRule
5 brand
StringOrArrayValidationRule
6 market
StringOrArrayValidationRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/adding
Controller ProductController
Controller Method @getAddingProducts

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id
StringOrArrayValidationRule
3 market
StringOrArrayValidationRule
4 parsing_status
ProductStatusRule
5 sort_field String Nullable
SortFieldRule
6 sort_order String Nullable
SortOrderRule
7 page Numeric Nullable
8 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/adding/filters
Controller ProductController
Controller Method @getAddingProductsFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id
StringOrArrayValidationRule
3 market
StringOrArrayValidationRule
4 status
ProductStatusRule
5 search String Nullable
6 page Numeric Nullable
7 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/adding/product-filter
Controller ProductController
Controller Method @getAddingProductsProductFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id
StringOrArrayValidationRule
3 market
StringOrArrayValidationRule
4 status
ProductStatusRule
5 search String Nullable
6 page Numeric Nullable
7 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/shark-guard
Controller ProductController
Controller Method @getSharkGuardProducts

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 market
StringOrArrayValidationRule
3 parsing_status
SharkGuardProductStatusRule
4 page Numeric Nullable
5 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/shark-guard/count
Controller ProductController
Controller Method @getSharkGuardProductsCount

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 market
StringOrArrayValidationRule
3 parsing_status
SharkGuardProductStatusRule
4 page Numeric Nullable
5 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/shark-guard/filters
Controller ProductController
Controller Method @getSharkGuardProductsFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 market
StringOrArrayValidationRule
3 status
SharkGuardProductStatusRule
4 search String Nullable
5 page Numeric Nullable
6 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/shark-guard/product-filter
Controller ProductController
Controller Method @getSharkGuardProductsProductFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 market
StringOrArrayValidationRule
3 status
SharkGuardProductStatusRule
4 search String Nullable
5 page Numeric Nullable
6 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products
Controller ProductController
Controller Method @getProducts

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id String Nullable
3 group_id String Nullable
4 brand
StringOrArrayValidationRule
5 market
StringOrArrayValidationRule
6 search String Nullable
7 is_supported Boolean Nullable
8 reviews_score
StringOrArrayValidationRule
9 badges Array Nullable
10 badges.* *required String
BadgeRule
11 lqs_score Array Nullable
12 lqs_score.* *required String
LqsScoreRule
13 monthly_sales Array Nullable
14 monthly_sales.* *required String
MonthlySalesRule
15 sellers_count Array Nullable
16 sellers_count.* *required String
SellersCountRule
17 listing_status Array Nullable
18 listing_status.* *required String
ListingStatusRule
19 bsr_categories Array Nullable
20 bsr_categories.* *required String
21 notification_types Array Nullable
22 notification_types.* *required String
23 page Numeric Nullable
24 per_page Numeric Nullable
25 reviews_from_date Date Nullable
date |
26 rating_from_date Date Nullable
date |
27 is_include_all_products Boolean Nullable
28 sort_field String Nullable
SortFieldRule
29 sort_order String Nullable
SortOrderRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/table
Controller ProductController
Controller Method @getProductsTable

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id String Nullable
3 group_id String Nullable
4 brand
StringOrArrayValidationRule
5 market
StringOrArrayValidationRule
6 search String Nullable
7 is_supported Boolean Nullable
8 reviews_score
StringOrArrayValidationRule
9 badges Array Nullable
10 badges.* *required String
BadgeRule
11 lqs_score Array Nullable
12 lqs_score.* *required String
LqsScoreRule
13 monthly_sales Array Nullable
14 monthly_sales.* *required String
MonthlySalesRule
15 sellers_count Array Nullable
16 sellers_count.* *required String
SellersCountRule
17 listing_status Array Nullable
18 listing_status.* *required String
ListingStatusRule
19 bsr_categories Array Nullable
20 bsr_categories.* *required String
21 notification_types Array Nullable
22 notification_types.* *required String
23 page Numeric Nullable
24 per_page Numeric Nullable
25 reviews_from_date Date Nullable
date |
26 rating_from_date Date Nullable
date |
27 is_include_all_products Boolean Nullable
28 sort_field String Nullable
SortFieldRule
29 sort_order String Nullable
SortOrderRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/table-product-filter
Controller ProductController
Controller Method @getTableProductFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id
StringOrArrayValidationRule
3 brand
StringOrArrayValidationRule
4 market
StringOrArrayValidationRule
5 reviews_score
StringOrArrayValidationRule
6 group_id String Nullable
7 badges Array Nullable
8 badges.* *required String
BadgeRule
9 lqs_score Array Nullable
10 lqs_score.* *required String
LqsScoreRule
11 monthly_sales Array Nullable
12 monthly_sales.* *required String
MonthlySalesRule
13 sellers_count Array Nullable
14 sellers_count.* *required String
SellersCountRule
15 listing_status Array Nullable
16 listing_status.* *required String
ListingStatusRule
17 bsr_categories Array Nullable
18 bsr_categories.* *required String
19 notification_types Array Nullable
20 notification_types.* *required String
21 search String Nullable
22 page Numeric Nullable
23 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/buy-box-tracker
Controller ProductController
Controller Method @getBuyBoxTrackerProducts

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id String Nullable
3 group_id String Nullable
4 brand String Nullable
5 market
StringOrArrayValidationRule
6 search String Nullable
7 reviews_score
StringOrArrayValidationRule
8 badges Array Nullable
9 badges.* *required String
BadgeRule
10 listing_status Array Nullable
11 listing_status.* *required String
ListingStatusRule
12 buy_box_percent Array Nullable
13 buy_box_percent.* *required String
BuyBoxPercentRule
14 from_date *required Date
date
15 to_date *required Date
date
16 page Numeric Nullable
17 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/buy-box-tracker-filters
Controller ProductController
Controller Method @getBuyBoxTrackerFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id String Nullable
3 group_id String Nullable
4 brand String Nullable
5 market
StringOrArrayValidationRule
6 search String Nullable
7 reviews_score
StringOrArrayValidationRule
8 badges Array Nullable
9 badges.* *required String
BadgeRule
10 listing_status Array Nullable
11 listing_status.* *required String
ListingStatusRule
12 buy_box_percent Array Nullable
13 buy_box_percent.* *required String
BuyBoxPercentRule
14 from_date *required Date
date
15 to_date *required Date
date
16 page Numeric Nullable
17 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/buy-box-tracker-products-filter
Controller ProductController
Controller Method @getBuyBoxTrackerProductFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id String Nullable
3 group_id String Nullable
4 brand String Nullable
5 market
StringOrArrayValidationRule
6 search String Nullable
7 reviews_score
StringOrArrayValidationRule
8 badges Array Nullable
9 badges.* *required String
BadgeRule
10 listing_status Array Nullable
11 listing_status.* *required String
ListingStatusRule
12 buy_box_percent Array Nullable
13 buy_box_percent.* *required String
BuyBoxPercentRule
14 from_date *required Date
date
15 to_date *required Date
date
16 page Numeric Nullable
17 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/export-buybox-history
Controller ProductController
Controller Method @exportProductsBuyBoxHistory

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 type *required String
in:csv,xlsx
2 user_product_ids Array Nullable
3 user_product_ids.* String
4 asin
StringOrArrayValidationRule
5 user_store_id String Nullable
6 group_id String Nullable
7 brand String Nullable
8 market
StringOrArrayValidationRule
9 search String Nullable
10 reviews_score
StringOrArrayValidationRule
11 badges Array Nullable
12 badges.* *required String
BadgeRule
13 listing_status Array Nullable
14 listing_status.* *required String
ListingStatusRule
15 buy_box_percent Array Nullable
16 buy_box_percent.* *required String
BuyBoxPercentRule
17 bsr_categories Array Nullable
18 bsr_categories.* *required String
19 notification_types Array Nullable
20 notification_types.* *required String
21 from_date *required Date
date
22 to_date *required Date
date

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/export
Controller ProductController
Controller Method @exportProducts

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 ids Array Nullable
2 ids.* *required String
3 asin
StringOrArrayValidationRule
4 user_store_id String Nullable
5 group_id String Nullable
6 type *required String
in:csv,xlsx
7 brand String Nullable
8 market
StringOrArrayValidationRule
9 search String Nullable
10 is_supported Boolean Nullable
11 reviews_score
StringOrArrayValidationRule
12 badges Array Nullable
13 badges.* *required String
BadgeRule
14 sellers_count Array Nullable
15 sellers_count.* *required String
SellersCountRule
16 listing_status Array Nullable
17 listing_status.* *required String
ListingStatusRule
18 bsr_categories Array Nullable
19 bsr_categories.* *required String
20 notification_types Array Nullable
21 notification_types.* *required String
22 sort_field String Nullable
SortFieldRule
23 sort_order String Nullable
SortOrderRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/export-price-history
Controller ProductController
Controller Method @exportProductsPriceHistory

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 from_date *required Date
date
2 to_date *required Date
date
3 type *required String
in:csv,xlsx

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/filters
Controller ProductController
Controller Method @getFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id
StringOrArrayValidationRule
3 brand
StringOrArrayValidationRule
4 market
StringOrArrayValidationRule
5 reviews_score
StringOrArrayValidationRule
6 group_id String Nullable
7 badges Array Nullable
8 badges.* *required String
BadgeRule
9 lqs_score Array Nullable
10 lqs_score.* *required String
LqsScoreRule
11 monthly_sales Array Nullable
12 monthly_sales.* *required String
MonthlySalesRule
13 sellers_count Array Nullable
14 sellers_count.* *required String
SellersCountRule
15 listing_status Array Nullable
16 listing_status.* *required String
ListingStatusRule
17 bsr_categories Array Nullable
18 bsr_categories.* *required String
19 notification_types Array Nullable
20 notification_types.* *required String
21 search String Nullable
22 page Numeric Nullable
23 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/product-filter
Controller ProductController
Controller Method @getProductFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id
StringOrArrayValidationRule
3 brand
StringOrArrayValidationRule
4 market
StringOrArrayValidationRule
5 reviews_score
StringOrArrayValidationRule
6 group_id String Nullable
7 badges Array Nullable
8 badges.* *required String
BadgeRule
9 lqs_score Array Nullable
10 lqs_score.* *required String
LqsScoreRule
11 monthly_sales Array Nullable
12 monthly_sales.* *required String
MonthlySalesRule
13 sellers_count Array Nullable
14 sellers_count.* *required String
SellersCountRule
15 listing_status Array Nullable
16 listing_status.* *required String
ListingStatusRule
17 bsr_categories Array Nullable
18 bsr_categories.* *required String
19 notification_types Array Nullable
20 notification_types.* *required String
21 search String Nullable
22 page Numeric Nullable
23 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/search-similar
Controller ProductController
Controller Method @searchSimilarProducts

Description


REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/fba-calculations-history
Controller ProductController
Controller Method @getFbaCalculationsHistory

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 page Numeric Nullable
2 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/groups
Controller ProductController
Controller Method @getGroups

Description


REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}
Controller ProductController
Controller Method @getProduct

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
required_without_all:market,asin |
2 market *required String
required_with:asin | size:2
3 asin *required String
required_with:market |

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{market}/{asin}
Controller ProductController
Controller Method @getProduct

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
required_without_all:market,asin |
2 market *required String
required_with:asin | size:2
3 asin *required String
required_with:market |

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/historical-activity
Controller ProductController
Controller Method @getHistoricalActivity

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 from_date *required Date
date
3 to_date *required Date
date

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/historical-activity-events
Controller ProductController
Controller Method @getHistoricalActivityEvents

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 from_date *required Date
date
3 to_date *required Date
date
4 groups *required Array
min:1
5 groups.* String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/keywords
Controller ProductController
Controller Method @getProductKeywords

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/get-recommended-competitors
Controller ProductController
Controller Method @getRecommendedCompetitors

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/review-analysis
Controller ProductController
Controller Method @getReviewAnalysis

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/history
Controller ProductController
Controller Method @getProductHistory

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 fields *required Array
min:1
3 fields.* String
in:buy_price,sellers_count,reviews_score,reviews_number,reviews_number_diff,one_tap_reviews_number_diff
4 from_date *required Date
date

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/bsr-history
Controller ProductController
Controller Method @getBsrProductHistory

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 from_date *required Date
date

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/sellers
Controller ProductController
Controller Method @getProductSellers

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 from_date *required Date
date
2 to_date *required Date
date

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/sellers-history
Controller ProductController
Controller Method @getProductSellersHistory

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 from_date *required Date
date

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/buybox-history
Controller ProductController
Controller Method @getProductBuyBoxHistory

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 from_date *required Date
date
2 to_date *required Date
date

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/price-history
Controller ProductController
Controller Method @getProductPriceHistory

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 from_date *required Date
date
3 to_date *required Date
date

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/export-price-history
Controller ProductController
Controller Method @exportProductPriceHistory

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 from_date *required Date
date
3 to_date *required Date
date
4 type *required String
in:csv,xlsx

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/export-buybox-history
Controller ProductController
Controller Method @exportProductBuyBoxHistory

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 from_date *required Date
date
2 to_date *required Date
date
3 type *required String
in:csv,xlsx

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/products/{id}/export-sellers
Controller ProductController
Controller Method @exportProductSellers

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 from_date *required Date
date
2 type *required String
in:csv,xlsx

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/competitors
Controller CompetitorController
Controller Method @getCompetitors

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id String Nullable
3 brand String Nullable
4 market
StringOrArrayValidationRule
5 search String Nullable
6 reviews_score
StringOrArrayValidationRule
7 badges Array Nullable
8 badges.* *required String
BadgeRule
9 page Numeric Nullable
10 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/competitors/filters
Controller CompetitorController
Controller Method @getFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id String Nullable
3 brand String Nullable
4 market
StringOrArrayValidationRule
5 reviews_score
StringOrArrayValidationRule
6 badges Array Nullable
7 badges.* *required String
BadgeRule
8 search String Nullable
9 page Numeric Nullable
10 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/competitors/product-filter
Controller CompetitorController
Controller Method @getProductFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id String Nullable
3 brand String Nullable
4 market
StringOrArrayValidationRule
5 reviews_score
StringOrArrayValidationRule
6 badges Array Nullable
7 badges.* *required String
BadgeRule
8 search String Nullable
9 page Numeric Nullable
10 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/competitors/export
Controller CompetitorController
Controller Method @exportCompetitors

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 ids Array Nullable
2 ids.* *required String
3 type *required String
in:csv,xlsx
4 asin
StringOrArrayValidationRule
5 user_store_id String Nullable
6 brand String Nullable
7 market
StringOrArrayValidationRule
8 search String Nullable
9 reviews_score
StringOrArrayValidationRule
10 badges Array Nullable
11 badges.* *required String
BadgeRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/competitors/{id}/comparison-details
Controller CompetitorController
Controller Method @getProductDetailsForComparison

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 competing_id *required String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/stores
Controller StoreController
Controller Method @getStores

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 search String Nullable
3 market
StringOrArrayValidationRule
4 page Numeric Nullable
5 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/stores/filters
Controller StoreController
Controller Method @getStoresFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 market
StringOrArrayValidationRule
3 page Numeric Nullable
4 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/stores/store-filter
Controller StoreController
Controller Method @getStoreFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 search String Nullable
3 market
StringOrArrayValidationRule
4 page Numeric Nullable
5 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/stores/{id}
Controller StoreController
Controller Method @getStoreDetails

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/reviews
Controller ReviewController
Controller Method @getReviews

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 group_id String Nullable
3 id_to_ignore String Nullable
4 search String Nullable
5 market
StringOrArrayValidationRule
6 brand String Nullable
7 user_product_id
StringOrArrayValidationRule
8 user_store_id String Nullable
9 competitor_of_user_product_id
StringOrArrayValidationRule
10 scores Array Nullable
11 scores.* *required Numeric
12 is_only_deleted Boolean Nullable
13 is_only_top Boolean Nullable
14 is_only_vine Boolean Nullable
15 is_only_image_reviews Boolean Nullable
16 is_review_verified Boolean Nullable
17 sex String Nullable
ReviewSexRule
18 reviewer_profile String Nullable
19 from_date Date Nullable
date |
20 to_date Date Nullable
date |
21 sort_field String Nullable
SortFieldRule
22 sort_order String Nullable
SortOrderRule
23 page Numeric Nullable
24 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/reviews/export
Controller ReviewController
Controller Method @exportReviews

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 group_id String Nullable
3 id_to_ignore String Nullable
4 from_date Date Nullable
date |
5 to_date Date Nullable
date |
6 type *required String
in:csv,xlsx
7 search String Nullable
8 market
StringOrArrayValidationRule
9 brand String Nullable
10 user_product_id
StringOrArrayValidationRule
11 user_store_id String Nullable
12 competitor_of_user_product_id
StringOrArrayValidationRule
13 scores Array Nullable
14 scores.* *required Numeric
15 is_only_deleted Boolean Nullable
16 is_only_top Boolean Nullable
17 is_only_vine Boolean Nullable
18 is_review_verified Boolean Nullable
19 is_only_image_reviews Boolean Nullable
20 sex String Nullable
ReviewSexRule
21 reviewer_profile String Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/reviews/filters
Controller ReviewController
Controller Method @getFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 group_id String Nullable
3 market
StringOrArrayValidationRule
4 brand String Nullable
5 user_product_id
StringOrArrayValidationRule
6 user_store_id String Nullable
7 competitor_of_user_product_id
StringOrArrayValidationRule
8 scores Array Nullable
9 scores.* *required Numeric
10 sex String Nullable
ReviewSexRule
11 is_only_deleted Boolean Nullable
12 is_only_top Boolean Nullable
13 is_only_vine Boolean Nullable
14 is_review_verified Boolean Nullable
15 is_only_image_reviews Boolean Nullable
16 search String Nullable
17 from_date Date Nullable
date |
18 to_date Date Nullable
date |
19 page Numeric Nullable
20 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/reviews/product-filter
Controller ReviewController
Controller Method @getProductFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 group_id String Nullable
3 market
StringOrArrayValidationRule
4 brand String Nullable
5 user_product_id
StringOrArrayValidationRule
6 user_store_id String Nullable
7 competitor_of_user_product_id
StringOrArrayValidationRule
8 scores Array Nullable
9 scores.* *required Numeric
10 sex String Nullable
ReviewSexRule
11 is_only_deleted Boolean Nullable
12 is_only_top Boolean Nullable
13 is_only_vine Boolean Nullable
14 is_review_verified Boolean Nullable
15 is_only_image_reviews Boolean Nullable
16 search String Nullable
17 from_date Date Nullable
date |
18 to_date Date Nullable
date |
19 page Numeric Nullable
20 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/reviews/product-competitors-filter
Controller ReviewController
Controller Method @getProductCompetitorsFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 competitor_of_user_product_id
StringOrArrayValidationRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/reviews/chart
Controller ReviewController
Controller Method @getReviewsChart

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 user_product_id
StringOrArrayValidationRule
2 from_date *required Date
date
3 to_date *required Date
date

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/reviews/keywords
Controller ReviewController
Controller Method @getReviewKeywords

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 user_product_id *required String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords
Controller KeywordController
Controller Method @getKeywords

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 search String Nullable
3 market
StringOrArrayValidationRule
4 brand String Nullable
5 user_product_id
StringOrArrayValidationRule
6 user_store_id String Nullable
7 is_only_amazon_choice Boolean Nullable
8 page Numeric Nullable
9 per_page Numeric Nullable
10 sort_field String Nullable
SortFieldRule
11 sort_order String Nullable
SortOrderRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/relative-positions
Controller KeywordController
Controller Method @getRelativePositions

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 search String Nullable
3 market
StringOrArrayValidationRule
4 brand String Nullable
5 user_product_id
StringOrArrayValidationRule
6 user_store_id String Nullable
7 is_only_amazon_choice Boolean Nullable
8 page Numeric Nullable
9 per_page Numeric Nullable
10 sort_field String Nullable
SortFieldRule
11 sort_order String Nullable
SortOrderRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/filters
Controller KeywordController
Controller Method @getFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 market
StringOrArrayValidationRule
3 brand String Nullable
4 user_product_id
StringOrArrayValidationRule
5 user_store_id String Nullable
6 is_only_amazon_choice Boolean Nullable
7 search String Nullable
8 page Numeric Nullable
9 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/product-filter
Controller KeywordController
Controller Method @getProductFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 market
StringOrArrayValidationRule
3 brand String Nullable
4 user_product_id
StringOrArrayValidationRule
5 user_store_id String Nullable
6 is_only_amazon_choice Boolean Nullable
7 search String Nullable
8 page Numeric Nullable
9 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/general-chart
Controller KeywordController
Controller Method @getGeneralChart

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 from_date *required Date
date
2 to_date *required Date
date
3 user_store_id
StringOrArrayValidationRule
4 user_product_id
StringOrArrayValidationRule
5 brand
StringOrArrayValidationRule
6 market
StringOrArrayValidationRule
7 is_only_amazon_choice Boolean Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/by-products
Controller KeywordController
Controller Method @getKeywordsByProducts

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 user_store_id
StringOrArrayValidationRule
2 brand
StringOrArrayValidationRule
3 market
StringOrArrayValidationRule
4 is_only_amazon_choice Boolean Nullable
5 search String Nullable
6 page Numeric Nullable
7 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/export
Controller KeywordController
Controller Method @exportKeywords

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 type *required String
in:csv,xlsx
2 ids Array Nullable
3 ids.* String
4 search String Nullable
5 market
StringOrArrayValidationRule
6 brand String Nullable
7 user_product_id
StringOrArrayValidationRule
8 user_store_id String Nullable
9 is_only_amazon_choice Boolean Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/export-by-product
Controller KeywordController
Controller Method @exportKeywordsByProduct

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 user_product_id *required String
2 type *required String
in:csv,xlsx

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/export-by-products
Controller KeywordController
Controller Method @exportKeywordsByProducts

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 type *required String
in:csv,xlsx
2 user_product_ids Array Nullable
3 user_product_ids.* String
4 user_store_id
StringOrArrayValidationRule
5 brand
StringOrArrayValidationRule
6 market
StringOrArrayValidationRule
7 is_only_amazon_choice Boolean Nullable
8 search String Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/share-of-voice
Controller KeywordController
Controller Method @getShareOfVoiceBrands

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 tab_type *required String
SovTabTypeRule
2 from_date *required Date
date
3 to_date *required Date
date
4 market *required String
5 keywords Array Nullable
6 keywords.* *required String
7 brands Array Nullable
8 brands.* *required String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/share-of-voice/markets-filter
Controller KeywordController
Controller Method @getShareOfVoiceMarketsFilter

Description


REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/share-of-voice/filters
Controller KeywordController
Controller Method @getShareOfVoiceFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 tab_type *required String
SovTabTypeRule
2 from_date *required Date
date
3 to_date *required Date
date
4 market *required String
5 keywords Array Nullable
6 keywords.* *required String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/{id}/chart
Controller KeywordController
Controller Method @getKeywordChart

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 from_date *required Date
date

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/{id}/history
Controller KeywordController
Controller Method @getKeywordHistory

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 is_ad Boolean

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/keywords/{id}/export
Controller KeywordController
Controller Method @exportKeyword

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 type *required String
in:csv,xlsx

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/notifications
Controller NotificationController
Controller Method @getNotifications

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 group_id String Nullable
3 market
StringOrArrayValidationRule
4 brand String Nullable
5 user_product_id
StringOrArrayValidationRule
6 user_store_id String Nullable
7 competitor_of_user_product_id
StringOrArrayValidationRule
8 types Array Nullable
9 notification_group String Nullable
NotificationGroupRule
10 is_unread Boolean Nullable
11 commented Boolean Nullable
12 from_date Date Nullable
date |
13 to_date Date Nullable
date |
14 page Numeric Nullable
15 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/notifications/export
Controller NotificationController
Controller Method @exportNotifications

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 group_id String Nullable
3 market
StringOrArrayValidationRule
4 brand String Nullable
5 user_product_id
StringOrArrayValidationRule
6 user_store_id String Nullable
7 types Array Nullable
8 is_unread Boolean Nullable
9 from_date Date Nullable
date |
10 to_date Date Nullable
date |
11 type *required String
in:csv,xlsx

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/notifications/filters
Controller NotificationController
Controller Method @getFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 market
StringOrArrayValidationRule
2 group_id String Nullable
3 brand String Nullable
4 user_product_id
StringOrArrayValidationRule
5 user_store_id String Nullable
6 types Array Nullable
7 is_unread Boolean Nullable
8 search String Nullable
9 from_date Date Nullable
date |
10 to_date Date Nullable
date |
11 page Numeric Nullable
12 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/notifications/product-filter
Controller NotificationController
Controller Method @getProductFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 market
StringOrArrayValidationRule
2 group_id String Nullable
3 brand String Nullable
4 user_product_id
StringOrArrayValidationRule
5 user_store_id String Nullable
6 types Array Nullable
7 is_unread Boolean Nullable
8 search String Nullable
9 from_date Date Nullable
date |
10 to_date Date Nullable
date |
11 page Numeric Nullable
12 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/notifications/product-competitors-filter
Controller NotificationController
Controller Method @getProductCompetitorsFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 competitor_of_user_product_id
StringOrArrayValidationRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/notifications/settings
Controller NotificationController
Controller Method @getNotificationSettings

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 group_id *required String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/notifications/unread-count
Controller NotificationController
Controller Method @getUnreadNotificationsCount

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 from_date Date Nullable
date |
2 to_date Date Nullable
date |

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/notifications/{id}
Controller NotificationController
Controller Method @getNotification

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/events
Controller EventController
Controller Method @getEvents

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 group_id String Nullable
3 market
StringOrArrayValidationRule
4 brand String Nullable
5 user_product_id
StringOrArrayValidationRule
6 user_store_id String Nullable
7 competitor_of_user_product_id
StringOrArrayValidationRule
8 types Array Nullable
9 notification_group String Nullable
NotificationGroupRule
10 commented Boolean Nullable
11 from_date Date Nullable
date |
12 to_date Date Nullable
date |
13 page Numeric Nullable
14 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/events/export
Controller EventController
Controller Method @exportEvents

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 group_id String Nullable
3 market
StringOrArrayValidationRule
4 brand String Nullable
5 user_product_id
StringOrArrayValidationRule
6 user_store_id String Nullable
7 types Array Nullable
8 from_date Date Nullable
date |
9 to_date Date Nullable
date |
10 type *required String
in:csv,xlsx

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/events/filters
Controller EventController
Controller Method @getFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 market
StringOrArrayValidationRule
2 group_id String Nullable
3 brand String Nullable
4 user_product_id
StringOrArrayValidationRule
5 user_store_id String Nullable
6 types Array Nullable
7 search String Nullable
8 from_date Date Nullable
date |
9 to_date Date Nullable
date |
10 page Numeric Nullable
11 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/events/product-filter
Controller EventController
Controller Method @getProductFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 market
StringOrArrayValidationRule
2 group_id String Nullable
3 brand String Nullable
4 user_product_id
StringOrArrayValidationRule
5 user_store_id String Nullable
6 types Array Nullable
7 search String Nullable
8 from_date Date Nullable
date |
9 to_date Date Nullable
date |
10 page Numeric Nullable
11 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/events/product-competitors-filter
Controller EventController
Controller Method @getProductCompetitorsFilter

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 competitor_of_user_product_id
StringOrArrayValidationRule

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/events/{id}
Controller EventController
Controller Method @getEvent

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/reports
Controller ReportController
Controller Method @getReports

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 search String Nullable
2 from_date Date Nullable
date |
3 to_date Date Nullable
date |
4 type String Nullable
ReportTypeRule
5 page Numeric Nullable
6 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method GET
URL {{window.location.origin}}/api/reports/filters
Controller ReportController
Controller Method @getFilters

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 search String Nullable
2 from_date Date Nullable
date |
3 to_date Date Nullable
date |
4 type String Nullable
ReportTypeRule
5 page Numeric Nullable
6 per_page Numeric Nullable

REQUEST URL *required

Enter your request URL with query params



RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/user-profile/channels

HTTP Method POST
URL {{window.location.origin}}/api/user-profile/channels
Controller UserController
Controller Method @createUserChannel

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 channel *required String
2 notify_period *required String
in:IMMEDIATELY,DAY,WEEK,OFF
3 destination *required String
max:255
4 time String Nullable
regex:/^[0-9]{2}:[0-9]{2}:[0-9]{2}$/
5 timezone *required
TimezoneRule
6 file_export_format String Nullable
in:csv,xlsx
7 is_send_immediately *required Boolean
8 is_muted *required Boolean
9 is_send_by_notification_types *required Boolean
10 notification_types Array Nullable
11 notification_types.* *required String
12 group_ids Array Nullable
13 group_ids.* *required String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/user-profile/account-sharings

HTTP Method POST
URL {{window.location.origin}}/api/user-profile/account-sharings
Controller UserController
Controller Method @createUserAccountSharing

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 email *required
email

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/products/shark-guard/all-found-shark-guard

HTTP Method POST
URL {{window.location.origin}}/api/products/shark-guard/all-found-shark-guard
Controller ProductController
Controller Method @addAllFoundSharkGuardProducts

Description


REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/products

HTTP Method POST
URL {{window.location.origin}}/api/products
Controller ProductController
Controller Method @addProduct

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 user_product_group_id String Nullable
present |
2 products *required Array
3 add_all_variations Boolean

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/products/add-all-found-products-from-import-overview

HTTP Method POST
URL {{window.location.origin}}/api/products/add-all-found-products-from-import-overview
Controller ProductController
Controller Method @addAllFoundProductsFromImportOverview

Description


REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/products/with-competitors

HTTP Method POST
URL {{window.location.origin}}/api/products/with-competitors
Controller ProductController
Controller Method @addProductWithCompetitors

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin *required String
2 market *required String
3 competitors Array
min:1
4 competitors.* String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/products/with-keywords

HTTP Method POST
URL {{window.location.origin}}/api/products/with-keywords
Controller ProductController
Controller Method @addProductWithKeywords

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin *required String
2 market
StringOrArrayValidationRule
3 keywords Array
min:1
4 keywords.* String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/products/import-with-keywords

HTTP Method POST
URL {{window.location.origin}}/api/products/import-with-keywords
Controller ProductController
Controller Method @importProductsWithKeywords

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 file *required
max:51200

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/products/import-with-competitors

HTTP Method POST
URL {{window.location.origin}}/api/products/import-with-competitors
Controller ProductController
Controller Method @importProductsWithCompetitors

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 file *required
max:51200

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/products/get-recommended-keywords

HTTP Method POST
URL {{window.location.origin}}/api/products/get-recommended-keywords
Controller ProductController
Controller Method @getRecommendedKeywords

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 * *required String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/products/groups

HTTP Method POST
URL {{window.location.origin}}/api/products/groups
Controller ProductController
Controller Method @createGroup

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 name *required String
2 ids Array Nullable
3 ids.* *required String
4 asin
StringOrArrayValidationRule
5 user_store_id String Nullable
6 brand String Nullable
7 market
StringOrArrayValidationRule
8 search String Nullable
9 is_supported Boolean Nullable
10 reviews_score
StringOrArrayValidationRule
11 badges Array Nullable
12 badges.* *required String
BadgeRule
13 bsr_categories Array Nullable
14 bsr_categories.* *required String
15 notification_types Array Nullable
16 notification_types.* *required String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/competitors

HTTP Method POST
URL {{window.location.origin}}/api/competitors
Controller CompetitorController
Controller Method @addCompetitor

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 competitor_user_product_id *required
StringOrArrayValidationRule
2 asins *required Array
3 asins.* *required String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/stores

HTTP Method POST
URL {{window.location.origin}}/api/stores
Controller StoreController
Controller Method @addStores

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 * *required Array
2 *.* *required String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/keywords

HTTP Method POST
URL {{window.location.origin}}/api/keywords
Controller KeywordController
Controller Method @addKeywords

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 user_product_id *required
StringOrArrayValidationRule
2 keywords Array
min:1
3 keywords.* String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/notifications/{id}/comment

HTTP Method POST
URL {{window.location.origin}}/api/notifications/{id}/comment
Controller NotificationController
Controller Method @addComment

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 text *required String
max:1000

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

POST api/events/{id}/comment

HTTP Method POST
URL {{window.location.origin}}/api/events/{id}/comment
Controller EventController
Controller Method @addComment

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 text *required String
max:1000

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PUT
URL {{window.location.origin}}/api/user-profile/channels/{id}
Controller UserController
Controller Method @updateUserChannel

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 channel *required String
3 notify_period *required String
in:IMMEDIATELY,DAY,WEEK,OFF
4 destination *required String
max:255
5 time String Nullable
regex:/^[0-9]{2}:[0-9]{2}:[0-9]{2}$/
6 timezone *required
TimezoneRule
7 file_export_format String Nullable
in:csv,xlsx
8 is_send_immediately *required Boolean
9 is_muted *required Boolean
10 is_send_by_notification_types *required Boolean
11 notification_types Array Nullable
12 notification_types.* *required String
13 group_ids Array Nullable
14 group_ids.* *required String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PUT
URL {{window.location.origin}}/api/user-profile/marketplace-seller-ids
Controller UserController
Controller Method @updateMarketplaceSellerIds

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 * *required Array
2 *.* *required String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PUT
URL {{window.location.origin}}/api/user-profile/exclude-marketplace-seller-ids
Controller UserController
Controller Method @updateExcludeMarketplaceSellerIds

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 * *required Array
2 *.* *required String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PUT
URL {{window.location.origin}}/api/user-profile/frontend-visual-settings
Controller UserController
Controller Method @updateFrontendVisualSettings

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 * *required Array

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PATCH
URL {{window.location.origin}}/api/user-profile/activate-shark-guard
Controller UserController
Controller Method @activateSharkGuard

Description


REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PATCH
URL {{window.location.origin}}/api/user-profile/deactivate-shark-guard
Controller UserController
Controller Method @deactivateSharkGuard

Description


REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PATCH
URL {{window.location.origin}}/api/products/title
Controller ProductController
Controller Method @updateProductTitle

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 title *required String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PATCH
URL {{window.location.origin}}/api/products/groups/{id}/items
Controller ProductController
Controller Method @addProductsToGroup

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 ids Array Nullable
3 ids.* *required String
4 asin
StringOrArrayValidationRule
5 user_store_id String Nullable
6 brand String Nullable
7 market
StringOrArrayValidationRule
8 search String Nullable
9 is_supported Boolean Nullable
10 reviews_score
StringOrArrayValidationRule
11 badges Array Nullable
12 badges.* *required String
BadgeRule
13 bsr_categories Array Nullable
14 bsr_categories.* *required String
15 notification_types Array Nullable
16 notification_types.* *required String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PATCH
URL {{window.location.origin}}/api/stores/{id}/adding-new-products
Controller StoreController
Controller Method @updateStoreAddingNewProducts

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 is_add *required Boolean

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PATCH
URL {{window.location.origin}}/api/keywords/{id}/favorite
Controller KeywordController
Controller Method @markKeywordAsFavorite

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 is_favorite *required Boolean

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PATCH
URL {{window.location.origin}}/api/notifications
Controller NotificationController
Controller Method @updateNotificationSettings

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 group_id *required String
2 channel_type *required String
ChannelTypeRule
3 field_name *required String
4 field_value *required Boolean

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PATCH
URL {{window.location.origin}}/api/notifications/inner-settings
Controller NotificationController
Controller Method @updateInnerNotificationSettings

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 group_id *required String
2 field_name *required String
3 field_value *required

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PATCH
URL {{window.location.origin}}/api/notifications/read-all
Controller NotificationController
Controller Method @markAllNotificationsAsRead

Description


REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method PATCH
URL {{window.location.origin}}/api/notifications/{id}/read
Controller NotificationController
Controller Method @markNotificationAsRead

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id String Nullable
2 is_read *required Boolean

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method DELETE
URL {{window.location.origin}}/api/user-profile/channels/{id}
Controller UserController
Controller Method @deleteUserChannel

Description


REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method DELETE
URL {{window.location.origin}}/api/user-profile/account-sharings
Controller UserController
Controller Method @deleteUserAccountSharing

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 email *required
email

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

DELETE api/products

HTTP Method DELETE
URL {{window.location.origin}}/api/products
Controller ProductController
Controller Method @deleteProducts

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 ids Array Nullable
2 ids.* *required String
3 asin
StringOrArrayValidationRule
4 user_store_id String Nullable
5 brand String Nullable
6 market
StringOrArrayValidationRule
7 search String Nullable
8 is_supported Boolean Nullable
9 reviews_score
StringOrArrayValidationRule
10 badges Array Nullable
11 badges.* *required String
BadgeRule

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method DELETE
URL {{window.location.origin}}/api/products/all-adding
Controller ProductController
Controller Method @deleteAllAddingProducts

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 asin
StringOrArrayValidationRule
2 user_store_id
StringOrArrayValidationRule
3 market
StringOrArrayValidationRule
4 parsing_status
ProductStatusRule

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method DELETE
URL {{window.location.origin}}/api/products/fba-calculations-history
Controller ProductController
Controller Method @clearFbaCalculationsHistory

Description


REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method DELETE
URL {{window.location.origin}}/api/products/groups/{id}/items
Controller ProductController
Controller Method @deleteProductsFromGroup

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String
2 ids *required Array
3 ids.* *required String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method DELETE
URL {{window.location.origin}}/api/products/groups/{id}
Controller ProductController
Controller Method @deleteGroup

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 id *required String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method DELETE
URL {{window.location.origin}}/api/competitors
Controller CompetitorController
Controller Method @deleteCompetitors

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 ids Array Nullable
2 ids.* *required String
3 asin
StringOrArrayValidationRule
4 user_store_id String Nullable
5 brand String Nullable
6 market
StringOrArrayValidationRule
7 search String Nullable
8 reviews_score
StringOrArrayValidationRule
9 badges Array Nullable
10 badges.* *required String
BadgeRule

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

DELETE api/stores

HTTP Method DELETE
URL {{window.location.origin}}/api/stores
Controller StoreController
Controller Method @deleteStores

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 is_remove_with_products *required Boolean
2 user_store_ids *required Array
min:1
3 user_store_ids.* String

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

DELETE api/keywords

HTTP Method DELETE
URL {{window.location.origin}}/api/keywords
Controller KeywordController
Controller Method @deleteKeywords

Description


Attributes


No. Attributes Type Nullable Bail Rules
1 ids Array Nullable
2 ids.* *required String
3 search String Nullable
4 market
StringOrArrayValidationRule
5 brand String Nullable
6 user_product_id
StringOrArrayValidationRule
7 user_store_id String Nullable
8 is_only_amazon_choice Boolean Nullable

REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method DELETE
URL {{window.location.origin}}/api/notifications/comment/{id}
Controller NotificationController
Controller Method @deleteComment

Description


REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms

HTTP Method DELETE
URL {{window.location.origin}}/api/events/comment/{id}
Controller EventController
Controller Method @deleteComment

Description


REQUEST URL *required

Enter your request URL with query params


REQUEST BODY *required

JSON body for the POST|PUT|DELETE request


RESPONSE

Response status, code and time.

Status SUCCESS ERROR
Status Code
Memory Usage
Response Time

Response headers.

Response from the server

SQL

No SQL queries executed for this request.

SQL queries executed for this request.

Total Queries
Total Query time ms

SQL queries

{{index+1}}. {{query.time}}ms