Update Order with ShipHero API on New Requests (Payload Only) from HTTP / Webhook API

Pipedream makes it easy to connect APIs for ShipHero, HTTP / Webhook and 2,400+ other apps remarkably fast.

Trigger workflow on

New Requests (Payload Only) from the HTTP / Webhook API

Next, do this

Update Order with the ShipHero 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#

This integration creates a workflow with a HTTP / Webhook trigger and ShipHero action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Requests (Payload Only) trigger
1. Connect your HTTP / Webhook account
Configure the Update Order action
1. Connect your ShipHero account
2. Select a Order ID
3. Optional- Configure Order Number
4. Optional- Configure Partner Order ID
5. Optional- Configure Fulfillment Status
6. Optional- Configure Order Date
7. Optional- Configure Total Tax
8. Optional- Configure Subtotal
9. Optional- Configure Total Discounts
10. Optional- Configure Total Price
11. Optional- Configure Custom Invoice URL
12. Optional- Configure Profile
13. Optional- Configure Packing Note
14. Optional- Configure Required Ship Date
15. Optional- Configure Tags
16. Optional- Configure Priority Flag
17. Optional- Configure Gift Note
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Requests (Payload Only) on HTTP / Webhook

Description:Get a URL and emit the HTTP body as an event on every request

Version:0.1.1

Key:http-new-requests-payload-only

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

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

// Core HTTP component
// Returns a 200 OK response, emits the HTTP payload as an event
export default {
  key: "http-new-requests-payload-only",
  name: "New Requests (Payload Only)",
  // eslint-disable-next-line
  description: "Get a URL and emit the HTTP body as an event on every request",
  version: "0.1.1",
  type: "source",
  props: {
    // eslint-disable-next-line
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    http,
  },
  async run(event) {
    const { body } = event;
    this.httpInterface.respond({
      status: 200,
      body,
    });
    // Emit the HTTP payload
    this.$emit({
      body,
    });
  },
};

Trigger 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
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Update Order on ShipHero

Description:Update an order. [See the documentation](https://developer.shiphero.com/getting-started/)

Version:0.0.1

Key:shiphero-update-order

View on GitHub

ShipHero Overview#

The ShipHero API enables granular control over warehousing and order fulfillment processes, offering endpoints for managing inventory, orders, returns, and shipping. In Pipedream, you can leverage this API to automate routine tasks, sync data across multiple platforms, and trigger actions based on specific events. This can save time, reduce errors, and increase operational efficiency for e-commerce businesses.

Action Code#

import app from "../../shiphero.app.mjs";
import orderMutations from "../../common/mutations/order.mjs";

export default {
  key: "shiphero-update-order",
  name: "Update Order",
  description: "Update an order. [See the documentation](https://developer.shiphero.com/getting-started/)",
  type: "action",
  version: "0.0.1",
  props: {
    app,
    orderId: {
      propDefinition: [
        app,
        "orderId",
      ],
    },
    orderNumber: {
      type: "string",
      label: "Order Number",
      description: "The order number.",
      optional: true,
    },
    partnerOrderId: {
      type: "string",
      label: "Partner Order ID",
      description: "The partner order ID.",
      optional: true,
    },
    fulfillmentStatus: {
      type: "string",
      label: "Fulfillment Status",
      description: "The fulfillment status.",
      optional: true,
    },
    orderDate: {
      type: "string",
      label: "Order Date",
      description: "The order date. A DateTime field type that understand **ISO 8601** strings, besides datetime objects. It supports strings with and without times, as well as using `T` or space as delimiter\nEg.\n- `YYYY-mm-dd`\n- `YYYY-mm-dd HH:MM:SS`\n - `YYYY-mm-ddTHH:MM:SS`",
      optional: true,
    },
    totalTax: {
      type: "string",
      label: "Total Tax",
      description: "The total tax for the order.",
      optional: true,
    },
    subtotal: {
      type: "string",
      label: "Subtotal",
      description: "The subtotal for the order.",
      optional: true,
    },
    totalDiscounts: {
      type: "string",
      label: "Total Discounts",
      description: "The total discounts for the order.",
      optional: true,
    },
    totalPrice: {
      type: "string",
      label: "Total Price",
      description: "The total price for the order.",
      optional: true,
    },
    customInvoiceUrl: {
      type: "string",
      label: "Custom Invoice URL",
      description: "The custom invoice URL for the order.",
      optional: true,
    },
    profile: {
      type: "string",
      label: "Profile",
      description: "The profile for the order.",
      optional: true,
    },
    packingNote: {
      type: "string",
      label: "Packing Note",
      description: "The packing note for the order.",
      optional: true,
    },
    requiredShipDate: {
      type: "string",
      label: "Required Ship Date",
      description: "The required ship date for the order. A DateTime field type that understand **ISO 8601** strings, besides datetime objects. It supports strings with and without times, as well as using `T` or space as delimiter\nEg.\n- `YYYY-mm-dd`\n- `YYYY-mm-dd HH:MM:SS`\n - `YYYY-mm-ddTHH:MM:SS`",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "The tags for the order.",
      optional: true,
    },
    priorityFlag: {
      type: "boolean",
      label: "Priority Flag",
      description: "The priority flag for the order.",
      optional: true,
    },
    giftNote: {
      type: "string",
      label: "Gift Note",
      description: "The gift note for the order.",
      optional: true,
    },
  },
  methods: {
    updateOrder(variables = {}) {
      return this.app.makeRequest({
        query: orderMutations.updateOrder,
        variables,
      });
    },
  },
  async run({ $: step }) {
    const {
      // eslint-disable-next-line no-unused-vars
      app,
      updateOrder,
      ...variables
    } = this;

    const response = await updateOrder(variables);

    step.export("$summary", `Successfully updated order with request ID \`${response.order_update.request_id}\`.`);

    return response;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
ShipHero	`app`	`app`	This component uses the ShipHero app.
Order ID	`orderId`	`string`	Select a value from the drop down menu.
Order Number	`orderNumber`	`string`	The order number.
Partner Order ID	`partnerOrderId`	`string`	The partner order ID.
Fulfillment Status	`fulfillmentStatus`	`string`	The fulfillment status.
Order Date	`orderDate`	`string`	The order date. A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using `T` or space as delimiter Eg. `YYYY-mm-dd` `YYYY-mm-dd HH:MM:SS` `YYYY-mm-ddTHH:MM:SS`
Total Tax	`totalTax`	`string`	The total tax for the order.
Subtotal	`subtotal`	`string`	The subtotal for the order.
Total Discounts	`totalDiscounts`	`string`	The total discounts for the order.
Total Price	`totalPrice`	`string`	The total price for the order.
Custom Invoice URL	`customInvoiceUrl`	`string`	The custom invoice URL for the order.
Profile	`profile`	`string`	The profile for the order.
Packing Note	`packingNote`	`string`	The packing note for the order.
Required Ship Date	`requiredShipDate`	`string`	The required ship date for the order. A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using `T` or space as delimiter Eg. `YYYY-mm-dd` `YYYY-mm-dd HH:MM:SS` `YYYY-mm-ddTHH:MM:SS`
Tags	`tags`	`string[]`	The tags for the order.
Priority Flag	`priorityFlag`	`boolean`	The priority flag for the order.
Gift Note	`giftNote`	`string`	The gift note for the order.

Action Authentication#

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

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

About ShipHero#

Whether you want to let go of running your own warehouse, or run your warehouse better, you can do both – and so much more – with ShipHero.

More Ways to Connect ShipHero + HTTP / Webhook#

Other Popular Integrations#

Get Order with ShipHero API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + ShipHero