Collections

APIs related to Jewellery Collections

Get jewellery collections

get

Get list of jewellery collections with pagination. Filters and sorting can be applied.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

limitinteger · min: 10 · max: 100Required

No of of records to fetch.

Default: 20

offsetintegerRequired

Records to be fetched from this offset.

Default: 0

order_bystring · enumOptional

Sort records by field

Default: namePossible values:

order_typestring · enumOptional

Order type - asc or desc.

Default: ascPossible values:

Responses

200

OK

application/json

403

Unauthorized

application/json

422

Unprocessable Entity

application/json

get

/collections

HTTPcURLJavaScriptPython

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

{
  "limit": 20,
  "offset": 0,
  "order_by": "name",
  "order_type": "asc",
  "filters": {
    "showcase_profile_id": 1,
    "visibility": "PUBLIC",
    "tags": [
      "text"
    ]
  }
}

{
  "data": [
    {
      "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
      }
    }
  ]
}

Create a jewellery collection

post

Create a jewellery collection

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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

Responses

201

Returns created collection

application/json

403

Unauthorized

application/json

422

Unprocessable Entity

application/json

post

/collections

HTTPcURLJavaScriptPython

POST /api/jewellery/collections HTTP/1.1
Host: console.studio360.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "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
  }
}

{
  "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-collection

get

Get a jewellery-collection details by id

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

ID of the collection to fetch

Responses

200

OK

application/json

403

Unauthorized

application/json

404

Collection not found

application/json

get

/collections/{id}

HTTPcURLJavaScriptPython

GET /api/jewellery/collections/{id} 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
  }
}

Update a jewellery-collection

put

Update a jewellery-collection details by id

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

ID of the collection to update

Body

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

Responses

200

Return updated collection

application/json

403

Unauthorized

application/json

404

Collection not found

application/json

422

Unprocessable Entity

application/json

put

/collections/{id}

HTTPcURLJavaScriptPython

PUT /api/jewellery/collections/{id} HTTP/1.1
Host: console.studio360.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "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
  }
}

{
  "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
  }
}