Get started
API Endpoint
https://api.bigvanet.com/v3
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 V3 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 product customizations included in orders.
# Here is a curl example
curl \
--location \
--request GET 'https://api.bigvanet.com/v3/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 V3 API KEY]'
# Here is a NodeJS example using Axios
var axios = require('axios');
var config = {
method: 'get',
url: 'https://api.bigvanet.com/v3/orders?shop=mystore.myshopify.com
&date_start=2000-01-01 00:00:00
&date_end=2022-12-31 23:59:59
&limit=2',
headers: {
'API_KEY': '[YOUR V3 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/v3/orders?shop=mystore.myshopify.com
&date_start=2000-01-01%2000:00:00
&date_end=2022-12-31%2023:59:59
&limit=2',
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 V3 API KEY]'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
CALL (GET):
https://api.bigvanet.com/v3/orders
Result example :
{
"statusCode": 200,
"headers": {
"Content-type": "application/json",
"access-control-allow-origin": "*",
"API": "Qstomizer API v3.0"
},
"body": {
"version": 3,
"error": false,
"error_message": "",
"data": [
{
"order_id": 779092,
"order_date": "2022/09/01 01:43",
"status_id": 1,
"status_date": "2022/09/01 01:43",
"hex_color": "",
"template_id": 522273,
"product_title": "2\" x 2\" Custom Rubber Stamp - No Handle / No Ink",
"comments": "",
"user_agent": ""
},
{
"order_id": 779092,
"order_date": "2022/09/01 01:43",
"status_id": 1,
"status_date": "2022/09/01 01:43",
"hex_color": "",
"template_id": 512275,
"product_title": "2\" x 2\" Custom Rubber Stamp - Add Handle / No Ink",
"comments": "",
"user_agent": ""
}
]
}
}
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. |
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. |
| hex_color | String | Color of the product in Hexadecimal format. |
| template_id | Number | ID of the product template. |
| comments | String | Coments added by the merchant to the store. |
| user_agent | String | Information about the device and browser where the customzation was made. |
get order
Get information about a specific customization order.
# Here is a curl example
curl \
--location \
--request GET 'https://api.bigvanet.com/v3/order?shop=mystore.myshopify.com
&orderId=1727839' \
--header 'API_KEY: [YOUR V3 API KEY]'
# Here is a NodeJS example using Axios
var axios = require('axios');
var config = {
method: 'get',
url: 'https://api.bigvanet.com/v3/order?shop=mystore.myshopify.com&
orderId=1727839',
headers: {
'API_KEY': '[YOUR V3 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/v3/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 V3 API KEY]'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
CALL (GET):
https://api.bigvanet.com/v3/order
Result example :
{
"statusCode": 200,
"headers": {
"Content-type": "application/json",
"access-control-allow-origin": "*",
"API": "Qstomizer API v3.0"
},
"body": {
"version": 3,
"error": false,
"error_message": "",
"data": {
"customization_date": "2022/09/01 15:09",
"status_id": 1,
"status_date": "2022/09/01 15:09",
"hex_color": "",
"template_id": 52275,
"comments": "",
"user_agent": "",
"sides": [
{
"side_id": 8443,
"side_name": "Front",
"image_url": "https://qstomizeruserimages.s3-us-west-2.amazonaws.com/mystore.myshopify.com/orderimages/r57tmGMP5GNABA5RVJ7pj0p3b1664443576571.jpg",
"design_png": "https://qstomizeruserimages.s3-us-west-2.amazonaws.com/mystore.myshopify.com/orderimages/r57tmGMP5GNABA5RVADssJ7pj0p3b1664443576571.png",
"generator_tool": "https://qstomizer.bigvanet.com/generator_tool/?sideid=8443&orderid=1789921&orderkey=633564ba88044428mh6j6h6x6pwjm8mqwp6j6cwfu46lw86o6cmhwc68wjwcuewem",
"nodes": [
{
"type": "image",
"formatOrigen": "clipart",
"id": "grupoimage0",
"position": {
"x": 308.9437466422602,
"y": 160.99318410868307
},
"scale": {
"x": 0.9505625335773963,
"y": 0.9505625335773963
},
"rotation": 0,
"size": {
"width": 200,
"height": 202
},
"src": "https://qstomizeruserimagesthumbnails.s3-us-west-2.amazonaws.com/clipart/people/00-png/basketball-player.png",
"keepRatio": true,
"globalScale": 1,
"isEditable": false,
"originalFileUrl": "https://qstomizeruserimages.s3-us-west-2.amazonaws.com/clipart/people/00-png/basketball-player.png"
},
{
"type": "text",
"id": "grupotexto1",
"position": {
"x": 321.7827914748848,
"y": 365.14487438625116
},
"fill": "#ffe599",
"hasStroke": true,
"stroke": "#000000",
"strokeWidth": 1.97,
"align": "center",
"fontSize": 40,
"fontFamily": "Carter One",
"text": "BASKETBALL",
"fillpattern": "",
"scale": {
"x": 0.6845284492272483,
"y": 0.6845284492272458
},
"rotation": -5.208257012803564,
"keepRatio": true,
"lineHeight": 1,
"globalScale": 1,
"shadowEnabled": true,
"shadowColor": "#fff",
"shadowOffset": {
"x": 0,
"y": 0
},
"shadowBlur": 0
}
]
},
{
"side_id": 8414,
"side_name": "Back",
"image_url": "https://qstomizeruserimages.s3-us-west-2.amazonaws.com/mystore.myshopify.com/orderimages/sZABUV0DTaVpcpRbZ6sDuIr2U1664443576548.jpg",
"generator_tool": "https://qstomizer.bigvanet.com/generator_tool/?sideid=8414&orderid=1789921&orderkey=633564ba880428mh6j6h6x6pwjm8mqwp6j6cwfu46lw86o6cmhwc68wjwcuewem",
"nodes": []
},
{
"side_id": 8415,
"side_name": "Right Sleeve",
"image_url": "https://qstomizeruserimages.s3-us-west-2.amazonaws.com/mystore.myshopify.com/orderimages/PJJ1JPf9AnKkJcmoh3yFx2nBK1664443576568.jpg",
"generator_tool": "https://qstomizer.bigvanet.com/generator_tool/?sideid=8415&orderid=1789921&orderkey=633564ba880428mh6j6h6x6pwjm8mqwp6j6cwfu46lw86o6cmhwc68wjwcuewem",
"nodes": []
},
{
"side_id": 8416,
"side_name": "Left Sleeve",
"image_url": "https://qstomizeruserimages.s3-us-west-2.amazonaws.com/mystore.myshopify.com/orderimages/CGXX0lV5PAPU3pA262NsRo15Z1664443576556.jpg",
"generator_tool": "https://qstomizer.bigvanet.com/generator_tool/?sideid=8416&orderid=1789921&orderkey=633564ba880428mh6j6h6x6pwjm8mqwp6j6cwfu46lw86o6cmhwc68wjwcuewem",
"nodes": []
}
],
"options_selected": {
"variation_id": "32277",
"option1": "Size",
"option1_value": "Small",
"option2": "Color",
"option2_value": "White",
"option3": null,
"option3_value": null,
"color": "#FFFFFF",
"color_des": "White",
"variantSelected": {
"id": 42232624808105,
"product_id": 7491705831593,
"title": "Small / White",
"price": "500.00",
"sku": "",
"position": 1,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Small",
"option2": "White",
"option3": null,
"created_at": "2022-05-24T04:12:21-04:00",
"updated_at": "2022-05-24T04:12:21-04:00",
"taxable": true,
"barcode": "",
"grams": 0,
"image_id": null,
"weight": 0,
"weight_unit": "lb",
"inventory_item_id": 44330857169065,
"inventory_quantity": 1000,
"old_inventory_quantity": 1000,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/42232624808105",
"qty": 1
},
"isProductSummary": true
},
"orders": [
{
"shopify_order_id": 4889333336255,
"shopify_order_name": "#3891",
"shopify_id_product": 7504436314495,
"shopify_variant_id": 42618944895551,
"quantity": 1
},
{
"shopify_order_id": 48931121342283,
"shopify_order_name": "#3909",
"shopify_id_product": 7504066314225,
"shopify_variant_id": 42612247895551,
"quantity": 3
}
]
}
}
}
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 |
|---|---|---|
| customization_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. |
| hex_color | String | Color of the product in Hexadecimal format. |
| template_id | Number | ID of the product template. |
| comments | String | Coments added by the merchant to the store. |
| user_agent | String | Information about the device and browser where the customzation was made. |
| orders | JSON |
Information about the orders that contains this customization. The customer can order this product 1 or more times. shopify_order_id: The Shopify internal ID of the order shopify_order_name: The ID or the order used by the merchant shopify_id_product: ID of the product in the Shopify system shopify_variant_id: ID of the product variant in the Shopify system quantity: quantity ordered. |
| sides | JSON |
Customization made on the product separated by sides. Each side contains: side_id: ID of the side. side_name: Name of the side. image_url: url of the customization image for that side, design_png: URL of the design in PNG format cropped using the diecut lines, generator_tool: Url that points to the generator tool to access and download the design. nodes: JSON object that contains all the specs of the nodes (images and texts that was used to create the design). options_selected: JSON object that contains the variation selected by the customer. |