Products

get

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

siteKeystringRequired

Query parameters

limitnumber | nullableOptional

pagenumber | nullableOptional

orderBystringOptional

dirstring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

tagsany ofOptional

stringOptional

or

string[]Optional

Responses

200

Retrieve a list of Products

application/json

get

/api/v2/{siteKey}/public/products

HTTPcURLJavaScriptPython

GET /api/v2/{siteKey}/public/products HTTP/1.1
Host: app.venuecms.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Retrieve a list of Products

{
  "records": [
    {
      "siteId": "text",
      "slug": "text",
      "order": 1,
      "featured": true,
      "featuredExpiration": "text",
      "author": "text",
      "tags": [
        {
          "tagId": "text",
          "tag": {
            "id": "text",
            "siteId": "text",
            "title": "text",
            "parentTags": [
              {
                "tagId": "text",
                "parentTagId": "text",
                "createdAt": "text",
                "parentTag": {
                  "id": "text",
                  "siteId": "text",
                  "title": "text"
                }
              }
            ]
          }
        }
      ],
      "image": {
        "siteId": "text",
        "uploaded": true,
        "inline": true,
        "url": "text",
        "mimeType": "text",
        "size": 1,
        "metadata": {},
        "title": "text",
        "caption": "text",
        "credit": "text",
        "altText": "text"
      },
      "localizedContent": [
        {
          "siteId": "text",
          "locale": "text",
          "title": "text",
          "content": "text",
          "shortContent": "text",
          "extraContent": "text",
          "excerpt": "text",
          "metaTitle": "text",
          "metaDescription": "text",
          "keywords": "text",
          "contentJSON": {}
        }
      ],
      "artists": [
        {
          "profile": {
            "siteId": "text",
            "slug": "text",
            "tags": [
              {
                "tagId": "text",
                "tag": {
                  "id": "text",
                  "siteId": "text",
                  "title": "text",
                  "parentTags": [
                    {
                      "tagId": "text",
                      "parentTagId": "text",
                      "createdAt": "text",
                      "parentTag": {
                        "id": "text",
                        "siteId": "text",
                        "title": "text"
                      }
                    }
                  ]
                }
              }
            ],
            "image": {
              "siteId": "text",
              "uploaded": true,
              "inline": true,
              "url": "text",
              "mimeType": "text",
              "size": 1,
              "metadata": {},
              "title": "text",
              "caption": "text",
              "credit": "text",
              "altText": "text"
            },
            "localizedContent": [
              {
                "siteId": "text",
                "locale": "text",
                "title": "text",
                "content": "text",
                "shortContent": "text",
                "extraContent": "text",
                "excerpt": "text",
                "metaTitle": "text",
                "metaDescription": "text",
                "keywords": "text",
                "contentJSON": {}
              }
            ],
            "custom": [
              {
                "data": null,
                "customSchemaId": "text"
              }
            ]
          }
        }
      ],
      "variants": [
        {
          "id": "text",
          "siteId": "text",
          "order": 1,
          "price": 1,
          "currency": "text",
          "quantity": 1,
          "externalLink": "text",
          "catalogID": "text",
          "publicationDate": "text",
          "productTypeId": "text",
          "productId": "text",
          "image": {
            "siteId": "text",
            "uploaded": true,
            "inline": true,
            "url": "text",
            "mimeType": "text",
            "size": 1,
            "metadata": {},
            "title": "text",
            "caption": "text",
            "credit": "text",
            "altText": "text"
          },
          "productType": {
            "id": "text",
            "type": "text"
          }
        }
      ],
      "custom": [
        {
          "data": null,
          "customSchemaId": "text"
        }
      ]
    }
  ],
  "count": 1
}

get

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

siteKeystringRequired

slugstringRequired

Responses

200

Retrieve a Product

application/json

404

Product not found

get

/api/v2/{siteKey}/public/products/{slug}

HTTPcURLJavaScriptPython

GET /api/v2/{siteKey}/public/products/{slug} HTTP/1.1
Host: app.venuecms.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteId": "text",
  "slug": "text",
  "order": 1,
  "featured": true,
  "featuredExpiration": "text",
  "author": "text",
  "tags": [
    {
      "tagId": "text",
      "tag": {
        "id": "text",
        "siteId": "text",
        "title": "text",
        "parentTags": [
          {
            "tagId": "text",
            "parentTagId": "text",
            "createdAt": "text",
            "parentTag": {
              "id": "text",
              "siteId": "text",
              "title": "text"
            }
          }
        ]
      }
    }
  ],
  "image": {
    "siteId": "text",
    "uploaded": true,
    "inline": true,
    "url": "text",
    "mimeType": "text",
    "size": 1,
    "metadata": {},
    "title": "text",
    "caption": "text",
    "credit": "text",
    "altText": "text"
  },
  "localizedContent": [
    {
      "siteId": "text",
      "locale": "text",
      "title": "text",
      "content": "text",
      "shortContent": "text",
      "extraContent": "text",
      "excerpt": "text",
      "metaTitle": "text",
      "metaDescription": "text",
      "keywords": "text",
      "contentJSON": {}
    }
  ],
  "artists": [
    {
      "profile": {
        "siteId": "text",
        "slug": "text",
        "tags": [
          {
            "tagId": "text",
            "tag": {
              "id": "text",
              "siteId": "text",
              "title": "text",
              "parentTags": [
                {
                  "tagId": "text",
                  "parentTagId": "text",
                  "createdAt": "text",
                  "parentTag": {
                    "id": "text",
                    "siteId": "text",
                    "title": "text"
                  }
                }
              ]
            }
          }
        ],
        "image": {
          "siteId": "text",
          "uploaded": true,
          "inline": true,
          "url": "text",
          "mimeType": "text",
          "size": 1,
          "metadata": {},
          "title": "text",
          "caption": "text",
          "credit": "text",
          "altText": "text"
        },
        "localizedContent": [
          {
            "siteId": "text",
            "locale": "text",
            "title": "text",
            "content": "text",
            "shortContent": "text",
            "extraContent": "text",
            "excerpt": "text",
            "metaTitle": "text",
            "metaDescription": "text",
            "keywords": "text",
            "contentJSON": {}
          }
        ],
        "custom": [
          {
            "data": null,
            "customSchemaId": "text"
          }
        ]
      }
    }
  ],
  "variants": [
    {
      "id": "text",
      "siteId": "text",
      "order": 1,
      "price": 1,
      "currency": "text",
      "quantity": 1,
      "externalLink": "text",
      "catalogID": "text",
      "publicationDate": "text",
      "productTypeId": "text",
      "productId": "text",
      "image": {
        "siteId": "text",
        "uploaded": true,
        "inline": true,
        "url": "text",
        "mimeType": "text",
        "size": 1,
        "metadata": {},
        "title": "text",
        "caption": "text",
        "credit": "text",
        "altText": "text"
      },
      "productType": {
        "id": "text",
        "type": "text"
      }
    }
  ],
  "custom": [
    {
      "data": null,
      "customSchemaId": "text"
    }
  ]
}