iotoms Docs

Get a color

GET
/api/v1/catalog/attributes/colors/{id}

Returns one product color by its numeric ID. The response is the bare object, without the standard {status, message, data} envelope; an unknown ID returns an error.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*integer

ID of the record.

Formatint64

Response Body

OK

*/*
  1. response
id?|

Color ID. Set by the server; use it in the URL of Get, Update and Delete a color.

Formatint64
name*string

Color name shown on items, e.g. "Navy". Required, and must be unique across the merchant's colors.

status*string

Free-text status for the color. Defaults to "active".

modifiedTime*string

When the color was last changed, ISO 8601. Defaults to the current time if not sent.

Formatdate-time
Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/catalog/attributes/colors/0'
Example Response
{  "id": 0,  "name": "string",  "status": "string",  "modifiedTime": "2019-08-24T14:15:22Z"}