shop

Full shop details. Includes shop data and links to load more related entities and perform actions such as creating products and variants.

HTTP GET

$ curl -X GET -H "Authorization: Bearer xxxx" -i https://api.bootic.net/v1/shops/{shop.id}.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

{
  "_class": [
    "shop"
  ],
  "_links": {
    "curies": [
      {
        "name": "btc",
        "href": "https://developers.bootic.net/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.bootic.net/v1/shops/47"
    },
    "btc:products": {
      "href": "https://api.bootic.net/v1/products?shop_ids=47",
      "title": "Products for this shop"
    },
    "btc:create_product": {
      "href": "https://api.bootic.net/v1/shops/47/products",
      "title": "Create products for this shop",
      "method": "post"
    },
    "btc:delete_product": {
      "title": "Remove a product",
      "method": "delete",
      "templated": true,
      "href": "https://api.bootic.net/v1/shops/47/products/{id}"
    },
    "btc:theme": {
      "href": "https://api.bootic.net/v1/shops/47/theme",
      "title": "HTML/CSS theme files for this shop"
    },
    "btc:orders": {
      "title": "Orders for this shop",
      "templated": true,
      "href": "https://api.bootic.net/v1/shops/47/orders{?page,per_page,q,status,code,product_id,payment_method,created_on.gte,created_on.lte,updated_on.gte,updated_on.lte,net_total.gte,net_total.lte,shipping_total.gte,shipping_total.lte,discount_total.gte,discount_total.lte,total.gte,total.lte,lat_long,distance,sort}"
    },
    "btc:order": {
      "href": "https://api.bootic.net/v1/shops/47/orders/{id}",
      "title": "Order details"
    },
    "btc:create_order": {
      "href": "https://api.bootic.net/v1/shops/47/orders",
      "title": "Create an order for this shop",
      "method": "post"
    },
    "btc:contacts": {
      "title": "Contacts (customers) for this shop",
      "templated": true,
      "href": "https://api.bootic.net/v1/shops/47/contacts{?page,per_page,created_on.gte,created_on.lte,updated_on.gte,updated_on.lte,q,sort}"
    },
    "btc:variant": {
      "href": "https://api.bootic.net/v1/shops/455/variants/{id}",
      "templated": true
    },
    "btc:create_variant": {
      "href": "https://api.bootic.net/v1/products/{product_id}/variants",
      "templated": true,
      "method": "post"
    },
    "btc:update_variant": {
      "href": "https://api.bootic.net/v1/shops/455/variants/{id}",
      "templated": true,
      "method": "put"
    },
    "btc:delete_variant": {
      "href": "https://api.bootic.net/v1/shops/455/variants/{id}",
      "templated": true,
      "method": "delete"
    },
    "btc:web": {
      "href": "http://www.acme.org",
      "type": "text/html",
      "title": "This shop's web site"
    }
  },
  "id": "47",
  "name": "Bootic",
  "subdomain": "acme",
  "url": "www.acme.org",
  "created_on": "Sat, 12 Dec 2009 23:05:46 +0000",
  "updated_on": "Fri, 20 Jun 2014 13:46:45 +0000",
  "description": "ACME Store",
  "locale": "en",
  "currency_code": "USD",
  "analytics_id": null,
  "asset_count": 125,
  "product_counts": {
    "visible": 2,
    "hidden": 1
  },
  "_embedded": {
    "account": {
      "_class": [
        "account"
      ],
      "status": "active",
      "created_on": "Mon, 20 Dec 2010 19:17:14 +0000",
      "updated_on": "Tue, 18 Jan 2011 20:34:18 +0000"
    },
    "image": {
      "_class": [
        "image",
        "asset"
      ],
      "_links": {
        "thumbnail": {
          "href": "http://api.url2png.com/v3/P4FDE2A5B29874/4fc234c5fe5a88d712716b426c412661/75x75/www.bootic.net"
        },
        "small": {
          "href": "http://api.url2png.com/v3/P4FDE2A5B29874/4fc234c5fe5a88d712716b426c412661/240x180/www.bootic.net"
        },
        "medium": {
          "href": "http://api.url2png.com/v3/P4FDE2A5B29874/4fc234c5fe5a88d712716b426c412661/500x375/www.bootic.net"
        }
      }
    },
    "branches": [
      {
        "_class": [
          "branch"
        ],
        "id": 123,
        "name": "Main store",
        "type": "Store",
        "allow_local_pickup": true,
        "_embedded": {
          "address": {
            "_class": [
              "address"
            ],
            "id": 322,
            "street": "Elm Street",
            "street_2": "",
            "locality_name": "Springwood",
            "region_name": "Ohio",
            "country_name": "USA",
            "postal_code": ""
          }
        }
      }
    ]
  }
}

Links

self

A link back to the current shop resource

btc:products

This shop products.

btc:create_product

Create a product for this shop. See create_product.

btc:delete_product

Delete a product on this shop. See delete_product.

btc:orders

List and search this shop’s orders. See orders.

btc:create_order

Create an order for this shop. See create_order.

btc:contacts

List and search this shop’s contacts.

btc:theme

The shop’s HTML/CSS theme files.

btc:create_variant

A shortcut templated link to create a variant in one of the shop’s products. It needs a product_id parameter. See create_variant

btc:update_variant

A shortcut templated link to update a variant in one the shop’s products. It needs a product_id and id parameters to identify the variant. See update_variant

btc:delete_variant

A shortcur templated link to delete a variant from one of the shop’s products. It needs a product_id and id parameters to identify the variant. See delete_variant