BookstoreBookstoreItemCategory

The BookstoreBookstoreItemCategory object

The BookstoreBookstoreItemCategory object looks like this in JSON:

{
    "object": "bookstore_item_category",
    "id": 9,
    "parent_id": null,
    "name": "Science Fiction",
    "status": "active",
    "order_id": 3,
    "sandbox": true
}

Attribute	Required	Data Type
id	No	int
parent_id	Yes	int
name	Yes	text (30)
status	Yes	enum (active, deleted)
order_id	Yes	int
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/itemcategories" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/itemcategories',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/itemcategories',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/itemcategories"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/itemcategories');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "bookstore_item_category",
            "id": 9,
            "parent_id": null,
            "name": "Science Fiction",
            "status": "active",
            "order_id": 3
        }
    ],
    "sandbox": true
}

Retrieves all BookstoreBookstoreItemCategory objects.

HTTP Request

GET /itemcategories

Parameters

None

Permissions

One of the following roles is required to call this method:

Campus Store Admin
Financial Admin

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/itemcategories/(bookstoreitemcategory)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/itemcategories/(bookstoreitemcategory)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/itemcategories/(bookstoreitemcategory)',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/itemcategories/(bookstoreitemcategory)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/itemcategories/(bookstoreitemcategory)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "list",
    "count": 7,
    "results": 7,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": {
        "object": "bookstore_item_category",
        "id": 9,
        "parent_id": null,
        "name": "Science Fiction",
        "status": "active",
        "order_id": 3,
        "items": []
    }
}

Retrieves a specific BookstoreBookstoreItemCategory object. Includes all Items in the specified ItemCategory.

HTTP Request

GET /itemcategories/(bookstoreitemcategory)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

Any role may call this method.