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 2024-10-22T18:58:28+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=f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c
  1. In the HTTP Authorization header:
X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c

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.

Total count

All resources with pagination have the total count of items added as an header X-Total-Count.

X-Total-Count: 1000

Errors

These are the possible types of client errors on API calls: 400, 401, 404, 409 and 413.

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 -X PUT 'https://api.shopk.it/v1/order/1337' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type: application/json' \
-d '{"paid":true, "status_alias":"sent"}'

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": "",
        "discount": 0,
        "discount_percent": 0
    },
    "created_at": "2017-05-17T10:45:05+01:00",
    "update_at": "2024-09-20T16:31:02+01:00",
    "sent_at": "2017-05-17T11:23:21+01:00",
    "paid_at": "2017-05-17T11:23:21+01:00",
    "currency": "EUR",
    "status": 3,
    "paid": true,
    "is_new": false,
    "invoice_url": "https://www.app.invoicexpress.com/documents/permalink",
    "weight": 0,
    "observations": "",
    "note": "",
    "client_note": "",
    "custom_field": "",
    "tracking_code": "",
    "tracking_carrier": "",
    "tracking_created_at": "",
    "tracking_url": "",
    "expected_arrival_from": null,
    "expected_arrival_until": null,
    "shipping_url": "",
    "at_code": "",
    "tax_exemption": null,
    "tax_settings": null,
    "wholesale": false,
    "billing_info_same_delivery": "1",
    "is_digital": false,
    "payment": {
        "data": {
            "entity": 10611,
            "reference": 909000077,
            "value": 157.03
        },
        "value": 0,
        "tax": 0,
        "tax_percent": "",
        "title": "Multibanco",
        "method": "multibanco",
        "type": "multibanco",
        "gateway": "easypay"
    },
    "status_alias": "sent",
    "status_description": "Sent",
    "coupon": {
        "code": "bajevolp",
        "type": "percent",
        "value": 10
    },
    "shipment_method": "Transportadora",
    "shipment_type": null,
    "tracking_status": {
        "event_alias": null,
        "event_description": null
    },
    "permalink": "https://parallax.shopk.it/order/a77e38d0b16ba62f32361331774324904278edcf",
    "shipment_method_id": "492",
    "client": {
        "name": "Shopkit",
        "hash": "cfc1c614870f7033bb0a033b6e7cd18e",
        "email": "support@shopk.it",
        "company": "Shopkit",
        "fiscal_id": "999999990",
        "is_registered": false,
        "picture": null,
        "delivery": {
            "name": "Shopkit",
            "phone": "+351969057993",
            "address": "Avenida do Empresário, 1",
            "address_extra": "Centro de Empresas Inovadoras",
            "country_code": "PRT",
            "country_code_alpha_2": "PT",
            "zip_code": "6000-767",
            "city": "Castelo Branco",
            "country": "Portugal - Continental"
        },
        "billing": {
            "same_as_delivery": true,
            "name": "Shopkit",
            "phone": "+351969057993",
            "address": "Avenida do Empresário, 1",
            "address_extra": "Centro de Empresas Inovadoras",
            "country_code": "PRT",
            "country_code_alpha_2": "PT",
            "zip_code": "6000-767",
            "city": "Castelo Branco",
            "country": "Portugal - Continental"
        },
        "address": "Avenida do Empresário, 1 Centro de Empresas Inovadoras",
        "postcode": "6000-767",
        "town": "Castelo Branco",
        "country": "Portugal - Continental",
        "country_code": "PRT",
        "phone": "+351969057993"
    },
    "tags": [
        {
            "id": 2800420,
            "title": "shopkit",
            "handle": "shopkit",
            "total_items": 1,
            "created_at": "2024-09-20T16:31:02+01:00"
        }
    ],
    "l10n": {
        "tax_id_abbr": "NIF/NIPC/VAT ID",
        "tax_name": "IVA"
    },
    "products_count": 2,
    "products_quantity": 2,
    "products": [
        {
            "id": 44753,
            "title": "Shelving Tree with Birds",
            "option": "Azul / Small",
            "reference": "STHFBF7574",
            "barcode": null,
            "price": 77.32,
            "price_with_tax": 95.1036,
            "price_without_tax": 77.32,
            "tax": 23,
            "quantity": 1,
            "discount": 7.731999999999999,
            "subtotal": 85.5932,
            "subtotal_with_tax": 85.5932,
            "subtotal_without_tax": 77.32,
            "discount_percent": 10,
            "weight": 0,
            "origin_country": null,
            "origin_country_alpha_2": null,
            "harmonized_code": null,
            "type": "physical",
            "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://cdn.shopk.it/usercontent/parallax/media/images/thumb/0c0014c3ddd01f19933ce97e2041acd3.jpg",
                "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/0c0014c3ddd01f19933ce97e2041acd3.jpg",
                "full": "https://cdn.shopk.it/usercontent/parallax/media/images/0c0014c3ddd01f19933ce97e2041acd3.jpg"
            },
            "is_product": true
        },
        {
            "id": 44752,
            "title": "Hanging Succulent Planter",
            "option": null,
            "reference": "",
            "barcode": null,
            "price": 71.32,
            "price_with_tax": 71.32,
            "price_without_tax": 71.32,
            "tax": 0,
            "quantity": 1,
            "discount": 7.132,
            "subtotal": 64.188,
            "subtotal_with_tax": 64.188,
            "subtotal_without_tax": 71.32,
            "discount_percent": 10,
            "weight": 0,
            "origin_country": null,
            "origin_country_alpha_2": null,
            "harmonized_code": null,
            "type": "physical",
            "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://cdn.shopk.it/usercontent/parallax/media/images/thumb/eacc633fe509af083776db911a5f02b9.jpg",
                "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/eacc633fe509af083776db911a5f02b9.jpg",
                "full": "https://cdn.shopk.it/usercontent/parallax/media/images/eacc633fe509af083776db911a5f02b9.jpg"
            },
            "is_product": true
        }
    ]
}

Resources

Store

GET store

GET store
GET/store

Get store info. No parameters

curl -X GET 'https://api.shopk.it/v1/store' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

GET https://api.shopk.it/v1/store
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "username": "parallax",
    "name": "Parallax",
    "logo": null,
    "description": "A Shopkit é um serviço que te permite criar a tua loja online 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 online.",
    "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,
    "enable_shipping_methods": true,
    "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",
    "basecolor_contrast": "#FFFFFF",
    "favicon": null,
    "latitude": "39.818466068593935",
    "longitude": "-7.491968556808545",
    "currency": "EUR",
    "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,
    "basecolor_contrast": "#FFFFFF",
    "secondarycolor": null,
    "secondarycolor_contrast": "#FFFFFF",
    "settings": {
        "cart": {
            "users_registration": "optional",
            "field_company": "optional",
            "field_fiscal_id": "optional",
            "field_delivery_phone": "optional",
            "field_billing_phone": "optional",
            "page_terms": {
                "id": "10713",
                "title": "Termos e condições",
                "url": "https://parallax.shopk.it/page/termos-e-condicoes",
                "handle": "termos-e-condicoes"
            },
            "page_privacy": {
                "id": "10714",
                "title": "Politica de Privacidade",
                "url": "https://parallax.shopk.it/page/politica-de-privacidade",
                "handle": "politica-de-privacidade"
            }
        },
        "order": {
            "status_cancel": null
        },
        "category": {
            "default_order": "position"
        },
        "categories": {
            "sorting": "position",
            "per_page": null
        },
        "abandoned": {
            "carts_automatic_notifications": false,
            "carts_client_notification": null,
            "carts_notification_type": null,
            "carts_send_after": null,
            "carts_coupon": null,
            "carts_email_subject": "{{ cart.client_name|first_word }}, deixou produtos no seu carrinho",
            "carts_email_lead": "Reparámos que deixou produtos no seu carrinho de compras. Finalize a encomenda para garantir os seus produtos."
        },
        "products": {
            "per_page_home": null,
            "per_page_catalog": null
        },
        "brands": {
            "per_page": null,
            "sorting": "position"
        },
        "wholesale": {
            "show_regular_price": false,
            "taxes_included": false,
            "client_signup": true,
            "checkbox_label": "Quero fazer inscrição para Revenda / B2B",
            "show_exclusive_only": false
        },
    },
    "url": "https://parallax.shopk.it/",
    "theme": "shopkit-parallax",
    "theme_origin": "shopkit-parallax",
    "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/about",
                "menu_item": "about",
                "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/sales",
                "menu_item": "sales",
                "target_blank": false
            },
            {
                "menu_text": "Novidades",
                "menu_type": "menu_page",
                "menu_url": "https://parallax.shopk.it/new",
                "menu_item": "new",
                "target_blank": false
            },
            {
                "menu_text": "Contactos",
                "menu_type": "menu_page",
                "menu_url": "https://parallax.shopk.it/contact",
                "menu_item": "contact",
                "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": {
        "credit_card": {
            "active": true,
            "message": "Instruções método de pagamento Cartão de Crédito.",
            "description": "Pague de forma segura com cartão de crédito ou débito.",
            "default": false,
            "gateway": "stripe",
            "method": "credit_card",
            "alias": "credit_card",
            "title": "Cartão de Crédito",
            "image": "https://cdn.shopk.it/templates/assets/common/icons/payments/credit_card-pt.png",
            "logo": "https://cdn.shopk.it/templates/assets/common/icons/payments/credit-card-brands.png"
        },
        "multibanco": {
            "active": true,
            "message": "Este texto é personalizável e apenas aparecerá aos clientes que seleccionarem o método de pagamento Multibanco.",
            "description": "O método de pagamento mais utilizado pelos portugueses para pagamentos online.",
            "default": true,
            "gateway": "stripe",
            "method": "multibanco",
            "alias": "multibanco",
            "title": "Multibanco",
            "image": "https://cdn.shopk.it/templates/assets/common/icons/payments/multibanco-pt.png",
            "logo": "https://cdn.shopk.it/templates/assets/common/icons/payments/multibanco-color.png"
        },
        "mbway": {
            "active": true,
            "message": "Instruções método de pagamento MB WAY.",
            "description": "Pague de forma rápida e segura usando o seu telemóvel.",
            "default": false,
            "gateway": "easypay",
            "method": "mbway",
            "alias": "mbway",
            "title": "MB WAY",
            "image": "https://cdn.shopk.it/templates/assets/common/icons/payments/mbway-pt.png",
            "logo": "https://cdn.shopk.it/templates/assets/common/icons/payments/mbway-color.png"
        },
        "paypal": {
            "active": true,
            "email": "info@shopk.it",
            "message": "Este texto é personalizável e apenas aparecerá aos clientes que seleccionarem o método de pagamento Paypal.",
            "description": "Pague de forma rápida e segura usando a sua conta Paypal.",
            "default": false,
            "gateway": "paypal",
            "method": "paypal",
            "alias": "paypal",
            "title": "Paypal",
            "image": "https://cdn.shopk.it/templates/assets/common/icons/payments/paypal-pt.png",
            "logo": "https://cdn.shopk.it/templates/assets/common/icons/payments/paypal-color.png"
        },
        "bank_transfer": {
            "active": true,
            "message": "Este texto é personalizável e apenas aparecerá aos clientes que seleccionarem o método de pagamento Transferência Bancária.",
            "description": "Pague por transferência bancária ou interbancária.",
            "default": false,
            "gateway": "manual",
            "method": "bank_transfer",
            "alias": "bank_transfer",
            "title": "Transferência Bancária",
            "image": "https://cdn.shopk.it/templates/assets/common/icons/payments/bank_transfer-pt.png"
        },
        "on_delivery": {
            "active": true,
            "value": 0,
            "message": "Este texto é personalizável e apenas aparecerá aos clientes que seleccionarem o método de pagamento À Cobrança.",
            "description": "Pagamento contra reembolso.",
            "default": false,
            "gateway": "manual",
            "method": "on_delivery",
            "alias": "on_delivery",
            "title": "À Cobrança",
            "image": "https://cdn.shopk.it/templates/assets/common/icons/payments/on_delivery-pt.png"
        },
        "pick_up": {
            "active": true,
            "message": "Este texto é personalizável e apenas aparecerá aos clientes que seleccionarem o método de pagamento Levantamento nas instalações.",
            "description": "Levante a sua encomenda nas nossas instalações. Não paga portes de envio.",
            "default": false,
            "gateway": "manual",
            "method": "pick_up",
            "alias": "pick_up",
            "title": "Levantamento nas instalações",
            "image": "https://cdn.shopk.it/templates/assets/common/icons/payments/pick_up-pt.png"
        },
        "custom": {
            "active": true,
            "title": "Instruções metodo de Ppagamento personalizado",
            "message": "Instruções método de pagamento Pagamento personalizado",
            "description": "Define um método de pagamento personalizado por ti",
            "default": false,
            "gateway": "manual",
            "method": "custom",
            "alias": "custom",
        }
    },
    "locations": [
        {
            "id": "469",
            "title": "Morada Principal",
            "name": "Shopkit",
            "address": "Avenida do Empresário, 1",
            "address_extra": "S1.19",
            "city": "Castelo Branco",
            "zip_code": "6000-767",
            "country": "Portugal - Continental",
            "country_code": "PRT",
            "phone": "+351919873646"
        }
    ],
    "category_default_order": "position",
    "categories_sorting": "position",
    "brands_sorting": "position",
    "products_per_page_home": 20,
    "products_per_page_catalog": null,
    "categories_per_page": null,
    "brands_per_page": null,
    "domain": "parallax.shopk.it",
    "is_ssl": true,
    "assets": {
        "url": "https://cdn.shopk.it/templates/assets/shopkit/parallax",
        "images": "https://cdn.shopk.it/templates/assets/shopkit/parallax/img",
        "css": "https://cdn.shopk.it/css/store/parallax/style.css?template=shopkit/parallax&last_modified=1504786507",
        "plugins": "https://cdn.shopk.it/templates/assets/shopkit/parallax/js/plugins.js?template=shopkit/parallax&last_modified=1504786507",
        "scripts": "https://cdn.shopk.it/templates/assets/shopkit/parallax/js/script.js?template=shopkit/parallax&last_modified=1504786507"
    },
    "images_header": [
        "https://cdn.shopk.it/usercontent/parallax/media/images/14bb24a112fafccdd36680be2b03f4ce.jpg",
        "https://cdn.shopk.it/usercontent/parallax/media/images/c788681a62eff02c640765d3c215c920.jpg",
        "https://cdn.shopk.it/usercontent/parallax/media/images/f669d550743b2e27a81c22812b270101.jpg"
    ],
    "featured_blocks": null,
    "dark_mode": null,
    "taxes_included": true
}

Products

GET product

GET product
GET/product{?id,ids,handle,category,status,status_alias,reference,featured,new,q,page,limit}

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

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

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

Example URI

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

Product identifier

ids
integer (optional) Example: 1337,7331

Product identifier, comma separated

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 or combined comma separated

Choices: 0 1 2 3 4

status_alias
string (optional) Example: all

Product status alias as a string or combined comma separated

Choices: all active hidden out_of_stock soon

reference
string (optional) Example: bowl-001

Product reference

featured
boolean (optional) Example: true

Product featured field

Choices: true false

new
boolean (optional) Example: true

Product new field

Choices: true false

q
string (optional) Example: bowl

Search for products

page
integer (optional) Example: 1

page number

limit
integer (optional) Default: 25 Example: 10

products per page

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 212322,
  "title": "Rustic Spice Bowl Set",
  "reference": "",
  "barcode": null,
  "price": 40.73,
  "price_formatted": "40,73 €",
  "price_promo": null,
  "price_promo_formatted": null,
  "price_wholesale": null,
  "price_wholesale_formatted": null,
  "promo_show_percentage": false,
  "price_promo_percentage": null,
  "price_on_request": false,
  "price_without_tax": 40.73,
  "created_at": "2020-11-27T15:36:57+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>",
  "excerpt": "This set of four rustic, pinch pots have been hand formed by me from textured, earthy",
  "video_url": "",
  "file": null,
  "tax": 0,
  "taxable": false,
  "reduced_rate": null,
  "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,
  "sales": 0,
  "variants_same_values": false,
  "updated_at": "2020-11-27T15:36:57+00:00",
  "wholesale": false,
  "wholesale_exclusive": false,
  "description_short": "This set of four rustic, pinch pots have been hand formed by me from textured, earthy",
  "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",
  "wishlist": {
    "add_url": "https://parallax.shopk.it/wishlist/add/rustic-spice-bowl-set",
    "remove_url": "https://parallax.shopk.it/wishlist/remove/rustic-spice-bowl-set"
  },
  "permalink": "https://parallax.shopk.it/product/rustic-spice-bowl-set",
  "video_embed_url": false,
  "image": {
    "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
    "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
    "full": "https://cdn.shopk.it/usercontent/parallax/media/images/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg"
  },
  "images": [
    {
      "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/f519f86-17d23f7b534bf365580989363da328d2.jpg",
      "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/f519f86-17d23f7b534bf365580989363da328d2.jpg",
      "full": "https://cdn.shopk.it/usercontent/parallax/media/images/f519f86-17d23f7b534bf365580989363da328d2.jpg"
    },
    {
      "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/0bb2c71-7d2fe8d66dd9925ac72a3112d691f352.jpg",
      "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/0bb2c71-7d2fe8d66dd9925ac72a3112d691f352.jpg",
      "full": "https://cdn.shopk.it/usercontent/parallax/media/images/0bb2c71-7d2fe8d66dd9925ac72a3112d691f352.jpg"
    },
    {
      "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/717897d-ff2216454ebbf8ca2727335ecacbc472.jpg",
      "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/717897d-ff2216454ebbf8ca2727335ecacbc472.jpg",
      "full": "https://cdn.shopk.it/usercontent/parallax/media/images/717897d-ff2216454ebbf8ca2727335ecacbc472.jpg"
    }
  ],
  "categories": [
    {
      "id": 44355,
      "parent": 0,
      "active": true,
      "title": "Cozinha",
      "description": "",
      "handle": "cozinha",
      "url": "https://parallax.shopk.it/category/cozinha",
      "image": []
    }
  ],
  "brand": null,
  "tags": [],
  "options": [
    {
      "id": 363364,
      "id_variant_1": 206585,
      "id_variant_2": 206587,
      "id_variant_3": null,
      "title": "Small bowl / White",
      "price": 40.73,
      "price_formatted": "40,73 €",
      "price_promo": null,
      "price_promo_formatted": null,
      "price_wholesale": null,
      "price_wholesale_formatted": null,
      "price_without_tax": 40.73,
      "promo": false,
      "price_promo_percentage": null,
      "price_on_request": false,
      "stock": 88,
      "shipping": 0,
      "weight": 0,
      "reference": "",
      "barcode": null,
      "active": true,
      "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=363364",
      "image": {
        "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
        "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
        "full": "https://cdn.shopk.it/usercontent/parallax/media/images/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg"
      },
      "wishlist": {
        "add_url": "https://parallax.shopk.it/wishlist/add/rustic-spice-bowl-set?option=363364",
        "remove_url": "https://parallax.shopk.it/wishlist/remove/rustic-spice-bowl-set?option=363364"
      }
    },
    {
      "id": 363365,
      "id_variant_1": 206585,
      "id_variant_2": 206588,
      "id_variant_3": null,
      "title": "Small bowl / Dark turquoise",
      "price": 40.73,
      "price_formatted": "40,73 €",
      "price_promo": null,
      "price_promo_formatted": null,
      "price_wholesale": null,
      "price_wholesale_formatted": null,
      "price_without_tax": 40.73,
      "promo": false,
      "price_promo_percentage": null,
      "price_on_request": false,
      "stock": 94,
      "shipping": 0,
      "weight": 0,
      "reference": "",
      "barcode": null,
      "active": true,
      "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=363365",
      "image": {
        "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
        "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
        "full": "https://cdn.shopk.it/usercontent/parallax/media/images/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg"
      },
      "wishlist": {
        "add_url": "https://parallax.shopk.it/wishlist/add/rustic-spice-bowl-set?option=363365",
        "remove_url": "https://parallax.shopk.it/wishlist/remove/rustic-spice-bowl-set?option=363365"
      }
    },
    {
      "id": 363366,
      "id_variant_1": 206586,
      "id_variant_2": 206587,
      "id_variant_3": null,
      "title": "Big bowl / White",
      "price": 45.73,
      "price_formatted": "45,73 €",
      "price_promo": null,
      "price_promo_formatted": null,
      "price_wholesale": null,
      "price_wholesale_formatted": null,
      "price_without_tax": 45.73,
      "promo": false,
      "price_promo_percentage": null,
      "price_on_request": false,
      "stock": 100,
      "shipping": 0,
      "weight": 0,
      "reference": "",
      "barcode": null,
      "active": true,
      "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=363366",
      "image": {
        "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
        "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
        "full": "https://cdn.shopk.it/usercontent/parallax/media/images/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg"
      },
      "wishlist": {
        "add_url": "https://parallax.shopk.it/wishlist/add/rustic-spice-bowl-set?option=363366",
        "remove_url": "https://parallax.shopk.it/wishlist/remove/rustic-spice-bowl-set?option=363366"
      }
    },
    {
      "id": 363367,
      "id_variant_1": 206586,
      "id_variant_2": 206588,
      "id_variant_3": null,
      "title": "Big bowl / Dark turquoise",
      "price": 45.73,
      "price_formatted": "45,73 €",
      "price_promo": null,
      "price_promo_formatted": null,
      "price_wholesale": null,
      "price_wholesale_formatted": null,
      "price_without_tax": 45.73,
      "promo": false,
      "price_promo_percentage": null,
      "price_on_request": false,
      "stock": 100,
      "shipping": 0,
      "weight": 0,
      "reference": "",
      "barcode": null,
      "active": true,
      "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=363367",
      "image": {
        "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
        "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
        "full": "https://cdn.shopk.it/usercontent/parallax/media/images/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg"
      },
      "wishlist": {
        "add_url": "https://parallax.shopk.it/wishlist/add/rustic-spice-bowl-set?option=363367",
        "remove_url": "https://parallax.shopk.it/wishlist/remove/rustic-spice-bowl-set?option=363367"
      }
    }
  ],
  "option_groups": [
    {
      "id": 62775,
      "title": "Size",
      "options": [
        {
          "id": 206585,
          "title": "Small bowl"
        },
        {
          "id": 206586,
          "title": "Big bowl"
        }
      ]
    },
    {
      "id": 62776,
      "title": "Color",
      "options": [
        {
          "id": 206587,
          "title": "White"
        },
        {
          "id": 206588,
          "title": "Dark turquoise"
        }
      ]
    }
  ],
  "stock": {
    "stock_enabled": true,
    "stock_qty": 88,
    "stock_backorder": true,
    "stock_show": true,
    "stock_sold_single": true,
    "stock_notify": 10
  },
  "rating": {
    "total_reviews": 0,
    "average_rating": 0,
    "max_rating": 0,
    "min_rating": 0
  },
  "custom_fields": null,
  "tabs": null
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

POST product

POST product
POST/product

Create a product.

curl -X POST 'https://api.shopk.it/v1/product/' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type: application/json' \
-d '{"title": "Rustic Spice Bowl Set", "price": 17.45, "categories": [44373]}'
Attributes Type Choices Description
title
(required)		 string Title
price
(required)		 float Price Required if not price_on_request
categories
(required)		 array[integer] Array with categories identifier
brand integer Brand identifier
handle string Handle
reference string SKU
barcode string EAN, ISBN, UPC, GTIN, etc.
price_promo float Promotion price (must be lower than price)
promo_show_percentage boolean true false Show discount in percent
price_on_request boolean true false Price is on request
wholesale boolean true false Product has wholesale price
price_wholesale float Product wholesale price (requires wholesale enabled)
wholesale_exclusive boolean true false Product is wholesale exclusive
status integer 1 2 3 4 Status: 1 (active) 2 (hidden) 3 (out of stock) 4 (soon)
shipping float Shipping cost
shipping_alone boolean true false Shipping alone option
featured boolean true false Product is featured option
new boolean true false Product is new option
is_promotion boolean true false Product is in promotion option
description string Description
excerpt string Excerpt (short description)
video_url string Video url, youtube or vimeo url
file string File url
tax float Tax (deprecated in favor of taxable)
taxable boolean Product is taxable
reduced_rate string choices VAT reduced rate
meta_description string Meta description
meta_tags string Meta tags
page_title string Product page title
weight integer Weight (in grams)
origin_country string Country code three-letter (ISO 3166-1 Alfa-3)
harmonized_code string harmonized code
images array[string] Array with images url, max 10
tags array[string] Array with tags
stock_enabled boolean true false Enables Product stock
stock_qty integer Units in stock (requires product stock enabled)
stock_backorder boolean true false Allows to receice orders without units in stock (requires stock enabled)
stock_show boolean true false Show product stock units (requires stock enabled)
stock_sold_single boolean true false Only allow to sell 1 unit per order (requires stock enabled)
stock_notify integer Product minium stock units (requires stock enabled)

Example URI

POST https://api.shopk.it/v1/product
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "title": "Rustic Spice Bowl Set",
  "price": 17.45,
  "categories": [
    44373
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 212314,
  "title": "Rustic Spice Bowl Set",
  "reference": null,
  "barcode": null,
  "price": 17.45,
  "price_formatted": "17,45 €",
  "price_promo": null,
  "price_promo_formatted": null,
  "price_wholesale": null,
  "price_wholesale_formatted": null,
  "promo_show_percentage": false,
  "price_promo_percentage": null,
  "price_on_request": false,
  "price_without_tax": 17.45,
  "created_at": "2020-11-27T14:07:10+00:0",
  "status": 1,
  "status_alias": "active",
  "position": 0,
  "shipping": 0,
  "shipping_alone": false,
  "featured": false,
  "new": false,
  "is_promotion": false,
  "description": null,
  "excerpt": "",
  "video_url": null,
  "file": null,
  "tax": 0,
  "taxable": false,
  "reduced_rate": null,
  "meta_description": null,
  "meta_tags": null,
  "handle": "rustic-spice-bowl-set",
  "page_title": "Rustic Spice Bowl Set",
  "weight": 0,
  "sales": 0,
  "variants_same_values": true,
  "updated_at": "2020-11-27T14:07:10+00:00",
  "wholesale": false,
  "wholesale_exclusive": false,
  "description_short": "",
  "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",
  "wishlist": {
    "add_url": "https://parallax.shopk.it/wishlist/add/rustic-spice-bowl-set",
    "remove_url": "https://parallax.shopk.it/wishlist/remove/rustic-spice-bowl-set"
  },
  "permalink": "https://parallax.shopk.it/product/rustic-spice-bowl-set",
  "video_embed_url": false,
  "image": {
    "thumb": "https://cdn.shopk.it/assets/store/img/no-img.jpg",
    "square": "https://cdn.shopk.it/assets/store/img/no-img.jpg",
    "full": "https://cdn.shopk.it/assets/store/img/no-img.jpg"
  },
  "images": [],
  "categories": [
    {
      "id": 44373,
      "parent": 0,
      "active": true,
      "title": "Cozinha",
      "description": "",
      "handle": "cozinha",
      "url": "https://parallax.shopk.it/category/cozinha",
      "image": []
    }
  ],
  "brand": null,
  "tags": [],
  "options": [],
  "option_groups": [],
  "stock": {
    "stock_enabled": false
  },
  "rating": {
    "total_reviews": 0,
    "average_rating": 0,
    "max_rating": 0,
    "min_rating": 0
  },
  "custom_fields": null,
  "tabs": null
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

PUT product

PUT product
PUT/product/{id}

Update a product.

curl -X POST 'https://api.shopk.it/v1/product/' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type: application/json' \
-d'{"reference": "SWB-001", "featured": true}'
Attributes Type Choices Description
title string Title
price float Price
categories array[integer] Array with categories identifier
brand integer Brand identifier
handle string Handle
reference string SKU
barcode string EAN, ISBN, UPC, GTIN, etc.
price_promo float Promotion price (must be lower than price)
promo_show_percentage boolean true false Show discount in percent
price_on_request boolean true false Price is on request
wholesale boolean true false Product has wholesale price
price_wholesale float Product wholesale price (requires wholesale enabled)
wholesale_exclusive boolean true false Product is wholesale exclusive
status integer 1 2 3 4 Status: 1 (active) 2 (hidden) 3 (out of stock) 4 (soon)
shipping float Shipping cost
shipping_alone boolean true false Shipping alone option
featured boolean true false Product is featured option
new boolean true false Product is new option
is_promotion boolean true false Product is in promotion option
description string Description
excerpt string Excerpt (short description)
video_url string Video url, youtube or vimeo url
file string File url
tax float Tax (deprecated in favor of taxable)
taxable boolean Product is taxable
reduced_rate string choices VAT reduced rate
meta_description string Meta description
meta_tags string Meta tags
page_title string Product page title
weight integer Weight (in grams)
origin_country string Country code three-letter (ISO 3166-1 Alfa-3)
harmonized_code string harmonized code
images array[string] Array with images url, max 10
tags array[string] Array with tags
stock_enabled boolean true false Enables Product stock
stock_qty integer Units in stock (requires product stock enabled)
stock_backorder boolean true false Allows to receice orders without units in stock (requires stock enabled)
stock_show boolean true false Show product stock units (requires stock enabled)
stock_sold_single boolean true false Only allow to sell 1 unit per order (requires stock enabled)
stock_notify integer Product minium stock units (requires stock enabled)

Example URI

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

Product identifier

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "reference": "SWB-001",
  "featured": true
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 212314,
  "title": "Rustic Spice Bowl Set",
  "reference": "bowl-001",
  "price": 17.45,
  "price_formatted": "17,45 €",
  "price_promo": null,
  "price_promo_formatted": null,
  "price_wholesale": null,
  "price_wholesale_formatted": null,
  "promo_show_percentage": false,
  "price_promo_percentage": null,
  "price_on_request": false,
  "price_without_tax": 17.45,
  "created_at": "2020-11-27T14:07:10+00:00",
  "status": 1,
  "status_alias": "active",
  "position": 0,
  "shipping": 0,
  "shipping_alone": false,
  "featured": false,
  "new": false,
  "is_promotion": false,
  "description": "This set of four rustic, pinch pots have been hand formed by me from textured, earthy stoneware clay",
  "excerpt": "This set of four rustic, pinch pots have been hand formed by me from textured, earthy",
  "video_url": null,
  "file": null,
  "tax": 0,
  "taxable": false,
  "reduced_rate": null,
  "meta_description": null,
  "meta_tags": null,
  "handle": "rustic-spice-bowl-set-2",
  "page_title": "Rustic Spice Bowl Set",
  "weight": 0,
  "sales": 0,
  "variants_same_values": true,
  "updated_at": "2020-11-27T15:15:12+00:00",
  "wholesale": false,
  "wholesale_exclusive": 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-2",
  "add_cart_url": "https://parallax.shopk.it/cart/add/rustic-spice-bowl-set-2",
  "wishlist": {
    "add_url": "https://parallax.shopk.it/wishlist/add/rustic-spice-bowl-set-2",
    "remove_url": "https://parallax.shopk.it/wishlist/remove/rustic-spice-bowl-set-2"
  },
  "permalink": "https://parallax.shopk.it/product/rustic-spice-bowl-set-2",
  "video_embed_url": false,
  "image": {
    "thumb": "https://cdn.shopk.it/assets/store/img/no-img.jpg",
    "square": "https://cdn.shopk.it/assets/store/img/no-img.jpg",
    "full": "https://cdn.shopk.it/assets/store/img/no-img.jpg"
  },
  "images": [],
  "categories": [
    {
      "id": 44373,
      "parent": 0,
      "active": true,
      "title": "API",
      "description": "",
      "handle": "api",
      "url": "https://parallax.shopk.it/category/api",
      "image": {
        "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/c61c5bd-c61c5bd-c61c5bd-sylwia-pietruszka-218363-unsplash.jpg",
        "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/c61c5bd-c61c5bd-c61c5bd-sylwia-pietruszka-218363-unsplash.jpg",
        "full": "https://cdn.shopk.it/usercontent/parallax/media/images/c61c5bd-c61c5bd-c61c5bd-sylwia-pietruszka-218363-unsplash.jpg"
      }
    }
  ],
  "options": [],
  "option_groups": [],
  "stock": {
    "stock_enabled": false
  },
  "rating": {
    "total_reviews": 0,
    "average_rating": 0,
    "max_rating": 0,
    "min_rating": 0
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

DELETE product

DELETE product
DELETE/product/{id}

Delete a product.

curl -X DELETE 'https://api.shopk.it/v1/product/1337' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

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

Product identifier

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

Product Option Groups

GET product option group

GET product option group
GET/product/{id}/option_group/{id_option_group}

Get a list of a product option groups or a single product option group by id.

curl -X GET 'https://api.shopk.it/v1/product/212322/option_group' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

curl -X GET 'https://api.shopk.it/v1/product/212322/option_group/62775' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

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

Product identifier

id_option_group
integer (optional) 

Product option group identifier

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 62775,
    "title": "Size",
    "options": [
      {
        "id": 206585,
        "title": "Small bowl"
      },
      {
        "id": 206586,
        "title": "Big bowl"
      }
    ]
  },
  {
    "id": 62776,
    "title": "Color",
    "options": [
      {
        "id": 206587,
        "title": "White"
      },
      {
        "id": 206588,
        "title": "Dark turquoise"
      }
    ]
  }
]
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

POST product option group

POST product option group
POST/product/{id}/option_group

Create a product option group.

curl -X POST 'https://api.shopk.it/v1/product/212322/option_group' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type: application/json' \
-d '{"title": "Color", "options": ["White", "Dark turquoise"]}'
Attributes Type Description
title
(required)		 string Product option group title
options
(required)		 array[string] Array with product option group values

Example URI

POST https://api.shopk.it/v1/product/id/option_group
URI Parameters
HideShow
id
integer (required) 

Product identifier

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "title": "Color",
  "options": [
    "White",
    "Dark turquoise"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 62775,
    "title": "Size",
    "options": [
      {
        "id": 206585,
        "title": "Small bowl"
      },
      {
        "id": 206586,
        "title": "Big bowl"
      }
    ]
  },
  {
    "id": 62776,
    "title": "Color",
    "options": [
      {
        "id": 206587,
        "title": "White"
      },
      {
        "id": 206588,
        "title": "Dark turquoise"
      }
    ]
  }
]
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

PUT product option group

PUT product option group
PUT/product/{id}/option_group/{id_option_group}

Update a product option group.

curl -X PUT 'https://api.shopk.it/v1/product/212322/option_group/62779' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type: application/json' \
-d '{"title": "Color", "options": ["White", "Dark turquoise"]}'
Attributes Type Description
title
(required)		 string Product option group title
options
(required)		 array[string] Array with product option group values

Example URI

PUT https://api.shopk.it/v1/product/id/option_group/id_option_group
URI Parameters
HideShow
id
integer (required) 

Product identifier

id_option_group
integer (required) 

Product option group identifier

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "title": "Color",
  "options": [
    "White",
    "Dark turquoise"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 62775,
    "title": "Size",
    "options": [
      {
        "id": 206585,
        "title": "Small bowl"
      },
      {
        "id": 206586,
        "title": "Big bowl"
      }
    ]
  },
  {
    "id": 62776,
    "title": "Color",
    "options": [
      {
        "id": 206587,
        "title": "White"
      },
      {
        "id": 206588,
        "title": "Dark turquoise"
      }
    ]
  }
]
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

DELETE product option group

DELETE product option group
DELETE/product/{id}/option_group/{id_option_group}

Delete a product option group.

curl -X DELETE 'https://api.shopk.it/v1/product/212322/option_group/62779' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

DELETE https://api.shopk.it/v1/product/id/option_group/id_option_group
URI Parameters
HideShow
id
integer (required) 

Product identifier

id_option_group
integer (required) 

Product option group identifier

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

Product Options

GET Product Option

GET Product Option
GET/product/{id}/option/{id_option}

Get a list of a product options or a single product option by id.

curl -X GET 'https://api.shopk.it/v1/product/212322/option' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

curl -X GET 'https://api.shopk.it/v1/product/212322/option/363364' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

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

Product identifier

id_option
integer (optional) 

Product option identifier

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 363364,
    "id_variant_1": 206585,
    "id_variant_2": 206587,
    "id_variant_3": null,
    "title": "Small bowl / White",
    "price": 40.73,
    "price_formatted": "40,73 €",
    "price_promo": null,
    "price_promo_formatted": null,
    "price_wholesale": null,
    "price_wholesale_formatted": null,
    "price_without_tax": 40.73,
    "promo": false,
    "price_promo_percentage": null,
    "price_on_request": false,
    "stock": 88,
    "shipping": 0,
    "weight": 0,
    "reference": "",
    "barcode": "",
    "active": true,
    "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=363364",
    "image": {
      "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
      "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
      "full": "https://cdn.shopk.it/usercontent/parallax/media/images/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg"
    },
    "wishlist": {
      "add_url": "https://parallax.shopk.it/wishlist/add/rustic-spice-bowl-set?option=363364",
      "remove_url": "https://parallax.shopk.it/wishlist/remove/rustic-spice-bowl-set?option=363364"
    }
  },
  {
    "id": 363365,
    "id_variant_1": 206585,
    "id_variant_2": 206588,
    "id_variant_3": null,
    "title": "Small bowl / Dark turquoise",
    "price": 40.73,
    "price_formatted": "40,73 €",
    "price_promo": null,
    "price_promo_formatted": null,
    "price_wholesale": null,
    "price_wholesale_formatted": null,
    "price_without_tax": 40.73,
    "promo": false,
    "price_promo_percentage": null,
    "price_on_request": false,
    "stock": 94,
    "shipping": 0,
    "weight": 0,
    "reference": "",
    "barcode": "",
    "active": true,
    "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=363365",
    "image": {
      "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
      "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
      "full": "https://cdn.shopk.it/usercontent/parallax/media/images/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg"
    },
    "wishlist": {
      "add_url": "https://parallax.shopk.it/wishlist/add/rustic-spice-bowl-set?option=363365",
      "remove_url": "https://parallax.shopk.it/wishlist/remove/rustic-spice-bowl-set?option=363365"
    }
  },
  {
    "id": 363366,
    "id_variant_1": 206586,
    "id_variant_2": 206587,
    "id_variant_3": null,
    "title": "Big bowl / White",
    "price": 45.73,
    "price_formatted": "45,73 €",
    "price_promo": null,
    "price_promo_formatted": null,
    "price_wholesale": null,
    "price_wholesale_formatted": null,
    "price_without_tax": 45.73,
    "promo": false,
    "price_promo_percentage": null,
    "price_on_request": false,
    "stock": 100,
    "shipping": 0,
    "weight": 0,
    "reference": "",
    "barcode": "",
    "active": true,
    "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=363366",
    "image": {
      "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
      "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
      "full": "https://cdn.shopk.it/usercontent/parallax/media/images/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg"
    },
    "wishlist": {
      "add_url": "https://parallax.shopk.it/wishlist/add/rustic-spice-bowl-set?option=363366",
      "remove_url": "https://parallax.shopk.it/wishlist/remove/rustic-spice-bowl-set?option=363366"
    }
  },
  {
    "id": 363367,
    "id_variant_1": 206586,
    "id_variant_2": 206588,
    "id_variant_3": null,
    "title": "Big bowl / Dark turquoise",
    "price": 45.73,
    "price_formatted": "45,73 €",
    "price_promo": null,
    "price_promo_formatted": null,
    "price_wholesale": null,
    "price_wholesale_formatted": null,
    "price_without_tax": 45.73,
    "promo": false,
    "price_promo_percentage": null,
    "price_on_request": false,
    "stock": 100,
    "shipping": 0,
    "weight": 0,
    "reference": "",
    "barcode": "",
    "active": true,
    "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=363367",
    "image": {
      "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
      "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
      "full": "https://cdn.shopk.it/usercontent/parallax/media/images/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg"
    },
    "wishlist": {
      "add_url": "https://parallax.shopk.it/wishlist/add/rustic-spice-bowl-set?option=363367",
      "remove_url": "https://parallax.shopk.it/wishlist/remove/rustic-spice-bowl-set?option=363367"
    }
  }
]
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

PUT Product Option

PUT Product Option
PUT/product/{id}/option/{id_option}

Update a product option.

curl -X PUT 'https://api.shopk.it/v1/product/212322/option/363364' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type: application/json' \
-d '{"reference": "SWB-001"}'
Attributes Type Choices Description
price float Price
price_promo float Promotion price (must be lower than price)
price_on_request boolean true false Price is on request
price_wholesale float Wholesale price (requires product wholesale enabled)
stock integer Units in stock (requires product stock enabled)
shipping float Shipping cost
weight integer Weight (in grams)
reference string SKU
barcode string EAN, ISBN, UPC, GTIN, etc.
image string Option image url
active boolean true false Option is active

Example URI

PUT https://api.shopk.it/v1/product/id/option/id_option
URI Parameters
HideShow
id
integer (required) 

Product identifier

id_option
integer (optional) 

Product option identifier

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "reference": "SWB-001"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 363364,
  "id_variant_1": 206585,
  "id_variant_2": 206587,
  "id_variant_3": null,
  "title": "Small bowl / White",
  "price": 40.73,
  "price_formatted": "40,73 €",
  "price_promo": null,
  "price_promo_formatted": null,
  "price_wholesale": null,
  "price_wholesale_formatted": null,
  "price_without_tax": 40.73,
  "promo": false,
  "price_promo_percentage": null,
  "price_on_request": false,
  "stock": 88,
  "shipping": 0,
  "weight": 0,
  "reference": "SWB-001",
  "barcode": "SWB-001",
  "active": true,
  "url": "https://parallax.shopk.it/product/rustic-spice-bowl-set?option=363364",
  "image": {
    "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
    "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg",
    "full": "https://cdn.shopk.it/usercontent/parallax/media/images/da84db6-472c46da6a786edb5b67cf338c2b9c58.jpg"
  },
  "wishlist": {
    "add_url": "https://parallax.shopk.it/wishlist/add/rustic-spice-bowl-set?option=363364",
    "remove_url": "https://parallax.shopk.it/wishlist/remove/rustic-spice-bowl-set?option=363364"
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

DELETE Product Option

DELETE Product Option
DELETE/product/{id}/option/{id_option}

Delete a product option.

curl -X DELETE 'https://api.shopk.it/v1/product/212322/option/363364' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

DELETE https://api.shopk.it/v1/product/id/option/id_option
URI Parameters
HideShow
id
integer (required) 

Product identifier

id_option
integer (required) 

Product option identifier

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

Categories

GET Category

GET Category
GET/category/{id,handle,active,is_parent,page,limit}

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

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

Example URI

GET https://api.shopk.it/v1/category/1337&rustic-bowl&active&is_parent&1&10
URI Parameters
HideShow
id
integer (optional) Example: 1337

Category identifier

handle
string (optional) Example: rustic-bowl

Category handle

active
boolean (optional) 

Category is active

Choices: true false

is_parent
boolean (optional) 

Category parent only

Choices: true false

page
integer (optional) Example: 1

Page number

limit
integer (optional) Default: 25 Example: 10

Categories per page

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "id": 14535,
    "title": "Decoração",
    "is_parent": true,
    "is_child": false,
    "parent": 0,
    "parent_title": null,
    "description": "Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.",
    "position": 7,
    "active": true,
    "handle": "decoracao",
    "page_title": "Decoração",
    "meta_description": "Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Morbi posuere sodales tellus, sit amet tincidunt mi al",
    "meta_tags": null,
    "num_products": 0,
    "url": "https://parallax.shopk.it/category/decoracao",
    "permalink": "https://parallax.shopk.it/category/decoracao",
    "image": {
        "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/4778681bb73229d7d038c077c741b7bd.jpg",
        "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/4778681bb73229d7d038c077c741b7bd.jpg",
        "full": "https://cdn.shopk.it/usercontent/parallax/media/images/4778681bb73229d7d038c077c741b7bd.jpg"
    },
    "parents": null,
    "children": [
        {
            "id": 167757,
            "title": "Sala",
            "is_parent": false,
            "is_child": true,
            "parent": 14535,
            "description": "Morbi posuere sodales tellus, sit amet tincidunt mi aliquam porta.",
            "position": 0,
            "active": true,
            "handle": "decoracao-sala",
            "page_title": "Sala",
            "meta_description": null,
            "meta_tags": null,
            "num_products": 9,
            "url": "https://parallax.shopk.it/category/decoracao-sala",
            "permalink": "https://parallax.shopk.it/category/decoracao-sala",
            "image": {
                "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/276f8c112c887d830a8e3c585da5d93d.jpg",
                "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/276f8c112c887d830a8e3c585da5d93d.jpg",
                "full": "https://cdn.shopk.it/usercontent/parallax/media/images/276f8c112c887d830a8e3c585da5d93d.jpg"
            },
            "children": null
        },
    ],
    "created_at": "2019-10-02T17:03:56+01:00",
    "updated_at": "2019-10-02T17:11:08+01:00"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

POST Category

POST Category
POST/category

Create a category.

curl -X POST 'https://api.shopk.it/v1/category/' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type: application/json' \
-d '{"title": "Prints", "categories": [44373]}'
Attributes Type Choices Description
title
(required)		 string Title
active boolean true false Category is active
parent_id integer Category parent identifier
description string Description
handle string Handle
image string Image url
position integer Position
meta_description string Meta description
meta_tags string Meta tags
page_title string Page title

Example URI

POST https://api.shopk.it/v1/category
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "title": "Prints"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 14534,
  "title": "Prints",
  "is_parent": false,
  "is_child": false,
  "parent": 0,
  "parent_title": null,
  "description": "",
  "position": 0,
  "active": true,
  "handle": "prints",
  "page_title": "Prints",
  "meta_description": "",
  "meta_tags": null,
  "num_products": 0,
  "url": "https://parallax.shopk.it/category/prints",
  "permalink": "https://parallax.shopk.it/category/prints",
  "image": {
    "thumb": "https://cdn.shopk.it/assets/store/img/no-img.png",
    "square": "https://cdn.shopk.it/assets/store/img/no-img.png",
    "full": "https://cdn.shopk.it/assets/store/img/no-img.png"
  },
  "parents": null,
  "children": null,
  "created_at": "2019-10-02T17:11:07+01:00",
  "updated_at": "2019-10-02T17:11:08+01:00"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

PUT Category

PUT Category
PUT/category/{id}

Update a category.

curl -X PUT 'https://api.shopk.it/v1/category/1337' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type: application/json' \
-d'{"active": "true", "page_title": "prints"}'
Attributes Type Choices Description
title
(required)		 string Title
active boolean true false Category is active
parent_id integer Category parent identifier
description string Description
handle string Handle
image string Image url
position integer Position
meta_description string Meta description
meta_tags string Meta tags
page_title string Page title

Example URI

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

Category identifier

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "description": "Mauris ut ex iaculis, rhoncus nisl sit amet, posuere nisl."
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 14534,
  "title": "Prints",
  "is_parent": false,
  "is_child": false,
  "parent": 0,
  "parent_title": null,
  "description": "Mauris ut ex iaculis, rhoncus nisl sit amet, posuere nisl.",
  "position": 0,
  "active": true,
  "handle": "prints",
  "page_title": "Prints",
  "meta_description": "",
  "meta_tags": null,
  "num_products": 0,
  "url": "https://parallax.shopk.it/category/prints",
  "permalink": "https://parallax.shopk.it/category/prints",
  "image": {
    "thumb": "https://cdn.shopk.it/assets/store/img/no-img.png",
    "square": "https://cdn.shopk.it/assets/store/img/no-img.png",
    "full": "https://cdn.shopk.it/assets/store/img/no-img.png"
  },
  "parents": null,
  "children": null,
  "created_at": "2019-10-02T17:11:07+01:00",
  "updated_at": "2019-10-02T17:11:09+01:00"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

DELETE Category

DELETE Category
DELETE/category/{id}

Delete a category.

curl -X DELETE 'https://api.shopk.it/v1/category/1337' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

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

Category identifier

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

Brands

GET Brand

GET Brand
GET/brand/{id,handle,active,page,limit}

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

curl -X GET 'https://api.shopk.it/v1/brand/1337' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

GET https://api.shopk.it/v1/brand/1337&pure-you&active&1&10
URI Parameters
HideShow
id
integer (optional) Example: 1337

Brand identifier

handle
string (optional) Example: pure-you

Brand handle

active
boolean (optional) 

Brand is active

Choices: true false

page
integer (optional) Example: 1

Page number

limit
integer (optional) Default: 25 Example: 10

Bramds per page

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 43,
  "title": "Pure You",
  "description": "",
  "position": 0,
  "active": true,
  "handle": "pure-you",
  "page_title": "Pure You",
  "meta_description": "",
  "meta_tags": null,
  "num_products": 0,
  "url": "https://parallax.shopk.it/brand/pure-you",
  "permalink": "https://parallax.shopk.it/brand/pure-you",
  "image": {
    "thumb": "https://cdn.shopk.it/usercontent/boxie/media/images/thumb/d65c706-logo-3.png",
    "square": "https://cdn.shopk.it/usercontent/boxie/media/images/square/d65c706-logo-3.png",
    "full": "https://cdn.shopk.it/usercontent/boxie/media/images/d65c706-logo-3.png"
  },
  "created_at": "2022-04-08T00:39:02+01:00",
  "updated_at": "2022-04-08T00:44:21+01:00"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

POST Brand

POST Brand
POST/brand

Create a brand.

curl -X POST 'https://api.shopk.it/v1/brand/' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type: application/json' \
-d '{"title": "Pure You"}'
Attributes Type Choices Description
title
(required)		 string Title
active boolean true false Brand is active
description string Description
handle string Handle
image string Image url
position integer Position
meta_description string Meta description
meta_tags string Meta tags
page_title string Page title

Example URI

POST https://api.shopk.it/v1/brand
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "title": "Prints"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 43,
  "title": "Pure You",
  "description": "",
  "position": 0,
  "active": true,
  "handle": "pure-you",
  "page_title": "Pure You",
  "meta_description": "",
  "meta_tags": null,
  "num_products": 0,
  "url": "https://parallax.shopk.it/brand/pure-you",
  "permalink": "https://parallax.shopk.it/brand/pure-you",
  "image": {
    "thumb": "https://cdn.shopk.it/usercontent/boxie/media/images/thumb/d65c706-logo-3.png",
    "square": "https://cdn.shopk.it/usercontent/boxie/media/images/square/d65c706-logo-3.png",
    "full": "https://cdn.shopk.it/usercontent/boxie/media/images/d65c706-logo-3.png"
  },
  "created_at": "2022-04-08T00:39:02+01:00",
  "updated_at": "2022-04-08T00:44:21+01:00"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

PUT Brand

PUT Brand
PUT/brand/{id}

Update a brand.

curl -X PUT 'https://api.shopk.it/v1/brand/1337' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type: application/json' \
-d'{"title": "Pure You", "active": true}'
Attributes Type Choices Description
title
(required)		 string Title
active boolean true false Brand is active
description string Description
handle string Handle
image string Image url
position integer Position
meta_description string Meta description
meta_tags string Meta tags
page_title string Page title

Example URI

PUT https://api.shopk.it/v1/brand/id
URI Parameters
HideShow
id
integer (required) 

Brand identifier

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "description": "Mauris ut ex iaculis, rhoncus nisl sit amet, posuere nisl."
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 43,
  "title": "Pure You",
  "description": "",
  "position": 0,
  "active": true,
  "handle": "pure-you",
  "page_title": "Pure You",
  "meta_description": "",
  "meta_tags": null,
  "num_products": 0,
  "url": "https://parallax.shopk.it/brand/pure-you",
  "permalink": "https://parallax.shopk.it/brand/pure-you",
  "image": {
    "thumb": "https://cdn.shopk.it/usercontent/boxie/media/images/thumb/d65c706-logo-3.png",
    "square": "https://cdn.shopk.it/usercontent/boxie/media/images/square/d65c706-logo-3.png",
    "full": "https://cdn.shopk.it/usercontent/boxie/media/images/d65c706-logo-3.png"
  },
  "created_at": "2022-04-08T00:39:02+01:00",
  "updated_at": "2022-04-08T00:44:21+01:00"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

DELETE Brand

DELETE Brand
DELETE/brand/{id}

Delete a brand.

curl -X DELETE 'https://api.shopk.it/v1/brand/1337' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

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

Brand identifier

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

Orders

GET Order

GET Order
GET/order{?id,ids,status_alias,paid,date_filter,date_from,date_to,date_type,coupon_code,q,page,limit}

Get a list of orders or single order by id.

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

curl -X GET 'https://api.shopk.it/v1/order?status_alias=sent&date_filter=last_month' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

GET https://api.shopk.it/v1/order?id=1337&ids=1337,7331&status_alias=all&paid=true&date_filter=yesterday&date_from=2015-01-01&date_to=2015-01-01&date_type=&coupon_code=1337&q=bowl&page=1&limit=10
URI Parameters
HideShow
id
integer (optional) Example: 1337

Order identifier

ids
integer (optional) Example: 1337,7331

Order identifier, comma separated

status_alias
string (optional) Example: all

Order status alias as a string or combined comma separated

Choices: all pending processing sent canceled waiting_confirmation waiting_payment waiting_stock delivered returned pickup_available waiting_shipment

paid
boolean (optional) Example: true

Order is paid

Choices: true false

is_new
boolean (optional) Example: true

Order is new

Choices: true false

shipped
boolean (optional) Example: true

Order is shipped

Choices: true false

invoice
boolean (optional) Example: true

Order has invoice

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

date_type
string (optional) 

Affects all date parameters

Choices: created_at update_at sent_at paid_at

client_email
string (optional) Example: info@shopk.it

Client e-mail

client_hash
string (optional) Example: 858b9f6902f34443ef5d19ebb77baed5

Client e-mail hash

coupon_code
integer (optional) Example: 1337

Orders with this coupon code

q
string (optional) Example: bowl

Search in orders

page
integer (optional) Example: 1

Page number

limit
integer (optional) Default: 25 Example: 10

Orders per page

Response  200
HideShow
Headers
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": "",
    "discount": 0,
    "discount_percent": 0
  },
  "created_at": "2017-05-17T10:45:05+01:00",
  "update_at": "2024-09-20T16:31:02+01:00",
  "sent_at": "2017-05-17T11:23:21+01:00",
  "paid_at": "2017-05-17T11:23:21+01:00",
  "currency": "EUR",
  "status": 3,
  "paid": true,
  "is_new": false,
  "invoice_url": "https://www.app.invoicexpress.com/documents/permalink",
  "weight": 0,
  "observations": "",
  "note": "",
  "client_note": "",
  "custom_field": "",
  "tracking_code": "",
  "tracking_carrier": "",
  "tracking_created_at": "",
  "tracking_url": "",
  "expected_arrival_from": null,
  "expected_arrival_until": null,
  "shipping_url": "",
  "at_code": "",
  "tax_exemption": null,
  "tax_settings": null,
  "wholesale": false,
  "billing_info_same_delivery": "1",
  "is_digital": false,
  "payment": {
    "data": {
      "entity": 10611,
      "reference": 909000077,
      "value": 157.03
    },
    "value": 0,
    "tax": 0,
    "tax_percent": "",
    "title": "Multibanco",
    "method": "multibanco",
    "type": "multibanco",
    "gateway": "easypay"
  },
  "status_alias": "sent",
  "status_description": "Sent",
  "coupon": {
    "code": "bajevolp",
    "type": "percent",
    "value": 10
  },
  "shipment_method": "Transportadora",
  "shipment_type": null,
  "tracking_status": {
    "event_alias": null,
    "event_description": null
  },
  "permalink": "https://parallax.shopk.it/order/a77e38d0b16ba62f32361331774324904278edcf",
  "shipment_method_id": "492",
  "client": {
    "name": "Shopkit",
    "hash": "cfc1c614870f7033bb0a033b6e7cd18e",
    "email": "support@shopk.it",
    "company": "Shopkit",
    "fiscal_id": "999999990",
    "is_registered": false,
    "picture": null,
    "delivery": {
      "name": "Shopkit",
      "phone": "+351969057993",
      "address": "Avenida do Empresário, 1",
      "address_extra": "Centro de Empresas Inovadoras",
      "country_code": "PRT",
      "country_code_alpha_2": "PT",
      "zip_code": "6000-767",
      "city": "Castelo Branco",
      "country": "Portugal - Continental"
    },
    "billing": {
      "same_as_delivery": true,
      "name": "Shopkit",
      "phone": "+351969057993",
      "address": "Avenida do Empresário, 1",
      "address_extra": "Centro de Empresas Inovadoras",
      "country_code": "PRT",
      "country_code_alpha_2": "PT",
      "zip_code": "6000-767",
      "city": "Castelo Branco",
      "country": "Portugal - Continental"
    },
    "address": "Avenida do Empresário, 1 Centro de Empresas Inovadoras",
    "postcode": "6000-767",
    "town": "Castelo Branco",
    "country": "Portugal - Continental",
    "country_code": "PRT",
    "phone": "+351969057993"
  },
  "tags": [
    {
      "id": 2800420,
      "title": "shopkit",
      "handle": "shopkit",
      "total_items": 1,
      "created_at": "2024-09-20T16:31:02+01:00"
    }
  ],
  "l10n": {
    "tax_id_abbr": "NIF/NIPC/VAT ID",
    "tax_name": "IVA"
  },
  "products_count": 2,
  "products_quantity": 2,
  "products": [
    {
      "id": 44753,
      "title": "Shelving Tree with Birds",
      "option": "Azul / Small",
      "reference": "STHFBF7574",
      "barcode": null,
      "price": 77.32,
      "price_with_tax": 95.1036,
      "price_without_tax": 77.32,
      "tax": 23,
      "quantity": 1,
      "discount": 7.731999999999999,
      "subtotal": 85.5932,
      "subtotal_with_tax": 85.5932,
      "subtotal_without_tax": 77.32,
      "discount_percent": 10,
      "weight": 0,
      "origin_country": null,
      "origin_country_alpha_2": null,
      "harmonized_code": null,
      "type": "physical",
      "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://cdn.shopk.it/usercontent/parallax/media/images/thumb/0c0014c3ddd01f19933ce97e2041acd3.jpg",
        "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/0c0014c3ddd01f19933ce97e2041acd3.jpg",
        "full": "https://cdn.shopk.it/usercontent/parallax/media/images/0c0014c3ddd01f19933ce97e2041acd3.jpg"
      },
      "is_product": true
    },
    {
      "id": 44752,
      "title": "Hanging Succulent Planter",
      "option": null,
      "reference": "",
      "barcode": null,
      "price": 71.32,
      "price_with_tax": 71.32,
      "price_without_tax": 71.32,
      "tax": 0,
      "quantity": 1,
      "discount": 7.132,
      "subtotal": 64.188,
      "subtotal_with_tax": 64.188,
      "subtotal_without_tax": 71.32,
      "discount_percent": 10,
      "weight": 0,
      "origin_country": null,
      "origin_country_alpha_2": null,
      "harmonized_code": null,
      "type": "physical",
      "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://cdn.shopk.it/usercontent/parallax/media/images/thumb/eacc633fe509af083776db911a5f02b9.jpg",
        "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/eacc633fe509af083776db911a5f02b9.jpg",
        "full": "https://cdn.shopk.it/usercontent/parallax/media/images/eacc633fe509af083776db911a5f02b9.jpg"
      },
      "is_product": true
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

PUT Order

PUT Order
PUT/order/{id}

Update an order.

curl -X PUT 'https://api.shopk.it/v1/order/1337' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type:application/json' \
-d '{"paid":true, "status_alias":"sent"}'
Attributes Type Choices Description
status_alias string pending processing sent canceled waiting_confirmation waiting_payment waiting_stock delivered returned pickup_available waiting_shipment Order status as a string
paid boolean true false Order paid field
is_new boolean true false Order is new
invoice_url string Invoice permalink
invoice_file string Invoice base64 encoded (instead of invoice_url)
tracking_url string Tracking URL
tracking_code string Tracking code
tracking_carrier string ctt, dpd, correos_express, dhl_express, dhl_globalmail, dhl_parcel, fedex, gls, mrw, rangel, nacex, seur, tnt, ups, vasp, other Tracking carrier
shipping_url string Shipping URL
at_code string AT code
pickup_code string Pickup code
tags array[string] Array with tags
note string Order note
client_note string Order note to client
notify_client boolean true false Notify client after order update

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-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": "",
    "discount": 0,
    "discount_percent": 0
  },
  "created_at": "2017-05-17T10:45:05+01:00",
  "update_at": "2024-09-20T16:31:02+01:00",
  "sent_at": "2017-05-17T11:23:21+01:00",
  "paid_at": "2017-05-17T11:23:21+01:00",
  "currency": "EUR",
  "status": 3,
  "paid": true,
  "is_new": false,
  "invoice_url": "https://www.app.invoicexpress.com/documents/permalink",
  "weight": 0,
  "observations": "",
  "note": "",
  "client_note": "",
  "custom_field": "",
  "tracking_code": "",
  "tracking_carrier": "",
  "tracking_created_at": "",
  "tracking_url": "",
  "expected_arrival_from": null,
  "expected_arrival_until": null,
  "shipping_url": "",
  "at_code": "",
  "tax_exemption": null,
  "tax_settings": null,
  "wholesale": false,
  "billing_info_same_delivery": "1",
  "is_digital": false,
  "payment": {
    "data": {
      "entity": 10611,
      "reference": 909000077,
      "value": 157.03
    },
    "value": 0,
    "tax": 0,
    "tax_percent": "",
    "title": "Multibanco",
    "method": "multibanco",
    "type": "multibanco",
    "gateway": "easypay"
  },
  "status_alias": "sent",
  "status_description": "Sent",
  "coupon": {
    "code": "bajevolp",
    "type": "percent",
    "value": 10
  },
  "shipment_method": "Transportadora",
  "shipment_type": null,
  "tracking_status": {
    "event_alias": null,
    "event_description": null
  },
  "permalink": "https://parallax.shopk.it/order/a77e38d0b16ba62f32361331774324904278edcf",
  "shipment_method_id": "492",
  "client": {
    "name": "Shopkit",
    "hash": "cfc1c614870f7033bb0a033b6e7cd18e",
    "email": "support@shopk.it",
    "company": "Shopkit",
    "fiscal_id": "999999990",
    "is_registered": false,
    "picture": null,
    "delivery": {
      "name": "Shopkit",
      "phone": "+351969057993",
      "address": "Avenida do Empresário, 1",
      "address_extra": "Centro de Empresas Inovadoras",
      "country_code": "PRT",
      "country_code_alpha_2": "PT",
      "zip_code": "6000-767",
      "city": "Castelo Branco",
      "country": "Portugal - Continental"
    },
    "billing": {
      "same_as_delivery": true,
      "name": "Shopkit",
      "phone": "+351969057993",
      "address": "Avenida do Empresário, 1",
      "address_extra": "Centro de Empresas Inovadoras",
      "country_code": "PRT",
      "country_code_alpha_2": "PT",
      "zip_code": "6000-767",
      "city": "Castelo Branco",
      "country": "Portugal - Continental"
    },
    "address": "Avenida do Empresário, 1 Centro de Empresas Inovadoras",
    "postcode": "6000-767",
    "town": "Castelo Branco",
    "country": "Portugal - Continental",
    "country_code": "PRT",
    "phone": "+351969057993"
  },
  "tags": [
    {
      "id": 2800420,
      "title": "shopkit",
      "handle": "shopkit",
      "total_items": 1,
      "created_at": "2024-09-20T16:31:02+01:00"
    }
  ],
  "l10n": {
    "tax_id_abbr": "NIF/NIPC/VAT ID",
    "tax_name": "IVA"
  },
  "products_count": 2,
  "products_quantity": 2,
  "products": [
    {
      "id": 44753,
      "title": "Shelving Tree with Birds",
      "option": "Azul / Small",
      "reference": "STHFBF7574",
      "barcode": null,
      "price": 77.32,
      "price_with_tax": 95.1036,
      "price_without_tax": 77.32,
      "tax": 23,
      "quantity": 1,
      "discount": 7.731999999999999,
      "subtotal": 85.5932,
      "subtotal_with_tax": 85.5932,
      "subtotal_without_tax": 77.32,
      "discount_percent": 10,
      "weight": 0,
      "origin_country": null,
      "origin_country_alpha_2": null,
      "harmonized_code": null,
      "type": "physical",
      "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://cdn.shopk.it/usercontent/parallax/media/images/thumb/0c0014c3ddd01f19933ce97e2041acd3.jpg",
        "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/0c0014c3ddd01f19933ce97e2041acd3.jpg",
        "full": "https://cdn.shopk.it/usercontent/parallax/media/images/0c0014c3ddd01f19933ce97e2041acd3.jpg"
      },
      "is_product": true
    },
    {
      "id": 44752,
      "title": "Hanging Succulent Planter",
      "option": null,
      "reference": "",
      "barcode": null,
      "price": 71.32,
      "price_with_tax": 71.32,
      "price_without_tax": 71.32,
      "tax": 0,
      "quantity": 1,
      "discount": 7.132,
      "subtotal": 64.188,
      "subtotal_with_tax": 64.188,
      "subtotal_without_tax": 71.32,
      "discount_percent": 10,
      "weight": 0,
      "origin_country": null,
      "origin_country_alpha_2": null,
      "harmonized_code": null,
      "type": "physical",
      "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://cdn.shopk.it/usercontent/parallax/media/images/thumb/eacc633fe509af083776db911a5f02b9.jpg",
        "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/eacc633fe509af083776db911a5f02b9.jpg",
        "full": "https://cdn.shopk.it/usercontent/parallax/media/images/eacc633fe509af083776db911a5f02b9.jpg"
      },
      "is_product": true
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

PUT Order/bulk

PUT Order/bulk
PUT/order/bulk

Update up to 50 orders.

curl -X PUT 'https://api.shopk.it/v1/order/bulk' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type:application/json' \
-d '{"paid":true, "status_alias":"sent"}'
Attributes Type Choices Description
id (required) integer Order identifier
status_alias string pending processing sent canceled waiting_confirmation waiting_payment waiting_stock delivered returned pickup_available waiting_shipment Order status as a string
paid boolean true false Order paid field
invoice_url string Invoice permalink
tracking_url string Tracking URL
tracking_code string Tracking code
tracking_carrier string ctt, dpd, correos_express, dhl_express, dhl_globalmail, dhl_parcel, fedex, gls, mrw, rangel, nacex, seur, tnt, ups, vasp, other Tracking carrier
shipping_url string Shipping URL
at_code string AT code
pickup_code string Pickup code
note string Order note
client_note string Order note to client

Example URI

PUT https://api.shopk.it/v1/order/bulk
Request
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 1337,
    "paid": true,
    "status_alias": "sent"
  },
  {
    "id": 7331,
    "status_alias": "delivered"
  }
]
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "code": 200,
    "message": "OK",
    "id": 1337
  },
  {
    "code": 404,
    "message": "Not found",
    "id": 7331
  }
]
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}
Response  413
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Content Too Large"
}

POST Order/invoice

POST Order/invoice
PUT/order/{id}/invoice

Create order invoice. Store must have an invoice app active

curl -X GET 'https://api.shopk.it/v1/product/1337/invoice' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

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

Order identifier

Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "The invoice was issued successfully"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "No invoice app active"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}
Response  409
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Already exists."
}
Response  409
Response  413
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Content Too Large"
}

PUT Order/bulk/invoice

PUT Order/bulk/invoice
PUT/order/bulk/invoice

Update up to 50 orders.

curl -X PUT 'https://api.shopk.it/v1/order/bulk/invoice' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type:application/json' \
-d '[{"id": 3005936}, {"id": 3005938}]'
Attributes Type Description
id (required) integer Order identifier

Example URI

PUT https://api.shopk.it/v1/order/bulk/invoice
Request
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "id": 1337,
    },
    {
        "id": 7331,
    }
]
Response  201
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "code": 201,
        "message": "The invoice was issued successfully"
        "id": 3005936
    },
    {
        "code": 201,
        "message": "The invoice was issued successfully"
        "id": 3005938
    }
]
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "No invoice app active"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}
Response  409
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Already exists."
}
Response  413
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Content Too Large"
}

DELETE Order

DELETE Order
DELETE/order/{id}/

Delete an order.

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

Example URI

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

Order identifier

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

Client

GET Client

GET Client
GET/client

Get a list of clients guest and registred.

curl -X GET 'https://api.shopk.it/v1/client?registered=true' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

GET https://api.shopk.it/v1/client
URI Parameters
HideShow
hash
string (optional) Example: info@shopk.it

Client e-mail hash

registered
boolean (optional) Example: true

Client is registered or guest

Choices: true false

cart
boolean (optional) Example: true

Client has products in cart

Choices: true false

wishlist
boolean (optional) Example: true

Client has products in wishlist

Choices: true false

accepts_marketing
boolean (optional) Example: true

Client consent to accept marketing

Choices: true false

banned
boolean (optional) Example: true

Client is banned

Choices: true false

wholesale
string (optional) Example: true

Client is wholesale

Choices: true false pending

tags
string (optional) Example: shopkit

Client tags, comma separated

q
string (optional) Example: Shopkit

Search for a client

page
integer (optional) Example: 1

Page number

limit
integer (optional) Default: 25 Example: 10

Clients per page

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "hash": "858b9f6902f34443ef5d19ebb77baed5",
    "name": "Shopkit",
    "email": "info@shopk.it",
    "company": null,
    "initials": "S",
    "fiscal_id": null,
    "locale": null,
    "gender": null,
    "birthday": null,
    "picture": null,
    "accepts_marketing": false,
    "wholesale": false,
    "created_at": null,
    "last_seen_at": null,
    "is_banned": null,
    "is_registered": false,
    "internal_notes": null,
    "tags": null,
    "delivery": {
      "name": "Shopkit",
      "phone": "969057993",
      "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08",
      "address_extra": null,
      "country_code": "PRT",
      "country_code_alpha_2": "PT",
      "zip_code": "6000-767",
      "city": "Castelo Branco",
      "country": "Portugal - Continental"
    },
    "billing": {
      "same_as_delivery": true,
      "name": "Shopkit",
      "phone": "969057993",
      "address": "Centro de Empresas Inovadoras\nAvª do Empresário, 1, S1.08",
      "address_extra": null,
      "country_code": "PRT",
      "country_code_alpha_2": "PT",
      "zip_code": "6000-767",
      "city": "Castelo Branco",
      "country": "Portugal - Continental"
    },
    "l10n": {
      "tax_id_abbr": "NIF/NIPC/VAT ID",
      "tax_name": "IVA"
    },
    "cart": null,
    "wishlist": null,
    "orders_summary": {
      "paid_count": 2,
      "unpaid_count": 25,
      "paid_value": 112.62,
      "unpaid_value": 3093.72,
      "total_count": 27,
      "total_value": 3206.34
    }
  }
]
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
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 -X GET 'https://api.shopk.it/v1/shipping?country_code=prt' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

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-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-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

Shipment

GET shipment

GET Shipment
GET/shipment

Get a list of shipments or filter by tracking code.

curl -X GET 'https://api.shopk.it/v1/shipment?country_code=prt' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

GET https://api.shopk.it/v1/shipment
URI Parameters
HideShow
tracking_code
string (optional) Example: PT1333337

Tracking code

carrier
string (optional) 

Shipment carrier alias

Choices: correos_express ctt dhl_express dhl_globalmail dhl_parcel dpd fedex gls mrw nacex rangel seur tnt ups asp other

paid
boolean (optional) 

Shipment is paid

Choices: true false

status
string (optional) 

Shipment carrier alias

Choices: expedited accepted out_for_delivery pickup_available delivery_unsuccessful returned delivered

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

q
string (optional) Example: PT1333337

Search in orders

page
integer (optional) Example: 1

Page number

limit
integer (optional) Default: 25 Example: 10

Orders per page

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "tracking_code": "PT1333337",
  "carrier": "other",
  "carrier_description": "Other",
  "tracking_url": "https://track.aftership.com/PT1333337",
  "order_id": "1337",
  "type": "manual",
  "created_at": "2024-01-11T17:45:31+00:00",
  "updated_at": null,
  "expected_arrival_from": null,
  "expected_arrival_until": null,
  "from": {
    "zip_code": null,
    "country_code": null,
    "country_code_alpha_2": null,
    "country": null
  },
  "to": {
    "zip_code": "6000-767",
    "country_code": "PRT",
    "country_code_alpha_2": "PT",
    "country": "Portugal - Continental"
  },
  "last_event": null,
  "last_event_description": null,
  "events": null,
  "automatic_shipping": null
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

GET shipment/carrier

GET Shipment/carrier
GET/shipment/carrier

Get a list of shipment carriers available. No parameters

curl -X GET 'https://api.shopk.it/v1/shipment/carrier' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

GET https://api.shopk.it/v1/shipment/carrier
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "alias": "correos_express",
    "title": "Correos Express"
  },
  {
    "alias": "ctt",
    "title": "CTT"
  },
  {
    "alias": "dhl_express",
    "title": "DHL Express"
  },
  {
    "alias": "dhl_globalmail",
    "title": "DHL Global Mail"
  },
  {
    "alias": "dhl_parcel",
    "title": "DHL Parcel"
  },
  {
    "alias": "dpd",
    "title": "DPD"
  },
  {
    "alias": "fedex",
    "title": "FedEx"
  },
  {
    "alias": "gls",
    "title": "GLS"
  },
  {
    "alias": "mrw",
    "title": "MRW"
  },
  {
    "alias": "nacex",
    "title": "Nacex"
  },
  {
    "alias": "rangel",
    "title": "Rangel"
  },
  {
    "alias": "seur",
    "title": "SEUR"
  },
  {
    "alias": "tnt",
    "title": "TNT"
  },
  {
    "alias": "ups",
    "title": "UPS"
  },
  {
    "alias": "vasp",
    "title": "VASP Expresso"
  },
  {
    "alias": "other",
    "title": "Other"
  }
]

Coupons

GET Coupon

GET Coupon
GET/coupon{?id,code}

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

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

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-Type: application/json
Body
[
  {
    "id": 1337,
    "code": "bajevolp",
    "limit": 5,
    "used": 2,
    "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-Type: application/json
Body
{
  "message": "Not found."
}

POST Coupon

POST Coupon
POST/coupon/

Create a coupon.

curl -X POST 'https://api.shopk.it/v1/coupon' \
-H "X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c" \
-H 'Content-Type:application/json' \
-d '{"code":"bajevolp", "limit":"5", "value":"10", "type":"percent", "applies_to":"all_orders"}'
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-Type: application/json
Body
[
  {
    "id": 1337,
    "code": "bajevolp",
    "limit": 5,
    "used": 2,
    "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  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  409
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Already exists."
}
Response  409

DELETE Coupon

DELETE Coupon
DELETE/coupon/{id}

Delete a coupon.

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

Example URI

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

Coupon identifier

Response  204
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}
Response  404
HideShow
Headers
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.

Available webhook events: order_canceled order_deleted order_created order_updated order_paid order_sent order_change_status order_invoice order_shipping order_delivered order_change_payment order_payment_failed order_returned order_pickup_available order_waiting_shipment client_created client_updated client_deleted newsletter_subscribed newsletter_unsubscribed

GET Webhook

GET Webhook
GET/webhook/{id}{?active,event}

Get a list of webhooks or single webhook by id.

curl -X GET 'https://api.shopk.it/v1/webhook/1337' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

GET https://api.shopk.it/v1/webhook/1337?active=true&event=order_created
URI Parameters
HideShow
id
integer (optional) Example: 1337

Webhook identifier

active
boolean (optional) Example: true

Webhook active status

Choices: true false

event
string (optional) Example: order_created

Webhook event, see list above

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1337,
  "event": "order_created",
  "url": "https://www.example.com/url",
  "active": true
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

POST Webhook

POST Webhook
POST/webhook/

Create a webhook.

curl -X POST 'https://api.shopk.it/v1/webhook' \
-H "X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c" \
-H 'Content-Type:application/json' \
-d '{"url":"https://www.example.com/url", "event":"order_created"}'
Attributes Type Description
url string Webhook url
event string Webhook event, see list above

Example URI

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

DELETE Webhook

DELETE Webhook
DELETE/webhook/{id}

Delete a webhook.

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

Example URI

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

Webhook identifier

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

Media

GET Media

GET Media
GET/media/{?id,checksum,type,q,page,limit}

Get a list of media files or single media file by id or hash.

curl -X GET 'https://api.shopk.it/v1/media/1337' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

GET https://api.shopk.it/v1/media/?id=1337&checksum=6afb72c3074212b171f472a1ade4c0f5&type=all&q=bowl&page=1&limit=10
URI Parameters
HideShow
id
integer (optional) Example: 1337

Media identifier

checksum
string (optional) Example: 6afb72c3074212b171f472a1ade4c0f5

Media md5 checksum

type
string (optional) Example: all

Choices: all image file

q
string (optional) Example: bowl

Search for media

page
integer (optional) Example: 1

Page number

limit
integer (optional) Default: 25 Example: 10

Media per page

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 725,
  "checksum": "3df623e086a7d6cd606c4b1043bd7150",
  "file_name": "3df623e-010547-4778681bb73229d7d038c077c741b7bd.jpg",
  "file_type": "image/jpeg",
  "file_ext": ".jpg",
  "file_size": 60.82,
  "image_width": 600,
  "image_height": 674,
  "created_at": "2021-05-07 01:05:51",
  "url": {
    "thumb": "https://cdn.shopk.it/usercontent/parallax/media/images/thumb/3df623e-010547-4778681bb73229d7d038c077c741b7bd.jpg",
    "square": "https://cdn.shopk.it/usercontent/parallax/media/images/square/3df623e-010547-4778681bb73229d7d038c077c741b7bd.jpg",
    "full": "https://cdn.shopk.it/usercontent/parallax/media/images/3df623e-010547-4778681bb73229d7d038c077c741b7bd.jpg"
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not found."
}

POST Media

POST Media
POST/media/

Upload a file to media, via url or base64 encoded.

Files are processed asynchronous, there is no body response.

curl -X POST 'https://api.shopk.it/v1/media/images' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c' \
-H 'Content-Type: application/json' \
-d '{"url": "https://cdn.shopk.it/usercontent/parallax/media/images/3df623e-010547-4778681bb73229d7d038c077c741b7bd.jpg"}'
Attributes Type Description
url string Media url
file string Media base64 encoded

Example URI

POST https://api.shopk.it/v1/media/
Response  201
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}

DELETE Media

DELETE Media
DELETE/media/{id,checksum}

Delete a media file by id or hash. Only one parameter is required.

curl -X DELETE 'https://api.shopk.it/v1/media/1337' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

DELETE https://api.shopk.it/v1/media/1337&6afb72c3074212b171f472a1ade4c0f5
URI Parameters
HideShow
id
integer (optional) Example: 1337

Media identifier

checksum
string (optional) Example: 6afb72c3074212b171f472a1ade4c0f5

Media md5 checksum

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

Stats

GET Stats

GET Stats
GET/stats/{?metric,date_from,date_to}

Get store stats, for orders or visitor.

curl -X GET 'https://api.shopk.it/v1/stats/resume' \
-H 'X-API-KEY: f4c3cfc9af72e01c60d8b5f0b47492b2ee467c0c'

Example URI

GET https://api.shopk.it/v1/stats/?metric=&date_from=2015-01-01&date_to=2015-01-01
URI Parameters
HideShow
metric
string` (required) 

Stats metric

Choices: live visitors orders resume

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

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "date_start": " 2 de set.",
  "date_end": " 8 de set.",
  "date_start_raw": "2024-09-02",
  "date_end_raw": "2024-09-08",
  "sessions": 12,
  "orders_revenue": 0,
  "orders_count": 0,
  "conversion_rate": 8.33,
  "abandon_rate": 0.08333333333333333,
  "direct_traffic": 11,
  "referral_traffic": 0,
  "search_traffic": 0,
  "percentage_direct_traffic": 91.66666666666667,
  "percentage_referral_traffic": 0,
  "percentage_search_traffic": 0,
  "websites_referral": [],
  "products_sold": 0,
  "order_avg_value": 0,
  "search_keywords": [],
  "abandoned_total_carts": 0,
  "abandoned_total_items": 0,
  "abandoned_cart_total": 0
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Bad request."
}