Portfolios

APIs related to Jewellery Portfolios

Get jewellery portfolios

get

Get list of jewellery portfolios

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

get

/portfolios

HTTPcURLJavaScriptPython

GET /api/jewellery/portfolios HTTP/1.1
Host: console.studio360.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "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 portfolio

get

Get a jewellery portfolio details by id

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

ID of the portfolio to fetch

Responses

200

OK

application/json

A jewellery portfolio

idstring · uuidRead-onlyRequired

Unique identifier of the portfolio

codestringRequired

Code of the portfolio

namestringRequired

Name of the portfolio

tagsstring[]Optional

Tags associated with the portfolio

typestringRequired

Type of the portfolio

403

Unauthorized

application/json

404

Portfolio not found

application/json

get

/portfolios/{id}

HTTPcURLJavaScriptPython

GET /api/jewellery/portfolios/{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",
  "catalogues": [
    {
      "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
      }
    }
  ]
}