@plasma-platform/service-delivery v1.6.3

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

Short documentation

Table of Contents

• DeliveryService
  • messages
  • getDeliveriesByOrderId
    • Parameters
    • Examples
  • getDeliveryByProductId
    • Parameters
    • Examples
  • getDeliveriesByOrdersIds
    • Parameters
    • Examples
  • getCountDownloadsProduct
    • Parameters
    • Examples

DeliveryService

• See: http://service-delivery.templatemonsterdev.com/doc/

messages

object with class service messages

Type: object

getDeliveriesByOrderId

• See: http://service-delivery.dev/api/v1/deliveries/orders/:order_id

Get deliveries by order id

Parameters

• params object
  • params.orderId string ID of order.
  • params.page number
  • params.perPage number

Examples

(async () => {
  const service = new DeliveryService(url, token);
  const request = await service.getDeliveriesByOrderId(params);
})();

Returns Promise<any>

getDeliveryByProductId

• See: http://service-delivery.dev/api/v1/deliveries/orders/:order_id

DeliveryService - Get delivery by order and product ID

Parameters

• params object
  • params.orderId string ID of order.
  • params.productId string ID of product.

Examples

(async () => {
  const service = new DeliveryService(url, token);
  const request = await service.getDeliveryByProductId(params);
})();

Returns Promise<any>

getDeliveriesByOrdersIds

• See: http://service-delivery.dev/api/v1/deliveries/?orderIds=2342sdf3,23435dfg

DeliveryService - Get delivery by orders ids

Parameters

• params object
  • params.order_ids string IDs of orders.
  • params.fields string fields in response.

Examples

(async () => {
  const service = new DeliveryService(url, token);
  const request = await service.getDeliveriesByOrdersIds(params);
})();

Returns Promise<any>

getCountDownloadsProduct

• See: http://service-delivery.dev/api/v1/downloads/UBgGf5pAkKNvs2VLZyDo/template/79332

DeliveryService - Count downloads product

Parameters

• params object
  • params.orderId string order Id
  • params.productType string product type
  • params.productId string product id

Examples

(async () => {
  const service = new DeliveryService(url, token);
  const request = await service.getCountDownloadsProduct(params);
})();

Returns Promise<any>