Products

{
  "_links": {
    "btc:products": {
      "href": "https://api.bootic.net/v1/...{?page,q,collections,shop_subdomains...}",
      "templated": true
    }
  }
}

HTTP GET

Returns a paginated results response for all products available for the access-token’s scope, or for a given shop when in the context of a shop’s links.

$ curl -X GET -H "Authorization: Bearer xxxx" -i https://api.bootic.net/v1/products.json

Status: 200 OK
Content-Type: application/json; charset=utf-8
Connection: keep-alive
ETag: "0728e2965bd03e20a7f1c33add2f8775"
Last-Modified: Fri, 20 Jun 2014 22:34:14 GMT
Cache-Control: must-revalidate, private, max-age=0
Date: Wed, 31 Jul 2013 21:11:52 GMT
X-OAuth-Scopes: public

{
  "_links": {
    "curies": [
      {
        "name": "btc",
        "href": "https://developers.bootic.net/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.bootic.net/v1/products.json?page=1"
    },
    "next": {
      "href": "https://api.bootic.net/v1/products.json?page=2"
    },
    "last": {
      "href": "https://api.bootic.net/v1/products.json?page=290"
    }
  },
  "total_items": 14486,
  "per_page": 50,
  "page": 1,
  "_embedded": {
    "items": [

    ]
  }
}

The response is a results entity for a paginated list of items.

Product entities

The items array within the _embedded block of the products results resource is an array of summary product entities. A single product entity looks like follows:

{
  "_links": {
    "btc:web": {
      "href": "http://apitest.bootic.net/products/xy-vision",
      "type": "text/html",
      "title": "Web page for this product on its original shop front-end"
    },
    "self": {
      "href": "https://api.bootic.net/v1/products/1234"
    },
    "btc:update_product": {
      "href": "https://api.bootic.net/v1/products/1234",
      "title": "Update this product",
      "method": "put"
    }
  },
  "id": "58908",
  "slug": "xy-vision",
  "title": "XY Vision",
  "price": 16000,
  "price_comparison": null,
  "discount_percentage": null,
  "status": "visible",
  "vendor": "",
  "created_on": "2014-05-13T13:21:58.000Z",
  "updated_on": "2014-05-13T13:21:58.000Z",
  "currency_code": "CLP",
  "tags": [
    "cool",
    "new"
  ],
  "global_tags": [

  ],
  "_embedded": {
    "type": {
      "id": "eyewear",
      "name": "Anteojos"
    },
    "shop": {
      "_links": {
        "self": {
          "href": "https://api.bootic.net/v1/shops/1268"
        }
      },
      "id": "1268",
      "name": "API Test",
      "subdomain": "apitest",
      "url": "apitest.bootic.net"
    },
    "account": {
      "plan": "advanced",
      "status": "trial"
    },
    "custom_attributes": [
      {
        "id": 123433,
        "name": "Colour",
        "value": "red",
        "field_type": "string",
        "required": true,
        "key": "colour"
      }
    ],
    "image": {
      "_links": {
        "thumbnail": {
          "href": "https://o.btcdn.co/1268/thumbnail/136591-eyeglasses.jpg"
        },
        "small": {
          "href": "https://o.btcdn.co/1268/small/136591-eyeglasses.jpg"
        },
        "medium": {
          "href": "https://o.btcdn.co/1268/medium/136591-eyeglasses.jpg"
        },
        "large": {
          "href": "https://o.btcdn.co/1268/large/136591-eyeglasses.jpg"
        },
        "original": {
          "href": "https://o.btcdn.co/1268/original/136591-eyeglasses.jpg"
        }
      },
      "file_name": "eyeglasses.jpg",
      "title": "eyeglasses.jpg"
    },
    "variants": [
      {
        "title": "Default",
        "id": "126470",
        "stock": 1,
        "available_if_no_stock": true,
        "sku": null,
        "weight_in_grams": 0,
        "price": 160000,
        "price_comparison": null
      }
    ],
    "collections": [
      {
        "title": "Accesorios",
        "id": 42344,
        "shop_id": 1268,
        "slug": "accessories"
      },
      {
        "title": "Destacados",
        "id": 42345,
        "shop_id": 1268,
        "slug": "featured"
      }
    ]
  }
}

A summary product’s self link points to a full product resource.

Query string filters

Parameter name	description	example	Default value	Allowed values
q	Full text search	“?q=fashion”
page	Page number	“?page=1”	1
per_page	Products per page	“?per_page=20”	50
status	Visibility status	“?status=visible”	“visible”	visible, hidden, all
shop_subdomains	Shop subdomains, comma-separated	“?shop_subdomains=romano,acme”
collections	Collection slugs, comma-separated	“?collections=featured,summer”
shop_ids	Shop ids, comma-separated	“?shop_ids=123,3222”
tags	Tag names, comma-separated	“?tags=green,red”
variants	Variant titles, comma-separated	“?variants=xl,s
sku	Sku codes, comma-separated	“?sku=AE123,AE124”
currency	Currency code	“?currency=USD”
price_gte	Price, greater of equal than (cents)	“?price_gte=1000”
price_lte	Price less or equal than (cents)	“?price_lte=20000”
discount_percentage_gte	Discount %, greater or equal	“?discount_percentage_gte=20”
dicount_percentage_lte	Dicount %, less or equal	“?discount_percentage_lte=50
created_on_gte	Created on, greater or equal	“?created_on_gte=2013-12-22 12:00:00”
created_on_lte	Created on, less or equal	“?created_on_lte=2013-12-22 23:59:59”
updated_on_gte	Updated on, greater or equal	“?updated_on_gte=2014-01-01”
updated_on_lte	Updated on, less or equal	“?updated_on_lte=2014-02-01”
sort	Sort column	“?sort=price.asc”	created_on.desc	title.asc, title.desc, type.asc, type.desc, vendor.asc, vendor.desc, price.asc, price.desc, created_on.asc, created_on.desc, updated_on.asc, updated_on.desc, discount_percentage.asc, discount_percentage.desc