Shopitag API Documentation API Reference

Welcome to Shopitags public API. Please make sure you obtain a valid api_token before calling any of the mentioned methods.

You can find your personal api_token by logging in to your Shopitag account, click top right corner on your profile picture, choose Settings and then click API.

Mandatory headers to use in your API calls

  1. Accept with value application/json
  2. Content-type with value application/json; charset=utf-8
  3. Authorization with value Bearer {your API token}
.

API Endpoint
https://app.shopitag.com/api/v1
Terms of Service: https://shopitag.com/terms-conditions/
Contact: support@shopitag.com
Schemes: https
Version: 1.0.0

tag

Methods to visit the Shopitag popup shops

tag

Generate a hyperlink to visit a popup shop or productcategory

POST /tag/generate/{hashtag}

Based on the provided # hashtag which identifies your popup shop (or one of its categories), we will generate a link so a user can immediately enter the popup shop when he clicks the link. The user will (potentially) not have to authenticate during checkout as the userdata is provided in the call.

The lifetime of such link is 3 hours.

hashtag

Hashtag of the popup shop or the product category. The # itself must not be provided.

type
string
in
path
email

User e-mail; if not available at moment of calling the API, generate one that has a valid email pattern

type
string
in
formData
firstname

User first name; if not available, provide dummy data.

type
string
in
formData
lastname

User last name; if not available, provide dummy data.

type
string
in
formData
lang

The language of the user; if used, use en for English, fr for French, de for German, es for Spanish, nl for Dutch. Unsupported languages will fall back to English.

type
string
in
formData
200 OK

The JSON containing the hyperlink to the popupshop.

422 Unprocessable Entity

See the error message

Response Content-Types: application/json
Response Example (200 OK) 
{
  "token": "string",
  "url": "string",
  "shop_title": "string",
  "valid_from": "string",
  "valid_until": "string"
}
tag

Generates a link that can be used in a mailing

POST /tag/generate/email/{hashtag}

This API call is linked to our email sales channel. This API call can be used by email providers (email marketing companies) that send out a batch of emails to opt-in subscribed email addresses. Calling the API will provide you the correct URL to a popup shop. The user that receives the email will then be able to visit the right popup shop when he clicks the link in the email.

The lifetime of this link is indefinite, or untill the popup shop itself expires or is deleted.

hashtag

Hashtag of the popup shop or the product category. You can skip the #.

type
string
in
path
lang

The language of the email campaign; if used, use en for English, fr for French, de for German, es for Spanish, nl for Dutch. Unsupported languages will fall back to English.

type
string
in
formData
200 OK

The JSON containing the hyperlink to the popupshop.

404 Not Found

The code does not exists or the shop is expired

Response Content-Types: application/json
Response Example (200 OK) 
{
  "redirect": "string"
}

shops

Methods to get information about your shops or to create new ones

shops

Get a list of all the configured pop-up shops in your Shopitag account

GET /shops

This API call gives you a listing of configured pop-up shops in your Shopitag account

200 OK

An array of object containing your pop-up shops details

Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "shop_title": "string",
    "hashtag": "string",
    "valid_from": "string",
    "valid_until": "string",
    "number_categories": "integer",
    "number_products": "integer",
    "has_theme": "boolean"
  }
]
shops

Create a new shop

POST /shop

This API call gives you the possibility to configure a new pop-up shop in your Shopitag account

CreatePopstore
undefined
Request Content-Types: application/json
Request Example
{
  "shop_title": "My first popup shop",
  "sales_profile": "599c2e679a8920142575e5a1",
  "hashtag": "first",
  "valid_from": "2018-01-22T00:00:00Z",
  "valid_until": "2019-01-21T23:59:59Z",
  "content": [
    {
      "category_name": "My first category",
      "products": [
        "599c2e679a8920142575e5a1"
      ],
      "sub_categories": [
        {
          "category_name": "My second category",
          "products": [
            "599c2e679a8920142575e5a1"
          ]
        }
      ]
    }
  ]
}
201 Created

The popup store has been created successfully

sales-profiles

Methods to get information about your sales profiles

sales-profiles

Get a list of all the configured sales profiles in your Shopitag account

GET /sales-profiles

This API call gives you a listing of configured sales profiles in your Shopitag account

200 OK

An array of object containing your sales profiles details

Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "id": "string",
    "title": "string"
  }
]

products

Methods to get information about your products

products

Get a list of all the configured products in your Shopitag account

GET /products

This API call gives you a listing of configured products in your Shopitag account

200 OK

An array of object containing your products details

Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "id": "string",
    "title": "string"
  }
]

Schema Definitions

CreatePopstore: object

shop_title: string

Your popup shop title.

sales_profile: string

The unique ID of the sales profile that you want to link to the popup shop. See sales-profiles operations to know how to get the list of your sales profiles.

hashtag: string

The hahstag to access your popup shop via Messenger.

valid_from: string (date-time)

Your popup store will be accessible from this date.

valid_until: string (date-time)

Your popup store will be accessible until this date.

content: CreatePopstoreContent

The categories and products of you popup store.

Example
{
  "shop_title": "My first popup shop",
  "sales_profile": "599c2e679a8920142575e5a1",
  "hashtag": "first",
  "valid_from": "2018-01-22T00:00:00Z",
  "valid_until": "2019-01-21T23:59:59Z",
  "content": [
    {
      "category_name": "My first category",
      "products": [
        "599c2e679a8920142575e5a1"
      ],
      "sub_categories": [
        {
          "category_name": "My second category",
          "products": [
            "599c2e679a8920142575e5a1"
          ]
        }
      ]
    }
  ]
}

CreatePopstoreContent: object

category_name: string

The category name

products: string[]

An array containing the unique ID of the products that you want it this category. See products operations to know how to get the list of your products.

sub_categories: CreatePopstoreSubcategory

You can define sub categories with this property.

Example
{
  "category_name": "My first category",
  "products": [
    "599c2e679a8920142575e5a1"
  ],
  "sub_categories": [
    {
      "category_name": "My second category",
      "products": [
        "599c2e679a8920142575e5a1"
      ]
    }
  ]
}

CreatePopstoreSubcategory: object

category_name: string

The category name

products: string[]

An array containing the unique ID of the products that you want it this category. See products operations to know how to get the list of your products.

Example
{
  "category_name": "My second category",
  "products": [
    "599c2e679a8920142575e5a1"
  ]
}
Documentation by Spectacle