Create Return Order with Returnless API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Return Order with the Returnless 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 Return Order with the Returnless API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Return Order action
1. Connect your Returnless account
2. Select a Form ID
3. Select a Locale
4. Configure Input
5. Select a Order ID
6. Configure Customer House Number
7. Configure Customer Street
8. Configure Customer Postal Code
9. Configure Customer City
10. Select a Country ID
11. Select one or more Item IDs
12. Optional- Configure Metadata
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 Return Order with Returnless API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Returnless

Try it

Create Return Order with Returnless API on New Submission from Typeform API

Typeform + Returnless

Try it

Create Return Order with Returnless API on New Submission (Instant) from Jotform API

Jotform + Returnless

Try it

Create Return Order with Returnless API on New Scheduled Tasks from Pipedream API

Pipedream + Returnless

Try it

Create Return Order with Returnless API on New Download Counts from npm API

npm + Returnless

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 Return Order on Returnless

Description:Create a return order. [See the documentation](https://docs.returnless.com/docs/api-rest-reference/1fce50b07484b-creates-a-return-order-from-a-return-order-intent)

Version:0.0.1

Key:returnless-create-return-order

View on GitHub

Code#

import returnless from "../../returnless.app.mjs";
import { parseObject } from "../../common/utils.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "returnless-create-return-order",
  name: "Create Return Order",
  description: "Create a return order. [See the documentation](https://docs.returnless.com/docs/api-rest-reference/1fce50b07484b-creates-a-return-order-from-a-return-order-intent)",
  version: "0.0.1",
  type: "action",
  props: {
    returnless,
    formId: {
      propDefinition: [
        returnless,
        "formId",
      ],
    },
    locale: {
      propDefinition: [
        returnless,
        "locale",
        (c) => ({
          formId: c.formId,
        }),
      ],
    },
    input: {
      type: "string",
      label: "Input",
      description: "The input for the order. This could be an email address or postalcode or something else.",
    },
    orderId: {
      propDefinition: [
        returnless,
        "orderId",
      ],
    },
    customerHouseNumber: {
      type: "string",
      label: "Customer House Number",
      description: "The house number of the customer",
    },
    customerStreet: {
      type: "string",
      label: "Customer Street",
      description: "The street of the customer",
    },
    customerPostalCode: {
      type: "string",
      label: "Customer Postal Code",
      description: "The postal code of the customer",
    },
    customerCity: {
      type: "string",
      label: "Customer City",
      description: "The city of the customer",
    },
    customerCountryId: {
      propDefinition: [
        returnless,
        "countryId",
      ],
    },
    itemIds: {
      propDefinition: [
        returnless,
        "itemIds",
        (c) => ({
          orderId: c.orderId,
        }),
      ],
      reloadProps: true,
    },
    metadata: {
      type: "object",
      label: "Metadata",
      description: "Metadata key/value pairs to add to the return order",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.itemIds) {
      return props;
    }
    const { data: items } = await this.returnless.listSalesOrderItems({
      orderId: this.orderId,
    });
    for (const item of items) {
      props[`item${item.id}Quantity`] = {
        type: "integer",
        label: `Item ${item.id} Quantity`,
        description: `The quantity of item ${item.id} to return`,
      };
      props[`item${item.id}ReturnReasonId`] = {
        type: "string",
        label: `Item ${item.id} Return Reason ID`,
        description: `The return reason for item ${item.id}`,
        options: async () => {
          const { data: returnReasons } = await this.returnless.listReturnReasons();
          return returnReasons.map(({
            id, label,
          }) => ({
            value: id,
            label,
          }));
        },
      };
    }
    return props;
  },
  async run({ $ }) {
    const { data: order } = await this.returnless.getOrder({
      $,
      orderId: this.orderId,
    });

    const { data: intent } = await this.returnless.createReturnOrderIntent({
      $,
      data: {
        form_id: this.formId,
        locale: this.locale,
        input: this.input,
        order_number: order.order_number,
      },
    });
    if (intent.status === "failed") {
      throw new ConfigurationError(intent.status_message);
    }

    const { data: returnOrder } = await this.returnless.createReturnOrder({
      $,
      data: {
        return_order_intent_id: intent.id,
        customer: {
          house_number: this.customerHouseNumber,
          street: this.customerStreet,
          postcode: this.customerPostalCode,
          city: this.customerCity,
          country_id: this.customerCountryId,
        },
        items: this.itemIds.map((itemId) => ({
          id: itemId,
          quantity: this[`item${itemId}Quantity`],
          return_reason_id: this[`item${itemId}ReturnReasonId`],
        })),
        metadata: parseObject(this.metadata),
      },
    });

    $.export("$summary", `Return order created: ${returnOrder.id}`);
    return returnOrder;
  },
};

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
Returnless	`returnless`	`app`	This component uses the Returnless app.
Form ID	`formId`	`string`	Select a value from the drop down menu.
Locale	`locale`	`string`	Select a value from the drop down menu.
Input	`input`	`string`	The input for the order. This could be an email address or postalcode or something else.
Order ID	`orderId`	`string`	Select a value from the drop down menu.
Customer House Number	`customerHouseNumber`	`string`	The house number of the customer
Customer Street	`customerStreet`	`string`	The street of the customer
Customer Postal Code	`customerPostalCode`	`string`	The postal code of the customer
Customer City	`customerCity`	`string`	The city of the customer
Country ID	`customerCountryId`	`string`	Select a value from the drop down menu.
Item IDs	`itemIds`	`string[]`	Select a value from the drop down menu.
Metadata	`metadata`	`object`	Metadata key/value pairs to add to the return order