Create Return with Sendcloud API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Return with the Sendcloud 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

Chase Roberts
@chsrbrts
@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨
@heyellieday
Evaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley
@MBraedley
Update: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting
@mrthomascutting
Want quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts
@mattdotroberts
day 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭
@auchenberg
Yahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑
@raymondcamden
Awesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero
@nachocaballero
I couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow
@jyksnw
Developed a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana
@steven_terrana
@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD
@DotDotJames
Want to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin
@Atinux
GitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul
@raul_predescu
If you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc
@bitfalls
So @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich
@ZachLanich
Um, wow 🤯 @pipedream
Steven Bell
@bellontech
I just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸
@_jayhack_
Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴‍♂️🌳
@philsturgeon
For context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.

Getting Started#

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

Configure the Create Return action
1. Connect your Sendcloud account
2. Configure From Address
3. Configure To Address
4. Configure Ship With
5. Optional- Configure Dimensions Length
6. Optional- Configure Dimensions Width
7. Optional- Configure Dimensions Height
8. Optional- Select a Dimensions Unit
9. Configure Weight Value
10. Select a Weight Unit
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 with Sendcloud API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Sendcloud

Try it

Create Return with Sendcloud API on New Submission from Typeform API

Typeform + Sendcloud

Try it

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

Jotform + Sendcloud

Try it

Create Return with Sendcloud API on New Scheduled Tasks from Pipedream API

Pipedream + Sendcloud

Try it

Create Return with Sendcloud API on New Download Counts from npm API

npm + Sendcloud

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 on Sendcloud

Description:Create a return. [See the documentation](https://api.sendcloud.dev/docs/sendcloud-public-api/returns/operations/create-a-return)

Version:0.0.1

Key:sendcloud-create-return

View on GitHub

Code#

import app from "../../sendcloud.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "sendcloud-create-return",
  name: "Create Return",
  description: "Create a return. [See the documentation](https://api.sendcloud.dev/docs/sendcloud-public-api/returns/operations/create-a-return)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    fromAddress: {
      label: "From Address",
      propDefinition: [
        app,
        "addressSetup",
      ],
    },
    toAddress: {
      label: "To Address",
      propDefinition: [
        app,
        "addressSetup",
      ],
    },
    shipWith: {
      propDefinition: [
        app,
        "shipWith",
      ],
    },
    dimensionsLength: {
      propDefinition: [
        app,
        "dimensionsLength",
      ],
    },
    dimensionsWidth: {
      propDefinition: [
        app,
        "dimensionsWidth",
      ],
    },
    dimensionsHeight: {
      propDefinition: [
        app,
        "dimensionsHeight",
      ],
    },
    dimensionsUnit: {
      propDefinition: [
        app,
        "dimensionsUnit",
      ],
    },
    weightValue: {
      propDefinition: [
        app,
        "weightValue",
      ],
    },
    weightUnit: {
      propDefinition: [
        app,
        "weightUnit",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      fromAddress,
      toAddress,
      shipWith,
      dimensionsLength,
      dimensionsWidth,
      dimensionsHeight,
      dimensionsUnit,
      weightValue,
      weightUnit,
    } = this;

    const response = await app.createReturn({
      $,
      data: {
        from_address: utils.parseJson(fromAddress),
        to_address: utils.parseJson(toAddress),
        ship_with: utils.parseJson(shipWith),
        ...(dimensionsLength
          && dimensionsWidth
          && dimensionsHeight
          && dimensionsUnit
          ? {
            dimensions: {
              length: dimensionsLength,
              width: dimensionsWidth,
              height: dimensionsHeight,
              unit: dimensionsUnit,
            },
          }
          : undefined
        ),
        ...(weightValue && weightUnit
          ? {
            weight: {
              value: weightValue,
              unit: weightUnit,
            },
          }
          : undefined
        ),
      },
    });

    $.export("$summary", "Successfully created return");

    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
Sendcloud	`app`	`app`	This component uses the Sendcloud app.
From Address	`fromAddress`	`object`	Required fields: `name` (string): Name associated with the address. Example: `John Doe` `address_line_1` (string): First line of the address. Example: `Stadhuisplein` `postal_code` (string): Zip code. Example: `1013 AB` `city` (string): City. Example: `Eindhoven` `country_code` (string): ISO 3166-1 alpha-2 code. Example: `NL` Optional fields: `company_name` (string): Company name. Example: `Sendcloud` `house_number` (string): House number. Example: `50` `address_line_2` (string): Additional info. Example: `Apartment 17B` `po_box` (string \| null): PO box code `state_province_code` (string): ISO 3166-2 code. Example: `IT-RM` `email` (string): Email. Example: `johndoe@gmail.com` `phone_number` (string): Phone number. Example: `+319881729999` Example: `{ "name": "John Doe", "address_line_1": "Stadhuisplein", "postal_code": "1013 AB", "city": "Eindhoven", "country_code": "NL" }`
To Address	`toAddress`	`object`	Required fields: `name` (string): Name associated with the address. Example: `John Doe` `address_line_1` (string): First line of the address. Example: `Stadhuisplein` `postal_code` (string): Zip code. Example: `1013 AB` `city` (string): City. Example: `Eindhoven` `country_code` (string): ISO 3166-1 alpha-2 code. Example: `NL` Optional fields: `company_name` (string): Company name. Example: `Sendcloud` `house_number` (string): House number. Example: `50` `address_line_2` (string): Additional info. Example: `Apartment 17B` `po_box` (string \| null): PO box code `state_province_code` (string): ISO 3166-2 code. Example: `IT-RM` `email` (string): Email. Example: `johndoe@gmail.com` `phone_number` (string): Phone number. Example: `+319881729999` Example: `{ "name": "John Doe", "address_line_1": "Stadhuisplein", "postal_code": "1013 AB", "city": "Eindhoven", "country_code": "NL" }`
Ship With	`shipWith`	`object`	Shipping specifications chosen for the return. Fields: type (string): How the carrier/method is selected. One of `shipping_option_code` or `shipping_product_code` (default is `shipping_product_code`). `shipping_option_code` (string): Required if type = `shipping_option_code`. Example: `dpd:return/return` `shipping_product_code` (string): Required if type = `shipping_product_code`. Example: `dpd:return/return` `functionalities` (object): Shipping functionalities. Provide only when type = `shipping_product_code`. `contract` (integer): Contract ID to ship the return with. `dimensions` (object): `length` (number, >= 0) `width` (number, >= 0) `height` (number, >= 0) `unit` (string): One of `cm`, `mm`, `m`, `yd`, `ft`, `in` `weight` (object): `value` (number, > 0) `unit` (string): One of `kg`, `g`, `lbs`, `oz` Example: `{ "type": "shipping_option_code", "shipping_option_code": "dpd:return/return", "contract": 1234, "dimensions": { "length": 15, "width": 20.5, "height": 37, "unit": "mm" }, "weight": { "value": 14.5, "unit": "g" } }`
Dimensions Length	`dimensionsLength`	`integer`	Length in the specified unit.
Dimensions Width	`dimensionsWidth`	`integer`	Width in the specified unit.
Dimensions Height	`dimensionsHeight`	`integer`	Height in the specified unit.
Dimensions Unit	`dimensionsUnit`	`string`	Select a value from the drop down menu:`cmmmmydftin`
Weight Value	`weightValue`	`integer`	Weight value in the specified unit.
Weight Unit	`weightUnit`	`string`	Select a value from the drop down menu:`kgglbsoz`

Authentication#

Sendcloud uses API keys for authentication. When you connect your Sendcloud account, Pipedream securely stores the keys so you can easily authenticate to Sendcloud APIs in both code and no-code steps.

To retrieve your API Keys,