Sign in

v1

latestOpenAPI 3.0.32026-07-2659199427.5 KB
Get signals

Purchase complete signals

When a user completes a purchase and is taken to the order confirmation page, a signal is recorded.

post/retail/signals/purchase

Request body

timestampinteger required

The event time displayed in epoch time milliseconds.

visitorIdstring required

The unique identifier for the visitor (user) associated with the signal. The field is a UTF-8 encoded string with a maximum of 128 characters. Do not use personally identifiable information (PII) or user data in the value.

sessionIdstring required

The unique identifier that tracks a specific session of a user's activity over a period of time.

queryIdstring required

The unique identifier for the query.

ipAddressstring

This optional parameter is the IP address of the browser or device that generated the signal.

The IP address may be passed in the signal. If it is not passed in the signal, it is extracted from the request, and the last octet is dropped to mask the user's location for security purposes.

sourceIdstring required

A freeform text field used to identify where the API call originates.

The value has no effect on search relevancy.

uristring required

The canonical URL of the product's detail page. The field is a UTF-8 encoded string with a maximum of 5000 characters.

cartIdstring required

The unique identifier (UUID) of the cart for this interaction.

orderIdstring

This optional unique identifier parameter is used on the purchase_complete signal and identifies an actual purchase as opposed to an attempted purchase.

revenuenumber float required

This floating number is the total price of the sale.

Example request

[
  {
    "timestamp": 1744305461169,
    "visitorId": "abcc8e25-d30f-2212-9f60-9b45a71453cf",
    "sessionId": "41a50e2-8e32-4674-5429-e1450dfdbb14",
    "queryId": "2a97fc33-3335-3369-c2dc-456b775eb90f",
    "ipAddress": "111.222.333",
    "productDetails": [
      {
        "product": {
          "productId": "1234567",
          "price": 2592,
          "title": "Silver french door bottom freezer 27.4 cu ft refrigerator",
          "imageuri": "https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg"
        }
      }
    ],
    "uri": "https://example.com/refrigerators/silver/bottomfreezer",
    "cartId": "7f626d8c-4176-4f55-b17d-e89531e92ef7",
    "orderId": "6a678f11d-2265-4d01-a4ed-6e9875bfbda2",
    "revenue": 2592
  }
]

Response

ACCEPTED