Search products

ProductStatus

type ProductStatus = 
  | 'active'
	| 'draft'
  | 'archived'

Variant

{
  "id": string,
  "sku": string,
  "item_title": string,
  "origin_country_code": string,
  "taxable": boolean,
}

Product

{
  "id": string,
  "source_product_id": string,
  "status": ProductStatus,
  "title": string,
  "category": string,
  "description": string,
  "created_at": string,
  "updated_at": string,
  "variants": Variant[]
}



SearchRequest Payload

{
  "query": {
    "filters": {
      "status": {
        "in": ProductStatus[]
      },
      "sku": {
        "in": string[]
      },
      "category": {
        "in": string[]
      },
      "created_at": {
        "gte": string,
        "lte": string
      },
      "title": {
        "like": string
      }
    },
    "sort": [
      {
        "field": string,
        "direction": 'desc' | 'asc'
      }
    ],
    "pagination": {
      "page": number,
      "page_size": number
    }
  }
}

Response payload

{
  "data": Product[],
  "meta": {
    "total_items": number,
    "page": number,
    "page_size": number,
    "total_pages": number
  }
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!