Products

Use products to describe the goods and services that your business sells. A product also describes sales items on invoices and receipts. Product pricing is defined in plans. A product may have one or many plans.

For information on the product resource, see Product.

Operations

Retrieve products

Request

Retrieves a list of products.

Security
SecretApiKey or JWT or ApplicationJWT
Query
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

qstring

Use this field to perform a partial search of text fields.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/products?filter=string&sort=string&limit=1000&offset=1000&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of products retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the product.

Example:"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"
namestring, [ 3 .. 255 ] charactersrequired

Name of the product.

Example:"Premium membership"
unitLabelstring, [ 1 .. 50 ] characters

Unit label, such as per seat or per unit.

Default:"unit"
Example:"seat"
descriptionstring or null, <= 512 characters

Description of the product.

requiresShippingboolean

Specifies if the product requires shipping. If this value is true, shipping calculations are applied.

Default:false
Example:false
optionsArray of strings

Product options such as color, size, and so forth. Product option values are defined in plans. For more information, see Plans.

taxCategoryIdstring or null

Tax category of the product. For a complete list of supported tax categories, see TaxJar sales tax API reference. If none of the tax categories from the list are applicable for your product, use the general tax category 00000.

Example:"00000"
accountingCodestring or null

Accounting code of the product.

Example:"4010"
recognitionobject or null
customFieldsobject(ResourceCustomFields)

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

Default:{}
Example:
{
  "foo": "bar"
}
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "prod_0YV7DES3WPC5J8JD8QTVNZBZNZ",
    "name": "Premium membership",
    "unitLabel": "seat",
    "description": "string",
    "requiresShipping": false,
    "options": [ … ],
    "taxCategoryId": "00000",
    "accountingCode": "4010",
    "recognition": { … },
    "customFields": { … },
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]