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-09-15T12:28:55+01: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": "a77e38d0b16ba62f32361331774324904278edcf",
    "total": 157.03,
    "subtotal": 148.64,
    "product_tax": 16.0052,
    "total_tax": 16.0052,
    "discount": 14.864,
    "shipping": {
        "value": 7.25,
        "tax": 0,
        "tax_percent": null,
        "discount": 0,
        "discount_percent": 0
    },
    "created_at": "2017-05-17T10:45:05+01:00",
    "update_at": "2017-05-17T10:54:38+01:00",
    "sent_at": "2017-05-17T11:00:49+01:00",
    "paid_at": "2017-05-17T11:16:35+01:00",
    "currency": "EUR",
    "payment": {
        "type": "multibanco",
        "data": {
            "entity": 88888,
            "reference": 888888888,
            "value": 157.03
        },
        "description": "Multibanco"
    },
    "status": 3,
    "status_alias": "sent",
    "status_description": "Sent",
    "paid": true,
    "is_new": false,
    "invoice_url": null,
    "weight": 0,
    "observations": null,
    "note": null,
    "client_note": null,
    "custom_field": null,
    "coupon": {
        "code": "bajevolp",
        "type": "percent",
        "value": 10
    },
    "shipment_method": "Transportadora",
    "tracking_url": null,
    "permalink": "https://parallax.shopk.it/order/a77e38d0b16ba62f32361331774324904278edcf",
    "client": {
        "name": "Shopkit",
        "email": "info@shopk.it",
        "fiscal_id": null,
        "company": null,
        "is_registered": false,
        "delivery": {
            "name": "Shopkit",
            "phone": "969057993",
            "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08",
            "address_extra": "",
            "country": "Portugal - Continental",
            "country_code": "PRT",
            "zip_code": "6000-767",
            "city": "Castelo Branco"
        },
        "billing": {
            "name": "Shopkit",
            "phone": "969057993",
            "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08",
            "address_extra": "",
            "country": "Portugal - Continental",
            "country_code": "PRT",
            "zip_code": "6000-767",
            "city": "Castelo Branco"
        },
        "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08 ",
        "postcode": "6000-767",
        "town": "Castelo Branco",
        "country": "Portugal - Continental",
        "country_code": "PRT",
        "phone": "969057993"
    },
    "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"
            }
        },
        {
            "id": 44752,
            "title": "Hanging Succulent Planter",
            "option": null,
            "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…",
            "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"
            }
        }
    ]
}

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,
  "head_html": null,
  "footer_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 é simpl",
  "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": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "message": "",
      "min_value": null,
      "max_value": null,
      "default": false,
      "alias": "paypal",
      "title": "Paypal",
      "image": "https://drwfxyu78e9uq.cloudfront.net/templates/assets/common/icons/payments/paypal.png"
    },
    "multibanco": {
      "active": true,
      "entity": 88888,
      "user": "USER88888",
      "cin": 888,
      "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "min_value": 1,
      "max_value": null,
      "default": false,
      "alias": "multibanco",
      "title": "Multibanco",
      "image": "https://drwfxyu78e9uq.cloudfront.net/templates/assets/common/icons/payments/multibanco.png"
    },
    "bank_transfer": {
      "active": true,
      "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "min_value": null,
      "max_value": null,
      "default": false,
      "alias": "bank_transfer",
      "title": "Bank transfer",
      "image": "https://drwfxyu78e9uq.cloudfront.net/templates/assets/common/icons/payments/transferencia-bancaria.png"
    },
    "on_delivery": {
      "active": false,
      "value": 0,
      "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "min_value": null,
      "max_value": null,
      "default": false,
      "alias": "on_delivery",
      "title": "On Delivery",
      "image": "https://drwfxyu78e9uq.cloudfront.net/templates/assets/common/icons/payments/contra-reembolso.png"
    },
    "pick_up": {
      "active": true,
      "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "min_value": null,
      "max_value": null,
      "default": false,
      "alias": "pick_up",
      "title": "Facility pick up",
      "image": "https://drwfxyu78e9uq.cloudfront.net/templates/assets/common/icons/payments/levantamento.png"
    }
  },
  "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{?id,handle,category,status,status_alias,reference,featured,new,page,limit}

Get a list of products or single product by id or handle

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

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?id=1337&handle=rustic-bowl&category=1337&status=0&status_alias=all&reference=bowl-001&featured=true&new=true&page=1&limit=10
URI Parameters
HideShow
id
integer (optional) Example: 1337

Product identifier

handle
string (optional) Example: rustic-bowl

Product handle

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: 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 fir",
  "meta_tags": "",
  "handle": "rustic-spice-bowl-set",
  "page_title": "Rustic Spice Bowl Set",
  "weight": 0,
  "hits": 104,
  "sales": 0,
  "variants_same_values": false,
  "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,
  "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"
  },
  "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"
    }
  },
  "options": [
    {
      "id": 192867,
      "id_variant_1": "45896",
      "id_variant_2": "90261",
      "id_variant_3": null,
      "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": null,
      "title": "Big bowl / White",
      "price": 45.73,
      "promo": false,
      "price_promo": 0,
      "price_on_request": false,
      "stock": 100,
      "shipping": 0,
      "weight": 0,
      "reference": null,
      "active": true,
      "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": null,
      "title": "Big bowl / Dark turquoise",
      "price": 45.73,
      "promo": false,
      "price_promo": 0,
      "price_on_request": false,
      "stock": 100,
      "shipping": 0,
      "weight": 0,
      "reference": null,
      "active": true,
      "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": 15942,
      "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  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/{id,handle}

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/1337&rustic-bowl
URI Parameters
HideShow
id
integer (optional) Example: 1337

Category identifier

handle
string (optional) 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 e",
  "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

Get Orders

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

Get a list of orders or single order by id

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

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?id=1337&status=0&status_alias=all&paid=true&date_filter=yesterday&date_from=2015-01-01&date_to=2015-01-01&page=1&limit=10&coupon_code=1337
URI Parameters
HideShow
id
integer (optional) Example: 1337

Order identifier

status
integer (optional) Example: 0

Order status as an integer

Choices: 0 1 2 3 4 5 6 7 8

status_alias
string (optional) Example: all

Order status as a string

Choices: all pending processing sent canceled waiting_confirmation waiting_payment waiting_stock delivered

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

coupon_code
integer (optional) Example: 1337

Coupon code

Response  200
HideShow
Headers
Content-Length: 3319
Content-Type: application/json
Body
{
  "id": 1337,
  "hash": "a77e38d0b16ba62f32361331774324904278edcf",
  "total": 157.03,
  "subtotal": 148.64,
  "product_tax": 16.0052,
  "total_tax": 16.0052,
  "discount": 14.864,
  "shipping": {
    "value": 7.25,
    "tax": 0,
    "tax_percent": null,
    "discount": 0,
    "discount_percent": 0
  },
  "created_at": "2017-05-17T10:45:05+01:00",
  "update_at": "2017-05-17T10:54:38+01:00",
  "sent_at": null,
  "paid_at": null,
  "currency": "EUR",
  "payment": {
    "type": "multibanco",
    "data": {
      "entity": 88888,
      "reference": 888888888,
      "value": 157.03
    },
    "description": "Multibanco"
  },
  "status": 5,
  "status_alias": "waiting_confirmation",
  "status_description": "Waiting Confirmation",
  "paid": false,
  "is_new": false,
  "invoice_url": null,
  "weight": 0,
  "observations": null,
  "note": null,
  "client_note": null,
  "custom_field": null,
  "coupon": {
    "code": "bajevolp",
    "type": "percent",
    "value": 10
  },
  "shipment_method": "Transportadora",
  "tracking_url": null,
  "permalink": "https://parallax.shopk.it/order/a77e38d0b16ba62f32361331774324904278edcf",
  "client": {
    "name": "Shopkit",
    "email": "info@shopk.it",
    "fiscal_id": null,
    "company": null,
    "is_registered": false,
    "delivery": {
      "name": "Shopkit",
      "phone": "969057993",
      "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08",
      "address_extra": "",
      "country": "Portugal - Continental",
      "country_code": "PRT",
      "zip_code": "6000-767",
      "city": "Castelo Branco"
    },
    "billing": {
      "name": "Shopkit",
      "phone": "969057993",
      "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08",
      "address_extra": "",
      "country": "Portugal - Continental",
      "country_code": "PRT",
      "zip_code": "6000-767",
      "city": "Castelo Branco"
    },
    "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08 ",
    "postcode": "6000-767",
    "town": "Castelo Branco",
    "country": "Portugal - Continental",
    "country_code": "PRT",
    "phone": "969057993"
  },
  "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": null,
      "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."
}

Put Order

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 8 Order status as an integer
status_alias string pending processing sent canceled waiting_confirmation waiting_payment waiting_stock delivered 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: 3332
Content-Type: application/json
Body
{
  "id": 1337,
  "hash": "a77e38d0b16ba62f32361331774324904278edcf",
  "total": 157.03,
  "subtotal": 148.64,
  "product_tax": 16.0052,
  "total_tax": 16.0052,
  "discount": 14.864,
  "shipping": {
    "value": 7.25,
    "tax": 0,
    "tax_percent": null,
    "discount": 0,
    "discount_percent": 0
  },
  "created_at": "2017-05-17T10:45:05+01:00",
  "update_at": "2017-05-17T10:54:38+01:00",
  "sent_at": "2017-05-17T11:00:49+01:00",
  "paid_at": "2017-05-17T11:16:35+01:00",
  "currency": "EUR",
  "payment": {
    "type": "multibanco",
    "data": {
      "entity": 88888,
      "reference": 888888888,
      "value": 157.03
    },
    "description": "Multibanco"
  },
  "status": 3,
  "status_alias": "sent",
  "status_description": "Sent",
  "paid": true,
  "is_new": false,
  "invoice_url": null,
  "weight": 0,
  "observations": null,
  "note": null,
  "client_note": null,
  "custom_field": null,
  "coupon": {
    "code": "bajevolp",
    "type": "percent",
    "value": 10
  },
  "shipment_method": "Transportadora",
  "tracking_url": null,
  "permalink": "https://parallax.shopk.it/order/a77e38d0b16ba62f32361331774324904278edcf",
  "client": {
    "name": "Shopkit",
    "email": "info@shopk.it",
    "fiscal_id": null,
    "company": null,
    "is_registered": false,
    "delivery": {
      "name": "Shopkit",
      "phone": "969057993",
      "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08",
      "address_extra": "",
      "country": "Portugal - Continental",
      "country_code": "PRT",
      "zip_code": "6000-767",
      "city": "Castelo Branco"
    },
    "billing": {
      "name": "Shopkit",
      "phone": "969057993",
      "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08",
      "address_extra": "",
      "country": "Portugal - Continental",
      "country_code": "PRT",
      "zip_code": "6000-767",
      "city": "Castelo Branco"
    },
    "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08 ",
    "postcode": "6000-767",
    "town": "Castelo Branco",
    "country": "Portugal - Continental",
    "country_code": "PRT",
    "phone": "969057993"
  },
  "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": null,
      "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
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."
}

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: 236
Content-Type: application/json
Body
{
    [
        {
            "title": "CTT",
            "description": "Via CTT Expresso. Entrega em 24 horas.",
            "price": 6.76,
            "price_formatted": "6,76 €"
        },
        {
            "title": "Transportadora",
            "description": "Envio via Nacex no próprio dia",
            "price": 7.25,
            "price_formatted": "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."
}

Coupon

Get Coupon

Get Coupon
GET/coupon{?id,code}

Get a coupon by id or code. Only one parameter is required.

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

Example URI

GET https://api.shopk.it/v1/coupon?id=1337&code=bajevolp
URI Parameters
HideShow
id
integer (optional) Example: 1337

Coupon identifier

code
string (optional) Example: bajevolp

Coupon code

Response  200
HideShow
Headers
Content-Length: 287
Content-Type: application/json
Body
{
  "id": 1337,
  "code": "bajevolp",
  "limit": 5,
  "used": 1,
  "value": 10,
  "type": "percent",
  "applies_to": "all_orders",
  "orders_over": null,
  "category": null,
  "product": null,
  "date_from": null,
  "date_to": null,
  "created_at": "2014-11-18T23:41:32+00:00",
  "orders_total": 157.03,
  "orders_discount": 14.864
}
Response  404
HideShow
Headers
Content-Length: 24
Content-Type: application/json
Body
{
  "message": "Not found."
}

Post Coupon

Post Coupon
POST/coupon/

Create a coupon

curl -i -X POST \
-H "X-API-KEY:0bb18b34ba33cb2d7c55d568353fdc6f345b8d78" \
-H 'Content-Type:application/json' \
-d '{"code":"bajevolp", "limit":"5", "value":"10", "type":"percent", "applies_to":"all_orders"}' \
'https://api.shopk.it/v1/coupon'
Attributes Type Choices Description
code (required) string Coupon code
limit (required) int Coupon usage limit. Set 0 for unlimited
value (required) float Coupon discount value
type (required) string money percent shipping Coupon allowed types
applies_to (required) string all_orders orders_over category product Coupon applies to…
orders_over float Order minimum value to apply discount.
Required when applies_to is orders_over
category mixed Category to apply discount.
Required when applies_to is category, valid category id or handle
product mixed Product to apply discount.
Required when applies_to is product, valid product id or handle
date_from string Coupon start date. Date format yyyy-mm-dd
date_to string Coupon expire date. Date format yyyy-mm-dd

Example URI

POST https://api.shopk.it/v1/coupon/
Response  201
HideShow
Headers
Content-Length: 279
Content-Type: application/json
Body
[
  {
    "id": 1337,
    "code": "bajevolp",
    "limit": 5,
    "used": 0,
    "value": 10,
    "type": "percent",
    "applies_to": "all_orders",
    "orders_over": null,
    "category": null,
    "product": null,
    "date_from": null,
    "date_to": null,
    "created_at": "2017-03-09T17:18:03+00:00",
    "orders_total": 0,
    "orders_discount": 0
  }
]
Response  400
HideShow
Headers
Content-Length: 26
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  409

Delete Coupon

Delete Coupon
DELETE/coupon/{id}

Delete a coupon

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

Example URI

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

Coupon 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."
}

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 order_delivered Available webhooks

Example URI

POST https://api.shopk.it/v1/webhook/
Response  201
HideShow
Headers
Content-Length: 98
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."
}
Response  409

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."
}
×