What you can do with Customify API
API feature is available for Ultimate and Enterprise account. The Customify API lets you do the following with the Order resource.
- GET https://mycustomify.com/API/orders
Retrieves a list of custom orders - GET https://mycustomify.com/API/orders/view/#{order_id}
Retrieves a specific order - GET https://mycustomify.com/API/orders/detail/#{request_id}
Retrieves a specific item detail
Please note that you need to add api_key into you API request header. You can obtain your api_key through the app backend.
Endpoints
GEThttps://mycustomify.com/API/orders
Retrieves a list of orders.
shop_id |
Your Shopify account URL minus .myshopify.com |
limit |
The maximum number of results to show on a page. (default:50 , maximum: 250 ) |
created_at_min |
Show orders created at or after date (format: 2014-04-25) |
created_at_max |
Show orders created at or before date (format: 2014-04-25) |
order_status |
Filter orders by their status.
|
Retrieve all orders
GET https://mycustomify.com/API/orders
View responseHTTP/1.1 200 OK
[
{
"order_id": "1285674205245",
"order_number": "75904",
"shop_id": "myshopid",
"currency": "USD",
"customer_name": "John Due",
"customer_email": "john.due@sample.com",
"ip_address": "99.236.179.110",
"browser": "Chrome",
"browser_version": "75.0",
"device": "desktop",
"os": "macOS",
"country_id": "CA",
"country_name": "Canada",
"status": "paid",
"request_date": "2019-07-06",
"details": [
{
"request_id": "1562460787509",
"product_id": "528511631421",
"product_name": "Full Cover - No Chip",
"product_price": "8",
"full_front": "//customifystorage.com/myshopid/orders/1562460787509/full-1.png",
"full_back": "",
"design_front": "//customifystorage.com/myshopid/orders/1562460787509/design-1.png",
"design_back": ""
}
]
},
{
"order_id": "1285669486653",
"order_number": "75902",
"shop_id": "myshopid",
"currency": "USD",
"customer_name": "John Due",
"customer_email": "john.due@sample.com",
"ip_address": "24.209.145.34",
"browser": "Chrome",
"browser_version": "75.0",
"device": "mobile",
"os": "iOS",
"country_id": "US",
"country_name": "United States",
"status": "paid",
"request_date": "2019-07-06",
"details": [
{
"request_id": "1562457908645",
"product_id": "525580795965",
"product_name": "Full Cover - No Chip w/ Window",
"product_price": "8",
"full_front": "//customifystorage.com/myshopid/orders/1562457908645/full-1.png",
"full_back": "",
"design_front": "//customifystorage.com/myshopid/orders/1562457908645/design-1.png",
"design_back": ""
},
{
"request_id": "1562460417103",
"product_id": "1397921644605",
"product_name": "Full Cover - Small Chip w/ Window",
"product_price": "8",
"full_front": "//customifystorage.com/myshopid/orders/1562460417103/full-1.png",
"full_back": "",
"design_front": "//customifystorage.com/myshopid/orders/1562460417103/design-1.png",
"design_back": ""
}
]
}
]
GEThttps://mycustomify.com/API/orders/view/#{order_id}
Retrieves a spesific order.
shop_id |
Your Shopify account URL minus .myshopify.com |
#{order_id} |
The id of the order |
Retrieve a spesific order
GET https://mycustomify.com/API/orders/1285669486653
View responseHTTP/1.1 200 OK
[
{
"order_id": "1285669486653",
"order_number": "75902",
"shop_id": "myshopid",
"currency": "USD",
"customer_name": "John Due",
"customer_email": "john.due@sample.com",
"ip_address": "24.209.145.34",
"browser": "Chrome",
"browser_version": "75.0",
"device": "mobile",
"os": "iOS",
"country_id": "US",
"country_name": "United States",
"status": "paid",
"request_date": "2019-07-06",
"details": [
{
"request_id": "1562457908645",
"product_id": "525580795965",
"product_name": "Full Cover - No Chip w/ Window",
"product_price": "8",
"full_front": "//customifystorage.com/myshopid/orders/1562457908645/full-1.png",
"full_back": "",
"design_front": "//customifystorage.com/myshopid/orders/1562457908645/design-1.png",
"design_back": ""
},
{
"request_id": "1562460417103",
"product_id": "1397921644605",
"product_name": "Full Cover - Small Chip w/ Window",
"product_price": "8",
"full_front": "//customifystorage.com/myshopid/orders/1562460417103/full-1.png",
"full_back": "",
"design_front": "//customifystorage.com/myshopid/orders/1562460417103/design-1.png",
"design_back": ""
}
]
}
]
GEThttps://mycustomify.com/API/orders/detail/#{request_id}
Retrieves a spesific design output.
shop_id |
Your Shopify account URL minus .myshopify.com |
#{request_id} |
The id of the design output |
Retrieve a spesific design output
GET https://mycustomify.com/API/orders/detail/1562487961308
View responseHTTP/1.1 200 OK
[
{
"request_id": "1562487961308",
"product_id": "591767732285",
"product_name": "Full Cover - Large Chip",
"product_price": "8",
"full_front": "//customifystorage.com/myshopid/orders/1562487961308/full-1.png",
"full_back": "",
"design_front": "//customifystorage.com/myshopid/orders/1562487961308/design-1.png",
"design_back": ""
}
]