Get products by external ID

curl --request GET \
  --url https://api.opencals.com/storefront/products/by-external-id/{productExternalId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.opencals.com/storefront/products/by-external-id/{productExternalId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.opencals.com/storefront/products/by-external-id/{productExternalId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.opencals.com/storefront/products/by-external-id/{productExternalId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.opencals.com/storefront/products/by-external-id/{productExternalId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.opencals.com/storefront/products/by-external-id/{productExternalId}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.opencals.com/storefront/products/by-external-id/{productExternalId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "1234567890",
    "externalVariantId": "9876543210",
    "storeId": "123e4567-e89b-12d3-a456-426614174001",
    "slug": "haircut-basic",
    "scheduleId": "<string>",
    "productPoolId": "<string>",
    "title": "Haircut Service",
    "variantTitle": "Short Hair",
    "description": "<string>",
    "imageId": "<string>",
    "color": "BLUE",
    "price": 250,
    "taxable": false,
    "duration": 3600,
    "allowCustomDuration": false,
    "maxDuration": -1,
    "maxAttendees": 1,
    "maxGuests": 123,
    "allowGuests": false,
    "allowCustomerReschedule": false,
    "allowCustomerCancel": false,
    "rescheduleGap": 123,
    "cancelGap": 123,
    "beforeGap": 123,
    "afterGap": 123,
    "fixedTimes": false,
    "fixedStartTime": "09:00:00",
    "fixedEndTime": "17:00:00",
    "advanceScheduleThreshold": 0,
    "sendConfirmationEmail": true,
    "sendReminderEmail": false,
    "sendFeedbackEmail": false,
    "skipCheckout": false,
    "status": "ACTIVE",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "staffMembers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "storeId": "123e4567-e89b-12d3-a456-426614174111",
        "userId": "user-uuid",
        "scheduleId": "123e4567-e89b-12d3-a456-426614174000",
        "imageId": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "slug": "mike",
        "refreshToken": "abc123xyz456",
        "createdAt": "2025-05-01T12:00:00Z",
        "updatedAt": "2025-05-15T14:30:00Z",
        "deletedAt": "2025-06-01T09:15:00Z",
        "image": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "externalId": "img_123456",
          "url": "https://storage.example.com/images/product-image.jpg",
          "filename": "product-image.jpg",
          "mime": "image/jpeg",
          "createdAt": "2023-01-01T12:00:00Z",
          "updatedAt": "2023-01-02T12:00:00Z",
          "deletedAt": "2023-01-03T12:00:00Z",
          "storeId": "store-uuid"
        }
      }
    ],
    "locations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "storeId": "123e4567-e89b-12d3-a456-426614174001",
        "scheduleId": "123e4567-e89b-12d3-a456-426614174002",
        "title": "Main Office",
        "description": "Our main downtown office location with 3 treatment rooms",
        "slug": "new-york",
        "type": "physical",
        "link": "https://zoom.us/j/123456789",
        "addressLine1": "123 Main Street",
        "addressLine2": "Suite 200",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "country": "United States",
        "addressPlaceId": "ChIJIQBpAG2ahYAR_6128GcTUEo",
        "latitude": 37.4224764,
        "longitude": -122.0842499,
        "createdAt": "2023-01-20T08:30:00Z",
        "updatedAt": "2023-02-15T14:20:00Z",
        "deletedAt": "2023-03-10T11:45:00Z",
        "address": "<string>",
        "staffMembers": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "storeId": "123e4567-e89b-12d3-a456-426614174111",
            "userId": "user-uuid",
            "scheduleId": "123e4567-e89b-12d3-a456-426614174000",
            "imageId": "123e4567-e89b-12d3-a456-426614174000",
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@example.com",
            "slug": "mike",
            "refreshToken": "abc123xyz456",
            "createdAt": "2025-05-01T12:00:00Z",
            "updatedAt": "2025-05-15T14:30:00Z",
            "deletedAt": "2025-06-01T09:15:00Z",
            "image": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "externalId": "img_123456",
              "url": "https://storage.example.com/images/product-image.jpg",
              "filename": "product-image.jpg",
              "mime": "image/jpeg",
              "createdAt": "2023-01-01T12:00:00Z",
              "updatedAt": "2023-01-02T12:00:00Z",
              "deletedAt": "2023-01-03T12:00:00Z",
              "storeId": "store-uuid"
            }
          }
        ],
        "schedule": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "storeId": "123e4567-e89b-12d3-a456-426614174001",
          "name": "Standard Business Hours",
          "timezone": "UTC",
          "scheduleGap": "every-15-minutes",
          "appointmentsGap": 900,
          "advanceScheduleDays": 60,
          "availabilityType": "recurring",
          "status": "active",
          "createdAt": "2023-01-20T08:30:00Z",
          "updatedAt": "2023-02-15T14:20:00Z",
          "deletedAt": "2023-06-03T09:45:00Z"
        },
        "availabilities": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "locationId": "123e4567-e89b-12d3-a456-426614174001",
            "fromDate": "2023-06-15",
            "fromTime": "09:00:00",
            "toDate": "2023-06-15",
            "toTime": "17:00:00",
            "day": 1,
            "status": "available",
            "createdAt": "2023-01-20T08:30:00Z",
            "updatedAt": "2023-02-15T14:20:00Z"
          }
        ]
      }
    ],
    "feedbackQuestions": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "internalName": "Service Quality Rating Question",
        "required": true,
        "type": "rating",
        "order": 1,
        "alwaysShow": false,
        "createdAt": "2023-01-01T00:00:00Z",
        "updatedAt": "2023-01-15T00:00:00Z",
        "deletedAt": "2023-06-03T09:45:00Z",
        "storeId": "store-uuid",
        "fileConfig": {
          "categories": [
            "images",
            "pdf"
          ],
          "maxSizeBytes": 26214400,
          "maxFiles": 5
        }
      }
    ],
    "checkoutQuestions": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "internalName": "Customer Allergies Question",
        "required": true,
        "type": "single-line-text-field",
        "order": 1,
        "alwaysShow": false,
        "createdAt": "2023-01-01T00:00:00Z",
        "updatedAt": "2023-01-15T00:00:00Z",
        "deletedAt": "2023-06-03T09:45:00Z",
        "storeId": "store-uuid",
        "fileConfig": {
          "categories": [
            "images",
            "pdf"
          ],
          "maxSizeBytes": 26214400,
          "maxFiles": 5
        }
      }
    ],
    "image": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "img_123456",
      "url": "https://storage.example.com/images/product-image.jpg",
      "filename": "product-image.jpg",
      "mime": "image/jpeg",
      "createdAt": "2023-01-01T12:00:00Z",
      "updatedAt": "2023-01-02T12:00:00Z",
      "deletedAt": "2023-01-03T12:00:00Z",
      "storeId": "store-uuid"
    }
  }
]

GET

storefront

products

by-external-id

{productExternalId}

Get products by external ID

curl --request GET \
  --url https://api.opencals.com/storefront/products/by-external-id/{productExternalId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.opencals.com/storefront/products/by-external-id/{productExternalId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.opencals.com/storefront/products/by-external-id/{productExternalId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.opencals.com/storefront/products/by-external-id/{productExternalId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.opencals.com/storefront/products/by-external-id/{productExternalId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.opencals.com/storefront/products/by-external-id/{productExternalId}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.opencals.com/storefront/products/by-external-id/{productExternalId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "1234567890",
    "externalVariantId": "9876543210",
    "storeId": "123e4567-e89b-12d3-a456-426614174001",
    "slug": "haircut-basic",
    "scheduleId": "<string>",
    "productPoolId": "<string>",
    "title": "Haircut Service",
    "variantTitle": "Short Hair",
    "description": "<string>",
    "imageId": "<string>",
    "color": "BLUE",
    "price": 250,
    "taxable": false,
    "duration": 3600,
    "allowCustomDuration": false,
    "maxDuration": -1,
    "maxAttendees": 1,
    "maxGuests": 123,
    "allowGuests": false,
    "allowCustomerReschedule": false,
    "allowCustomerCancel": false,
    "rescheduleGap": 123,
    "cancelGap": 123,
    "beforeGap": 123,
    "afterGap": 123,
    "fixedTimes": false,
    "fixedStartTime": "09:00:00",
    "fixedEndTime": "17:00:00",
    "advanceScheduleThreshold": 0,
    "sendConfirmationEmail": true,
    "sendReminderEmail": false,
    "sendFeedbackEmail": false,
    "skipCheckout": false,
    "status": "ACTIVE",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "staffMembers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "storeId": "123e4567-e89b-12d3-a456-426614174111",
        "userId": "user-uuid",
        "scheduleId": "123e4567-e89b-12d3-a456-426614174000",
        "imageId": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "slug": "mike",
        "refreshToken": "abc123xyz456",
        "createdAt": "2025-05-01T12:00:00Z",
        "updatedAt": "2025-05-15T14:30:00Z",
        "deletedAt": "2025-06-01T09:15:00Z",
        "image": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "externalId": "img_123456",
          "url": "https://storage.example.com/images/product-image.jpg",
          "filename": "product-image.jpg",
          "mime": "image/jpeg",
          "createdAt": "2023-01-01T12:00:00Z",
          "updatedAt": "2023-01-02T12:00:00Z",
          "deletedAt": "2023-01-03T12:00:00Z",
          "storeId": "store-uuid"
        }
      }
    ],
    "locations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "storeId": "123e4567-e89b-12d3-a456-426614174001",
        "scheduleId": "123e4567-e89b-12d3-a456-426614174002",
        "title": "Main Office",
        "description": "Our main downtown office location with 3 treatment rooms",
        "slug": "new-york",
        "type": "physical",
        "link": "https://zoom.us/j/123456789",
        "addressLine1": "123 Main Street",
        "addressLine2": "Suite 200",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "country": "United States",
        "addressPlaceId": "ChIJIQBpAG2ahYAR_6128GcTUEo",
        "latitude": 37.4224764,
        "longitude": -122.0842499,
        "createdAt": "2023-01-20T08:30:00Z",
        "updatedAt": "2023-02-15T14:20:00Z",
        "deletedAt": "2023-03-10T11:45:00Z",
        "address": "<string>",
        "staffMembers": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "storeId": "123e4567-e89b-12d3-a456-426614174111",
            "userId": "user-uuid",
            "scheduleId": "123e4567-e89b-12d3-a456-426614174000",
            "imageId": "123e4567-e89b-12d3-a456-426614174000",
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@example.com",
            "slug": "mike",
            "refreshToken": "abc123xyz456",
            "createdAt": "2025-05-01T12:00:00Z",
            "updatedAt": "2025-05-15T14:30:00Z",
            "deletedAt": "2025-06-01T09:15:00Z",
            "image": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "externalId": "img_123456",
              "url": "https://storage.example.com/images/product-image.jpg",
              "filename": "product-image.jpg",
              "mime": "image/jpeg",
              "createdAt": "2023-01-01T12:00:00Z",
              "updatedAt": "2023-01-02T12:00:00Z",
              "deletedAt": "2023-01-03T12:00:00Z",
              "storeId": "store-uuid"
            }
          }
        ],
        "schedule": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "storeId": "123e4567-e89b-12d3-a456-426614174001",
          "name": "Standard Business Hours",
          "timezone": "UTC",
          "scheduleGap": "every-15-minutes",
          "appointmentsGap": 900,
          "advanceScheduleDays": 60,
          "availabilityType": "recurring",
          "status": "active",
          "createdAt": "2023-01-20T08:30:00Z",
          "updatedAt": "2023-02-15T14:20:00Z",
          "deletedAt": "2023-06-03T09:45:00Z"
        },
        "availabilities": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "locationId": "123e4567-e89b-12d3-a456-426614174001",
            "fromDate": "2023-06-15",
            "fromTime": "09:00:00",
            "toDate": "2023-06-15",
            "toTime": "17:00:00",
            "day": 1,
            "status": "available",
            "createdAt": "2023-01-20T08:30:00Z",
            "updatedAt": "2023-02-15T14:20:00Z"
          }
        ]
      }
    ],
    "feedbackQuestions": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "internalName": "Service Quality Rating Question",
        "required": true,
        "type": "rating",
        "order": 1,
        "alwaysShow": false,
        "createdAt": "2023-01-01T00:00:00Z",
        "updatedAt": "2023-01-15T00:00:00Z",
        "deletedAt": "2023-06-03T09:45:00Z",
        "storeId": "store-uuid",
        "fileConfig": {
          "categories": [
            "images",
            "pdf"
          ],
          "maxSizeBytes": 26214400,
          "maxFiles": 5
        }
      }
    ],
    "checkoutQuestions": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "internalName": "Customer Allergies Question",
        "required": true,
        "type": "single-line-text-field",
        "order": 1,
        "alwaysShow": false,
        "createdAt": "2023-01-01T00:00:00Z",
        "updatedAt": "2023-01-15T00:00:00Z",
        "deletedAt": "2023-06-03T09:45:00Z",
        "storeId": "store-uuid",
        "fileConfig": {
          "categories": [
            "images",
            "pdf"
          ],
          "maxSizeBytes": 26214400,
          "maxFiles": 5
        }
      }
    ],
    "image": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "img_123456",
      "url": "https://storage.example.com/images/product-image.jpg",
      "filename": "product-image.jpg",
      "mime": "image/jpeg",
      "createdAt": "2023-01-01T12:00:00Z",
      "updatedAt": "2023-01-02T12:00:00Z",
      "deletedAt": "2023-01-03T12:00:00Z",
      "storeId": "store-uuid"
    }
  }
]

Authorizations

x-api-key

string

header

default:sfk_your_api_key

required

Storefront API key (sfk_...)

Path Parameters

productExternalId

string

required

External ID (e.g., Shopify product ID)

Response

200 - application/json

Products retrieved successfully

string

required

Unique identifier for the product

Example:

"123e4567-e89b-12d3-a456-426614174000"

productId

string

required

ID of the product

Example:

"123e4567-e89b-12d3-a456-426614174000"

externalId

string

required

External platform product ID (e.g. Shopify Product ID)

Example:

"1234567890"

externalVariantId

string

required

External platform variant ID (e.g. Shopify Variant ID)

Example:

"9876543210"

storeId

string

required

ID of the store that owns this product

Example:

"123e4567-e89b-12d3-a456-426614174001"

slug

string

required

URL-friendly slug for the product (unique per store)

Example:

"haircut-basic"

scheduleId

string

required

ID of the schedule associated with this product

productPoolId

string | null

required

ID of the product pool this product belongs to (controls overlap prevention)

title

string

required

Title of the product

Example:

"Haircut Service"

variantTitle

string

required

Title of the specific product variant

Example:

"Short Hair"

description

string

required

Detailed description of the product

imageId

string

required

ID of the product image

color

enum<string>

default:slate

required

Color code for displaying the product

Available options:

slate,

gray,

zinc,

neutral,

stone,

red,

orange,

amber,

yellow,

lime,

green,

emerald,

teal,

cyan,

sky,

blue,

indigo,

violet,

purple,

fuchsia,

pink,

rose

Example:

"BLUE"

price

number

required

Price of the product

Example:

250

taxable

boolean

default:false

required

Whether the product is taxable

duration

number

required

Duration of the service in seconds

Example:

3600

allowCustomDuration

boolean

default:false

required

Whether customers can customize the duration by selecting multiples of the base service duration (e.g., if base duration is 1 day, customers can book 1, 2, 3+ days)

maxDuration

number

default:-1

required

When allow_custom_duration=true, maximum duration allowed for multi-duration bookings in seconds (-1 for unlimited)

maxAttendees

number

default:1

required

Maximum number of attendees allowed

maxGuests

number | null

required

Maximum number of guests allowed per appointment. Null means unlimited.

allowGuests

boolean

default:false

required

Whether customers can invite guests to the appointment

allowCustomerReschedule

boolean

default:false

required

Whether customers can reschedule their bookings

allowCustomerCancel

boolean

default:false

required

Whether customers can cancel their bookings

rescheduleGap

number

required

Time in seconds before appointment when rescheduling is no longer allowed

cancelGap

number

required

Time in seconds before appointment when cancellation is no longer allowed

beforeGap

number

required

Buffer time in seconds required before this service

afterGap

number

required

Buffer time in seconds required after this service

fixedTimes

boolean

default:false

required

When allow_custom_duration=true, whether appointments must start and end at fixed times (like fixed check-in/check-out times for multi-duration bookings)

fixedStartTime

string

required

When allow_custom_duration=true and fixed_times=true, the fixed time when appointments must start (HH:MM:SS) - specified in the product's schedule timezone, or user settings timezone if no schedule is assigned

Example:

"09:00:00"

fixedEndTime

string

required

When allow_custom_duration=true and fixed_times=true, the fixed time when appointments must end (HH:MM:SS) - specified in the product's schedule timezone, or user settings timezone if no schedule is assigned

Example:

"17:00:00"

advanceScheduleThreshold

number

default:0

required

How many days in advance bookings can be made

sendConfirmationEmail

boolean

default:true

required

Whether to send confirmation emails for bookings

sendReminderEmail

boolean

default:false

required

Whether to send reminder emails before appointments

sendFeedbackEmail

boolean

default:false

required

Whether to send feedback request emails after appointments

skipCheckout

boolean

default:false

required

Whether to skip the checkout process for this product (Shopify merchants only)

status

enum<string>

default:active

required

Current status of the product

Available options:

active,

inactive

Example:

"ACTIVE"

createdAt

string

required

Timestamp when the product was created

updatedAt

string

required

Timestamp when the product was last updated

deletedAt

string

required

Timestamp when the product was deleted (for soft deletes)

staffMembers

object[]

required

Staff members who can provide this service

Show child attributes

locations

object[]

required

Locations where this service is offered

Show child attributes

feedbackQuestions

object[]

required

Feedback questions associated with this product

Show child attributes

checkoutQuestions

object[]

required

Checkout questions associated with this product

Show child attributes

image

object | null

Primary image of the product

Show child attributes

Last modified on July 26, 2026

Get product by ID Get a product by external variant ID

Getting started

Endpoints

Get products by external ID

Authorizations

Path Parameters

Response