Order data

The order feed is crucial for effective integration and is therefore required.

Note: At this time, customers cannot set up the order feed themselves. Once the order feed is ready, please send it to support@helloretail.com, and our team will handle the setup for you.

Default Behavior

The feed should, by default, include orders from the past 2-3 days at the time of the request. However, it must also support a parameter called daysBack, allowing retrieval of older orders.

Example Request:
To retrieve orders from approximately 3 months ago, use the following format:

https://domain.com/helloretail/orderfeed?daysBack=90

Order Data

Required fields

The following fields must be included for each order entry:

• orderNumber: Order number from the shop system.
• products: List of products within the order. See the specification for each product below.
• date: Date and time the order was placed.
• total: Total amount for the order.
• email: Customer's email address.

Optional fields

The following fields can be included in each order entry:

• customerId: If you use another ID instead of email for customers. Remember to use the same ID in the tracking setup.

Order Product Data

For each product in an order, the following fields are required:

• url: URL of the product as it appears on the site.
• productNumber: Product number from the shop system.
• quantity: Quantity of the product purchased.
• lineTotal: Price of the products (including tax).

---

Variants

If a variant product has been purchased, the products should reflect the details of the specific variant rather than the master product.

Example

Below you can find an example of a order feed

[
    {
        "total": 499.32,
        "orderNumber": "123-4567",
        "email": "customer@example.com",
        "customerId": "123456",
        "date": "2024-05-12 10:04:05",
        "products": [
            {
                "productNumber": "p-1234",
                "url": "https://shop.example.com/p1234",
                "count": 2,
                "lineTotal": 100.12,
            },
            {
                "productNumber": "p-341",
                "url": "https://shop.example.com/p-341",
                "count": 1,
                "lineTotal": 299.08
            }
        ]
    },
    {
        ...
    }
]