Skip to content
Crossmart Docs

Products of a workspace, in title order

GET
/api/v1/workspaces/{workspaceId}/products
curl --request GET \
  --url 'https://api.crossmart.io/api/v1/workspaces/example/products?status=DRAFT&gap=images&storeFilter=in_store&sort=title&direction=asc&limit=25'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspaceId
required
string

Query Parameters

Section titled “Query Parameters”
search
string

Matches title, handle or SKU

status
string
Allowed values: DRAFT ACTIVE ARCHIVED
gap
string
Allowed values: images description sku barcode out_of_stock

Only products that lack this value

tags
Array<string>

Only products with any of these tags. Repeat the parameter for several.

vendor
string

Only products of this vendor, ignoring case

storeFilter
string
Allowed values: in_store not_in_store in_no_store with_errors

By the stores products are in; in_store and not_in_store need storeId

storeId
string format: uuid

The store storeFilter is about

sort
string
Allowed values: title updatedAt createdAt
direction
string
Allowed values: asc desc
cursor
string format: uuid

nextCursor from the previous page

page
number
>= 1

1-based page number, for tables with page numbers. It wins over cursor.

limit
number
default: 25 >= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
handle
required
string
title
required
string
status
required
string
Allowed values: DRAFT ACTIVE ARCHIVED
vendor
required
string
nullable
productType
required
string
nullable
variantCount
required
number
totalAvailable
required

Stock across variants that track it; null when none do

number
nullable
priceRange
required
object
min
required

Decimal string in the workspace currency

string
max
required
string
imageUrl
required
string
nullable
stores
required

The stores it is in, in the order it joined them

Array<object>
object
connectionId
required
string format: uuid
channel
required
string
Allowed values: shopify ebay google_merchant etsy amazon walmart
storeName
required
string
status
required
string
Allowed values: PENDING ACTIVE INACTIVE ERROR DELISTED
source
required
string
Allowed values: MANUAL IMPORT RULE
updatedAt
required
string format: date-time
nextCursor
required

Null on the last page

string
nullable
total
required

How many match in all, for page numbers

number

Example 

{
  "items": [
    {
      "status": "DRAFT",
      "priceRange": {
        "min": "22.00",
        "max": "89.00"
      },
      "stores": [
        {
          "channel": "shopify",
          "storeName": "Demo Store",
          "status": "PENDING",
          "source": "MANUAL"
        }
      ]
    }
  ]
}