Opérateurs de filtrage et de requête
Filtrez et paginez la liste des cartes à l’aide de conditions sur les champs, d’opérateurs sur les chaînes et les ensembles, et d’une pagination basée sur le décalage.
Opérateurs de filtre et de requête
GET /api/{tenantId}/passes?pageIndex=0&pageSize=20
&filter[0].field=passType&filter[0].operator=equals&filter[0].value=loyalty
&sortBy[0].field=creationDate&sortBy[0].direction=DESCGET /api/{tenantId}/passes?filter[0].field=installationStatus&filter[0].operator=contains&filter[0].value=appleZero-based page index.
0Number of passes per page.
20Paged list of passes returned successfully.
Represents a pass returned by the API.
Platform-assigned unique pass identifier. This is a random alphanumeric string generated at creation time and cannot be set by callers (e.g., xK9mP2nQr7sT).
Platform-generated opaque token used internally to authenticate pass delivery. Read-only; treat as confidential.
Timestamp when the pass was created by the platform. Read-only. Accepts ISO 8601 date-time string or Unix epoch seconds in request inputs. Responses are serialized as ISO 8601 date-time strings.
Timestamp of the most recent update. Equals CreationDate when no update has occurred. Read-only. Accepts ISO 8601 date-time string or Unix epoch seconds in request inputs. Responses are serialized as ISO 8601 date-time strings.
Type of pass, matching a file in the tenant server/passes/ configuration.
Paged list of passes returned successfully.
POST /api/{tenantId}/passes/pushUpdate
?filter[0].field=passType&filter[0].operator=equals&filter[0].value=loyalty
{
"additionalData": { "offer": "summer2025", "discount": "20%" },
"options": {
"updateMetadata": true,
"throughput": 12,
"correlationId": "campaign-summer-2025"
}
}Arbitrary data to persist with the pass (for example, loyalty tier, store code, or campaign flags).
Optional pass type to convert the pass to.
Specifies if passes metadata should be updated. Updating metadata is time consuming and could be avoided for notification only push update
falsePasses scheduled for update; returns the count in the response body.
Result returned after scheduling a bulk push update operation.
Count of passes scheduled for update.
Passes scheduled for update; returns the count in the response body.
Create a time-limited download token for exporting passes as Excel.
Filter specification for pass queries.
Field to filter by. Supported values:
passType — pass type name (string).installationStatus — concatenation of installed wallet names (e.g. "apple", "google", "applegoogle"). Use contains to test for a single wallet.identifiers.{key} — an external identifier (string).metadata.{key} — a metadata field. The comparison type (string, number, boolean, datetime) is resolved automatically from the pass configuration.
Comparison operator to apply.
Filter value(s). Interpretation depends on Operator and the metadata field's configured type:
String fields (identifiers.*, passType, installationStatus, or metadata.* configured as string)
— plain string value for most operators; an array of strings for in / notIn.Numeric fields (metadata configured as number) — decimal number as a string, e.g. "42" or "3.14".
Parsed using invariant culture (. as decimal separator).Boolean fields (metadata configured as boolean) — "true" or "false" (case-insensitive).Date fields (metadata configured as datetime) — ISO 8601 date-time string with timezone, e.g. "2024-06-01T00:00:00+00:00" or "2024-06-01T00:00:00Z".
The value is converted to a unix timestamp (seconds) before comparison against the stored unix timestamp.
The query parameter name is value (repeated for multiple values).
Single value (equals, contains, startsWith, …):
GET /passes?filter[0].field=passType&filter[0].operator=equals&filter[0].value=boarding
Multiple values (in / notIn):
GET /passes?filter[0].field=passType&filter[0].operator=in&filter[0].value=boarding&filter[0].value=loyalty
Date comparison (metadata field configured as datetime):
GET /passes?filter[0].field=metadata.eventDate&filter[0].operator=greaterThan&filter[0].value=2024-01-01T00:00:00Z
Boolean comparison (metadata field configured as boolean):
GET /passes?filter[0].field=metadata.isVip&filter[0].operator=equals&filter[0].value=true
```</example>
Download token created successfully.
Download token created successfully.
Structure de la requête de filtre
Opérateurs
Opérateurs de chaîne
Opérateurs de présence
Opérateurs d’ensemble
Pagination
Combinaison des filtres et de la pagination
Mis à jour

