Search for shopify products

Request

Search for products from a given Shopify store

Security

bearerToken

Bodyapplication/jsonrequired

shopstringrequired

The shop to search within

Example:"planto.myshopify.com"

shopifyAccessTokenstringrequired

An access token obtained for the above Shopify store that will be used to make requests to Shopify with

Example:"cjuqb_6bp89123d45516c78288f433bd8bc13j"

criterionanyrequired

pageSizeinteger, [ 0 .. 1000 ]required

The maximum number of items to return in the result set.

Example:100

cursorstring or null

The position to start the search results from. Starts from the start if no value provided

Example:"eyJsYXN0X2lkIjo3MDE3MjQ0MDY1ODQ4LCJsYXN0X3ZhbHVlIjoiNzAxNzI0NDA2NTg0OCJ9"

curl -i -X POST \
  https://api-v2.dash.app/shopify-product-searches \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "shop": "planto.myshopify.com",
    "shopifyAccessToken": "cjuqb_6bp89123d45516c78288f433bd8bc13j",
    "criterion": {
      "type": "FIELD_IN",
      "values": [
        "this",
        "that"
      ],
      "field": "SKU"
    },
    "pageSize": 100,
    "cursor": "eyJsYXN0X2lkIjo3MDE3MjQ0MDY1ODQ4LCJsYXN0X3ZhbHVlIjoiNzAxNzI0NDA2NTg0OCJ9"
  }'

Responses

Success

Bodyapplication/json

resultsArray of objectsrequired

The specified page of Shopify Product resources which match the search criterion

nextCursorstring or null

The cursor to feed back into the next search request to get the next page of results. Null if there are no more results

Example:"eyJsYXN0X2lkIjo3MDE3MjQ0MDY1ODQ4LCJsYXN0X3ZhbHVlIjoiNzAxNzI0NDA2NTg0OCJ9"

Response

{
  "results": [
    { … }
  ],
  "nextCursor": "eyJsYXN0X2lkIjo3MDE3MjQ0MDY1ODQ4LCJsYXN0X3ZhbHVlIjoiNzAxNzI0NDA2NTg0OCJ9"
}