Get Visits

Gets a collection of visit info specified by filter and sort order.

GET /commerce/customer/visits

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "accountId": 123,
      "browserLocationCode": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "locationCode": "<string>",
      "transactions": [
        {
          "amount": 123,
          "currencyCode": "<string>",
          "date": "2023-11-07T05:31:56Z",
          "interactionType": "<string>",
          "transactionId": "<string>",
          "transactionType": "<string>",
          "visitId": "<string>"
        }
      ],
      "type": "<string>",
      "userId": "<string>",
      "webReferrer": "<string>",
      "webSessionId": "<string>",
      "webSiteId": 123,
      "webUserAgent": "<string>"
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

startIndex · integer<int32> · default: 0

pageSize · integer<int32> · default: 0

sortBy · string

filter · string

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>