Skip to main content
GET
/
organizations
/
{orgId}
/
catalogs
/
{catalogId}
/
products
/
{productId}
Get Product
curl --request GET \
  --url https://api.joinrefine.io/organizations/{orgId}/catalogs/{catalogId}/products/{productId} \
  --header 'REFINE_API_KEY: <api-key>'
{
  "id": "<string>",
  "catalogId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "imageUrl": "<string>",
  "objectUrl": "<string>",
  "descriptor": "<string>",
  "metadata": {},
  "createAt": "2023-11-07T05:31:56Z",
  "status": "PROCESSING",
  "rank": "NO_BOOST",
  "updateAt": "2023-11-07T05:31:56Z"
}

Authorizations

REFINE_API_KEY
string
header
required

API key for authentication

Path Parameters

orgId
string<uuid>
required

Organization ID (UUID)

catalogId
string<uuid>
required

Catalog ID (UUID)

productId
string
required

Product ID

Example:

"sku001"

Response

Product details

id
string

Product ID

catalogId
string<uuid>

Catalog ID

imageUrl
string<uri>

Product image URL

objectUrl
string

Internal object storage URL

descriptor
string

Product description (lowercase)

metadata
object

Product metadata

createAt
string<date-time>

Creation timestamp

status
enum<string>

Processing status

Available options:
PROCESSING,
PROCESSED,
ERROR
rank
enum<string>

Ranking boost level

Available options:
NO_BOOST,
BOOST,
SUPER_BOOST
updateAt
string<date-time>

Last update timestamp

I