Shopify

Manage your Shopify products, customers, and orders.

Create Shopify customer

Create a new customer record in Shopify.

Parameters

Parameter	Type	Required	Description
`email`	string	Yes	Customer email address
`first_name`	string	No	Customer first name
`last_name`	string	No	Customer last name
`phone`	string	No	Customer phone number

Response

{
  "email": "customer@example.com",
  "id": "987654321"
}

Create Shopify order

Create a new order in Shopify (for testing or custom use cases).

Parameters

Parameter	Type	Required	Description
`line_items`	array	Yes	The products and quantities to include in the order.
`customer_id`	string	No	The ID of the customer for this order. For example, 123456789.
`financial_status`	string	No	Payment status: paid, pending, or authorized.

Response

{
  "financial_status": "paid",
  "id": "555666777",
  "name": "#1001",
  "total_price": "49.99"
}

Create Shopify product

Create a new product in Shopify with basic details.

Parameters

Parameter	Type	Required	Description
`title`	string	Yes	The product's name.
`body_html`	string	No	The product description. Basic HTML formatting is allowed.
`vendor`	string	No	The product's vendor or manufacturer.
`product_type`	string	No	The product category or type.
`tags`	string	No	Tags to organize the product, separated by commas.
`price`	number	No	The product's price.
`inventory_quantity`	number	No	The starting number of items in stock.

Response

{
  "id": "987654321",
  "status": "active",
  "title": "New Sample Product"
}

Fulfill Shopify order

Mark an order as fulfilled in Shopify.

Parameters

Parameter	Type	Required	Description
`order_id`	string	Yes	The ID of the order to fulfill. For example, 123456789.
`tracking_number`	string	No	Tracking number for shipment
`tracking_company`	string	No	The shipping carrier's name.
`notify_customer`	boolean	No	Set to true to email the customer when the order ships.

Response

{
  "id": "fulfillment_123",
  "status": "success"
}

Get Shopify product by ID

Retrieve details about a specific Shopify product using its ID.

Parameters

Parameter	Type	Required	Description
`product_id`	string	Yes	The ID of the Shopify product. For example, 123456789.

Response

{
  "body_html": "<p>Sample product description</p>",
  "id": "123456789",
  "title": "Sample Product",
  "variants": [
    {
      "inventory_quantity": 42,
      "price": "19.99",
      "sku": "SAMPLE-SKU"
    }
  ]
}

List Shopify products

List products from your Shopify store with an optional limit.

Parameters

Parameter	Type	Required	Description
`limit`	number	No	Maximum number of products to return.

Response

{
  "results": [
    {
      "id": "123456789",
      "inventory_quantity": 42,
      "title": "Sample Product",
      "variants": [
        {
          "inventory_quantity": 42,
          "price": "19.99",
          "sku": "SAMPLE-SKU"
        }
      ]
    }
  ]
}

Update Shopify product

Update an existing Shopify product's details.

Parameters

Parameter	Type	Required	Description
`product_id`	string	Yes	The ID of the Shopify product to update. For example, 123456789.
`title`	string	No	The new product name.
`body_html`	string	No	The new product description. Basic HTML formatting is allowed.
`vendor`	string	No	The new vendor or manufacturer.
`product_type`	string	No	The new product category or type.
`tags`	string	No	The new product tags, separated by commas.
`price`	number	No	The new product price.
`inventory_quantity`	number	No	The new number of items in stock.

Response

{
  "id": "123456789",
  "title": "Updated Product Title"
}

Shopify

On this page