# Search for shopify products

Search for products from a given Shopify store

Endpoint: POST /shopify-product-searches
Version: 2.0.0
Security: bearerToken

## Request fields (application/json):

  - `shop` (string, required)
    The shop to search within
    Example: "planto.myshopify.com"

  - `shopifyAccessToken` (string, required)
    An access token obtained for the above Shopify store that will be used to make requests to Shopify with
    Example: "cjuqb_6bp89123d45516c78288f433bd8bc13j"

  - `criterion` (any, required)

  - `pageSize` (integer, required)
    Number of results to include in a page
    Example: 100

  - `cursor` (string,null)
    The position to start the search results from.  Starts from the start if no value provided
    Example: "eyJsYXN0X2lkIjo3MDE3MjQ0MDY1ODQ4LCJsYXN0X3ZhbHVlIjoiNzAxNzI0NDA2NTg0OCJ9"

## Response 200 fields (application/json):

  - `results` (array, required)
    The specified page of Shopify Product resources which match the search criterion

  - `results.result` (object, required)

  - `results.result.id` (string, required)
    The ID of the product in Shopify
    Example: 7693497762034

  - `results.result.title` (string, required)
    The title shown on the product page
    Example: "Sol classic tee"

  - `results.result.handle` (string, required)
    The no-spaces-allowed-but-still-human-readable identifier of the product
    Example: "mens-premium-cotton-tshirt-1"

  - `results.result.media` (array, required)

  - `results.result.media.id` (string, required)
    The ID of the media in Shopify
    Example: 5692493762034

  - `results.result.media.previewUrl` (string,null)
    A URL that provides a preview image of the media
    Example: "https://example.com/preview"

  - `results.result.media.duration` (integer,null)
    The duration of the media in milliseconds, if it has one
    Example: 60000

  - `results.result.skus` (array, required)
    The list of SKUs associated with the product

  - `results.permittedActions` (array, required)

  - `results.permittedActions.resourceType` (string, required)
    Defines the type of the resource that is being permitted to act on
    Enum: "ACCOUNT", "ASSET", "ASSET_SHARES", "ASSETS", "ASSETS_IN_NO_FOLDERS", "CLOUD_CONNECTION", "CLOUD_CONNECTIONS", "COLLECTION", "COLLECTIONS", "COMMENT", "CUSTOM_TERMS_AND_CONDITIONS", "EMAILS", "FIELD_OPTION", "FIELDS", "INDESIGN_EXTENSION", "INTELLIGENCE_SETTINGS", "METADATA_SCHEMA", "PORTALS", "PRESET_SIZES", "REFERRAL", "SAVED_SEARCHES", "SHOPIFY_INTEGRATION_V2", "SUBSCRIPTION", "THEME", "TOP_LEVEL_FIELD_OPTIONS", "USER_GROUPS", "WEB_USAGE"

  - `results.permittedActions.resourceId` (string)
    The ID of the resource that is being permitted to act on.  This may be null if the permission is on the resource type as a whole rather than an individual instance.
    Example: "7af90a8b-7ccd-430f-a85d-e8614015bc47"

  - `results.permittedActions.action` (string, required)
    Defines the action that is being permitted
    Enum: "ADD_ASSET_TO_COLLECTION", "ADD_COLLABORATOR_TO_COLLECTION", "APPROVE_ASSETS", "CONFIGURE_SHOPIFY_INTEGRATION", "CREATE_ASSET_SHARES", "CREATE_ASSETS", "CREATE_CHILD_FIELD_OPTIONS", "CREATE_CLOUD_CONNECTIONS", "CREATE_COLLECTIONS", "CREATE_COLLECTION_COMMENTS", "CREATE_COMMENTS", "CREATE_EMBEDDABLE_LINKS", "CREATE_PORTALS", "CREATE_SAVED_SEARCHES", "CREATE_SUBSCRIPTION", "CREATE_TOP_LEVEL_FIELD_OPTIONS", "CUSTOMISE_EMAILS", "DELETE_ASSET", "DELETE_CLOUD_CONNECTION", "DELETE_COLLECTION", "DELETE_COMMENT", "DOWNLOAD_ASSET", "DOWNLOAD_INDESIGN_EXTENSION", "EDIT_ACCOUNT", "EDIT_ASSET", "EDIT_CLOUD_CONNECTION", "EDIT_COLLECTION", "EDIT_COMMENT", "EDIT_FIELDS", "EDIT_INTELLIGENCE_SETTINGS_ADDRESS_LOOKUP", "EDIT_INTELLIGENCE_SETTINGS_IMAGE_AUTO_TAGGING", "EDIT_INTELLIGENCE_SETTINGS_IMAGE_FACIAL_REC", "EDIT_INTELLIGENCE_SETTINGS_TEXT_IN_IMAGE", "EDIT_INTELLIGENCE_SETTINGS_VIDEO_AUTO_TAGGING", "EDIT_INTELLIGENCE_SETTINGS_VIDEO_FACIAL_REC", "EDIT_METADATA_SCHEMA", "EDIT_PRESET_SIZES", "EDIT_THEME", "EDIT_USER_GROUPS", "EXPORT_TO_SHOPIFY", "IMPORT_ASSETS_OR_METADATA", "IMPORT_FROM_CLOUD", "MAKE_REFERRAL", "MANAGE_CUSTOM_TERMS_AND_CONDITIONS", "PROMOTE_ASSETS_TO_LIVE", "PUT_ASSETS_IN_NO_FOLDER", "REMOVE_ASSET_FROM_COLLECTION", "REMOVE_COLLABORATOR_FROM_COLLECTION", "RUN_NATURAL_LANGUAGE_SEARCH", "SEARCH_FOR_VIEW", "SET_ASSETS_LIFECYCLE_STATUS_BINNED", "SET_ASSETS_LIFECYCLE_STATUS_LIVE", "UPDATE_METADATA_WITH_FIELD_OPTION", "USE_CANVA_INTEGRATION", "USE_CLOUD_CONNECTION", "USE_COLLECTIONS", "USE_EMBEDDABLE_LINKS", "VIEW_ASSET", "VIEW_ASSET_EVENTS", "VIEW_ASSET_FACES", "VIEW_ASSETS_IN_NO_FOLDER", "VIEW_CLOUD_CONNECTION", "VIEW_COLLECTION", "VIEW_COMMENTS", "VIEW_WEB_USAGE"

  - `nextCursor` (string,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 4XX fields (application/json):

  - `timestamp` (string)
    The datetime that the error occurred in ISO offset format
    Example: "2021-02-16T16:21:58.640+00:00"

  - `status` (integer)
    The HTTP status code of the error
    Example: 401

  - `error` (string)
    The title of the error
    Example: "Unauthorized"

  - `message` (string)
    A more detailed error message

  - `path` (string)
    The path that was called which led to the error
    Example: "/folder-settings"