Create Draft Listing Product with Etsy API

Pipedream makes it easy to connect APIs for Etsy and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Draft Listing Product with the Etsy API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Draft Listing Product with the Etsy API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Draft Listing Product action
1. Connect your Etsy account
2. Configure Quantity
3. Configure Title
4. Configure Description
5. Configure Price
6. Select a Who Made
7. Select a When Made
8. Select a Taxonomy Type
9. Select a Taxonomy ID
10. Configure Is Supply
11. Select a Listing Type
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Draft Listing Product with Etsy API on New Record from Adalo API

Adalo + Etsy

Try it

Create Draft Listing Product with Etsy API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Etsy

Try it

Create Draft Listing Product with Etsy API on New Submission from Typeform API

Typeform + Etsy

Try it

Create Draft Listing Product with Etsy API on Custom Events from Zoom API

Zoom + Etsy

Try it

Create Draft Listing Product with Etsy API on New Submission (Instant) from Jotform API

Jotform + Etsy

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Draft Listing Product on Etsy

Description:Creates a physical draft listing product in a shop on the Etsy channel. [See the Documentation](https://developers.etsy.com/documentation/reference#operation/createDraftListing)

Version:0.0.3

Key:etsy-create-draft-listing-product

View on GitHub

Code#

import constants from "../../common/constants.mjs";
import app from "../../etsy.app.mjs";

export default {
  key: "etsy-create-draft-listing-product",
  name: "Create Draft Listing Product",
  description: "Creates a physical draft listing product in a shop on the Etsy channel. [See the Documentation](https://developers.etsy.com/documentation/reference#operation/createDraftListing)",
  type: "action",
  version: "0.0.3",
  props: {
    app,
    quantity: {
      type: "integer",
      label: "Quantity",
      description: "The positive non-zero number of products available for purchase in the listing. Note: The listing quantity is the sum of available offering quantities.",
      default: 1,
    },
    title: {
      type: "string",
      label: "Title",
      description: "The listing's title string. When creating or updating a listing, valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, `™`, `©`, and `®`. (regex: `/[^\\p{L}\\p{Nd}\\p{P}\\p{Sm}\\p{Zs}™©®]/u`) You can only use the `%`, `:`, `&` and `+` characters once each.",
    },
    description: {
      type: "string",
      label: "Description",
      description: "A description string of the product for sale in the listing.",
    },
    price: {
      type: "string",
      label: "Price",
      description: "The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price.",
    },
    whoMade: {
      type: "string",
      label: "Who Made",
      description: "An enumerated string indicating who made the product. Helps buyers locate the listing under the Handmade heading. Requires **Is Supply** and **Who Made** properties.",
      options: constants.WHO_MADE_OPTIONS,
    },
    whenMade: {
      type: "string",
      label: "When Made",
      description: "An enumerated string for the era in which the maker made the product in this listing. Helps buyers locate the listing under the Vintage heading. Requires **Is Supply** and **Who Made** properties.",
      options: constants.WHEN_MADE_OPTIONS,
    },
    taxonomyType: {
      propDefinition: [
        app,
        "taxonomyType",
      ],
    },
    taxonomyId: {
      propDefinition: [
        app,
        "taxonomyId",
        ({ taxonomyType }) => ({
          taxonomyType,
        }),
      ],
    },
    isSupply: {
      type: "boolean",
      label: "Is Supply",
      description: "When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires **Who Made** and **When Made**.",
    },
    listingType: {
      reloadProps: true,
      propDefinition: [
        app,
        "listingType",
      ],
    },
  },
  async additionalProps() {
    const hasPhysicalType = [
      constants.LISTING_TYPE.PHYSICAL,
      constants.LISTING_TYPE.BOTH,
    ].includes(this.listingType);

    if (!hasPhysicalType) {
      return {};
    }

    const { shop_id: shopId } = await this.app.getMe();
    const { results } = await this.app.getShopShippingProfiles({
      shopId,
    });

    return {
      shippingProfileId: {
        type: "string",
        label: "Shipping Profile",
        description: "The numeric ID of the shipping profile associated with the listing. Required when listing type is `physical`.",
        options: results?.map(({
          shipping_profile_id: value,
          title: label,
        }) => ({
          value,
          label,
        })),
      },
    };
  },
  methods: {
    createDraftListing({
      shopId, ... args
    } = {}) {
      return this.app.post({
        path: `/application/shops/${shopId}/listings`,
        ... args,
      });
    },
  },
  async run({ $: step }) {
    const {
      quantity,
      title,
      description,
      price,
      whoMade,
      whenMade,
      taxonomyId,
      isSupply,
      listingType,
      shippingProfileId,
    } = this;

    const { shop_id: shopId } = await this.app.getMe();

    const response = await this.createDraftListing({
      step,
      shopId,
      data: {
        quantity,
        title,
        description,
        price,
        who_made: whoMade,
        when_made: whenMade,
        taxonomy_id: taxonomyId,
        is_supply: isSupply,
        type: listingType,
        shipping_profile_id: shippingProfileId,
      },
    });

    step.export("$summary", `Successfully created draft listing product with ID ${response.listing_id}.`);

    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Etsy	`app`	`app`	This component uses the Etsy app.
Quantity	`quantity`	`integer`	The positive non-zero number of products available for purchase in the listing. Note: The listing quantity is the sum of available offering quantities.
Title	`title`	`string`	The listing's title string. When creating or updating a listing, valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, `™`, `©`, and `®`. (regex: `/[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u`) You can only use the `%`, `:`, `&` and `+` characters once each.
Description	`description`	`string`	A description string of the product for sale in the listing.
Price	`price`	`string`	The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price.
Who Made	`whoMade`	`string`	Select a value from the drop down menu:`{ "label": "I Did", "value": "i_did" }{ "label": "Collective", "value": "collective" }{ "label": "Someone Else", "value": "someone_else" }`
When Made	`whenMade`	`string`	Select a value from the drop down menu:`{ "label": "Made to Order", "value": "made_to_order" }{ "label": "2020 - 2023", "value": "2020_2023" }{ "label": "2010 - 2019", "value": "2010_2019" }{ "label": "2004 - 2009", "value": "2004_2009" }{ "label": "Before 2004", "value": "before_2004" }{ "label": "2000 - 2003", "value": "2000_2003" }{ "label": "1990s", "value": "1990s" }1980s1970s1960s1950s1940s1930s1920s1910s1900s1800s1700s{ "label": "Before 1700", "value": "before_1700" }`
Taxonomy Type	`taxonomyType`	`string`	Select a value from the drop down menu:`sellerbuyer`
Taxonomy ID	`taxonomyId`	`string`	Select a value from the drop down menu.
Is Supply	`isSupply`	`boolean`	When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires Who Made and When Made.
Listing Type	`listingType`	`string`	Select a value from the drop down menu:`physicaldownloadboth`

Authentication#

Etsy uses OAuth authentication. When you connect your Etsy account, Pipedream will open a popup window where you can sign into Etsy and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Etsy API.

Pipedream requests the following authorization scopes when you connect your account:

profile_rprofile_wfeedback_rtransactions_rtransactions_wshops_rshops_wemail_rlistings_dlistings_wlistings_r

About Etsy#

Shop for handmade, vintage, custom, and unique gifts

More Ways to Use Etsy#

Triggers#

Listing Updated from the Etsy API

Emit new event when a listing is updated. See the Documentation

Try it

New Shop Receipt from the Etsy API

Emit new event when a new shop receipt is created. See the Documentation

Try it

New Transaction from the Etsy API

Emit new event when a new transaction is created. See the Documentation

Try it

Actions#

Delete Listing with the Etsy API

Open API V3 endpoint to delete a ShopListing. A ShopListing can be deleted only if the state is one of the following: SOLD_OUT, DRAFT, EXPIRED, INACTIVE, ACTIVE and is_available or ACTIVE and has seller flags: SUPRESSED (frozen), VACATION, CUSTOM_SHOPS (pattern), SELL_ON_FACEBOOK. See the Documentation

Try it

Get Listing with the Etsy API

Retrieves a listing record by listing ID. See the Documentation

Try it

Get Listing Inventory with the Etsy API

Retrieves the inventory record for a listing by listing ID. See the Documentation

Try it

Update Listing Inventory with the Etsy API

Updates the inventory for a listing identified by a listing ID. See the Documentation

Try it

Update Listing Property with the Etsy API

Updates or populates the properties list defining product offerings for a listing. Each offering requires both a value and a value_id that are valid for a scale_id assigned to the listing or that you assign to the listing with this request. See the Documentation

Try it