Catalogues

APIs related to Jewellery Catalogues

Get jewellery catalogues

get

Get list of jewellery catalogues. Can be filtered by portfolio code.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

portfolio_idstringRequired

Portfolio id to filter catalogues

Responses

200

OK

application/json

A jewellery collection

idstring · uuidRead-onlyOptional

Unique identifier of the collection

showcase_profile_idnumberRequired

Id of the associated showcase

namestring · max: 32Required

Name of the collection

visibilitystring · enumRequired

Visibility of the collection Values are:

• PUBLIC: Visible to all
• PROTECTED: Showcase view is protected by the password
• PRIVATE: Not visible to anyone

Possible values:

descriptionstring · max: 512Optional

Description of the collection

tagsstring[]Optional

Tags associated with the collection

403

Unauthorized

application/json

422

Unprocessable Entity

application/json

get

/catalogues

HTTPcURLJavaScriptPython

GET /api/jewellery/catalogues HTTP/1.1
Host: console.studio360.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "portfolio_id": "text"
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "showcase_profile_id": 1,
    "name": "text",
    "visibility": "PUBLIC",
    "description": "text",
    "tags": [
      "text"
    ],
    "features": {
      "is_multi": true,
      "filter_by_tag": true,
      "filter_by_properties": true,
      "is_like": true,
      "is_conversation": true,
      "is_share": true
    }
  }
]

Get a jewellery catalogue

get

Get a jewellery catalogue details by id

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

ID of the catalogue to fetch

Responses

200

OK

application/json

A jewellery catalogue

idstring · uuidRead-onlyRequired

Unique identifier of the catalogue

codestringRequired

Code of the catalogue

namestringRequired

Name of the catalogue

tagsstring[]Optional

Tags associated with the catalogue

typestringRequired

Type of the catalogue

403

Unauthorized

application/json

404

Catalogue not found

application/json

get

/catalogues/{id}

HTTPcURLJavaScriptPython

GET /api/jewellery/catalogues/{id} HTTP/1.1
Host: console.studio360.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "code": "text",
  "name": "text",
  "tags": [
    "text"
  ],
  "type": "text",
  "collections": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "showcase_profile_id": 1,
      "name": "text",
      "visibility": "PUBLIC",
      "description": "text",
      "tags": [
        "text"
      ],
      "features": {
        "is_multi": true,
        "filter_by_tag": true,
        "filter_by_properties": true,
        "is_like": true,
        "is_conversation": true,
        "is_share": true
      }
    }
  ]
}