inventora-shopify-admin-api/services/draft_orders.ts

Shopify Admin API is a NodeJS library built to help developers easily authenticate and make calls against the Shopify API. It was inspired by and borrows heavily from ShopifySharp.

import * as Options from "../options";
import { BaseService } from "../infrastructure";
import { DraftOrder } from "../interfaces";

/**
 * A service for manipulating Shopify draft orders.
 */
export class DraftOrders extends BaseService {
    constructor(shopDomain: string, accessToken: string) {
        super(shopDomain, accessToken, "draft_orders");
    }

    /**
     * Creates a new draft order.
     */
    public create(order: Partial<DraftOrder>, useCustomerDefaultAddress: boolean = false) {
        const body = {
            ...order,
            use_customer_default_address: useCustomerDefaultAddress
        };

        return this.createRequest<DraftOrder>("POST", ".json", "draft_order", { draft_order: body });
    }

    /**
     * Updates the draft order with the given id.
     */
    public update(id: number, order: Partial<DraftOrder>) {
        return this.createRequest<DraftOrder>("PUT", `${id}.json`, "draft_order", { draft_order: order });
    }

    /**
     * Gets a list of up to 250 of the shop's draft orders.
     * @param options Options for filtering the results.
     */
    public list(options?: Options.ListOptions) {
        return this.createRequest<DraftOrder[]>("GET", ".json", "draft_orders", options);
    }

    /**
     * Counts the draft orders on the shop.
     */
    public count(options?: any) {
        return this.createRequest<number>("GET", "count.json", "count");
    }

    /**
     * Retrieves the draft order with the given id.
     */
    public get(id: number) {
        return this.createRequest<DraftOrder>("GET", `${id}.json`, "draft_order");
    }

    /**
     * Deletes the draft order with the given id.
     */
    public delete(id: number) {
        return this.createRequest<void>("DELETE", `${id}.json`);
    }

    /**
     * Completes the draft order, transitioning it to a full order.
     */
    public complete(id: number, paymentPending: boolean = false) {
        return this.createRequest<DraftOrder>(
            "POST",
            `${id}/complete.json?paymentPending=${paymentPending}`,
            "draft_order"
        );
    }

    // TODO: Implement DraftOrders.sendInvoice
}

export default DraftOrders;