shopify-api-node/resources/checkout.js

Shopify API bindings for Node.js

'use strict';

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

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

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

  this.name = 'checkouts';
  this.key = 'checkout';
}

assign(Checkout.prototype, omit(base, 'delete'));

/**
 * Completes a free checkout.
 *
 * @param {String} token Checkout token
 * @return {Promise} Promise that resolves with the result
 * @public
 */
Checkout.prototype.complete = function complete(token) {
  const url = this.buildUrl(`${token}/complete`);
  return this.shopify
    .request(url, 'POST', undefined, {})
    .then((body) => body[this.key]);
};

/**
 * Gets a list of available shipping rates for the specified checkout.
 *
 * @param {String} token Checkout token
 * @return {Promise} Promise that resolves with the result
 * @public
 */
Checkout.prototype.shippingRates = function shippingRates(token) {
  const url = this.buildUrl(`${token}/shipping_rates`);
  return this.shopify.request(url, 'GET', 'shipping_rates');
};

module.exports = Checkout;