Shelves

This resource allows you to fetch, create and update the Shelf details.

You can search for any existing shelves using filters as defined here.

Methods

This method allows you to fetch the shelves details.

Pagination is supported for this resource. Click here to see the details of it.

Use the page parameter to navigate, Next-Page and Page-Count headers for pagination details.

End Point: /shelves

Sample response payload

CODE

[
 {
    "recordid": "string",
    "id": "string",
    "description": "string",
    "active": true
  }
]

Retrieves the information of a specific Shelf by providing its Shelf ID or Record ID.

End Point: /shelves/{ID}

Sample response payload

CODE

{
 "recordid": "string",
 "id": "string",
 "description": "string",
 "active": true
}

Creates a new Shelf.

End Point: /shelves/

Sample request payload

CODE

{
 "recordid": "string",
 "id": "string",
 "description": "string",
 "active": true
}

Sample response payload

CODE

{
 "recordid": "string",
 "id": "string",
 "description": "string",
 "active": true
}

Updates an existing Shelf.

End Point: /shelves/{iD}

Sample request payload

CODE

{
 "recordid": "string",
 "id": "string",
 "description": "string",
 "active": true
}

Sample response payload

CODE

{
 "recordid": "string",
 "id": "string",
 "description": "string",
 "active": true
}