README
Orders
Kind: global class
- Orders
- new Orders()
- .getListOfUsersOrders(token, params) ⇒
Array
- .getOrderById(token, ID) ⇒
Object
- .restoreDownloadLink(token, orderID, productID) ⇒
Object
- .checkDownloadLink(token, orderID, productID) ⇒
Object
- ._isValidId(id) ⇒
Bool
- ._fetchRequest(url, token) ⇒
Promise
new Orders()
Orders API JS client.
In order to use Orders API you should create an instance of this class.
import Orders from "tm-orders-api-client-js";
const products = new Orders ('http://service-orders.dev/api/v2', 'en');
Array
orders.getListOfUsersOrders(token, params) ⇒ Get list of users orders
Kind: instance method of Orders
Returns: Array
-
[ { "affiliate_id": "TM", "order_id": "NDrMh3S3XvSt0LfbHoWh", "user_id": "124088", "date": 1481166873, "status": 1, "amount": "138", "locale": "EN", "project_id": "0", "merchantTransactionId": "", "merchantSystem": "PayPal", "products": [ { "id": "52995", "class": "template", "price": "89", "license": "single site", "products": [] }, { "id": "53001", "class": "template", "price": "75", "license": "single site", "products": [] }, { "id": "55932", "class": "template", "price": "11", "license": "single site", "products": [], "name": "PRO Industry PSD Template", "url": "/psd-templates/pro-industry-psd-template-55932.html", "type": "PSD Template", "image": "55932-original.jpg" } ] }, ...]
Param | Type | Description |
---|---|---|
token | String |
User token |
params | Object |
list of orders parameters { page: Number, per-page: Number, product-type: String, product-ids: String, ids: String } |
Object
orders.getOrderById(token, ID) ⇒ Get Order By ID
Kind: instance method of Orders
Returns: Object
-
{ "affiliate_id": "TM", "order_id": "NDrMh3S3XvSt0LfbHoWh", "user_id": "124088", "date": 1481166873, "status": 1, "amount": "138", "locale": "EN", "project_id": "0", "merchantTransactionId": "", "merchantSystem": "PayPal", "products": [ { "id": "52995", "class": "template", "price": "89", "license": "single site", "products": [] }, { "id": "53001", "class": "template", "price": "75", "license": "single site", "products": [] }, { "id": "55932", "class": "template", "price": "11", "license": "single site", "products": [], "name": "PRO Industry PSD Template", "url": "/psd-templates/pro-industry-psd-template-55932.html", "type": "PSD Template", "image": "55932-original.jpg" } ] }
Param | Type | Description |
---|---|---|
token | String |
User token |
ID | Number |
Order ID |
Object
orders.restoreDownloadLink(token, orderID, productID) ⇒ Restore Download Link
Kind: instance method of Orders
Returns: Object
-
{ "orderId": "xdtGS1apwbLKmv9ZXOlV", "productId": 123, "link": "http://dddd.ccc/dgdfgdfg", "downloadStatus": "inZipper", "isExpired": false, "rate": 1, "zipperTime": 1 }
Param | Type | Description |
---|---|---|
token | String |
User token |
orderID | Number |
Order ID |
productID | Number |
Product ID |
Object
orders.checkDownloadLink(token, orderID, productID) ⇒ Check Download Link
Kind: instance method of Orders
Returns: Object
-
{ "orderId": "xdtGS1apwbLKmv9ZXOlV", "productId": 123, "link": "http://dddd.ccc/dgdfgdfg", "downloadStatus": "inZipper", "isExpired": false, "rate": 1, "zipperTime": 1 }
Param | Type | Description |
---|---|---|
token | String |
User token |
orderID | Number |
Order ID |
productID | Number |
Product ID |
Bool
orders._isValidId(id) ⇒ Return Correct id or not
Kind: instance method of Orders
Param | Type | Description |
---|---|---|
id | Number |
Product id |
Promise
orders._fetchRequest(url, token) ⇒ Return Fetch Promise
Kind: instance method of Orders
Param | Type | Description |
---|---|---|
url | String |
Where request go |
token | String |
auth user token |