findOrdersByNumber

Introduction

The findOrdersByNumber function allows locating a specific order by its order number. When executed in the Execute JavaScript block, it checks for the existence of the order based on the order number provided by the customer and, if found, returns as a response an array with complete details about the order in question.

How to Use

1. First, it is necessary to use the advanced settings of our WhatsApp messages to request the order number from the customer, saving the response provided by the customer into a variable, which in this case will be payload.number.

   

   

Note: To learn more about the advanced settings of our WhatsApp messages, visit our help center article: Help Center – Understanding the Logic, Time, Chat, and Advanced Actions in Automations

2. Next, as soon as the customer provides the order number, within the automation structure, we will use the Execute JavaScript block to run the findOrdersByNumber function and search for the order associated with the provided order number.

   

3. In the Execute JavaScript block, we use the code payload.orders = await findOrdersByNumber(payload.number) to search for the order associated with the number provided by the customer. In this way, the order number saved in the payload.number variable is used by the findOrdersByNumber function to retrieve the order linked to that number. The result is stored in payload.orders as an array containing the corresponding order.

4. The search response may return, in the following messages, information about the order found.

   

   

Example Code

{% if payload.orders is not empty %}
We found *{{ payload.orders|length }}* order(s). Here are the details:

{% for data in payload.orders %}
*#{{ data.order.number }}*
{% if data.order.payment_method == 'BOLETO' %}🏷 _Boleto_{% elseif data.order.payment_method == 'CREDIT_CARD' %}💳 _Credit Card_{% elseif data.order.payment_method == 'PIX' %}🤳🏼 _Pix_{% else %}🏷 _Other_{% endif %}

{% if data.order.payment_status == 'PAID' %}✅ _Paid_{% elseif data.order.payment_status == 'PENDING' %}⏳ _Pending_{% else %}❌ _Not Paid_{% endif %}

{% if data.order.tracking_numbers_url is not empty %}🚚 {{ data.order.tracking_numbers_url }}{% else %}🚚 _Pending Shipment_{% endif %}

{% endfor %}
{% else %}
No orders found.
{% endif %}

Note: In the example code, if no orders are found for the provided phone number, the message “No orders found” will be displayed.

To structure the response message containing the order data in this example, we use the Reportana® Script template language, which supports for and if/else structures. These commands allow for detailed and conditional formatting of the displayed information. To deepen your understanding of Reportana® Script and explore additional examples, refer to the full documentation: Reportana® Script - Documentation.

Return of the findOrdersByNumber Function

{
  "orders": [
    {
      "reference_id": 1234,
      "reference_type": "ORDER",
      "customer_id": 1234,
      "name": "John Smith",
      "first_name": "John",
      "last_name": "Smith",
      "email": "[e-mail]",
      "phone": "[phone]",
      "shop": {
        "id": 1234,
        "name": "Test Store",
        "currency_code": "USD",
        "billing_address_formatted": "123 Maple Street, Downtown, Springfield, IL, 62704, USA"
      },
      "customer": {
        "id": 104657184,
        "name": "John Smith",
        "email": "[e-mail]",
        "phone": "[phone]",
        "birth_date": null,
        "metadata": []
      },
      "order": {
        "admin_url": "https://….png",
        "customer_name": "John Smith",
        "customer_email": "[e-mail]",
        "customer_phone": "[phone]",
        "customer_document": "123-45-6789",
        "billing_address": {
          "name": "John Smith",
          "first_name": "John",
          "last_name": "Smith",
          "company": null,
          "phone": "[phone]",
          "address1": "456 Oak Avenue, Apt 31",
          "address2": "Downtown",
          "city": "Springfield",
          "province": "Illinois",
          "province_code": "IL",
          "country": "United States",
          "country_code": "US",
          "zip": "62704",
          "latitude": null,
          "longitude": null
        },
        "shipping_address": {
          "name": "John Smith",
          "first_name": "John",
          "last_name": "Smith",
          "company": null,
          "phone": "[phone]",
          "address1": "456 Oak Avenue, Apt 31",
          "address2": "Downtown",
          "city": "Springfield",
          "province": "Illinois",
          "province_code": "IL",
          "country": "United States",
          "country_code": "US",
          "zip": "62704",
          "latitude": null,
          "longitude": null
        },
        "number": "1234",
        "currency": "USD",
        "total_price": "99.90",
        "total_price_formatted": "$99.90",
        "subtotal_price": "0.00",
        "subtotal_price_formatted": "$0.00",
        "line_items": [
          {
            "title": "My Robot",
            "variant_title": "Blue",
            "quantity": 1,
            "price": 210.27,
            "path": "https://….png",
            "image_url": "https://….png",
            "tracking_number": null
          }
        ],
        "payment_status": "PAID",
        "payment_method": "BOLETO",
        "billet_url": "https://boleto.pl/1234abcd",
        "billet_line": "00000000000000000000000000000000000000000000000",
        "billet_expired_at": "2024-04-30 00:00:00",
        "billet_expired_at_formatted": "04/30/2024",
        "original_created_at": "2024-04-27 08:30:06",
        "billing_address_formatted": "456 Oak Avenue, Apt 31, Downtown, Springfield, IL, 62704",
        "shipping_address_formatted": "456 Oak Avenue, Apt 31, Downtown, Springfield, IL, 62704",
        "line_items_formatted": "My Robot",
        "line_items_formatted_with_variant": "My Robot - Blue",
        "tracking_numbers_formatted": "1234ABCD",
        "tracking_numbers_url": "https://boleto.pl/1234ABCD",
        "tracking_numbers": [
          {
            "code": "NL0000000000US",
            "new_code": "NL0000000123US",
            "full_status": "DELIVERED",
            "elapsed_time": 30,
            "tax_at": "2024-11-30 11:46:45",
            "delivered_at": "2024-12-14 11:46:45",
            "returning_to_sender_at": "2024-11-30 11:46:45",
            "returned_to_sender_at": "2024-11-30 11:46:45",
            "first_update_at": "2024-11-14 11:46:45",
            "last_update_at": "2024-12-14 11:46:45",
            "last_request_at": "2024-12-14 11:46:45",
            "events": [
              {
                "type": "COURIER",
                "date": "2024-12-14 11:46:45",
                "label": "Delivered",
                "location": "Springfield, IL",
                "description": "Your package has been delivered"
              },
              {
                "type": "COURIER",
                "date": "2024-11-14 11:46:45",
                "label": "Shipped",
                "location": "Springfield, IL",
                "description": "Accepted by the courier"
              }
            ]
          }
        ]
      }
    }
  ]
}

Response Data

The search returns various detailed information about the orders, including:

• Customer Data: Name, phone number, email used to place the order, etc;
• Order Information: Order ID, payment status (e.g., paid, pending), payment method (e.g., boleto, credit card), order creation date, etc;
• Address Data: Billing and shipping address, including city, state, ZIP code, etc;
• Order Items: Product name, variant (e.g., color), quantity, unit price, product image URL, etc;
• Payment Information: Boleto URL, boleto digitable line, due date, Pix copy and paste code, total order value, etc;
• Useful URLs: Tracking link and any other relevant URLs.

This data enables composing personalized messages to inform the customer about the details of the orders associated with the phone number used in the search.