Querying for items

GET 
/api/v3/item

Available query parameter values for filtering:

• item_id
• name
• external_key
• accounting_sku
• item_type
• custom_1
• custom_2
• custom_3

Valid values for item_type

• service (for Services)
• discount (for Discounts)

Request

Query Parameters

where string

item_type:EQUALS:service

order string

item_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

Example (from schema)

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

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "response": [
    {
      "item_id": 1,
      "item_type": "service",
      "tierset_id": 1,
      "name": "My Test Service Plan",
      "description": "This is a ChargeOver test item.",
      "units": "",
      "accounting_sku": null,
      "external_key": null,
      "token": "d56c047651ec",
      "custom_1": "",
      "custom_2": "",
      "custom_3": "",
      "write_datetime": "2014-12-02 18:46:48",
      "mod_datetime": "2014-12-02 18:46:48",
      "units_plural": "",
      "tiersets": [
        {
          "tierset_id": 1,
          "setup": 0,
          "base": 10.95,
          "paycycle": "mon",
          "pricemodel": "fla",
          "write_datetime": "2014-12-02 18:46:48",
          "mod_datetime": "2014-12-02 18:46:48",
          "setup_formatted": "$ 0.00",
          "base_formatted": "$ 10.95",
          "pricemodel_desc": "Flat Pricing (e.g. $X dollars per month)",
          "tiers": []
        }
      ]
    }
  ]
}

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...