Query for categories

GET 
/api/v3/item_category

Request

Query Parameters

where string

item_category_id:EQUALS:1

order string

item_category_id:ASC

limit string

2

offset string

8

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object[]

Array [

item_category_id integer

Item category ID #

name string

Category name

external_key string

External key value

]

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": [
    {
      "item_category_id": 0,
      "name": "string",
      "external_key": "string"
    }
  ]
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "response": [
    {
      "item_category_id": 1,
      "name": "Root",
      "external_key": null
    },
    {
      "item_category_id": 2,
      "name": "Cars",
      "external_key": ""
    },
    {
      "item_category_id": 3,
      "name": "Motorcycles",
      "external_key": ""
    },
    {
      "item_category_id": 4,
      "name": "Trucks",
      "external_key": ""
    },
    {
      "item_category_id": 8,
      "name": "SUVs",
      "external_key": ""
    },
    {
      "item_category_id": 7,
      "name": "Sports Cars",
      "external_key": ""
    },
    {
      "item_category_id": 9,
      "name": "Ducati",
      "external_key": ""
    },
    {
      "item_category_id": 10,
      "name": "Kawasaki",
      "external_key": ""
    },
    {
      "item_category_id": 11,
      "name": "Triumph",
      "external_key": ""
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...