shopify-api-node/resources/fulfillment-order.js

Shopify API bindings for Node.js

'use strict';

const assign = require('lodash/assign');
const pick = require('lodash/pick');

const base = require('../mixins/base');

/**
 * Creates a FulfillmentOrder instance.
 *
 * @param {Shopify} shopify Reference to the Shopify instance
 * @constructor
 * @public
 */
function FulfillmentOrder(shopify) {
  this.shopify = shopify;

  this.name = 'fulfillment_orders';
  this.key = 'fulfillment_order';
}

assign(FulfillmentOrder.prototype, pick(base, ['get', 'buildUrl']));

/**
 * Retrieves a list of fulfillment orders on a shop for a specific app.
 *
 * @param {Object} [params] Query parameters
 * @return {Promise} Promise that resolves with the result
 * @public
 */
FulfillmentOrder.prototype.list = function list(params) {
  const url = base.buildUrl.call(
    { ...this, name: 'assigned_fulfillment_orders' },
    undefined,
    params
  );
  return this.shopify.request(url, 'GET', this.name);
};

/**
 * Marks a fulfillment order as cancelled.
 *
 * @param {Number} id Fulfillment order ID
 * @return {Promise} Promise that resolves with the result
 * @public
 */
FulfillmentOrder.prototype.cancel = function cancel(id) {
  const url = this.buildUrl(`${id}/cancel`);
  return this.shopify
    .request(url, 'POST', undefined, {})
    .then((body) => body[this.key]);
};

/**
 * Marks an in progress fulfillment order as incomplete, indicating the
 * fulfillment service is unable to ship any remaining items and intends to
 * close the fulfillment order.
 *
 * @param {Number} id Fulfillment order ID
 * @param {String} [message] The reason for marking the fulfillment order as
 *     incomplete
 * @return {Promise} Promise that resolves with the result
 * @public
 */
FulfillmentOrder.prototype.close = function close(id, message = '') {
  const url = this.buildUrl(`${id}/close`);
  return this.shopify.request(url, 'POST', this.key, { message });
};

/**
 * Moves a fulfillment order from one merchant managed location to another
 * merchant managed location.
 *
 * @param {Number} id Fulfillment order ID
 * @param {Number} locationId The ID of the location to which the fulfillment
 *     order will be moved
 * @return {Promise} Promise that resolves with the result
 * @public
 */
FulfillmentOrder.prototype.move = function move(id, locationId) {
  const url = this.buildUrl(`${id}/move`);
  return this.shopify
    .request(url, 'POST', undefined, {
      fulfillment_order: {
        new_location_id: locationId
      }
    })
    .then((body) => body.original_fulfillment_order);
};

/**
 * Retrieves a list of locations that a fulfillment order can potentially move
 * to.
 *
 * @param {Number} id Fulfillment order ID
 * @return {Promise} Promise that resolves with the result
 * @public
 */
FulfillmentOrder.prototype.locationsForMove = function locationsForMove(id) {
  const url = this.buildUrl(`${id}/locations_for_move`);
  return this.shopify.request(url, 'GET', 'locations_for_move');
};

/**
 * Sets the latest date and time by which the fulfillment orders need to be
 * fulfilled.
 *
 * @param {Object} params An object containing the new fulfillment deadline and
 *     and the IDs of the fulfillment orders for which the deadline is being set
 * @return {Promise} Promise that resolves with the result
 * @public
 */
FulfillmentOrder.prototype.setFulfillmentOrdersDeadline =
  function setFulfillmentOrdersDeadline(params) {
    const url = this.buildUrl('set_fulfillment_orders_deadline');
    return this.shopify.request(url, 'POST', undefined, params);
  };

/**
 * Lists fulfillments for a fulfillment order.
 *
 * @param {Number} id Fulfillment order ID
 * @return {Promise} Promise that resolves with the result
 * @public
 */
FulfillmentOrder.prototype.fulfillments = function fulfillments(id) {
  const url = this.buildUrl(`${id}/fulfillments`);
  return this.shopify.request(url, 'GET', 'fulfillments');
};

/**
 * Halts all fulfillment work on a fulfillment order with status `OPEN` and
 * changes the status of the fulfillment order to `ON_HOLD`.
 *
 * @param {Number} id Fulfillment Order ID
 * @param {Object} params An object containing the reason for the fulfillment
       hold and additional optional information
 * @return {Promise} Promise that resolves with the result
 * @public
 */
FulfillmentOrder.prototype.hold = function hold(id, params) {
  const url = this.buildUrl(`${id}/hold`);
  return this.shopify
    .request(url, 'POST', undefined, { fulfillment_hold: params })
    .then((body) => body[this.key]);
};

/**
 * Release the fulfillment hold on a fulfillment order and changes the status of
 * the fulfillment order to `OPEN` or `SCHEDULED`.
 *
 * @param {Number} id Fulfillment Order ID
 * @return {Promise} Promise that resolves with the result
 * @public
 */
FulfillmentOrder.prototype.releaseHold = function releaseHold(id) {
  const url = this.buildUrl(`${id}/release_hold`);
  return this.shopify
    .request(url, 'POST', undefined, {})
    .then((body) => body[this.key]);
};

/**
 * Reschedules a scheduled fulfillment order. Updates the value of the
 * `fulfill_at field` on a scheduled fulfillment order. The fulfillment order
 * will be marked as ready for fulfillment at this date and time.
 *
 * @param {Number} id Fulfillment Order ID
 * @param {String} deadline The new fulfillment deadline of the fulfillment
 *     order
 * @return {Promise} Promise that resolves with the result
 * @public
 */
FulfillmentOrder.prototype.reschedule = function reschedule(id, deadline) {
  const url = this.buildUrl(`${id}/reschedule`);
  return this.shopify.request(url, 'POST', this.key, {
    new_fulfill_at: deadline
  });
};

module.exports = FulfillmentOrder;