Version: 2.0.0
Last Updated: 12th May, 2022
Go to Version 3.0

Get started

    API Endpoint

        https://api.bigvanet.com/v2

The Qstomizer API provides programmatic access to read the customizations data made with the Qstomizer App. Retrieve a list of customization orders, order details, etc.

To use this API, you need an API key. You can get an API key from the App backend. You need to have subscribed to a specific subscription Plan. Check the website for more details. Please contact us at info@bigvanstudio.com if you have any doubt.

To make a call, it is necessary to pass the API key in the header of the cal with the format API_KEY. See the examples for more info.

get orders

Get a list of customizations orders.


# Here is a curl example
curl \
--location \
--request GET 'https://api.bigvanet.com/v2/orders?shop=mystore.myshopify.com
                &date_start=2000-01-01 00:00:00
                &date_end=2022-12-31 23:59:59
                &limit=2
                &included_in_order=1' \
--header 'API_KEY: [YOUR API KEY]'
            

# Here is a NodeJS example using Axios
var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api.bigvanet.com/v2/orders?shop=mystore.myshopify.com
        &date_start=2000-01-01 00:00:00
        &date_end=2022-12-31 23:59:59
        &limit=2
        &included_in_order=1',
  headers: { 
    'API_KEY': '[YOUR API KEY]'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});
            

# Here is a PHP example using CURL
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://api.bigvanet.com/v2/orders?shop=mystore.myshopify.com
                &date_start=2000-01-01%2000:00:00
                &date_end=2022-12-31%2023:59:59
                &limit=2
                &included_in_order=1',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
    'API_KEY: [YOUR API KEY]'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

CALL (GET):
https://api.bigvanet.com/v2/orders 



Result example :

{
    "statusCode": 200,
    "headers": {
        "Content-type": "application/json",
        "access-control-allow-origin": "*",
        "API": "Qstomizer API v2.0"
    },
    "body": {
        "version": 2,
        "error": false,
        "error_message": "",
        "data": [
            {
                "order_id": 1177801,
                "order_date": "2020/04/20 21:06",
                "status_id": 6,
                "status_date": "2020/04/29 18:04",
                "url_image_side_1": "https://qsmzorderimages.s3.amazonaws.com/3830_CAPTFRON_1587416762.2554.jpeg",
                "url_image_side_2": "https://qsmzorderimages.s3.amazonaws.com/3830_CAPTBACK_1587416763.3383.jpeg",
                "hex_color": "#ffffff",
                "template_id": 17832,
                "shopify_order": true,
                "shopify_order_id": 2179836215373,
                "shopify_order_name": "3134",
                "comments": "",
                "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.113 Safari/537.36",
                "gen_link_side_1": "https://www.qstomizer.com/backend/generateDesign.php?front=1&order_id=1177801&order_key=5e9e0ebc7eeb7xwlwzucw8wcm8wem8wqw4mhwj68uymcm4ucwlw8upwhw868u7w&scale=1",
                "gen_link_side_2": "https://www.qstomizer.com/backend/generateDesign.php?front=2&order_id=1177801&order_key=5e9e0ebc7eeb7xwlwzucw8wcm8wem8wqw4mhwj68uymcm4ucwlw8upwhw868u7w&scale=1"
            },
            {
                "order_id": 1251233,
                "order_date": "2020/07/06 15:03",
                "status_id": 1,
                "status_date": "2020/07/06 15:03",
                "url_image_side_1": "https://qsmzorderimages.s3.amazonaws.com/105_CAPTFRON_1594047837.8626.jpeg",
                "url_image_side_2": "",
                "hex_color": "#FFFFFF",
                "template_id": 32,
                "shopify_order": true,
                "shopify_order_id": 2261771288627,
                "shopify_order_name": "",
                "comments": "",
                "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36",
                "gen_link_side_1": "https://www.qstomizer.com/backend/generateDesign.php?front=1&order_id=1251233&order_key=5f033d5ed6347yw4we6cwfwcwc6fmhul6cwx6emcuowjw8wp6e6xulu7u4wcwcu&scale=1",
                "gen_link_side_2": ""
            }
        ]
    }
}

QUERY PARAMETERS

Field Type Description
shop String Shopify store URL with the format [merchanstore].myshopify.com.
Example: mystore.myshopify.com
date_start String Start date with the format YEAR-MONTH-DAY HOUR:MINUTE:SECOND.
date_end String End date with the format YEAR-MONTH-DAY HOUR:MINUTE:SECOND.
limit Number (optional - default 25) A limit on the number of objects to be returned, between 1 and 250.
included_in_order Integer (optional - default: 0) A value that indicates if the customization is included in a Shopify order.
0: not included
1: included


RESULTS

Field Type Description
order_id Number ID of the customization order in the Qstomizer system.
order_date String Date and hour of the customization with the format YEAR-MONTH-DAY HOUR:MINUTE.
status_id Number Status of the order. Possible values:
1: Pending
2: Stopped
3: In Production
4: Finished
5: Canceled
6: Deleted
7: Artwork approval pending
status_date String Date and hour of the order status with the format YEAR-MONTH-DAY HOUR:MINUTE.
url_image_side_1 String URL that points to the image in low resolution of the front side of the product.
url_image_side_2 String URL that points to the image in low resolution of the back side of the product.
hex_color String Color of the product in Hexadecimal format.
template_id Number ID of the product template.
shopify_order Boolean Indicates if the customization is included in a store order. Values:
True: The customization is included in an order.
False: The customization is not included in an order.
shopify_order_id Number ID of the order in the Shopify system where this customization is included.
shopify_order_name String ID of the order in the merchant store where this customization is included.
comments String Coments added by the merchant to the store.
user_agent String Information about the device and browser where the customzation was made.
gen_link_side_1 String URL that points to the generation tool to generate and download the image of the customization (Side 1/Front).
gen_link_side_2 String URL that points to the generation tool to generate and download the image of the customization (Side 2/Back).

get order

Get information about a specific customization order.


# Here is a curl example
curl \
--location \
--request GET 'https://api.bigvanet.com/v2/order?shop=mystore.myshopify.com
                &orderId=1727839' \
--header 'API_KEY: [YOUR API KEY]'
            

# Here is a NodeJS example using Axios
var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api.bigvanet.com/v2/order?shop=mystore.myshopify.com&
        orderId=1727839',
  headers: { 
    'API_KEY': '[YOUR API KEY]'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});
            

# Here is a PHP example using cCURL
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.bigvanet.com/v2/order?shop=mystore.myshopify.com
        &orderId=1727839',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'API_KEY: [YOUR API KEY]'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

CALL (GET):
https://api.bigvanet.com/v2/order 



Result example :

{
    "statusCode": 200,
    "headers": {
        "Content-type": "application/json",
        "access-control-allow-origin": "*",
        "API": "Qstomizer API v2.0"
    },
    "body": {
        "version": 2,
        "error": false,
        "error_message": "",
        "data": {
            "order_date": "2022/05/10 10:50",
            "status_id": 1,
            "status_date": "2022/05/10 10:50",
            "url_image_side_1": "https://qsmzorderimages.s3.amazonaws.com/105_CAPTFRON_1652179843.7154.jpeg",
            "url_image_side_2": "",
            "hex_color": "FEFF52",
            "template_id": 69,
            "shopify_order": false,
            "shopify_order_id": "",
            "shopify_order_name": "",
            "comments": "",
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/101.0.4951.54 Safari/537.36",
            "gen_link_side_1": "https://www.qstomizer.com/backend/generateDesign.php?front=1&order_id=1727839&order_key=627a438472b347wfuowyulwou7my6x6lufmculwcwcwhmjuj6juzw8wj6qw468w&scale=1",
            "gen_link_side_2": ""
        }
    }
}

QUERY PARAMETERS

Field Type Description
shop String Shopify store URL with the format [merchanstore].myshopify.com.
Example: mystore.myshopify.com
orderId Number Id of the customization order in the Qstomizer system.


RESULTS

Field Type Description
order_date String Date and hour of the customization with the format YEAR-MONTH-DAY HOUR:MINUTE.
status_id Number Status of the order. Possible values:
1: Pending
2: Stopped
3: In Production
4: Finished
5: Canceled
6: Deleted
7: Artwork approval pending
status_date String Date and hour of the order status with the format YEAR-MONTH-DAY HOUR:MINUTE.
url_image_side_1 String URL that points to the image in low resolution of the front side of the product.
url_image_side_2 String URL that points to the image in low resolution of the back side of the product.
hex_color String Color of the product in Hexadecimal format.
template_id Number ID of the product template.
shopify_order Boolean Indicates if the customization is included in a store order. Values:
True: The customization is included in an order.
False: The customization is not included in an order.
shopify_order_id Number ID of the order in the Shopify system where this customization is included.
shopify_order_name String ID of the order in the merchant store where this customization is included.
comments String Coments added by the merchant to the store.
user_agent String Information about the device and browser where the customzation was made.
gen_link_side_1 String URL that points to the generation tool to generate and download the image of the customization (Side 1/Front).
gen_link_side_2 String URL that points to the generation tool to generate and download the image of the customization (Side 2/Back).

get order texts

Get the text layers information related to a customization order.


# Here is a curl example
curl \
--location \
--request GET 'https://api.bigvanet.com/v2/order/texts?shop=mystore.myshopify.com
    &orderId=1727839' \
--header 'API_KEY: [YOUR API KEY]'
            

# Here is a NodeJS example using Axios
var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api.bigvanet.com/v2/order/texts?shop=mystore.myshopify.com
        &orderId=1727839',
  headers: { 
    'API_KEY': '[YOUR API KEY]'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});
            

# Here is a PHP example using cCURL
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.bigvanet.com/v2/order/texts?shop=mystore.myshopify.com
        &orderId=1727839',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'API_KEY: [YOUR API KEY]'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

CALL (GET):
https://api.bigvanet.com/v2/order/texts 



Result example :

{
    "statusCode": 200,
    "headers": {
        "Content-type": "application/json",
        "access-control-allow-origin": "*",
        "API": "Qstomizer API v2.0"
    },
    "body": {
        "version": 2,
        "error": false,
        "error_message": "",
        "data": {
            "order_id": "1727839",
            "texts": [
                {
                    "text": "text layer 1",
                    "font_size": 50,
                    "font_family": "Covered By Your Grace",
                    "font_style": null,
                    "side": 2,
                    "color": "#000000",
                    "x": 400,
                    "y": 200,
                    "rotation": 180,
                    "width": 180,
                    "height": 180,
                    "circular": true,
                    "scale_x": 1,
                    "scale_y": 1,
                    "order": 9,
                    "text_alignment": "left",
                    "line_height": 1
                },
                {
                    "text": "Another text layer",
                    "font_size": 50,
                    "font_family": "Comfortaa Bold",
                    "font_style": null,
                    "side": 2,
                    "color": "#ff0000",
                    "x": 395.710455764075,
                    "y": 351.2064343163538,
                    "rotation": 0,
                    "width": 146.044921875,
                    "height": 50,
                    "circular": false,
                    "scale_x": 1,
                    "scale_y": 1,
                    "order": 10,
                    "text_alignment": "left",
                    "line_height": 1
                }
            ]
        }
    }
}

QUERY PARAMETERS

Field Type Description
shop String Shopify store URL with the format [merchanstore].myshopify.com.
Example: mystore.myshopify.com
orderId Number Id of the customization order in the Qstomizer system.


RESULTS

Field Type Description
text String Text added by the customer to the layer.
font_size Number Size of the font.
font_family String Font family of the text.
font_style String Font style of the text
side Number Inidicates the side where the text layer was placed. Values:
1: Side 1 / Front
2: Side 2 / Back
color String Color of the text in hex format.
x Number X coordenate of the position of the text in the canvas.
y Number y coordenate of the position of the text in the canvas.
rotation Number Rotation in degrees of the text layer.
width Number Width of the layer.
height Number Height of the layer.
circular Boolean Indicates if the text is circular or straigh. Values:
true: Circular
false: Straight
scale_x Number X Scale of the layer.
scale_y Number Y Scale of the layer.
order Number Order of the layer with respect of other layers. 0 is the first layer at the bottom.
text_alignment String Alignment of the text. Values:
left: Left alignment
center: Center alignment
right: Right alignment
line_height Number Indicates the line height of the text.

get order images

Get the text layers information related to a customization order.


# Here is a curl example
curl \
--location \
--request GET 'https://api.bigvanet.com/v2/order/images
        ?shop=mystore.myshopify.com
        &orderId=1727839' \
--header 'API_KEY: [YOUR API KEY]'
            

# Here is a NodeJS example using Axios
var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api.bigvanet.com/v2/order/images
        ?shop=mystore.myshopify.com
        &orderId=1727839',
  headers: { 
    'API_KEY': '[YOUR API KEY]'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});
            

# Here is a PHP example using cCURL
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.bigvanet.com/v2/order/images
        ?shop=mystore.myshopify.com
        &orderId=1727839',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'API_KEY: [YOUR API KEY]'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

CALL (GET):
https://api.bigvanet.com/v2/order/images 



Result example :

{
    "statusCode": 200,
    "headers": {
        "Content-type": "application/json",
        "access-control-allow-origin": "*",
        "API": "Qstomizer API v2.0"
    },
    "body": {
        "version": 2,
        "error": false,
        "error_message": "",
        "data": {
            "order_id": "1727839",
            "images": [
                {
                    "url": "https://qstomizruser.s3.amazonaws.com/CLIP_QADLDLQS1231614763457.1619.png",
                    "side": 1,
                    "x": 479.3565683646112,
                    "y": 209.5174262734584,
                    "rotation": 0,
                    "width": 200,
                    "height": 200
                },
                {
                    "url": "https://qstomizruser.s3.amazonaws.com/DLQL9A2K16521231179134.6275.png",
                    "side": 1,
                    "x": 354.9597855227882,
                    "y": 481.90348525469165,
                    "rotation": 0,
                    "width": 120,
                    "height": 200
                },
                {
                    "url": "https://qstomizruser.s3.amazonaws.com/ILALIKDS1652dds179146.833.jpg",
                    "side": 1,
                    "x": 504.0214477211796,
                    "y": 495.8445040214477,
                    "rotation": -18,
                    "width": 187,
                    "height": 200
                }
            ]
        }
    }
}

QUERY PARAMETERS

Field Type Description
shop String Shopify store URL with the format [merchanstore].myshopify.com.
Example: mystore.myshopify.com
orderId Number Id of the customization order in the Qstomizer system.


RESULTS

Field Type Description
url String URL of the original image.
side Number Inidicates the side where the text layer was placed. Values:
1: Side 1 / Front
2: Side 2 / Back
x Number X coordenate of the position of the text in the canvas.
y Number y coordenate of the position of the text in the canvas.
rotation Number Rotation in degrees of the text layer.
width Number Width of the layer.
height Number Height of the layer.