Add Shipment To Order with Billbee API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Add Shipment To Order action
1. Connect your Billbee account
2. Select a Order ID
3. Optional- Select a Shipping Provider ID
4. Optional- Select a Shipping Provider Product ID
5. Optional- Select a Shipping ID
6. Optional- Select a Carrier ID
7. Optional- Select a Shipment Type
8. Optional- Configure Comment
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#

Add Shipment To Order with Billbee API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Billbee

Try it

Add Shipment To Order with Billbee API on New Submission from Typeform API

Typeform + Billbee

Try it

Add Shipment To Order with Billbee API on New Submission (Instant) from Jotform API

Jotform + Billbee

Try it

Add Shipment To Order with Billbee API on New Scheduled Tasks from Pipedream API

Pipedream + Billbee

Try it

Add Shipment To Order with Billbee API on New Download Counts from npm API

npm + Billbee

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.

Add Shipment To Order on Billbee

Description:Add a shipment to an existing order. [See the documentation](https://app.billbee.io//swagger/ui/index#/Orders/OrderApi_AddShipment)

Version:0.0.1

Key:billbee-add-shipment-to-order

View on GitHub

Code#

import app from "../../billbee.app.mjs";

export default {
  key: "billbee-add-shipment-to-order",
  name: "Add Shipment To Order",
  description: "Add a shipment to an existing order. [See the documentation](https://app.billbee.io//swagger/ui/index#/Orders/OrderApi_AddShipment)",
  type: "action",
  version: "0.0.1",
  props: {
    app,
    orderId: {
      propDefinition: [
        app,
        "orderId",
      ],
    },
    shippingProviderId: {
      propDefinition: [
        app,
        "shippingProviderId",
      ],
    },
    shippingProviderProductId: {
      label: "Shipping Provider Product ID",
      description: "The ID of the shipping provider product/service",
      propDefinition: [
        app,
        "shipment",
        ({
          orderId, shippingProviderId,
        }) => ({
          orderId,
          shippingProviderId,
          mapper: ({ ShippingProviderProductId: value }) => value,
        }),
      ],
    },
    shippingId: {
      label: "Shipping ID",
      description: "The ID of the shipment",
      propDefinition: [
        app,
        "shipment",
        ({
          orderId, shippingProviderId,
        }) => ({
          orderId,
          shippingProviderId,
          mapper: ({ ShippingId: value }) => value,
        }),
      ],
    },
    carrierId: {
      propDefinition: [
        app,
        "carrierId",
      ],
    },
    shipmentType: {
      propDefinition: [
        app,
        "shipmentType",
      ],
    },
    comment: {
      type: "string",
      label: "Comment",
      description: "Additional comment for the shipment",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      app,
      orderId,
      shippingProviderId,
      shippingProviderProductId,
      comment,
      shippingId,
      carrierId,
      shipmentType,
    } = this;

    await app.addShipmentToOrder({
      $,
      orderId,
      data: {
        ShippingProviderId: shippingProviderId,
        ShippingProviderProductId: shippingProviderProductId,
        Comment: comment,
        ShippingId: shippingId,
        CarrierId: carrierId,
        ShipmentType: shipmentType,
      },
    });

    $.export("$summary", `Successfully added shipment to order \`${orderId}\``);

    return {
      success: true,
    };
  },
};

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
Billbee	`app`	`app`	This component uses the Billbee app.
Order ID	`orderId`	`string`	Select a value from the drop down menu.
Shipping Provider ID	`shippingProviderId`	`string`	Select a value from the drop down menu.
Shipping Provider Product ID	`shippingProviderProductId`	`string`	Select a value from the drop down menu.
Shipping ID	`shippingId`	`string`	Select a value from the drop down menu.
Carrier ID	`carrierId`	`string`	Select a value from the drop down menu.
Shipment Type	`shipmentType`	`string`	Select a value from the drop down menu.
Comment	`comment`	`string`	Additional comment for the shipment