Shopkit Developers

Tools, Docs and API's for developing with Shopkit.

Developers › API


 Back to top

Shopkit API

Welcome to the Shopkit REST API documentation.

For now there are only a few available methods. We will add more over time.

If you have a suggestion, find a bug or something worth fixing, create an issue or a pull request on the Github repo.

Last Modified 2017-01-13T18:24:04+00:00

API Status

Authentication

You must first create a new API key from your store administration area:

  1. Login into your store.

  2. Navigate to the API section under the Account settings > Developers.

  3. Create a new API key

Do not share your API keys with other users or store them in insecure places.

All requests to the API must be authenticated with an API key in one of two ways:

  1. In the URL as the X-API-KEY parameter:
https://api.shopk.it/v1/?X-API-KEY=0bb18b34ba33cb2d7c55d568353fdc6f345b8d78
  1. In the HTTP Authorization header:
X-API-KEY: 0bb18b34ba33cb2d7c55d568353fdc6f345b8d78

Endpoints

All API requests are made to https://api.shopk.it/ and all requests are served over HTTPS. The current version is v1.

Schema

The API only supports JSON. (2005 called and wants its XML back)

All timestamps are returned in ISO 8601 format: YYYY-MM-DDTHH:MM:SS±HH:MM

HTTP Verbs

Where possible, the API strives to use appropriate HTTP verbs for each action.

Verb Description
GET Used for retrieving resources.
POST Used for creating resources.
PUT Used for updating resources, or performing custom actions.
DELETE Used for deleting resources.

Rate Limiting

You can make up to 3600 requests per hour.

Pagination

Requests that return multiple items will be paginated to 25 items by default.

You can specify further pages with the page parameter. For some resources, you can also set a custom page size up to 50 with the limit parameter.

{
   "paging" : {
      "previous" : "https://api.shopk.it/v1/product?limit=50&page=1",
      "next" : "https://api.shopk.it/v1/product?limit=50&page=3"
   }
}

Note that omitting the page parameter will return the first page.

Note that for technical reasons not all endpoints respect the limit parameter.

Errors

There are 3 possible types of client errors on API calls: 400, 401 and 404.

An error will return JSON in the following format:

{
  "message" : "Bad request"
}

Making a request

If you are sending data to the API, you need to make sure you correctly set the Content-Type header.

This is a simple example on how to update an order:

curl -i -X PUT \
-H 'X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78' \
-H 'Content-Type:application/json' \
-d '{"paid":true, "status_alias":"sent"}' \
https://api.shopk.it/v1/order/1337

Response: 200 OK

{
    "id": 1337,
    "hash": "2e59759fb542d880ed58175d0626b34cf079b1f5",
    "total": 92.84,
    "subtotal": 77.32,
    "product_tax": 16.01,
    "total_tax": 16.01,
    "discount": 7.73,
    "shipping": {
        "value": 7.25,
        "tax": 0,
        "tax_percent": 0,
        "discount": 0,
        "discount_percent": 0
    },
    "coupon_code": "bajevolp",
    "created_at": "2014-11-19T00:44:19+00:00",
    "update_at": "2014-11-26T15:30:00+00:00",
    "sent_at": "2014-11-25T15:00:20+00:00",
    "paid_at": "2014-11-25T25:00:20+00:00",
    "currency": "EUR",
    "payment": {
        "type": "Multibanco",
        "data": {
            "entity": 88888,
            "reference": 888888888,
            "value": 92.84
        }
    },
    "status": 3,
    "status_alias": "sent",
    "paid": true,
    "is_new": false,
    "invoice_url": null,
    "weight": 0,
    "observations": "",
    "custom_field": "",
    "coupon": {
        "code": "bajevolp",
        "type": "percent",
        "value": 10
    },
    "shipment_method": "Transportadora",
    "client": {
        "name": "Shopkit",
        "email": "info@shopk.it",
        "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08\n",
        "postcode": "6000-767",
        "town": "Castelo Branco",
        "country": "Portugal - Continental",
        "country_code": "PRT",
        "phone": "969057993",
        "fiscal_id": ""
    },
    "products": [
        {
            "id": 44753,
            "title": "Shelving Tree with Birds",
            "option": "Azul / Small",
            "reference": "STHFBF7574",
            "price": 77.32,
            "tax": 23,
            "quantity": 1,
            "discount": 7.732,
            "subtotal": 85.59324,
            "discount_percent": 10,
            "weight": 0,
            "url": "https://parallax.shopk.it/product/shelving-tree-with-birds",
            "description_short": "This is a tree decal that is created to work with standard 24\" wall shelves that you…",
            "image":{
                "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/4778681bb73229d7d038c077c741b7bd.jpg",
                "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/4778681bb73229d7d038c077c741b7bd.jpg",
                "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/4778681bb73229d7d038c077c741b7bd.jpg"
            }
        }
    ]
}

Resources

Store

Get Store

Get Store
GET/

Get Store info. No parameters

curl -i -X GET \
-H 'X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78' \
https://api.shopk.it/v1/

Example URI

GET https://api.shopk.it/v1/
Response  200
HideShow
Headers
Content-Length: 4284
Content-Type: application/json
Body
{
  "username": "parallax",
  "name": "Parallax",
  "logo": null,
  "description": "A Shopkit é um serviço que te permite criar a tua loja on-line de forma fácil, prática e adequada ao teu tipo de negócio. O processo é simples e rápido. Em 5 minutos estás pronto para começar a vender os teus produtos on-line.",
  "notice": "Portes grátis para encomendas superiores a 59€",
  "facebook": "https://www.facebook.com/shopkit",
  "twitter": "https://twitter.com/shopkit_pt",
  "instagram": "https://www.instagram.com/shopk.it/",
  "pinterest": null,
  "show_email": false,
  "email": "info@shopk.it",
  "phone": null,
  "cellphone": "(+351) 969 057 993",
  "address": "Avª do Empresário, 1, S1.08\n6000-767 Castelo Branco",
  "basecolor": "#db0a5b",
  "favicon": null,
  "latitude": "39.818466068593935",
  "longitude": "-7.491968556808545",
  "currency": "EUR",
  "custom_css": null,
  "custom_js": null,
  "custom_html": null,
  "footer_info": "Os produtos listados são apenas de apresentação e não se encontram á venda.",
  "page_title": "Parallax",
  "meta_description": "A Shopkit é um serviço que te permite criar a tua loja on-line de forma fácil, prática e adequada ao teu tipo de negócio. O processo é simples e rápido. Em 5 minutos estás pronto para começar a vender os teus produtos on-line.",
  "meta_tags": null,
  "navigation": {
    "primary": [
      {
        "menu_text": "Home",
        "menu_type": "menu_page",
        "menu_url": "https://parallax.shopk.it",
        "menu_item": "/",
        "target_blank": false
      },
      {
        "menu_text": "Sobre nós",
        "menu_type": "menu_page",
        "menu_url": "https://parallax.shopk.it/sobre-nos",
        "menu_item": "sobre-nos",
        "target_blank": false
      },
      {
        "menu_text": "Blog",
        "menu_type": "menu_page",
        "menu_url": "https://parallax.shopk.it/blog",
        "menu_item": "blog",
        "target_blank": false
      },
      {
        "menu_text": "Promoções",
        "menu_type": "menu_page",
        "menu_url": "https://parallax.shopk.it/promocoes",
        "menu_item": "promocoes",
        "target_blank": false
      },
      {
        "menu_text": "Novidades",
        "menu_type": "menu_page",
        "menu_url": "https://parallax.shopk.it/novidades",
        "menu_item": "novidades",
        "target_blank": false
      },
      {
        "menu_text": "Contactos",
        "menu_type": "menu_page",
        "menu_url": "https://parallax.shopk.it/contatos",
        "menu_item": "contatos",
        "target_blank": false
      }
    ],
    "secondary": [
      {
        "menu_text": "Termos e condições",
        "menu_type": "menu_page",
        "menu_url": "https://parallax.shopk.it/page/termos-e-condicoes",
        "menu_item": "10713",
        "target_blank": false
      },
      {
        "menu_text": "Politica de Privacidade",
        "menu_type": "menu_page",
        "menu_url": "https://parallax.shopk.it/page/politica-de-privacidade",
        "menu_item": "10714",
        "target_blank": false
      }
    ]
  },
  "payments": {
    "paypal": {
      "active": true,
      "email": "email@example.com",
      "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "min_value": null,
      "max_value": null
    },
    "multibanco": {
      "active": true,
      "entity": 88888,
      "user": "USER88888",
      "cin": 888,
      "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "min_value": 1,
      "max_value": null
    },
    "bank_transfer": {
      "active": true,
      "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "min_value": null,
      "max_value": null
    },
    "on_delivery": {
      "active": false,
      "value": 0,
      "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "min_value": null,
      "max_value": null
    },
    "pick_up": {
      "active": true,
      "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "min_value": null,
      "max_value": null
    }
  },
  "category_default_order": null,
  "assets": {
    "url": "https://drwfxyu78e9uq.cloudfront.net/templates/assets/shopkit/parallax",
    "images": "https://drwfxyu78e9uq.cloudfront.net/templates/assets/shopkit/parallax/img",
    "css": "https://drwfxyu78e9uq.cloudfront.net/css/store/parallax/style.css?template=shopkit/parallax&last_modified=1479844384",
    "plugins": "https://drwfxyu78e9uq.cloudfront.net/templates/assets/shopkit/parallax/js/plugins.js?template=shopkit/parallax&last_modified=1479844384",
    "scripts": "https://drwfxyu78e9uq.cloudfront.net/templates/assets/shopkit/parallax/js/script.js?template=shopkit/parallax&last_modified=1479844384"
  },
  "images_header": [
    "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/14bb24a112fafccdd36680be2b03f4ce.jpg",
    "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/c788681a62eff02c640765d3c215c920.jpg",
    "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/f669d550743b2e27a81c22812b270101.jpg"
  ],
  "taxes_included": true
}

Products

Get Product

Get Product
GET/product/

Get a product by id or handle. Only one parameter is required.

curl -i -X GET \
-H 'X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78' \
https://api.shopk.it/v1/product/1337

Example URI

GET https://api.shopk.it/v1/product/
URI Parameters
HideShow
id
integer (required) Example: 1337

Product identifier

handle
string (required) Example: rustic-bowl

Product handle

Response  200
HideShow
Headers
Content-Length: 6625
Content-Type: application/json
Body
{
  "id": 1337,
  "title": "Rustic Spice Bowl Set",
  "reference": "",
  "price": 40.73,
  "price_promo": 0,
  "price_on_request": false,
  "created_at": "2014-11-30T01:04:40+00:00",
  "status": 1,
  "status_alias": "active",
  "position": 0,
  "shipping": 0,
  "shipping_alone": false,
  "featured": false,
  "new": true,
  "is_promotion": false,
  "description": "<p>This set of four rustic, pinch pots have been hand formed by me from textured, earthy stoneware clay. After shaping and drying, I bisque fired them and then glazed them in contrasting shades of white and dark turquoise. Pieces then went back into the kiln and were high fired, giving them strength and durability. These bowls are ideal for spices, dukkah, oil, chopped chilli or garlic.&nbsp;<br /><br />In many of my ceramic pieces you will find slight imperfections and marks left by the handmade process. These contribute to the uniqueness and beauty of the forms and are simply part of the character of the individual piece.<br /><br />Larger size (x2) - 8cm (3\") across, 5cm (2\") deep<br />Mid size - 7cm (2.5\") across, 5cm (2\") deep<br />Small size - 5cm (2\") across, 4cm (1.5\") deep<br /><br />Please Note : These items are MADE TO ORDER and may vary slightly from the image shown. Current make time is 2-3 weeks.&nbsp;<br /><br />*food, oven and dishwasher safe<br />*not suitable for microwave</p>",
  "video_url": "",
  "file": null,
  "tax": 0,
  "meta_description": "This set of four rustic, pinch pots have been hand formed by me from textured, earthy stoneware clay. After shaping and drying, I bisque fired them and then glazed them in contrasting shades of white and dark turquoise. Pieces then went back into the kiln",
  "meta_tags": "",
  "handle": "rustic-spice-bowl-set",
  "page_title": "Rustic Spice Bowl Set",
  "weight": 0,
  "hits": 104,
  "description_short": "This set of four rustic, pinch pots have been hand formed by me from textured, earthy&#8230;",
  "promo": false,
  "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set",
  "add_cart_url": "https://parallax.shopk.it/cart/add/rustic-spice-bowl-set",
  "permalink": "https://parallax.shopk.it/product/rustic-spice-bowl-set",
  "video_embed_url": false,
  "sales": 0,
  "images": {
    "1": {
      "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/17d23f7b534bf365580989363da328d2.jpg",
      "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/17d23f7b534bf365580989363da328d2.jpg",
      "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/17d23f7b534bf365580989363da328d2.jpg"
    },
    "2": {
      "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/7d2fe8d66dd9925ac72a3112d691f352.jpg",
      "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/7d2fe8d66dd9925ac72a3112d691f352.jpg",
      "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/7d2fe8d66dd9925ac72a3112d691f352.jpg"
    },
    "3": {
      "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/ff2216454ebbf8ca2727335ecacbc472.jpg",
      "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/ff2216454ebbf8ca2727335ecacbc472.jpg",
      "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/ff2216454ebbf8ca2727335ecacbc472.jpg"
    }
  },
  "image": {
    "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/472c46da6a786edb5b67cf338c2b9c58.jpg",
    "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/472c46da6a786edb5b67cf338c2b9c58.jpg",
    "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/472c46da6a786edb5b67cf338c2b9c58.jpg"
  },
  "options": [
    {
      "id": "192867",
      "id_variant_1": "45896",
      "id_variant_2": "90261",
      "id_variant_3": "",
      "title": "Small bowl / White",
      "price": "40.73",
      "promo": false,
      "price_promo": "0",
      "price_on_request": "",
      "stock": "99",
      "shipping": "0",
      "weight": "0",
      "active": "1",
      "reference": "RSBS001",
      "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=192867",
      "image": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/472c46da6a786edb5b67cf338c2b9c58.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/472c46da6a786edb5b67cf338c2b9c58.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/472c46da6a786edb5b67cf338c2b9c58.jpg"
      }
    },
    {
      "id": "192868",
      "id_variant_1": "45896",
      "id_variant_2": "90262",
      "id_variant_3": "",
      "title": "Small bowl / Dark turquoise",
      "price": "40.73",
      "promo": false,
      "price_promo": "0",
      "price_on_request": "",
      "stock": "95",
      "shipping": "0",
      "weight": "0",
      "active": "1",
      "reference": "RSBS002",
      "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=192868",
      "image": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/472c46da6a786edb5b67cf338c2b9c58.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/472c46da6a786edb5b67cf338c2b9c58.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/472c46da6a786edb5b67cf338c2b9c58.jpg"
      }
    },
    {
      "id": "192869",
      "id_variant_1": "45897",
      "id_variant_2": "90261",
      "id_variant_3": "",
      "title": "Big bowl / White",
      "price": "45.73",
      "promo": false,
      "price_promo": "0",
      "price_on_request": "",
      "stock": "100",
      "shipping": "0",
      "weight": "0",
      "active": "1",
      "reference": "RSBS003",
      "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=192869",
      "image": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/472c46da6a786edb5b67cf338c2b9c58.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/472c46da6a786edb5b67cf338c2b9c58.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/472c46da6a786edb5b67cf338c2b9c58.jpg"
      }
    },
    {
      "id": "192870",
      "id_variant_1": "45897",
      "id_variant_2": "90262",
      "id_variant_3": "",
      "title": "Big bowl / Dark turquoise",
      "price": "45.73",
      "promo": false,
      "price_promo": "0",
      "price_on_request": "",
      "stock": "100",
      "shipping": "0",
      "weight": "0",
      "active": "1",
      "reference": "RSBS004",
      "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=192870",
      "image": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/472c46da6a786edb5b67cf338c2b9c58.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/472c46da6a786edb5b67cf338c2b9c58.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/472c46da6a786edb5b67cf338c2b9c58.jpg"
      }
    }
  ],
  "categories": [
    {
      "id": 1337,
      "parent": 0,
      "title": "Cozinha",
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque lacus neque, dapibus eu volutpat a, consectetur elementum purus. Nam quis eros eu nunc mollis venenatis.",
      "handle": "cozinha",
      "url": "https://parallax.shopk.it/category/cozinha"
    }
  ],
  "option_groups": [
    {
      "title": "Size",
      "options": [
        {
          "id": "45896",
          "title": "Small bowl"
        },
        {
          "id": "45897",
          "title": "Big bowl"
        }
      ]
    },
    {
      "title": "Color",
      "options": [
        {
          "id": "90261",
          "title": "White"
        },
        {
          "id": "90262",
          "title": "Dark turquoise"
        }
      ]
    }
  ],
  "stock": {
    "stock_enabled": true,
    "stock_qty": 100,
    "stock_backorder": true,
    "stock_show": true,
    "stock_sold_single": true,
    "stock_notify": "5"
  }
}
Response  404
HideShow
Headers
Content-Length: 24
Content-Type: application/json
Body
{
  "message": "Not found."
}

Get Products

Get Products
GET/product{?category,status,status_alias,reference,featured,new,page,limit}

Get a list of products

curl -i -X GET \
-H 'X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78' \
https://api.shopk.it/v1/product/?category=1337&limit=5

Example URI

GET https://api.shopk.it/v1/product?category=1337&status=0&status_alias=all&reference=bowl-001&featured=true&new=true&page=1&limit=10
URI Parameters
HideShow
category
integer (optional) Example: 1337

Product category identifier

status
integer (optional) Example: 0

Product status as an integer

Choices: 0 1 2 3 4

status_alias
string (optional) Example: all

Product status as a string

Choices: all active hidden out_of_stock soon

reference
string (optional) Example: bowl-001

Product reference

featured
string (optional) Example: true

Product featured field

Choices: true false

new
string (optional) Example: true

Product new field

Choices: true false

page
integer (optional) Example: 1

page number

limit
integer (optional) Default: 25 Example: 10

products per page

Response  200
HideShow
Headers
Content-Length: 9558
Content-Type: application/json
Body
{
  "0": {
    "id": 1337,
    "title": "Rustic Spice Bowl Set",
    "reference": "",
    "price": 40.73,
    "price_promo": 0,
    "price_on_request": false,
    "created_at": "2014-11-30T01:04:40+00:00",
    "status": 1,
    "status_alias": "active",
    "position": 0,
    "shipping": 0,
    "shipping_alone": false,
    "featured": false,
    "new": true,
    "is_promotion": false,
    "description": "<p>This set of four rustic, pinch pots have been hand formed by me from textured, earthy stoneware clay. After shaping and drying, I bisque fired them and then glazed them in contrasting shades of white and dark turquoise. Pieces then went back into the kiln and were high fired, giving them strength and durability. These bowls are ideal for spices, dukkah, oil, chopped chilli or garlic.&nbsp;<br /><br />In many of my ceramic pieces you will find slight imperfections and marks left by the handmade process. These contribute to the uniqueness and beauty of the forms and are simply part of the character of the individual piece.<br /><br />Larger size (x2) - 8cm (3\") across, 5cm (2\") deep<br />Mid size - 7cm (2.5\") across, 5cm (2\") deep<br />Small size - 5cm (2\") across, 4cm (1.5\") deep<br /><br />Please Note : These items are MADE TO ORDER and may vary slightly from the image shown. Current make time is 2-3 weeks.&nbsp;<br /><br />*food, oven and dishwasher safe<br />*not suitable for microwave</p>",
    "video_url": "",
    "file": null,
    "tax": 0,
    "meta_description": "This set of four rustic, pinch pots have been hand formed by me from textured, earthy stoneware clay. After shaping and drying, I bisque fired them and then glazed them in contrasting shades of white and dark turquoise. Pieces then went back into the kiln",
    "meta_tags": "",
    "handle": "rustic-spice-bowl-set",
    "page_title": "Rustic Spice Bowl Set",
    "weight": 0,
    "hits": 104,
    "description_short": "This set of four rustic, pinch pots have been hand formed by me from textured, earthy&#8230;",
    "promo": false,
    "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set",
    "add_cart_url": "https://parallax.shopk.it/cart/add/rustic-spice-bowl-set",
    "permalink": "https://parallax.shopk.it/product/rustic-spice-bowl-set",
    "video_embed_url": false,
    "sales": 0,
    "images": {
      "1": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/17d23f7b534bf365580989363da328d2.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/17d23f7b534bf365580989363da328d2.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/17d23f7b534bf365580989363da328d2.jpg"
      },
      "2": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/7d2fe8d66dd9925ac72a3112d691f352.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/7d2fe8d66dd9925ac72a3112d691f352.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/7d2fe8d66dd9925ac72a3112d691f352.jpg"
      },
      "3": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/ff2216454ebbf8ca2727335ecacbc472.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/ff2216454ebbf8ca2727335ecacbc472.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/ff2216454ebbf8ca2727335ecacbc472.jpg"
      }
    },
    "image": {
      "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/472c46da6a786edb5b67cf338c2b9c58.jpg",
      "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/472c46da6a786edb5b67cf338c2b9c58.jpg",
      "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/472c46da6a786edb5b67cf338c2b9c58.jpg"
    },
    "options": [
      {
        "id": "192867",
        "id_variant_1": "45896",
        "id_variant_2": "90261",
        "id_variant_3": "",
        "title": "Small bowl / White",
        "price": "40.73",
        "promo": false,
        "price_promo": "0",
        "price_on_request": "",
        "stock": "99",
        "shipping": "0",
        "weight": "0",
        "active": "1",
        "reference": "RSBS001",
        "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=192867",
        "image": {
          "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/472c46da6a786edb5b67cf338c2b9c58.jpg",
          "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/472c46da6a786edb5b67cf338c2b9c58.jpg",
          "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/472c46da6a786edb5b67cf338c2b9c58.jpg"
        }
      },
      {
        "id": "192868",
        "id_variant_1": "45896",
        "id_variant_2": "90262",
        "id_variant_3": "",
        "title": "Small bowl / Dark turquoise",
        "price": "40.73",
        "promo": false,
        "price_promo": "0",
        "price_on_request": "",
        "stock": "95",
        "shipping": "0",
        "weight": "0",
        "active": "1",
        "reference": "RSBS002",
        "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=192868",
        "image": {
          "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/472c46da6a786edb5b67cf338c2b9c58.jpg",
          "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/472c46da6a786edb5b67cf338c2b9c58.jpg",
          "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/472c46da6a786edb5b67cf338c2b9c58.jpg"
        }
      },
      {
        "id": "192869",
        "id_variant_1": "45897",
        "id_variant_2": "90261",
        "id_variant_3": "",
        "title": "Big bowl / White",
        "price": "45.73",
        "promo": false,
        "price_promo": "0",
        "price_on_request": "",
        "stock": "100",
        "shipping": "0",
        "weight": "0",
        "active": "1",
        "reference": "RSBS003",
        "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=192869",
        "image": {
          "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/472c46da6a786edb5b67cf338c2b9c58.jpg",
          "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/472c46da6a786edb5b67cf338c2b9c58.jpg",
          "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/472c46da6a786edb5b67cf338c2b9c58.jpg"
        }
      },
      {
        "id": "192870",
        "id_variant_1": "45897",
        "id_variant_2": "90262",
        "id_variant_3": "",
        "title": "Big bowl / Dark turquoise",
        "price": "45.73",
        "promo": false,
        "price_promo": "0",
        "price_on_request": "",
        "stock": "100",
        "shipping": "0",
        "weight": "0",
        "active": "1",
        "reference": "RSBS004",
        "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=192870",
        "image": {
          "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/472c46da6a786edb5b67cf338c2b9c58.jpg",
          "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/472c46da6a786edb5b67cf338c2b9c58.jpg",
          "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/472c46da6a786edb5b67cf338c2b9c58.jpg"
        }
      }
    ],
    "categories": [
      {
        "id": 1337,
        "parent": 0,
        "title": "Cozinha",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque lacus neque, dapibus eu volutpat a, consectetur elementum purus. Nam quis eros eu nunc mollis venenatis.",
        "handle": "cozinha",
        "url": "https://parallax.shopk.it/category/cozinha"
      }
    ],
    "option_groups": [
      {
        "title": "Size",
        "options": [
          {
            "id": "45896",
            "title": "Small bowl"
          },
          {
            "id": "45897",
            "title": "Big bowl"
          }
        ]
      },
      {
        "title": "Color",
        "options": [
          {
            "id": "90261",
            "title": "White"
          },
          {
            "id": "90262",
            "title": "Dark turquoise"
          }
        ]
      }
    ],
    "stock": {
      "stock_enabled": true,
      "stock_qty": 100,
      "stock_backorder": true,
      "stock_show": true,
      "stock_sold_single": true,
      "stock_notify": "5"
    }
  },
  "1": {
    "id": 1338,
    "title": "Let's Cook cutting board",
    "reference": "",
    "price": 29.72,
    "price_promo": 0,
    "price_on_request": false,
    "created_at": "2014-11-30T00:59:27+00:00",
    "status": 1,
    "status_alias": "active",
    "position": 0,
    "shipping": 0,
    "shipping_alone": false,
    "featured": false,
    "new": true,
    "is_promotion": false,
    "description": "<p>Heisenberg, Let's Cook, personalized engraved cutting board, breaking bad. Walter white cutting board.<br /><br />We make and ship these boards daily, so the turnaround time is really quick.<br /><br />In honor of the brilliance that is breaking bad, we decided to make a cutting board for all the loyal fans! This beautifully engraved cutting board is the perfect gift for any fan that wants to reminisce Heisenberg every time they cook a meal.&nbsp;<br /><br />Wood type: bamboo<br />Size: 14 x 11</p>",
    "video_url": "",
    "file": null,
    "tax": 0,
    "meta_description": "Heisenberg, Let's Cook, personalized engraved cutting board, breaking bad. Walter white cutting board.We make and ship these boards daily, so the turnaround time is really quick.In honor of the brilliance that is breaking bad, we decided to make a cutting",
    "meta_tags": "",
    "handle": "let-s-cook-cutting-board",
    "page_title": "Let's Cook cutting board",
    "weight": 0,
    "hits": 93,
    "description_short": "Heisenberg, Let's Cook, personalized engraved cutting board, breaking bad. Walter white&#8230;",
    "promo": false,
    "url": "https://parallax.shopk.it/product/let-s-cook-cutting-board",
    "add_cart_url": "https://parallax.shopk.it/cart/add/let-s-cook-cutting-board",
    "permalink": "https://parallax.shopk.it/product/let-s-cook-cutting-board",
    "video_embed_url": false,
    "sales": 0,
    "images": {
      "1": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/697610aa34185dfefa326724ea867818.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/697610aa34185dfefa326724ea867818.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/697610aa34185dfefa326724ea867818.jpg"
      },
      "2": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/5d6f7ac0314930ef1c756da68c60cbb3.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/5d6f7ac0314930ef1c756da68c60cbb3.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/5d6f7ac0314930ef1c756da68c60cbb3.jpg"
      }
    },
    "image": {
      "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/1609f7f3d86847eba5a5cc184577deea.jpg",
      "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/1609f7f3d86847eba5a5cc184577deea.jpg",
      "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/1609f7f3d86847eba5a5cc184577deea.jpg"
    },
    "options": [],
    "categories": [
      {
        "id": 1337,
        "parent": 0,
        "title": "Cozinha",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque lacus neque, dapibus eu volutpat a, consectetur elementum purus. Nam quis eros eu nunc mollis venenatis.",
        "handle": "cozinha",
        "url": "https://parallax.shopk.it/category/cozinha"
      }
    ],
    "option_groups": [],
    "stock": {
      "stock_enabled": false
    }
  },
  "paging": null
}
Response  400
HideShow
Headers
Content-Length: 26
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Length: 24
Content-Type: application/json
Body
{
  "message": "Not found."
}

Categories

Get Category

Get Category
GET/category/

Get products categories by id or handle. Only one parameter is required.

curl -i -X GET \
-H 'X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78' \
https://api.shopk.it/v1/category/1337

Example URI

GET https://api.shopk.it/v1/category/
URI Parameters
HideShow
id
integer (required) Example: 1337

Category identifier

handle
string (required) Example: rustic-bowl

Category handle

Response  200
HideShow
Headers
Content-Length: 543
Content-Type: application/json
Body
{
  "id": 1337,
  "title": "Cozinha",
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque lacus neque, dapibus eu volutpat a, consectetur elementum purus. Nam quis eros eu nunc mollis venenatis.",
  "parent": 0,
  "handle": "cozinha",
  "page_title": "Cozinha",
  "meta_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque lacus neque, dapibus eu volutpat a, consectetur elementum purus. Nam quis eros eu nunc mollis venenatis.",
  "meta_tags": "",
  "url": "https://parallax.shopk.it/category/cozinha",
  "total_products": 2
}
Response  404
HideShow
Headers
Content-Length: 24
Content-Type: application/json
Body
{
  "message": "Not found."
}

Orders

Order

Get Order
GET/order/{id}

Get an order

curl -i -X GET \
-H 'X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78' \
https://api.shopk.it/v1/order/1337

Example URI

GET https://api.shopk.it/v1/order/1337
URI Parameters
HideShow
id
integer (optional) Example: 1337

Order identifier

Response  200
HideShow
Headers
Content-Length: 2552
Content-Type: application/json
Body
{
  "id": 1337,
  "hash": "2e59759fb542d880ed58175d0626b34cf079b1f5",
  "total": 157.03,
  "subtotal": 148.64,
  "product_tax": 16.01,
  "total_tax": 16.01,
  "discount": 14.86,
  "shipping": {
    "value": 7.25,
    "tax": 0,
    "tax_percent": 0,
    "discount": 0,
    "discount_percent": 0
  },
  "coupon_code": "bajevolp",
  "created_at": "2014-11-19T00:44:19+00:00",
  "update_at": "2014-11-26T15:30:00+00:00",
  "sent_at": null,
  "paid_at": null,
  "currency": "EUR",
  "payment": {
    "type": "multibanco",
    "data": {
      "entity": 88888,
      "reference": 888888888,
      "value": 157.03
    }
  },
  "status": 5,
  "status_alias": "waiting_confirmation",
  "paid": false,
  "is_new": false,
  "invoice_url": null,
  "weight": 0,
  "observations": "",
  "custom_field": "",
  "coupon": {
    "code": "bajevolp",
    "type": "percent",
    "value": 10
  },
  "shipment_method": "Transportadora",
  "client": {
    "name": "Shopkit",
    "email": "info@shopk.it",
    "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08\n",
    "postcode": "6000-767 ",
    "town": "Castelo Branco",
    "country": "Portugal - Continental",
    "country_code": "PRT",
    "phone": "969057993",
    "fiscal_id": ""
  },
  "products": [
    {
      "id": 44753,
      "title": "Shelving Tree with Birds",
      "option": "Azul / Small",
      "reference": "STHFBF7574",
      "price": 77.32,
      "tax": 23,
      "quantity": 1,
      "discount": 7.732,
      "subtotal": 85.59324,
      "discount_percent": 10,
      "weight": 0,
      "url": "https://parallax.shopk.it/product/shelving-tree-with-birds",
      "description_short": "This is a tree decal that is created to work with standard 24\" wall shelves that you&#8230;",
      "image": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/4778681bb73229d7d038c077c741b7bd.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/4778681bb73229d7d038c077c741b7bd.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/4778681bb73229d7d038c077c741b7bd.jpg"
      }
    },
    {
      "id": 44752,
      "title": "Hanging Succulent Planter",
      "option": "",
      "reference": "",
      "price": 71.32,
      "tax": 0,
      "quantity": 1,
      "discount": 7.132,
      "subtotal": 64.188,
      "discount_percent": 10,
      "weight": 0,
      "url": "https://parallax.shopk.it/product/hanging-succulent-planter",
      "description_short": "This stoneware planter/pot has been hand made by me from earthy textured, speckled clay&#8230;",
      "image": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/eacc633fe509af083776db911a5f02b9.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/eacc633fe509af083776db911a5f02b9.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/eacc633fe509af083776db911a5f02b9.jpg"
      }
    }
  ]
}
Response  404
HideShow
Headers
Content-Length: 24
Content-Type: application/json
Body
{
  "message": "Not found."
}

Put Order
PUT/order/{id}

Update an order

curl -i -X PUT \
-H 'X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78' \
-H 'Content-Type:application/json' \
-d '{"paid":true, "status_alias":"sent"}' \
https://api.shopk.it/v1/order/1337
Attributes Type Choices Description
status integer 1 2 3 4 5 6 7 Order status as an integer
status_alias string pending processing sent canceled waiting_confirmation waiting_payment waiting_stock Order status as a string
paid string true false Order paid field
invoice_url string Invoice permalink
note string Order note
client_note string Order note from client

Example URI

PUT https://api.shopk.it/v1/order/1337
URI Parameters
HideShow
id
integer (optional) Example: 1337

Order identifier

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "paid": true,
  "status_alias": "sent"
}
Response  200
HideShow
Headers
Content-Length: 2581
Content-Type: application/json
Body
{
  "id": 1337,
  "hash": "2e59759fb542d880ed58175d0626b34cf079b1f5",
  "total": 157.03,
  "subtotal": 148.64,
  "product_tax": 16.01,
  "total_tax": 16.01,
  "discount": 14.86,
  "shipping": {
    "value": 7.25,
    "tax": 0,
    "tax_percent": 0,
    "discount": 0,
    "discount_percent": 0
  },
  "coupon_code": "bajevolp",
  "created_at": "2014-11-19T00:44:19+00:00",
  "update_at": "2014-11-26T15:30:00+00:00",
  "sent_at": "2014-11-25T15:00:20+00:00",
  "paid_at": "2014-11-25T25:00:20+00:00",
  "currency": "EUR",
  "payment": {
    "type": "multibanco",
    "data": {
      "entity": 88888,
      "reference": 888888888,
      "value": 157.03
    }
  },
  "status": 3,
  "status_alias": "sent",
  "paid": true,
  "is_new": false,
  "invoice_url": null,
  "weight": 0,
  "observations": "",
  "custom_field": "",
  "coupon": {
    "code": "bajevolp",
    "type": "percent",
    "value": 10
  },
  "shipment_method": "Transportadora",
  "client": {
    "name": "Shopkit",
    "email": "info@shopk.it",
    "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08\n",
    "postcode": "6000-767 ",
    "town": "Castelo Branco",
    "country": "Portugal - Continental",
    "country_code": "PRT",
    "phone": "969057993",
    "fiscal_id": ""
  },
  "products": [
    {
      "id": 44753,
      "title": "Shelving Tree with Birds",
      "option": "Azul / Small",
      "reference": "STHFBF7574",
      "price": 77.32,
      "tax": 23,
      "quantity": 1,
      "discount": 7.732,
      "subtotal": 85.59324,
      "discount_percent": 10,
      "weight": 0,
      "url": "https://parallax.shopk.it/product/shelving-tree-with-birds",
      "description_short": "This is a tree decal that is created to work with standard 24\" wall shelves that you&#8230;",
      "image": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/4778681bb73229d7d038c077c741b7bd.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/4778681bb73229d7d038c077c741b7bd.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/4778681bb73229d7d038c077c741b7bd.jpg"
      }
    },
    {
      "id": 44752,
      "title": "Hanging Succulent Planter",
      "option": "",
      "reference": "",
      "price": 71.32,
      "tax": 0,
      "quantity": 1,
      "discount": 7.132,
      "subtotal": 64.188,
      "discount_percent": 10,
      "weight": 0,
      "url": "https://parallax.shopk.it/product/hanging-succulent-planter",
      "description_short": "This stoneware planter/pot has been hand made by me from earthy textured, speckled clay&#8230;",
      "image": {
        "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/eacc633fe509af083776db911a5f02b9.jpg",
        "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/eacc633fe509af083776db911a5f02b9.jpg",
        "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/eacc633fe509af083776db911a5f02b9.jpg"
      }
    }
  ]
}
Response  400
HideShow
Headers
Content-Length: 26
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Length: 24
Content-Type: application/json
Body
{
  "message": "Not found."
}

Delete Order
DELETE/order/{id}

Delete an order

curl -i -X DELETE \
-H 'X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78' \
https://api.shopk.it/v1/order/1337

Example URI

DELETE https://api.shopk.it/v1/order/1337
URI Parameters
HideShow
id
integer (required) Example: 1337

Order identifier

Response  204
Response  400
HideShow
Headers
Content-Length: 26
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Length: 24
Content-Type: application/json
Body
{
  "message": "Not found."
}

Get Orders

Get Orders
GET/order{?status,status_alias,paid,date_filter,date_from,date_to,page,limit}

Get a list of orders

curl -i -X GET \
-H 'X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78' \
https://api.shopk.it/v1/order?status=3&date_filter=last_month

Example URI

GET https://api.shopk.it/v1/order?status=0&status_alias=all&paid=true&date_filter=yesterday&date_from=2015-01-01&date_to=2015-01-01&page=1&limit=10
URI Parameters
HideShow
status
integer (optional) Example: 0

Order status as an integer

Choices: 0 1 2 3 4 5 6 7

status_alias
string (optional) Example: all

Order status as a string

Choices: all pending processing sent canceled waiting_confirmation waiting_payment waiting_stock

paid
string (optional) Example: true

Order paid field

Choices: true false

date_filter
string (optional) Example: yesterday

Date filter

Choices: today yesterday last_week last_month

date_from
string (optional) Example: 2015-01-01

Date format yyyy-mm-dd

date_to
string (optional) Example: 2015-01-01

Date format yyyy-mm-dd

page
integer (optional) Example: 1

Page number

limit
integer (optional) Default: 25 Example: 10

Orders per page

Response  200
HideShow
Headers
Content-Length: 2574
Content-Type: application/json
Body
{
  "0": {
    "id": 1337,
    "hash": "2e59759fb542d880ed58175d0626b34cf079b1f5",
    "total": 157.03,
    "subtotal": 148.64,
    "product_tax": 16.01,
    "total_tax": 16.01,
    "discount": 14.86,
    "shipping": {
      "value": 7.25,
      "tax": 0,
      "tax_percent": 0,
      "discount": 0,
      "discount_percent": 0
    },
    "coupon_code": "bajevolp",
    "created_at": "2014-11-19T00:44:19+00:00",
    "update_at": "2014-11-26T15:30:00+00:00",
    "sent_at": null,
    "paid_at": null,
    "currency": "EUR",
    "payment": {
      "type": "multibanco",
      "data": {
        "entity": 88888,
        "reference": 888888888,
        "value": 157.03
      }
    },
    "status": 5,
    "status_alias": "waiting_confirmation",
    "paid": false,
    "is_new": false,
    "invoice_url": null,
    "weight": 0,
    "observations": "",
    "custom_field": "",
    "coupon": {
      "code": "bajevolp",
      "type": "percent",
      "value": 10
    },
    "shipment_method": "Transportadora",
    "client": {
      "name": "Shopkit",
      "email": "info@shopk.it",
      "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08\n",
      "postcode": "6000-767 ",
      "town": "Castelo Branco",
      "country": "Portugal - Continental",
      "country_code": "PRT",
      "phone": "969057993",
      "fiscal_id": ""
    },
    "products": [
      {
        "id": 44753,
        "title": "Shelving Tree with Birds",
        "option": "Azul / Small",
        "reference": "STHFBF7574",
        "price": 77.32,
        "tax": 23,
        "quantity": 1,
        "discount": 7.732,
        "subtotal": 85.59324,
        "discount_percent": 10,
        "weight": 0,
        "url": "https://parallax.shopk.it/product/shelving-tree-with-birds",
        "description_short": "This is a tree decal that is created to work with standard 24\" wall shelves that you&#8230;",
        "image": {
          "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/4778681bb73229d7d038c077c741b7bd.jpg",
          "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/4778681bb73229d7d038c077c741b7bd.jpg",
          "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/4778681bb73229d7d038c077c741b7bd.jpg"
        }
      },
      {
        "id": 44752,
        "title": "Hanging Succulent Planter",
        "option": "",
        "reference": "",
        "price": 71.32,
        "tax": 0,
        "quantity": 1,
        "discount": 7.132,
        "subtotal": 64.188,
        "discount_percent": 10,
        "weight": 0,
        "url": "https://parallax.shopk.it/product/hanging-succulent-planter",
        "description_short": "This stoneware planter/pot has been hand made by me from earthy textured, speckled clay&#8230;",
        "image": {
          "thumb": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/thumb/eacc633fe509af083776db911a5f02b9.jpg",
          "square": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/square/eacc633fe509af083776db911a5f02b9.jpg",
          "full": "https://drwfxyu78e9uq.cloudfront.net/usercontent/parallax/media/images/eacc633fe509af083776db911a5f02b9.jpg"
        }
      }
    ]
  },
  "paging": null
}
Response  400
HideShow
Headers
Content-Length: 26
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Length: 24
Content-Type: application/json
Body
{
  "message": "Not found."
}

Shipping

Get Shipping

Get Shipping
GET/shipping{?country_code,weight,value}

Get a list of shipping methods available for a country

curl -i -X GET \
-H 'X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78' \
https://api.shopk.it/v1/shipping?country_code=prt

Example URI

GET https://api.shopk.it/v1/shipping?country_code=prt&weight=100&value=10
URI Parameters
HideShow
country_code
string (required) Example: prt

three-letter country codes (ISO 3166-1 Alfa-3)

weight
integer (optional) Example: 100

Order weight

value
integer (optional) Example: 10

Orders value

Response  200
HideShow
Headers
Content-Length: 180
Content-Type: application/json
Body
{
    [
        {
            "title": "CTT",
            "description": "Via CTT Expresso. Entrega em 24 horas.",
            "price": 6.76
        },
        {
            "title": "Transportadora",
            "description": "Envio via Nacex no próprio dia",
            "price": 7.25
        }
    ]
}
Response  400
HideShow
Headers
Content-Length: 26
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Length: 24
Content-Type: application/json
Body
{
  "message": "Not found."
}

Webhooks

Webhooks allow you to build or set up integrations which subscribe to certain events on Shopkit stores. For more information visit webhooks documentation.

Post Webhook

Post Webhook
POST/webhook/

Create a webhook

curl -i -X POST \
-H "X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78" \
-H 'Content-Type:application/json' \
-d '{"url":"https://www.mysite.com/mywebhook_url", "event":"order_created"}' \
'https://api.shopk.it/v1/webhook'
Attributes Type Choices Description
url string Webhook url
event string order_canceled order_deleted order_created order_updated order_paid order_sent order_change_status order_invoice Available webhooks

Example URI

POST https://api.shopk.it/v1/webhook/
Response  201
HideShow
Headers
Content-Length: 94
Content-Type: application/json
Body
{
  "id": 1337,
  "event": "order_created",
  "url": "https://www.mysite.com/mywebhook_url",
  "active": true
}
Response  400
HideShow
Headers
Content-Length: 26
Content-Type: application/json
Body
{
  "message": "Bad request."
}

Delete Webhook

Delete Webhook
DELETE/webhook/{id}

Delete a webhook

curl -i -X DELETE \
-H 'X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78' \
https://api.shopk.it/v1/webhook/1337

Example URI

DELETE https://api.shopk.it/v1/webhook/1337
URI Parameters
HideShow
id
integer (required) Example: 1337

Webhook identifier

Response  204
Response  400
HideShow
Headers
Content-Length: 26
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Length: 24
Content-Type: application/json
Body
{
  "message": "Not found."
}
×