tm-service-orders v1.1.1

Documentation

OrdersService

• See: http://service-orders.dev/doc/

messages

object with class service messages

checkDownloadLinkStatus

• See: http://service-orders.dev/api/v1/orders/:orderId/:productId/download-link

Download link status (check)

Parameters

• orderId {string} - Order id (required).
• productId {number} - Product id (required).

Examples

(async () => {
  const service = new Service('http://service-orders.dev/api/v1/', token);
  const request = await service.checkDownloadLinkStatus('NDrMh3S3XvSt0LfbHoWh', 222);
})();

Returns Promise<any>

restoreDownloadLinkStatus

• See: http://service-orders.dev/api/v1/orders/:orderId/:productId/download-link

Download link status (restore)

Parameters

• orderId {string} - Order id (required).
• productId {number} - Product id (required).

Examples

(async () => {
  const service = new Service('http://service-orders.dev/api/v1/', token);
  const request = await service.restoreDownloadLinkStatus('NDrMh3S3XvSt0LfbHoWh', 222);
})();

Returns Promise<any>

getListOfUserOrders

• See: http://service-orders.dev/api/v2/orders

Get list of users orders

Parameters

• props object
• page number page number to view.
• perPage number records per page.
• productType string type of product. Allowed values: 'template', 'offer', 'membership', 'weblium', 'subscription'.
• productIds string ID's of products.
• orderIds string ID's of orders.
• status number order status

Examples

(async () => {
  const service = new Service('http://service-orders.dev/api/v2/', token);
  const request = await service.getListOfUserOrders({ page: 1, ids: 'NDrMh3S3XvSt0LfbHoWh' });
})();

Returns Promise<any>

getOrderById

• See: http://service-orders.dev/api/v2/orders/:id

Get order by ID

Parameters

• orderId string ID of order.

Examples

(async () => {
  const service = new Service('http://service-orders.dev/api/v2/', token);
  const request = await service.getOrderById('NDrMh3S3XvSt0LfbHoWh');
})();

Returns Promise<any>

getOrderInfo

• See: http://service-orders.dev/api/v2/orders

Get order info

Parameters

• args object Arguments for payments
  • args.page number Page number to view
  • args.perPage number Records per page
  • args.productType string Type of product
  • args.productIds string ID's of products
  • args.ids string ID's of orders
  • args.userId string Customer's ID
  • args.email string Customer's email
  • args.status number Order status
  • args.dateFrom string Date range start
  • args.dateTo string Date range end

Examples

(async () => {
  const service = new Service('http://service-orders.dev/api/v2/', token);
  const request = await service.getOrderById('NDrMh3S3XvSt0LfbHoWh');
})();

Returns Promise<any>