Order Transfer Using the Add Orders API Method

To transfer orders, send a request using the Add orders API method. You can transfer up to 1000 orders in one request.

Every time you send an API order, the system creates an event that can trigger a workflow. You can create different events for different order statuses, which allows setting triggers for each change in the order status.

Event Names

Event names consist of two parts: the word order and its status, for example, orderINITIALIZED, orderIN_PROGRESS, orderDELIVERED, orderCANCELLED, orderABANDONED_SHOPPING_CART.

To see the created events, go to Automation → Event history.

Event Parameters

Each event contains required parameters and can include optional parameters.

• ${eventKey} - event unique key transferred in externalOrderId. Used as an order identifier;
• ${orderId} - event ID in our system. Required to assign the event to a workflow.

The contact ID must be one of the following:

• ${externalCustomerId} - external contact ID;
• ${email} - contact’s email address;
• ${phone} - contact’s phone number.

To substitute parameter values in messages, send the fields with event parameters as an array.

• Required parameters for the order array: externalOrderId, totalCost, status, date, currency.
• Required parameters for the items array: externalItemId, quantity.

You don't need to transfer the items array if you don't use product data in messages or send orders only for RFM analysis.

See the full list of order fields with descriptions.

Request body example:

{

"orders": [{

"externalOrderId": "100500",

"externalCustomerId": "12345",

"totalCost": 1000,

"status": "INITIALIZED",

"date": "2017-03-08T09:30:00+02:00",

"email": "mail@example.com",

"phone": "380942583691",

"firstName": "John",

"lastName": "Smith",

"currency": "USD",

"shipping": 10,

"discount": 0,

"deliveryMethod": "express",

"paymentMethod": "cash",

"deliveryAddress": "First str. 1",

"items": [{

"externalItemId": "200600",

"name": "Super Device",

"category": "devices",

"quantity": 1,

"cost": 990,

"url": "http://example.com/item/200600",

"imageUrl": "http://example.com/item/200600/image.png",

"description": "High quality"

}]

}]
}

If the request is successful, the server returns the 200 status code. The response body contains the list of orders that cannot be added or updated.

The possible reasons for an order to fail:

• One or more required fields are empty, or the format is incorrect.
• All the following optional fields are empty: externalCustomerId, email, phone. At least one of them is required for order creation.

You can use orders with the DELIVERED status to build segments with the following conditions: average check, order count, last order date.

Send an ABANDONED_SHOPPING_CART status for abandoned carts. Use it if you track abandoned carts on an external platform. If you use web tracking, you don’t need to send abandoned cart events through API.

To update the status or other order data, send an updated order with the same externalOrderId parameter. It determines the order's uniqueness in the system.

Checking Event Parameters

To check whether the order is sent to the system with all the parameters, go to Automation → Orders. Click the order ID to see all the fields in JSON format. Also you can see information about the contact by clicking Contact preview icon.

Creating Workflow

1. Go to the Automation → Workflows section and click New workflow.

2. Specify the workflow’s name (Order delivered, Order in progress, etc.).

3. Add the following blocks to the workflow:

• The Task block → Get order. Using this block, the system will extract all the order data and transfer it to the message;
• A message-sending block. Select the message that you previously created for this workflow (order notification, NPS, etc.)

Instead of one message, you can make a series. For example, 1-2 weeks after the message about the delivered order, send a request to leave feedback.

More about setting up workflow start and stop conditions >