WinShopAPI docs
ReferenceItem lists

Jewellery / Stone colors

List stone colors

GET
/api/item-lists/jewellery/stone-colors

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Response Body

application/json
  1. response
[index: integer]?

Base item list class containing only Id and Name

curl -X GET 'https://<your-instance>/api/item-lists/jewellery/stone-colors' \  -H 'Authorization: Bearer <access-token>'
[  {    "id": 0,    "name": "string"  }]

Create a stone color

POST
/api/item-lists/jewellery/stone-colors

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Request Body

application/json
  1. body

Base item list class for creating a new Id,Name item list

name?string

Display name of the new entry, as it will appear in pickers throughout Winshop.

Response Body

curl -X POST 'https://<your-instance>/api/item-lists/jewellery/stone-colors' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{}'
Empty

Get a stone color

GET
/api/item-lists/jewellery/stone-colors/{id}

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

id*integer
Formatint32

Response Body

application/json
  1. response

Base item list class containing only Id and Name

id?integer

Row id of the item-list entry. Read-only; the server assigns it.

Formatint32
name?string

Display name of the entry, as it appears in pickers throughout Winshop.

curl -X GET 'https://<your-instance>/api/item-lists/jewellery/stone-colors/0' \  -H 'Authorization: Bearer <access-token>'
{  "id": 0,  "name": "string"}

Update a stone color

PUT
/api/item-lists/jewellery/stone-colors/{id}

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

id*integer
Formatint32

Request Body

application/json
  1. body

Base item list class containing only Id and Name

id?integer

Row id of the item-list entry. Read-only; the server assigns it.

Formatint32
name?string

Display name of the entry, as it appears in pickers throughout Winshop.

Response Body

application/json
  1. response

Base item list class containing only Id and Name

id?integer

Row id of the item-list entry. Read-only; the server assigns it.

Formatint32
name?string

Display name of the entry, as it appears in pickers throughout Winshop.

curl -X PUT 'https://<your-instance>/api/item-lists/jewellery/stone-colors/0' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": 0,  "name": "string"}