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[]

Array [

item_id integer

Item ID #

item_type string

Item type

name string

Item name

description string

Description

enabled boolean

Enabled/disabled

accounting_sku string

Accounting SKU

accounting_account_income string

Accounting Income Account

external_key string

External key value

units string

Units string

units_plural string

Units string pluralized

tax_group_id integer

Tax group ID #

tax_group_name string

Tax group name

expire_recurs integer

Default number of times to recur

trial_recurs integer

Default number of times to skip/free trial cycles

token string

Unique token

tierset_id integer

Default pricing tierset ID #

write_datetime string

Date/time the item was created

mod_datetime string

Date/time the item was last updated

custom_1 string

Custom field value #1

custom_2 string

Custom field value #2

custom_3 string

Custom field value #3

custom_4 string

Custom field value #4

custom_5 string

Custom field value #5

custom_6 string

Custom field value #6

custom_7 string

Custom field value #7

custom_8 string

Custom field value #8

custom_9 string

Custom field value #9

custom_10 string

Custom field value #10

custom_11 string

Custom field value #11

custom_12 string

Custom field value #12

custom_13 string

Custom field value #13

custom_14 string

Custom field value #14

custom_15 string

Custom field value #15

custom_16 string

Custom field value #16

custom_17 string

Custom field value #17

custom_18 string

Custom field value #18

custom_19 string

Custom field value #19

custom_20 string

Custom field value #20

]

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": [
    {
      "item_id": 0,
      "item_type": "string",
      "name": "string",
      "description": "string",
      "enabled": true,
      "accounting_sku": "string",
      "accounting_account_income": "string",
      "external_key": "string",
      "units": "string",
      "units_plural": "string",
      "tax_group_id": 0,
      "tax_group_name": "string",
      "expire_recurs": 0,
      "trial_recurs": 0,
      "token": "string",
      "tierset_id": 0,
      "write_datetime": "string",
      "mod_datetime": "string",
      "custom_1": "string",
      "custom_2": "string",
      "custom_3": "string",
      "custom_4": "string",
      "custom_5": "string",
      "custom_6": "string",
      "custom_7": "string",
      "custom_8": "string",
      "custom_9": "string",
      "custom_10": "string",
      "custom_11": "string",
      "custom_12": "string",
      "custom_13": "string",
      "custom_14": "string",
      "custom_15": "string",
      "custom_16": "string",
      "custom_17": "string",
      "custom_18": "string",
      "custom_19": "string",
      "custom_20": "string"
    }
  ]
}

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