# Simile API - Public

Welcome to Simile's API. Here are some pre-made requests for you to explore the API using Postman.

# API Keys

You'll need your API keys, so contact support@scopemedia.com if you don't have them. There is a client_id/client_secret key for your store. Think of your client_secret key like a password: Store it securely

  • Don't share it with anyone outside of your organization
  • Don't put it in any code on your website or in a Url that someone could find

# Setup

Before you want to use our apis, you need contact support@scopemedia.com to create a store and sync your products to scopemedia's platform

# APIs

# Simile|Similar Upsell

Increase Sales with Automated AI Recommendations

# POST Get similar product suggestions

https://api.scopemedia.com/simile/v2/search

By default max 20 products will be returned. Append parameter "size=40" on the url can increase the return products to maximum 40.

HEADERS

Content-Type application/json
Client-Id {your-client-id}
Client-Secret {your-client-secret}

BODY

{
  "mediaId":{your-product-image-id}
}

# Example Request

Find visually similar images

curl --location --request POST 'https://api.scopemedia.com/simile/v2/search' \
--header 'Content-Type: application/json' \
--header 'Client-Id: {your-client-id}' \
--header 'Client-Secret: {your-client-secret}' \
--data-raw '{
  "mediaId":{your-product-image-id}
}'

# Example Response

200 - OK

{
  "status": "OK",
  "medias": [
    {
      "mediaId": 16630696,
      "mediaUrl": "https://cdn-images.farfetch-contents.com/11/92/18/29/11921829_9097156_800.jpg",
      "metadata": {
        "appId": "demo",
        "classification": "whole person suit",
        "searchable": "true",
        "primary": "false"
      }
    }
  ]
}

# Simile|Smart Bundles

Automated 'Bought Together' Bundles that Increase Revenue

# GET Get Bundle For Product/Item

https://api.scopemedia.com/simile/v2/bundles/{your-item-id}

Get an item's bundle

HEADERS

Content-Type application/json
Client-Id {your-client-id}
Client-Secret {your-client-secret}

# Example Request

Bundle

curl --location --request GET 'https://api.scopemedia.com/simile/v2/bundles/{your-item-id}' \
--header 'Content-Type: application/json' \
--header 'Client-Id: {your-client-id}' \
--header 'Client-Secret: {your-client-secret}'

# Example Response

200 - OK

[
  {
    "itemId": "2064173",
    "appId": "15198-App-8",
    "name": "Kandy Sequin Cami | Allen Schwartz",
    "vendor": "allenschwartz",
    "variants": "{\"price\": 0.0}",
    "images": "https://cdn.shopify.com/s/files/1/1871/8999/products/KANDY_MINA_7_2019_07_09_ALLEN_SCHWARTZ_ECOM_41_054_428x@2x.progressive.jpg?v=1563815588\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/KANDY_MINA_7_2019_07_09_ALLEN_SCHWARTZ_ECOM_41_054_428x@2x.progressive.jpg",
    "image": "https://cdn.shopify.com/s/files/1/1871/8999/products/KANDY_MINA_7_2019_07_09_ALLEN_SCHWARTZ_ECOM_41_054_428x@2x.progressive.jpg?v=1563815588\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/KANDY_MINA_7_2019_07_09_ALLEN_SCHWARTZ_ECOM_41_054_428x@2x.progressive.jpg",
    "bundleItems": "24885051,61438682",
    "itemUrl": "https://allenschwartz.com/products/kandy-sequin-cami-sapphire",
    "bundleCategory": "Women",
    "bundleStatus": "READY",
    "searchable": true
  },
  {
    "itemId": "53933870",
    "appId": "15198-App-8",
    "name": "Charley Cami | Allen Schwartz",
    "vendor": "allenschwartz",
    "variants": "{\"price\": 0.0}",
    "images": "https://cdn.shopify.com/s/files/1/1871/8999/products/CHARLEY_EGS_1_2019_07_11_ALLEN_SCHWARTZ_ECOM_06_003_428x@2x.progressive.jpg?v=1563555721\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/CHARLEY_EGS_1_2019_07_11_ALLEN_SCHWARTZ_ECOM_06_003_428x@2x.progressive.jpg",
    "image": "https://cdn.shopify.com/s/files/1/1871/8999/products/CHARLEY_EGS_1_2019_07_11_ALLEN_SCHWARTZ_ECOM_06_003_428x@2x.progressive.jpg?v=1563555721\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/CHARLEY_EGS_1_2019_07_11_ALLEN_SCHWARTZ_ECOM_06_003_428x@2x.progressive.jpg",
    "bundleItems": "40263670,64058792",
    "itemUrl": "https://allenschwartz.com/products/charley-cami-eggshell",
    "bundleCategory": "Sports & Outdoors",
    "bundleStatus": "READY",
    "searchable": true
  }
]

# GET Get Product/Item Detail

https://api.scopemedia.com/simile/v2/items/{your-item-id}

HEADERS

Content-Type application/json
Client-Id {your-client-id}
Client-Secret {your-client-secret}

# Example Request

Item

curl --location --request GET 'https://api.scopemedia.com/simile/v2/items/{your-item-id}' \
--header 'Content-Type: application/json' \
--header 'Client-Id: {your-client-id}' \
--header 'Client-Secret: {your-client-secret}'

# Example Response

200 - OK

{
  "itemId": "77202505",
  "appId": "15198-App-8",
  "name": "Finn Double Breasted Blazer | Allen Schwartz",
  "vendor": "allenschwartz",
  "variants": "{\"price\": 0.0}",
  "images": "https://cdn.shopify.com/s/files/1/1871/8999/products/FINN_BLAZER_CHARLEY_CAMI_STEPH_PANT_MAG_11_2019_10_14_ALLEN_SCHWARTZ_ECOM_17_119_428x@2x.progressive.jpg?v=1574891420\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/FINN_BLAZER_CHARLEY_CAMI_STEPH_PANT_MAG_11_2019_10_14_ALLEN_SCHWARTZ_ECOM_17_119_428x@2x.progressive.jpg",
  "image": "https://cdn.shopify.com/s/files/1/1871/8999/products/FINN_BLAZER_CHARLEY_CAMI_STEPH_PANT_MAG_11_2019_10_14_ALLEN_SCHWARTZ_ECOM_17_119_428x@2x.progressive.jpg?v=1574891420\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/FINN_BLAZER_CHARLEY_CAMI_STEPH_PANT_MAG_11_2019_10_14_ALLEN_SCHWARTZ_ECOM_17_119_428x@2x.progressive.jpg",
  "bundleItems": "2064173,53933870",
  "itemUrl": "https://allenschwartz.com/products/finn-double-breasted-blazer-magenta",
  "bundleCategory": "Clothing, Shoes & Jewelry",
  "bundleStatus": "READY",
  "searchable": true
}

# Simile | Personalization Suite

Dynamic AI Personalization for Individual Customers:

  • Automated Personalization
  • Unique to Each Customer
  • Easy Setup Without Coding

See https://apps.shopify.com/simile-personalization for more detail information.

# GET Get Personalized Recommendation

https://api.scopemedia.com/recommendstylist/v2/recommend?customer={your-customer-id}&size={your-page-size}&item={your-item-id}

HEADERS

Content-Type application/json
Client-Id {your-client-id}
Client-Secret {your-client-secret}

PARAMS

customer {your-customer-id}
size {your-page-size}
item {your-item-id}

# Example Request

curl --location --request GET 'https://api.scopemedia.com/recommendstylist/v2/recommend?customer={your-customer-id}&size={your-page-size}&item={your-item-id}' \
--header 'Content-Type: application/json' \
--header 'Client-Id: {your-client-id}' \
--header 'Client-Secret: {your-client-secret}'

# Example Response

[
  {
    "mediaUrl": "https://cdn.shopify.com/s/files/1/1871/8999/products/GINA_3_2019_08_06_ALLEN_SCHWARTZ_ECOM_42_019_428x@2x.progressive.jpg?v=1565303838\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/GINA_3_2019_08_06_ALLEN_SCHWARTZ_ECOM_42_019_428x@2x.progressive.jpg",
    "mediaThumbnail": "https://cdn.shopify.com/s/files/1/1871/8999/products/GINA_3_2019_08_06_ALLEN_SCHWARTZ_ECOM_42_019_428x@2x.progressive.jpg?v=1565303838\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/GINA_3_2019_08_06_ALLEN_SCHWARTZ_ECOM_42_019_428x@2x.progressive.jpg",
    "itemId": "69147445",
    "metadata": {
      "itemId": "69147445",
      "shotTime": "1575577054142",
      "vendor": "allenschwartz",
      "appId": "15198-App-8",
      "caption": "Gina Velvet Scoopneck Bodysuit | Allen Schwartz",
      "source": "https://allenschwartz.com/products/gina-velvet-scoopneck-bodysuit-cream",
      "searchable": "true",
      "primary": "true",
      "variants": "{\"price\": 0.0}"
    },
    "appId": "15198-App-8"
  },
  {
    "mediaUrl": "https://cdn.shopify.com/s/files/1/1871/8999/products/BROOKE_PAZ_6_2019_07_09_ALLEN_SCHWARTZ_ECOM_46_048_d141818b-faf9-4389-857f-ab246de96e0f_428x@2x.progressive.jpg?v=1563814839\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/BROOKE_PAZ_6_2019_07_09_ALLEN_SCHWARTZ_ECOM_46_048_d141818b-faf9-4389-857f-ab246de96e0f_428x@2x.progressive.jpg",
    "mediaThumbnail": "https://cdn.shopify.com/s/files/1/1871/8999/products/BROOKE_PAZ_6_2019_07_09_ALLEN_SCHWARTZ_ECOM_46_048_d141818b-faf9-4389-857f-ab246de96e0f_428x@2x.progressive.jpg?v=1563814839\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/BROOKE_PAZ_6_2019_07_09_ALLEN_SCHWARTZ_ECOM_46_048_d141818b-faf9-4389-857f-ab246de96e0f_428x@2x.progressive.jpg",
    "itemId": "61438682",
    "metadata": {
      "itemId": "61438682",
      "shotTime": "1575577080620",
      "vendor": "allenschwartz",
      "appId": "15198-App-8",
      "caption": "Brooke One Shoulder Blouse | Allen Schwartz",
      "source": "https://allenschwartz.com/products/brooke-one-shoulder-blouse-cheetah",
      "searchable": "true",
      "primary": "true",
      "variants": "{\"price\": 0.0}"
    },
    "appId": "15198-App-8"
  },
  {
    "mediaUrl": "https://cdn.shopify.com/s/files/1/1871/8999/products/HOLLIDAY_TRACY_7_2019_07_09_ALLEN_SCHWARTZ_ECOM_16_054_428x@2x.progressive.jpg?v=1563564089\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/HOLLIDAY_TRACY_7_2019_07_09_ALLEN_SCHWARTZ_ECOM_16_054_428x@2x.progressive.jpg",
    "mediaThumbnail": "https://cdn.shopify.com/s/files/1/1871/8999/products/HOLLIDAY_TRACY_7_2019_07_09_ALLEN_SCHWARTZ_ECOM_16_054_428x@2x.progressive.jpg?v=1563564089\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/HOLLIDAY_TRACY_7_2019_07_09_ALLEN_SCHWARTZ_ECOM_16_054_428x@2x.progressive.jpg",
    "itemId": "56417721",
    "metadata": {
      "itemId": "56417721",
      "shotTime": "1575577083387",
      "vendor": "allenschwartz",
      "appId": "15198-App-8",
      "caption": "Holliday Turtleneck | Allen Schwartz",
      "source": "https://allenschwartz.com/products/holliday-turtleneck-dark-green",
      "searchable": "true",
      "primary": "true",
      "variants": "{\"price\": 0.0}"
    },
    "appId": "15198-App-8"
  }
]

# GET Get Customer's Recently Viewed Products/Items

https://api.scopemedia.com/recommendstylist/v2/recent?customer={your-customer-id}&size={your-page-size}

HEADERS

Content-Type application/json
Client-Id {your-client-id}
Client-Secret {your-client-secret}

PARAMS

customer {your-customer-id}
size {your-page-size}

# Example Request

curl --location --request GET 'https://api.scopemedia.com/recommendstylist/v2/recent?customer={your-customer-id}&size={your-page-size}' \
--header 'Content-Type: application/json' \
--header 'Client-Id: {your-client-id}' \
--header 'Client-Secret: {your-client-secret}'

# Example Response

200 - OK

[
  {
    "mediaUrl": "https://cdn.shopify.com/s/files/1/1871/8999/products/FINN_BLAZER_CHARLEY_CAMI_STEPH_PANT_MAG_11_2019_10_14_ALLEN_SCHWARTZ_ECOM_17_119_428x@2x.progressive.jpg?v=1574891420\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/FINN_BLAZER_CHARLEY_CAMI_STEPH_PANT_MAG_11_2019_10_14_ALLEN_SCHWARTZ_ECOM_17_119_428x@2x.progressive.jpg",
    "mediaThumbnail": "https://cdn.shopify.com/s/files/1/1871/8999/products/FINN_BLAZER_CHARLEY_CAMI_STEPH_PANT_MAG_11_2019_10_14_ALLEN_SCHWARTZ_ECOM_17_119_428x@2x.progressive.jpg?v=1574891420\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/FINN_BLAZER_CHARLEY_CAMI_STEPH_PANT_MAG_11_2019_10_14_ALLEN_SCHWARTZ_ECOM_17_119_428x@2x.progressive.jpg",
    "itemId": "77202505",
    "metadata": {
      "itemId": "77202505",
      "shotTime": "1575577062721",
      "vendor": "allenschwartz",
      "appId": "15198-App-8",
      "caption": "Finn Double Breasted Blazer | Allen Schwartz",
      "source": "https://allenschwartz.com/products/finn-double-breasted-blazer-magenta",
      "searchable": "true",
      "primary": "true",
      "variants": "{\"price\": 0.0}"
    },
    "appId": "15198-App-8"
  },
  {
    "mediaUrl": "https://cdn.shopify.com/s/files/1/1871/8999/products/SYBIL_ARLO_2_2019_08_06_ALLEN_SCHWARTZ_ECOM_07_044_428x@2x.progressive.jpg?v=1569968380\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/SYBIL_ARLO_2_2019_08_06_ALLEN_SCHWARTZ_ECOM_07_044_428x@2x.progressive.jpg",
    "mediaThumbnail": "https://cdn.shopify.com/s/files/1/1871/8999/products/SYBIL_ARLO_2_2019_08_06_ALLEN_SCHWARTZ_ECOM_07_044_428x@2x.progressive.jpg?v=1569968380\" src=\"//cdn.shopify.com/s/files/1/1871/8999/products/SYBIL_ARLO_2_2019_08_06_ALLEN_SCHWARTZ_ECOM_07_044_428x@2x.progressive.jpg",
    "itemId": "74032361",
    "metadata": {
      "itemId": "74032361",
      "shotTime": "1575577074331",
      "vendor": "allenschwartz",
      "appId": "15198-App-8",
      "caption": "Arlo Pleated Skirt | Allen Schwartz",
      "source": "https://allenschwartz.com/products/arlo-pleated-skirt-silver-sparkle",
      "searchable": "true",
      "primary": "true",
      "variants": "{\"price\": 0.0}"
    },
    "appId": "15198-App-8"
  }
]