@plasma-platform/service-orders v2.8.1

Full documentation
install:
npm i @plasma-platform/service-orders -S

Short documentation

Table of Contents

• OrdersService
  • messages
  • changeOrderPhoneNumber
    • Parameters
    • Examples
  • checkOrders
    • Parameters
    • Examples
  • checkRepurchase
    • Parameters
    • Examples
  • getListOfUserOrders
    • Parameters
    • Examples
  • getOrderById
    • Parameters
    • Examples
  • getOrderByIdPublic
    • Parameters
    • Examples
  • checkDownloadLinkStatusByToken
    • Parameters
    • Examples
  • restoreDownloadLinkStatusByToken
    • Parameters
    • Examples
  • getInvoiceData
    • Parameters
    • Examples
  • createInvoice
    • Parameters
    • Examples

OrdersService

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

messages

object with class service messages

Type: object

changeOrderPhoneNumber

Orders - Change the phone number of the order

Parameters

• params object
  • params.orderId string ID of order (required).
  • params.phoneNumber string order phone number (required).

Examples

(async () => {
  const service = new Service(url, token);
  const request = await service.changeOrderPhoneNumber(orderId);
})();

Returns Promise<any>

checkOrders

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

Check orders

Parameters

• params object params object
  • params.productType string Type of product. Allowed values: 'template', 'offer', 'membership'.
  • params.productIds string ID's of products
  • params.orderIds string ID's of orders
  • params.userId string Customer's ID
  • params.email string Customer's email
  • params.status number Order status
  • params.dateFrom string Date range start
  • params.dateTo string Date range end
  • params.paidOnly boolean Search only paid orders
  • params.strict boolean Strict search mode

Examples

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

Returns Promise<any>

checkRepurchase

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

Check repurchase

Parameters

• params object params object
  • params.products object Array of products objects.
    • params.products.type string template, offer, membership, item.
    • params.products.id string ID's of products.
  • params.orderIds string ID's of orders
  • params.userId string Customer's ID
  • params.email string Customer's email
  • params.status number Order status
  • params.dateFrom string Date range start
  • params.dateTo string Date range end
  • params.paidOnly boolean Search only paid orders
  • params.strict boolean Strict search mode

Examples

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

Returns Promise<any>

getListOfUserOrders

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

Get list of users orders

Parameters

• params object params object
  • params.page number page number to view.
  • params.perPage number records per page.
  • params.productType string type of product. Allowed values: 'template', 'offer', 'membership'.
  • params.productIds string ID's of products.
  • params.orderIds string ID's of orders.
  • params.status number order status
  • params.email number Customer's email
  • params.dateFrom number Date range start
  • params.dateTo number Date range end
  • params.paidOnly number Search only paid orders
  • params.strict number Strict search mode

Examples

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

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(orderId);
})();

Returns Promise<any>

getOrderByIdPublic

Orders - Get order public data

Parameters

• orderId string ID of order (required).

Examples

(async () => {
  const service = new Service(url);
  const request = await service.getOrderByIdPublic(orderId);
})();

Returns Promise<any>

checkDownloadLinkStatusByToken

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

Check download link status by access token

Parameters

• params object params object
  • params.orderId string Order id (required).
  • params.productId number Product id (required).

Examples

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

Returns Promise<any>

restoreDownloadLinkStatusByToken

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

Restore download link status by access token

Parameters

• params object params object
  • params.orderId string Order id (required).
  • params.productId number Product id (required).

Examples

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

Returns Promise<any>

getInvoiceData

• See: http://service-orders.templatemonsterdev.com/api/v2/invoices/:order_id

Get invoice data

Parameters

• params object params object
  • params.order_id string Order id (required).

Examples

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

Returns Promise<any>

createInvoice

• See: http://service-orders.templatemonsterdev.com/api/v2/invoices/:order_id

Invoices - Create Invoice

Parameters

• params object params object
  • params.order_id string (required) Order ID for import
  • params.billingName string (required) Billing user name
  • params.billingCountryISO2 string (required) Country in ISO2
  • params.billingCity string (required) City
  • params.billingAddress string (required) Address
  • params.billingZip string (required) Zip
  • params.companyName string Company name
  • params.billingStateISO2 string State in ISO2
  • params.taxId string taxID

Examples

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

Returns Promise<any>