Find or Create Contact with Xero Accounting API on New Order Created from Selling Partner API (SP-API) API

Pipedream makes it easy to connect APIs for Xero Accounting, Selling Partner API (SP-API) and 2,800+ other apps remarkably fast.

Trigger workflow on

New Order Created from the Selling Partner API (SP-API) API

Next, do this

Find or Create Contact with the Xero Accounting 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 Selling Partner API (SP-API) trigger and Xero Accounting action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Order Created trigger
1. Connect your Selling Partner API (SP-API) account
2. Configure timer
3. Select a Marketplace ID
Configure the Find or Create Contact action
1. Connect your Xero Accounting account
2. Select a Tenant ID
3. Optional- Configure Contact name
4. Optional- Configure Email address
5. Select a Create a new contact if not found
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 Order Created on Selling Partner API (SP-API)

Description:Emit new event when a new order is created in Amazon Seller Central. [See the documentation](https://developer-docs.amazon.com/sp-api/reference/getorders)

Version:0.0.1

Key:amazon_selling_partner-new-order-created

View on GitHub

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "amazon_selling_partner-new-order-created",
  name: "New Order Created",
  description: "Emit new event when a new order is created in Amazon Seller Central. [See the documentation](https://developer-docs.amazon.com/sp-api/reference/getorders)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    generateMeta(order) {
      return {
        id: order.AmazonOrderId,
        summary: `New Order: ${order.AmazonOrderId}`,
        ts: Date.parse(order.PurchaseDate),
      };
    },
  },
  async run() {
    const lastTs = this._getLastTs();
    let maxTs = lastTs;

    const orders = await this.amazonSellingPartner.getPaginatedResources({
      fn: this.amazonSellingPartner.listOrders,
      params: {
        MarketplaceIds: this.marketplaceId,
        CreatedAfter: lastTs,
      },
      resourceKey: "Orders",
    });

    if (!orders?.length) {
      return;
    }

    for (const order of orders) {
      if (Date.parse(order.PurchaseDate) > Date.parse(maxTs)) {
        maxTs = order.PurchaseDate;
      }
      const meta = this.generateMeta(order);
      this.$emit(order, meta);
    }

    this._setLastTs(maxTs);
  },
};

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
Selling Partner API (SP-API)	`amazonSellingPartner`	`app`	This component uses the Selling Partner API (SP-API) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Marketplace ID	`marketplaceId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

About Selling Partner API (SP-API)#

Selling Partner API (SP-API) allow you to programmatically access data on your orders, shipments, payments, and much more. Applications using the SP-API can increase selling efficiency, reduce labor requirements, and improve response time to customers, helping selling partners grow their businesses.

Action#

Find or Create Contact on Xero Accounting

Description:Finds a contact by name or email address. Optionally, create one if none are found. [See the docs here](https://developer.xero.com/documentation/api/accounting/contacts/#get-contacts)

Version:0.1.0

Key:xero_accounting_api-find-or-create-contact

View on GitHub

Xero Accounting Overview#

The Xero Accounting API offers a powerful gateway to access and manipulate financial data within Xero. Leveraging Pipedream's capabilities, developers can build custom workflows that streamline accounting processes, sync financial data with external systems, and trigger actions based on financial events. This API allows for the automation of tasks such as invoicing, bank reconciliation, bill payments, and reporting, which can lead to significant time savings and enhanced data accuracy.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  formatQueryString,
  removeNullEntries,
} from "../../common/util.mjs";
import xeroAccountingApi from "../../xero_accounting_api.app.mjs";

export default {
  key: "xero_accounting_api-find-or-create-contact",
  name: "Find or Create Contact",
  description: "Finds a contact by name or email address. Optionally, create one if none are found. [See the docs here](https://developer.xero.com/documentation/api/accounting/contacts/#get-contacts)",
  version: "0.1.0",
  type: "action",
  props: {
    xeroAccountingApi,
    tenantId: {
      propDefinition: [
        xeroAccountingApi,
        "tenantId",
      ],
    },
    name: {
      type: "string",
      label: "Contact name",
      description: "Full name of contact/organization ",
      optional: true,
    },
    emailAddress: {
      type: "string",
      label: "Email address",
      description: "Email address of contact/organization.",
      optional: true,
    },
    createContactIfNotFound: {
      description: "Create a new contact if not found?.",
      label: "Create a new contact if not found",
      type: "string",
      options: [
        "Yes",
        "No",
      ],
      reloadProps: true,
    },
  },
  additionalProps() {
    const props = {};
    if (this.createContactIfNotFound === "Yes") {
      props.firstName = {
        type: "string",
        label: "First name",
        description: "First name of contact person .",
        optional: true,
      };
      props.lastName = {
        type: "string",
        label: "Last name",
        description: "Last name of contact person.",
        optional: true,
      };
      props.contactStatus = {
        type: "string",
        label: "Contact status",
        description:
          "See [contact status reference](https://developer.xero.com/documentation/api/accounting/types#contacts)",
        options: [
          "ACTIVE",
          "ARCHIVED",
          "GDPRREQUEST",
        ],
        optional: true,
        default: "ACTIVE",
      };
    }
    return props;
  },
  async run({ $ }) {
    let contactDetail;
    const {
      tenantId,
      name,
      firstName,
      lastName,
      emailAddress,
      contactStatus,
      createContactIfNotFound,
    } = this;
    if (createContactIfNotFound === "No" && emailAddress && name) {
      throw new ConfigurationError(
        "Choose exclusively between Email Address or Name to find a contact.",
      );
    }
    const findPayload = removeNullEntries({
      Name: name,
      EmailAddress: emailAddress,
    });
    const createPayload = removeNullEntries({
      Name: name,
      FirstName: firstName,
      LastName: lastName,
      EmailAddress: emailAddress,
      ContactStatus: contactStatus,
    });
    try {
      contactDetail = await this.xeroAccountingApi.getContact({
        $,
        tenantId,
        queryParam: formatQueryString(findPayload, true),
      });
    } catch (error) {
      if (createContactIfNotFound === "Yes") {
        $.export("$summary", "Contact not found. Creating new contact");
      } else {
        $.export("$summary", "No contact found.");
        return {};
      }
    }

    if (
      (!contactDetail || !contactDetail?.Contacts?.length) &&
      createContactIfNotFound === "Yes"
    ) {
      return await this.xeroAccountingApi.createOrUpdateContact({
        $,
        tenantId,
        data: createPayload,
      });
    }
    return contactDetail;
  },
};

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
Xero Accounting	`xeroAccountingApi`	`app`	This component uses the Xero Accounting app.
Tenant ID	`tenantId`	`string`	Select a value from the drop down menu.
Contact name	`name`	`string`	Full name of contact/organization
Email address	`emailAddress`	`string`	Email address of contact/organization.
Create a new contact if not found	`createContactIfNotFound`	`string`	Select a value from the drop down menu:`YesNo`

Action Authentication#

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

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

offline_accessopenidprofileemailaccounting.transactionsaccounting.transactions.readaccounting.reports.readaccounting.settingsaccounting.settings.readaccounting.contactsaccounting.attachmentsaccounting.journals.read

About Xero Accounting#

Accounting Software

More Ways to Connect Xero Accounting + Selling Partner API (SP-API)#

Other Popular Integrations#

Check FBA Inventory Levels with Selling Partner API (SP-API) API on New or updated contact from Xero Accounting API

Xero Accounting + Selling Partner API (SP-API)

Find or Create Contact with Xero Accounting API on New Order Created from Selling Partner API (SP-API) API

Pipedream makes it easy to connect APIs for Xero Accounting, Selling Partner API (SP-API) and 2,800+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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