Skip to main content
GET
/
v1
/
scraped-products
List scraped products
curl --request GET \
  --url http://localhost:3000/v1/scraped-products
{
  "products": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "brand": "<string>",
      "description": "<string>",
      "image_url": "<string>",
      "barcode": "<string>",
      "size": "<string>",
      "size_uom": "<string>",
      "is_active": true,
      "full_category_hierarchy": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "sellable_product": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "selling_price": 123,
        "is_active": true
      },
      "has_sellable_product": true,
      "has_description": true,
      "has_image": true,
      "has_size": true,
      "has_barcode": true,
      "has_category": true,
      "has_retailer_mappings": true,
      "has_pricing": true,
      "retailer_mappings_count": 123,
      "pricing_records_count": 123
    }
  ],
  "total": 123
}

Query Parameters

limit
integer
default:25

Number of items to return

Required range: 1 <= x <= 100
Example:

25

offset
integer | null
default:0

Number of items to skip

Required range: x >= 0
Example:

0

Search query

Maximum string length: 200
Example:

"organic milk"

category
string

Category filter

Example:

"Dairy"

subcategory
string

Subcategory filter

Example:

"Milk"

is_active
enum<string>
default:all

Active status filter

Available options:
true,
false,
all
has_sellable
enum<string>
default:all

Has sellable product filter

Available options:
true,
false,
all
has_description
enum<string>
default:all

Has description filter

Available options:
true,
false,
all
has_image
enum<string>
default:all

Has image filter

Available options:
true,
false,
all
has_size
enum<string>
default:all

Has size filter

Available options:
true,
false,
all
has_barcode
enum<string>
default:all

Has barcode filter

Available options:
true,
false,
all
has_category
enum<string>
default:all

Has category filter

Available options:
true,
false,
all
has_retailer_mappings
enum<string>
default:all

Has retailer mappings filter

Available options:
true,
false,
all
has_pricing
enum<string>
default:all

Has pricing filter

Available options:
true,
false,
all

Response

List of scraped products

List scraped products response

products
object[]
required
total
number
required