complete-draft-order

Instructions

Implementation Reference

• src/index.ts:484-509 (registration)

  Registration of the MCP 'complete-draft-order' tool, including Zod input schema and inline handler that calls ShopifyClient.completeDraftOrder

  server.tool(
    "complete-draft-order",
    "Complete a draft order",
    {
      draftOrderId: z.string().describe("ID of the draft order to complete"),
      variantId: z.string().describe("ID of the variant in the draft order"),
    },
    async ({ draftOrderId, variantId }) => {
      const client = new ShopifyClient();
      try {
        const completedOrder = await client.completeDraftOrder(
          SHOPIFY_ACCESS_TOKEN,
          MYSHOPIFY_DOMAIN,
          draftOrderId,
          variantId
        );
        return {
          content: [
            { type: "text", text: JSON.stringify(completedOrder, null, 2) },
          ],
        };
      } catch (error) {
        return handleError("Failed to complete draft order", error);
      }
    }
  );

• src/ShopifyClient/ShopifyClient.ts:1293-1386 (handler)

  Core implementation of completeDraftOrder in ShopifyClient: validates variant, executes GraphQL mutation to complete draft order, returns order ID

  async completeDraftOrder(
    accessToken: string,
    shop: string,
    draftOrderId: string,
    variantId: string
  ): Promise<CompleteDraftOrderResponse> {
    // First, load the variant to check if it's available for sale
    const variantResult = await this.loadVariantsByIds(accessToken, shop, [
      variantId,
    ]);
  
    if (!variantResult.variants || variantResult.variants.length === 0) {
      throw new ShopifyProductVariantNotFoundError({
        contextData: {
          shop,
          variantId,
        },
      });
    }
  
    const variant = variantResult.variants[0];
  
    if (!variant.availableForSale) {
      throw new ShopifyProductVariantNotAvailableForSaleError({
        contextData: {
          shop,
          variantId,
        },
      });
    }
  
    const myshopifyDomain = await this.getMyShopifyDomain(accessToken, shop);
  
    const graphqlQuery = gql`
      mutation draftOrderComplete($id: ID!) {
        draftOrderComplete(id: $id) {
          draftOrder {
            id
            name
            order {
              id
            }
          }
          userErrors {
            field
            message
          }
        }
      }
    `;
  
    const res = await this.shopifyGraphqlRequest<{
      data: {
        draftOrderComplete: {
          draftOrder: {
            id: string;
            name: string;
            order: {
              id: string;
            };
          };
          userErrors: Array<{
            field: string[];
            message: string;
          }>;
        };
      };
    }>({
      url: `https://${myshopifyDomain}/admin/api/${this.SHOPIFY_API_VERSION}/graphql.json`,
      accessToken,
      query: graphqlQuery,
      variables: {
        id: draftOrderId,
      },
    });
  
    const draftOrder = res.data.data.draftOrderComplete.draftOrder;
    const order = draftOrder.order;
    const userErrors = res.data.data.draftOrderComplete.userErrors;
  
    if (userErrors && userErrors.length > 0) {
      throw getGraphqlShopifyUserError(userErrors, {
        shop,
        draftOrderId,
        variantId,
      });
    }
  
    return {
      draftOrderId: draftOrder.id,
      orderId: order.id,
      draftOrderName: draftOrder.name,
    };
  }

• src/ShopifyClient/ShopifyClientPort.ts:562-566 (schema)

  TypeScript type definition for the response of completeDraftOrder

  export type CompleteDraftOrderResponse = {
    draftOrderId: string;
    draftOrderName: string;
    orderId: string;
  };

• src/ShopifyClient/ShopifyClientPort.ts:1081-1086 (helper)

  Interface definition in ShopifyClientPort for the completeDraftOrder method

  completeDraftOrder(
    accessToken: string,
    shop: string,
    draftOrderId: string,
    variantId: string
  ): Promise<CompleteDraftOrderResponse>;