Update Order with Order Desk API on New Requests from HTTP / Webhook API

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

Trigger workflow on

New Requests from the HTTP / Webhook API

Next, do this

Update Order with the Order Desk API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a HTTP / Webhook trigger and Order Desk 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 trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
Configure the Update Order action
1. Connect your Order Desk account
2. Select a Order ID
3. Optional- Configure Order Items
4. Optional- Configure Customer First Name
5. Optional- Configure Customer Last Name
6. Optional- Configure Customer Company
7. Optional- Configure Shipping First Name
8. Optional- Configure Shipping Last Name
9. Optional- Configure Shipping Company
10. Optional- Configure Source ID
11. Optional- Select a Source Name
12. Optional- Configure Email
13. Optional- Configure Shipping Method
14. Optional- Configure Quantity Total
15. Optional- Configure Weight Total
16. Optional- Configure Product Total
17. Optional- Configure Shipping Total
18. Optional- Configure Handling Total
19. Optional- Configure Tax Total
20. Optional- Configure Discount Total
21. Optional- Configure Order Total
22. Optional- Configure Credit Card Number
23. Optional- Configure Credit Card Expiration
24. Optional- Configure Processor Response
25. Optional- Configure Payment Type
26. Optional- Select a Payment Status
27. Optional- Configure Processor Balance
28. Optional- Configure Refund Total
29. Optional- Configure Customer ID
30. Optional- Configure IP Address
31. Optional- Configure Fulfillment ID
32. Optional- Configure Fulfillment Name
33. Optional- Configure Folder ID
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 on HTTP / Webhook

Description:Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Version:0.1.1

Key:http-new-requests

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
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

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.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
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 Order Desk

Description:Update Order [See the documentation](https://apidocs.orderdesk.com/#update-an-order).

Version:0.0.1

Key:order_desk-update-order

View on GitHub

Order Desk Overview#

The Order Desk API allows you to automate and streamline order management processes within the Order Desk platform. With this API, you have the power to create, update, and get detailed information on orders, inventory, and shipments. Pipedream's serverless platform enables you to connect the Order Desk API with numerous other apps and services to build dynamic workflows. Whether you're syncing order data, managing inventory, or connecting to fulfillment services, Pipedream can help you craft custom automations that save time and reduce manual errors.

Action Code#

import { getParsedOrderItems } from "../../common/validate-order-items.mjs";
import app  from "../../order_desk.app.mjs";

export default {
  name: "Update Order",
  description: "Update Order [See the documentation](https://apidocs.orderdesk.com/#update-an-order).",
  key: "order_desk-update-order",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    order_id: {
      propDefinition: [
        app,
        "order_id",
      ],
    },
    order_items: {
      propDefinition: [
        app,
        "order_items",
      ],
      optional: true,
    },
    customer_first_name: {
      propDefinition: [
        app,
        "customer_first_name",
      ],
    },
    customer_last_name: {
      propDefinition: [
        app,
        "customer_last_name",
      ],
    },
    customer_company: {
      propDefinition: [
        app,
        "customer_company",
      ],
    },
    shipping_first_name: {
      propDefinition: [
        app,
        "shipping_first_name",
      ],
    },
    shipping_last_name: {
      propDefinition: [
        app,
        "shipping_last_name",
      ],
    },
    shipping_company: {
      propDefinition: [
        app,
        "shipping_company",
      ],
    },
    source_id: {
      propDefinition: [
        app,
        "source_id",
      ],
    },
    source_name: {
      propDefinition: [
        app,
        "source_name",
      ],
    },
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    shipping_method: {
      propDefinition: [
        app,
        "shipping_method",
      ],
    },
    quantity_total: {
      propDefinition: [
        app,
        "quantity_total",
      ],
    },
    weight_total: {
      propDefinition: [
        app,
        "weight_total",
      ],
    },
    product_total: {
      propDefinition: [
        app,
        "product_total",
      ],
    },
    shipping_total: {
      propDefinition: [
        app,
        "shipping_total",
      ],
    },
    handling_total: {
      propDefinition: [
        app,
        "handling_total",
      ],
    },
    tax_total: {
      propDefinition: [
        app,
        "tax_total",
      ],
    },
    discount_total: {
      propDefinition: [
        app,
        "discount_total",
      ],
    },
    order_total: {
      propDefinition: [
        app,
        "order_total",
      ],
    },
    cc_number: {
      propDefinition: [
        app,
        "cc_number",
      ],
    },
    cc_exp: {
      propDefinition: [
        app,
        "cc_exp",
      ],
    },
    processor_response: {
      propDefinition: [
        app,
        "processor_response",
      ],
    },
    payment_type: {
      propDefinition: [
        app,
        "payment_type",
      ],
    },
    payment_status: {
      propDefinition: [
        app,
        "payment_status",
      ],
    },
    processor_balance: {
      propDefinition: [
        app,
        "processor_balance",
      ],
    },
    refund_total: {
      propDefinition: [
        app,
        "refund_total",
      ],
    },
    customer_id: {
      propDefinition: [
        app,
        "customer_id",
      ],
    },
    ip_address: {
      propDefinition: [
        app,
        "ip_address",
      ],
    },
    fulfillment_id: {
      propDefinition: [
        app,
        "fulfillment_id",
      ],
    },
    fulfillment_name: {
      propDefinition: [
        app,
        "fulfillment_name",
      ],
    },
    folder_id: {
      propDefinition: [
        app,
        "folder_id",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      ...data
    } = this;

    const res = await app.updateOrder({
      ...data,
      order_items: getParsedOrderItems(data.order_items),
    });
    $.export("summary", `Order successfully updated with id "${res.order.id}".`);
    return res;
  },
};

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
Order Desk	`app`	`app`	This component uses the Order Desk app.
Order ID	`order_id`	`string`	Select a value from the drop down menu.
Order Items	`order_items`	`string[]`	A valid JSON string. Order Items Object can have the following properties: `id, name, price, quantity, weight, code, delivery_type, category_code, variation_list, metadata`. Please check the documentation in the description for more information.
Customer First Name	`customer_first_name`	`string`	Customer first name
Customer Last Name	`customer_last_name`	`string`	Customer last name
Customer Company	`customer_company`	`string`	Customer company
Shipping First Name	`shipping_first_name`	`string`	Shipping first name
Shipping Last Name	`shipping_last_name`	`string`	Shipping last name
Shipping Company	`shipping_company`	`string`	Shipping company
Source ID	`source_id`	`string`	Your order ID. If blank, Order Desk's internal ID will be used read-only.
Source Name	`source_name`	`string`	Select a value from the drop down menu:`Order DeskFoxyCartWooCommerceBigCommerceAmazonShopifyeBayMagentoMagento 2GumroadWufooInterspirePayPalStripeEtsyJetZapierSpark PaySnipcartRecurlyVolusionChargebeeWeeblyWalmartWalmart.comModular MerchantEcwidUltraCartnopCommerceSquarespaceCeleryE-junkieCommerceHQBrightStoresSamCartWayfairSpree`
Email	`email`	`string`	Customer email address
Shipping Method	`shipping_method`	`string`	Name of shipping method selected.
Quantity Total	`quantity_total`	`string`	Total number of items in the order.
Weight Total	`weight_total`	`string`	Total weight of the order.
Product Total	`product_total`	`string`	Total cost of all items in the order.
Shipping Total	`shipping_total`	`string`	Total cost of shipping.
Handling Total	`handling_total`	`string`	Total cost of handling.
Tax Total	`tax_total`	`string`	Total cost of tax.
Discount Total	`discount_total`	`string`	Total cost of discounts.
Order Total	`order_total`	`string`	Total cost of the order.
Credit Card Number	`cc_number`	`string`	Obfuscated credit card number. Enter only the last four digits.
Credit Card Expiration	`cc_exp`	`string`	Credit card expiration date in MM/YYYY format.
Processor Response	`processor_response`	`string`	Gateway transaction ID in format `<gateway_name>: <transaction_id>`
Payment Type	`payment_type`	`string`	Payment type. Can be `Visa`, `Paypal`, `Mastercard`, etc
Payment Status	`payment_status`	`string`	Select a value from the drop down menu:`ApprovedAuthorizedCapturedFully RefundedPartially RefundedPendingRejectedVoided`
Processor Balance	`processor_balance`	`string`	The amount that the was charged at the processor. This amount will be decremented when refunds are made. By default it will be set the same as `order_total`
Refund Total	`refund_total`	`string`	The amount that jhas been refunded on the order from within Order Desk. This is generally something that will be set internally.
Customer ID	`customer_id`	`string`	The ID of the customer. This is generally something that will be set internally.
IP Address	`ip_address`	`string`	The IP address of the customer.
Fulfillment ID	`fulfillment_id`	`string`	The internal ID of the fulfillment service will be saved here for some services.
Fulfillment Name	`fulfillment_name`	`string`	Once the order has been sent for fulfillment, the name of the fulfillment method is entered here.
Folder ID	`folder_id`	`string`	The ID number of the folder in which the order is stored. If nothing is entered when adding an order, the folder will be the first folder in the list.

Action Authentication#

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

To retrieve your API key,

Navigate to your Order Desk account and sign in
Go to “Store Settings” > “API”

About Order Desk#

Save time and use Order Desk to automate your ecommerce order management workflow with 300+ integrations and counting!

More Ways to Connect Order Desk + HTTP / Webhook#

Other Popular Integrations#

Create Order with Order Desk API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Order Desk