Products

The Products API provides a simple interface to manage the Product Catalog.

The catalog lists products available in your account. To add products to a deal, you should create an Order, then populate it with Line Items.

The API allows you to create, delete and update your products. You can also retrieve a single product as well as list of all products.

All users can read the Product Catalog, but it can be edited only by an account administrator. However, changes to products can be completely disabled in account's settings. When disabled, all data are preserved and only GET requests are allowed, even for administrators.

Line Items, Products and Orders are available only to users who are on the Enterprise plan.

JSON format

Retrieve all products

GET /v2/products

Returns all products from the catalog according to the parameters provided.

Parameters

Allowed for

• Agents

Using cURL

curl -v -X GET https://api.getbase.com/v2/products \-H "Accept: application/json" \-H "Authorization: Bearer $ACCESS_TOKEN"

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "items": [    {      "data": {        "id": 1,        "name": "Enterprise Plan",        "sku": "enterprise-plan",        "description": "Includes more storage options",        "active": true,        "prices": [          {            "amount": "1599.99",            "currency": "USD"          },          {            "amount": "3599.99",            "currency": "PLN"          }        ],        "cost": "999.99",        "cost_currency": "USD",        "max_discount": 15,        "max_markup": null,        "created_at": "2014-08-27T16:32:56Z",        "updated_at": "2014-08-27T17:32:56Z"      },      "meta": {        "type": "product"      }    }  ],  "meta": {    "type": "collection",    "count": 1,    "links": {      "self": "http://api.getbase.com/v2/products?page=1&per_page=25"    }  }}

---

Create a product

POST /v2/products

Create a new product.

Products can be created only by an account administrator.

Parameters

Allowed for

• Admins

Using cURL

curl -v -X POST https://api.getbase.com/v2/products \-H "Accept: application/json" \-H "Content-Type: application/json" \-H "Authorization: Bearer $ACCESS_TOKEN" \-d '{  "data": {    "name": "Enterprise Plan",    "sku": "enterprise-plan",    "description": "Includes more storage options",    "active": true,    "prices": [      {        "amount": "1599.99",        "currency": "USD"      },      {        "amount": "3599.99",        "currency": "PLN"      }    ],    "cost": "1599.99",    "cost_currency": "USD",    "max_discount": 15  },  "meta": {    "type": "product"  }}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "data": {    "id": 1,    "updated_at": "2014-08-27T16:32:56Z",    "created_at": "2014-08-27T16:32:56Z",    "active": true,    "name": "Enterprise Plan",    "sku": "enterprise-plan",    "description": "Includes more storage options",    "prices": [      {        "amount": "1599.99",        "currency": "USD"      },      {        "amount": "3599.99",        "currency": "PLN"      }    ],    "max_discount": 15,    "max_markup": null,    "cost": "1599.99",    "cost_currency": "USD"  },  "meta": {    "type": "product"  }}

---

Retrieve a single product

GET /v2/products/:id

Returns a single product, according to the unique product ID provided. If the specified product does not exist, the request will return an error.

Parameters

Allowed for

• Agents

Using cURL

curl -v -X GET https://api.getbase.com/v2/products/1 \-H "Accept: application/json" \-H "Authorization: Bearer $ACCESS_TOKEN"

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "data": {    "id": 1,    "updated_at": "2014-08-27T16:32:56Z",    "created_at": "2014-08-27T16:32:56Z",    "active": true,    "name": "Enterprise Plan",    "sku": "enterprise-plan",    "description": "Includes more storage options",    "prices": [      {        "amount": "1599.99",        "currency": "USD"      },      {        "amount": "3599.99",        "currency": "PLN"      }    ],    "max_discount": 15,    "max_markup": null,    "cost": "1599.99",    "cost_currency": "USD"  },  "meta": {    "type": "product"  }}

---

Update a product

PUT /v2/products/:id

Updates product information. If the specified product does not exist, the request will return an error.

Products can be modified only by an account administrator.

In order to modify prices used on a record, you need to supply the entire set. prices are replaced every time they are used in a request.

Parameters

Allowed for

• Agents

Using cURL

curl -v -X PUT https://api.getbase.com/v2/products/1 \-H "Accept: application/json" \-H "Content-Type: application/json" \-H "Authorization: Bearer $ACCESS_TOKEN" \-d '{  "data": {    "active": false  }}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "data": {    "id": 1,    "updated_at": "2014-08-27T16:32:56Z",    "created_at": "2014-08-27T16:32:56Z",    "active": false,    "name": "Enterprise Plan",    "sku": "enterprise-plan",    "description": "Includes more storage options",    "prices": [      {        "amount": "1599.99",        "currency": "USD"      },      {        "amount": "3599.99",        "currency": "PLN"      }    ],    "max_discount": 15,    "max_markup": null,    "cost": "1599.99",    "cost_currency": "USD"  },  "meta": {    "type": "product"  }}

---

Delete a product

DELETE /v2/products/:id

Delete an existing product from the catalog. Existing orders and line items are not affected. If the specified product does not exist, the request will return an error. This operation cannot be undone.

Products can be removed only by an account administrator.

Allowed for

• Agents

Using cURL

curl -v -X DELETE https://api.getbase.com/v2/products/1 \-H "Authorization: Bearer $ACCESS_TOKEN"

Example response

HTTP/1.1 204 No Content

---