Find Wallet

GET

https://api.npretail.app/:tenant/:environment/:company/attractionWallet

GET

/:tenant/:environment/:company/attractionWallet

curl -G https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./attractionWallet \
     -H "x-np-api-key: <NaviPartner API Key>" \
     --data-urlencode "referenceNumbers=john.doe@acme.com, WALLET-12345" \
     -d withAssets=true \
     -d withDetails=true \
     -d languageCode=ENU

200Find Wallets with Assets including Details

[
  {
    "description": "My wallet holds my tickets, coupons and vouchers for the event.",
    "expiryDatetime": "2026-12-31T23:59:59Z",
    "lastPrintedAt": "2026-12-31T23:59:59Z",
    "printCount": 1,
    "referenceNumber": "141234529930210327",
    "walletId": "a2cbd5bc-5cf4-ef11-b3a1-a1084fe21c78",
    "assets": [
      {
        "id": "2c3a84c7-059f-41d3-8033-0d94e08d4b13",
        "type": "ticket",
        "assetId": "3d4b95d8-16e0-42e4-9b2a-1d95f08d5c14",
        "itemNo": "31005",
        "description": "General Admission",
        "referenceNumber": "ATF-BIL010665L-3",
        "isSuperseded": false,
        "expiryDatetime": "2026-12-31T23:59:59Z",
        "ticketDetails": {
          "validFrom": "2024-10-15T12:00:00Z",
          "validUntil": "2024-10-15T23:59:59Z",
          "issuedAt": "2024-10-15T12:13:00Z",
          "blocked": false,
          "accessHistory": [
            {
              "admissionCode": "CASTLE",
              "firstAdmissionAt": "2025-01-31T09:12:00Z"
            }
          ],
          "unitPrice": 80,
          "unitPriceInclVat": 100,
          "currencyCode": "DKK",
          "content": [
            {
              "admissionDetails": {
                "capacityControl": "sales",
                "code": "CASTLE",
                "default": true,
                "description": {
                  "title": "Castle Museum Entrance",
                  "subtitle": "Adult Castle Ticket",
                  "name": "Explore the Castle",
                  "description": "<b>Access</b> to the castle exhibit",
                  "fullDescription": "<p>Experience the grandeur of the castle's architecture and marvel at its intricate details.  Walk through beautifully decorated rooms and admire the stunning artwork and furniture on display.</p>"
                },
                "included": "mandatory"
              },
              "scheduleDetails": {
                "code": "MORNING",
                "duration": 10800,
                "endDate": "2024-10-15",
                "endTime": "12:00",
                "externalNumber": 452,
                "startDate": "2024-10-15",
                "startTime": "09:00",
                "type": "initialEntry",
                "arrivalFromTime": "08:30",
                "arrivalUntilTime": "10:00",
                "description": "Morning schedule"
              }
            }
          ]
        }
      },
      {
        "id": "7e8f90ab-cdef-1234-5678-90abcdef1234",
        "type": "membership",
        "assetId": "5f6d17fa-38a2-64a6-bd4c-3f17a20f7e16",
        "itemNo": "320100",
        "description": "Membership Card",
        "referenceNumber": "CARD-FWGEASWFJFD",
        "isSuperseded": false,
        "expiryDatetime": "2026-12-31T23:59:59Z"
      }
    ],
    "externalReferenceNumber": "151234529930210327",
    "originatesFromDescription": "Family Fun Pack",
    "originatesFromItemNo": "70009"
  }
]

Find a wallet by any of its external references.

Authentication

x-np-api-keystring

API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Query parameters

referenceNumberstringOptional

Any external identity associated with the wallet.

referenceNumbersstringOptional

A comma separated list of external reference numbers used when searching for wallets.

withAssetsbooleanOptional

Indicates whether the asset should be included in the response.

withDetailsbooleanOptional

Indicates whether the asset details should be included in the response.

languageCodestringOptional

The language code for localization of item description purposes.

Response

This endpoint returns a list of objects.

descriptionstring

A human-readable description of the wallet.

expiryDatetimestring

The expiry datetime of the wallet in ISO 8601 format. Use an empty string if not applicable.

lastPrintedAtstring

The datetime when the wallet was last printed in ISO 8601 format. Use an empty string if not applicable.

printCountinteger

The number of times the wallet has been printed.

referenceNumberstring

The visual reference number associated with the wallet.

walletIdUUID

A globally unique identifier for the wallet.

assetslist of objectsOptional

externalReferenceNumberstringOptional

The first external reference on the wallet that is neither blocked nor expired. null when there is none.

originatesFromDescriptionstringOptional

The item description from which the wallet originates.

originatesFromItemNostringOptional

The item number from which the wallet originates.

Authentication

Path parameters

Headers

Query parameters

Response