Action: Add Line Item to Order

Shopify Operation

The Add Line Item to Order action adds a new product or service (line item) to an existing order.

Example User Story

I want to add a free gift to a customer's order after they've already checked out, so I can surprise and delight them.

Fields

Field Name	Field Type	Required
orderId	String	Yes
variantId	String	Yes
quantity	Integer	Yes
customAttributes	Map	No

Related Connections

Shopify

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "add-line-item-to-order",
  "state": "inDev",
  "meta": {
    "short": "Add Line Item to Order",
    "description": "Adds a line item to an existing Shopify order."
  },
  "input": [
    {
      "name": "orderId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the order to which the line item will be added."
      }
    },
    {
      "name": "variantId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the product variant to add to the order."
      }
    },
    {
      "name": "quantity",
      "type": "Integer",
      "required": true,
      "meta": {
        "description": "The quantity of the product variant to add."
      }
    },
    {
      "name": "customAttributes",
      "type": "Map",
      "required": false,
      "meta": {
        "description": "Custom attributes for the line item."
      }
    }
  ],
  "output": [
    {
      "name": "lineItem",
      "type": "Map",
      "selector": ["line_item"],
      "meta": {
        "description": "The added line item details."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/admin/api/2023-10/orders/{{orderId}}/line_items.json",
        "headers": {
          "Content-Type": "application/json",
          "X-Shopify-Access-Token": "{{accessToken}}"
        },
        "bodyTemplate": {
          "value": "{\"line_item\": {\"variant_id\": {{variantId}}, \"quantity\": {{quantity}}, \"custom_attributes\": {{customAttributes}}}}",
          "placeholders": [
            {
              "name": "variantId",
              "type": "String",
              "description": "The ID of the product variant.",
              "required": true
            },
            {
              "name": "quantity",
              "type": "Integer",
              "description": "The quantity of the product variant.",
              "required": true
            },
            {
              "name": "customAttributes",
              "type": "Map",
              "description": "Custom attributes for the line item.",
              "required": false
            }
          ]
        }
      }
    }
  ]
}