Assets

Assets Management

Get jewellery-assets

get

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
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: asset_noPossible values:
order_typestring · enumOptional

Order type - asc or desc.

Default: descPossible values:
Responses
chevron-right
200

OK

application/json
countintegerOptional

Total number of records

limitintegerOptional

Limit of records fetched

offsetintegerOptional

Offset of records fetched

get
/assets

Get a jewellery-asset

get

Get a jewellery-asset details by id

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

ID of the asset to fetch

Responses
chevron-right
200

OK

application/json

A jewellery asset for display

idstring · uuidRead-onlyRequired

Unique identifier of the asset

asset_nonumberRead-onlyRequired

A numeric identifier of the asset

asset_namestringRequired

Name of the asset

asset_type_codestring · enumRequired

Type of the asset i.e. Ring, Earring, Necklace etc. Values are:

  • BN: Bangle
  • BR: Bracelet
  • E: Earring
  • N: Necklace
  • NE: Necklace + Earring
  • NET: Necklace + Earring + Tikka
  • P: Pendant
  • R: Ring
  • W: Watch
  • D: Diamond
  • A: Accessories
Possible values:
asset_typestringRequired

Type of the asset i.e. Ring, Earring, Necklace etc.

background_colorstring · enumRead-onlyRequired

Background color of the asset Values are:

  • B: Black
  • BM: Black-Matt
  • W: White
  • WM: White-Matt
  • O: Other
Possible values:
tagsstring[]Required

Tags associated with the asset

expires_atstring · date-timeRequired

URL expiration date

thumbnailstring · uriRequired

Thumbnail url of the asset

previewstring · uriRequired

Animated preview url of the asset

datestring · date-timeOptional

Date of asset creation

statusstring · enumRequired

Status of the asset

Possible values:
get
/assets/{id}

Update a jewellery-asset

put

Update a jewellery-asset details by id.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

ID of the asset to update

Body

Request schema for updating an asset

asset_namestring · max: 32Required

Name of the asset (unique). Allowed characters are alphabets, numbers, hyphen and underscore.

tagsstring[]Optional

Tags associated with the asset. Tag names should be registered at the settings section of your account.

Responses
chevron-right
200

Asset updated successfully

application/json
messagestringRequired
put
/assets/{id}

Last updated