Centra Search For Order by Email
Find Centra orders by Order Number
This action retrieves orders from Centra that correspond to a specific customer email address.
The action will return Success output as false and an empty list of orders in the following cases:
- If no customer is found based on the input email
- If the customer was found, but no order is found for this customer
- If more than one customer is identified based on input email
The order properties can be found here: https://centra.dev/docs/apis/order-api/api-reference#get-orders
This action can be used in cases when the order number can't be found in the ticket description and/or subject.
Inputs
In order to use the action in your flow you need to provide it with the following inputs:
Input | Type | Description |
---|---|---|
Email Address | String | The action will search for orders matching this email address. |
API Key | String | API Key |
Base URI | String | Base URI - should be in the format clientname.centra.com/api/dg-order-api/xx |
Outputs
Output | Type | Description |
---|---|---|
Success | Boolean | True if managed to find an order; False if no orders found. |
Orders | Object | The list of orders found. To access the latest order, please use /0 |
This action works by:
- Searching for the list of customers with the input email address using https://centra.dev/docs/apis/order-api/api-reference#list-customers
- Searching for the list of orders associated with the customer ID using https://centra.dev/docs/apis/order-api/api-reference#get-customer
Centra Order API Setup Instructions
Go to System -> Stores -> Retail -> Add Plugin Method
1. Set Status = Active
2. Set Plugin name = DG Order API
3. Set Plugin = Order API
4. Set URI = dg-order-api
5. Set Secret API Key = any generated API Key (you can use an online API Key generator) - please send this value to us
6. Base URL should automatically be created - please send this value to us
7. Get Orders with Status Setting - set to ALL
8. Allow access to the following endpoints - set to ALL
Updated 22 days ago