← Order Desk

Update Order with Order Desk API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Update Order with the Order Desk API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

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

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Update Order with Order Desk API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Order Desk
 
Try it
Update Order with Order Desk API on New Submission from Typeform API
Typeform + Order Desk
 
Try it
Update Order with Order Desk API on Custom Events from Zoom API
Zoom + Order Desk
 
Try it
Update Order with Order Desk API on New Submission (Instant) from Jotform API
Jotform + Order Desk
 
Try it
Update Order with Order Desk API on New Scheduled Tasks from Pipedream API
Pipedream + Order Desk
 
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.

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

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;
  },
};

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.
LabelPropTypeDescription
Order DeskappappThis component uses the Order Desk app.
Order IDorder_idstringSelect a value from the drop down menu.
Order Itemsorder_itemsstring[]

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 Namecustomer_first_namestring

Customer first name

Customer Last Namecustomer_last_namestring

Customer last name

Customer Companycustomer_companystring

Customer company

Shipping First Nameshipping_first_namestring

Shipping first name

Shipping Last Nameshipping_last_namestring

Shipping last name

Shipping Companyshipping_companystring

Shipping company

Source IDsource_idstring

Your order ID. If blank, Order Desk's internal ID will be used read-only.

Source Namesource_namestringSelect a value from the drop down menu:Order DeskFoxyCartWooCommerceBigCommerceAmazonShopifyeBayMagentoMagento 2GumroadWufooInterspirePayPalStripeEtsyJetZapierSpark PaySnipcartRecurlyVolusionChargebeeWeeblyWalmartWalmart.comModular MerchantEcwidUltraCartnopCommerceSquarespaceCeleryE-junkieCommerceHQBrightStoresSamCartWayfairSpree
Emailemailstring

Customer email address

Shipping Methodshipping_methodstring

Name of shipping method selected.

Quantity Totalquantity_totalstring

Total number of items in the order.

Weight Totalweight_totalstring

Total weight of the order.

Product Totalproduct_totalstring

Total cost of all items in the order.

Shipping Totalshipping_totalstring

Total cost of shipping.

Handling Totalhandling_totalstring

Total cost of handling.

Tax Totaltax_totalstring

Total cost of tax.

Discount Totaldiscount_totalstring

Total cost of discounts.

Order Totalorder_totalstring

Total cost of the order.

Credit Card Numbercc_numberstring

Obfuscated credit card number. Enter only the last four digits.

Credit Card Expirationcc_expstring

Credit card expiration date in MM/YYYY format.

Processor Responseprocessor_responsestring

Gateway transaction ID in format <gateway_name>: <transaction_id>

Payment Typepayment_typestring

Payment type. Can be Visa, Paypal, Mastercard, etc

Payment Statuspayment_statusstringSelect a value from the drop down menu:ApprovedAuthorizedCapturedFully RefundedPartially RefundedPendingRejectedVoided
Processor Balanceprocessor_balancestring

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 Totalrefund_totalstring

The amount that jhas been refunded on the order from within Order Desk. This is generally something that will be set internally.

Customer IDcustomer_idstring

The ID of the customer. This is generally something that will be set internally.

IP Addressip_addressstring

The IP address of the customer.

Fulfillment IDfulfillment_idstring

The internal ID of the fulfillment service will be saved here for some services.

Fulfillment Namefulfillment_namestring

Once the order has been sent for fulfillment, the name of the fulfillment method is entered here.

Folder IDfolder_idstring

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.

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 Use Order Desk

Triggers

New Order Created from the Order Desk API

Emit new event a new order is created

 
Try it
New Order Updated from the Order Desk API

Emit new event a new order is updated

 
Try it

Actions

Create Order with the Order Desk API

Create Order See the documentation.

 
Try it
Find Order with the Order Desk API
 
Try it
List Orders with the Order Desk API

List Orders based on a search criteria See the documentation.

 
Try it

Explore Other Apps

1
-
24
of
2,000+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Salesforce (REST API)
Salesforce (REST API)
Web services API for interacting with Salesforce
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Snowflake
Snowflake
A data warehouse built for the cloud
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.