Etsy Integration — ModuleX AI

Field	Description	Required	Format
Client ID	Etsy OAuth App Client ID (API Key)	Yes	`xxxxxxxxxxxxxxxxxxxxxxxx`
Client Secret	Etsy OAuth App Client Secret	Yes	`xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

create_draft_listing_product — Creates a physical draft listing product in a shop on Etsy

Parameters

integer

required

The positive non-zero number of products available for purchase

string

required

The listing’s title string

string

required

A description of the product for sale in the listing

string

required

The positive non-zero price of the product as a decimal string (e.g. ‘29.99’)

string

required

Who made the product: i_did, collective, someone_else

string

required

Era when product was made: made_to_order, 2020_2023, 2010_2019, 2004_2009, before_2004, 2000_2003, 1990s, 1980s, 1970s, 1960s, 1950s, 1940s, 1930s, 1920s, 1910s, 1900s, 1800s, 1700s, before_1700

string

required

The numerical taxonomy ID of the listing

boolean

required

When true, tags the listing as a supply product; otherwise a finished product

string

required

Listing type: physical, download, both

string

The numeric ID of the shipping profile. Required when listing type is physical.

Response

{
  "$defs": {
    "ListingResource": {
      "additionalProperties": false,
      "properties": {
        "listing_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Listing Id"
        },
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "state": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "State"
        },
        "url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url"
        },
        "quantity": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Quantity"
        },
        "price": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Price"
        },
        "who_made": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Who Made"
        },
        "when_made": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "When Made"
        },
        "taxonomy_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Taxonomy Id"
        },
        "is_supply": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Is Supply"
        },
        "listing_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Listing Type"
        },
        "views": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Views"
        },
        "num_favorers": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Num Favorers"
        },
        "shipping_profile_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Shipping Profile Id"
        }
      },
      "title": "ListingResource",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "listing": {
      "anyOf": [
        {
          "$ref": "#/$defs/ListingResource"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateDraftListingProductOutput",
  "type": "object"
}

delete_listing — Delete an Etsy listing by listing ID

Parameters

string

required

The ID of the listing to delete

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "listing_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Listing Id"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteListingOutput",
  "type": "object"
}

get_listing — Retrieve an Etsy listing record by listing ID

Parameters

string

required

The ID of the listing to retrieve

Response

{
  "$defs": {
    "ListingResource": {
      "additionalProperties": false,
      "properties": {
        "listing_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Listing Id"
        },
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "state": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "State"
        },
        "url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url"
        },
        "quantity": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Quantity"
        },
        "price": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Price"
        },
        "who_made": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Who Made"
        },
        "when_made": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "When Made"
        },
        "taxonomy_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Taxonomy Id"
        },
        "is_supply": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Is Supply"
        },
        "listing_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Listing Type"
        },
        "views": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Views"
        },
        "num_favorers": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Num Favorers"
        },
        "shipping_profile_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Shipping Profile Id"
        }
      },
      "title": "ListingResource",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "listing": {
      "anyOf": [
        {
          "$ref": "#/$defs/ListingResource"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GetListingOutput",
  "type": "object"
}

get_listing_inventory — Retrieve the inventory record for a listing by listing ID

Parameters

string

required

The ID of the listing whose inventory to retrieve

Response

{
  "$defs": {
    "InventoryProduct": {
      "additionalProperties": false,
      "properties": {
        "product_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Product Id"
        },
        "sku": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Sku"
        },
        "property_values": {
          "items": {
            "$ref": "#/$defs/PropertyValue"
          },
          "title": "Property Values",
          "type": "array"
        },
        "offerings": {
          "items": {
            "$ref": "#/$defs/Offering"
          },
          "title": "Offerings",
          "type": "array"
        }
      },
      "title": "InventoryProduct",
      "type": "object"
    },
    "Offering": {
      "additionalProperties": false,
      "properties": {
        "offering_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Offering Id"
        },
        "price": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Price"
        },
        "quantity": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Quantity"
        },
        "is_enabled": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Is Enabled"
        }
      },
      "title": "Offering",
      "type": "object"
    },
    "PropertyValue": {
      "additionalProperties": false,
      "properties": {
        "property_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Property Id"
        },
        "property_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Property Name"
        },
        "value_ids": {
          "items": {
            "type": "integer"
          },
          "title": "Value Ids",
          "type": "array"
        },
        "values": {
          "items": {
            "type": "string"
          },
          "title": "Values",
          "type": "array"
        }
      },
      "title": "PropertyValue",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "products": {
      "items": {
        "$ref": "#/$defs/InventoryProduct"
      },
      "title": "Products",
      "type": "array"
    },
    "price_on_property": {
      "items": {
        "type": "integer"
      },
      "title": "Price On Property",
      "type": "array"
    },
    "quantity_on_property": {
      "items": {
        "type": "integer"
      },
      "title": "Quantity On Property",
      "type": "array"
    },
    "sku_on_property": {
      "items": {
        "type": "integer"
      },
      "title": "Sku On Property",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetListingInventoryOutput",
  "type": "object"
}

update_listing_inventory — Update the inventory for a listing identified by listing ID

Parameters

string

required

The ID of the listing whose inventory to update

array

JSON array of product objects containing sku, property_values, and offerings

array

List of listing property ID integers for properties that change product prices

array

List of listing property ID integers for properties that change product quantity

array

List of listing property ID integers for properties that change the product SKU

Response

{
  "$defs": {
    "InventoryProduct": {
      "additionalProperties": false,
      "properties": {
        "product_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Product Id"
        },
        "sku": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Sku"
        },
        "property_values": {
          "items": {
            "$ref": "#/$defs/PropertyValue"
          },
          "title": "Property Values",
          "type": "array"
        },
        "offerings": {
          "items": {
            "$ref": "#/$defs/Offering"
          },
          "title": "Offerings",
          "type": "array"
        }
      },
      "title": "InventoryProduct",
      "type": "object"
    },
    "Offering": {
      "additionalProperties": false,
      "properties": {
        "offering_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Offering Id"
        },
        "price": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Price"
        },
        "quantity": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Quantity"
        },
        "is_enabled": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Is Enabled"
        }
      },
      "title": "Offering",
      "type": "object"
    },
    "PropertyValue": {
      "additionalProperties": false,
      "properties": {
        "property_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Property Id"
        },
        "property_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Property Name"
        },
        "value_ids": {
          "items": {
            "type": "integer"
          },
          "title": "Value Ids",
          "type": "array"
        },
        "values": {
          "items": {
            "type": "string"
          },
          "title": "Values",
          "type": "array"
        }
      },
      "title": "PropertyValue",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "products": {
      "items": {
        "$ref": "#/$defs/InventoryProduct"
      },
      "title": "Products",
      "type": "array"
    },
    "price_on_property": {
      "items": {
        "type": "integer"
      },
      "title": "Price On Property",
      "type": "array"
    },
    "quantity_on_property": {
      "items": {
        "type": "integer"
      },
      "title": "Quantity On Property",
      "type": "array"
    },
    "sku_on_property": {
      "items": {
        "type": "integer"
      },
      "title": "Sku On Property",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateListingInventoryOutput",
  "type": "object"
}

update_listing_property — Update or populate the properties list defining product offerings for a listing

Parameters

string

required

The ID of the listing

string

required

The ID of the property to update

array

required

Array of integer value IDs for the property

array

required

Array of string value labels for the property (e.g. ‘Black’, ‘Christmas’)

Response

{
  "$defs": {
    "ListingProperty": {
      "additionalProperties": false,
      "properties": {
        "property_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Property Id"
        },
        "property_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Property Name"
        },
        "scale_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Scale Id"
        },
        "value_ids": {
          "items": {
            "type": "integer"
          },
          "title": "Value Ids",
          "type": "array"
        },
        "values": {
          "items": {
            "type": "string"
          },
          "title": "Values",
          "type": "array"
        }
      },
      "title": "ListingProperty",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "listing_property": {
      "anyOf": [
        {
          "$ref": "#/$defs/ListingProperty"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateListingPropertyOutput",
  "type": "object"
}

Using

Providers

Building

Tools

Etsy Integration for AI Agents & Workflows

Overview

Authentication

OAuth2 Authentication

Required Credentials

OAuth Configuration

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Amazon Selling Partner

Google Merchant Center

Instacart

Links

​Overview

​Authentication

​OAuth2 Authentication

​Required Credentials

​OAuth Configuration

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Amazon Selling Partner

Google Merchant Center

Instacart

​Links

Overview

Authentication

OAuth2 Authentication

Required Credentials

OAuth Configuration

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links