BigCommerce Search for Order by Email

Finds the most recent BigCommerce order for an email address and adds its products and shipments. Also returns up to 5 of the most recent orders for the email. Uses the BigCommerce module connection, or the Access Token and Store Key inputs.

What it does

  • Finds the most recent BigCommerce order for the provided email address.
  • Adds the order's products (lines) and shipments (shipments) to the returned order object.
  • Returns up to 5 of the most recent orders for the email address as a list.

Authentication

The action uses the BigCommerce module connection when that connection has an auth header and a Store Key. In that case, you can leave the Access Token and Store Key inputs unmapped. If the connection is missing or incomplete, the action uses the Access Token and Store Key inputs instead.

Inputs

In order to use the action in your flow you need to provide it the following inputs:

InputTypeDescription
EmailStringThe action searches for an order matching this email. The action encodes plus signs (+), ampersands (&), and number signs (#) automatically, so addresses such as [email protected] match. Emails that are already URL-encoded (for example, buyer%[email protected]) also still match.
Access TokenCredentialsBigCommerce API access token. Leave unmapped when a BigCommerce connection is set up.
Store KeyCredentialsBigCommerce store key. Leave unmapped when a BigCommerce connection is set up.

Outputs

OutputTypeDecription
SuccessBooleantrue if managed to find an order; false if no orders found.
OrderObjectIf an order is found, this output contains the most recent order object with all the order fields, plus its products in lines and its shipments in shipments.
OrdersListUp to 5 of the most recent orders for the email, newest first, as BigCommerce returns them. These orders don't include products or shipments. The list is empty when no orders are found.

Did this page help you?