| Resource | Description |
|---|---|
| GET passes | Returns descriptions of all created Wallet passes |
| GET passes/:passTypeIdentifier | Returns descriptions of all Wallet passes for a given Pass Type ID |
| GET passes/:passTypeIdentifier/:serialNumber | Downloads a given Wallet pass (.pkpass file including JSON, signature and images) |
| GET passes/:passTypeIdentifier/:serialNumber/url | Returns a short link to the Wallet pass |
| GET passes/:passTypeIdentifier/:serialNumber/passjson | Returns the full Wallet pass description of the given pass |
| POST passes/:passTypeIdentifier/:serialNumber/email | Sends a given Wallet pass to an email address |
| POST passes/:passTypeIdentifier/:serialNumber/push | Sends a push update to a given Wallet pass |
| DELETE passes/:passTypeIdentifier/:serialNumber | Deletes the pass |
| Resource | Description |
|---|---|
| GET passes/:passTypeIdentifier/:serialNumber/values | Returns the placeholder values of the Wallet pass |
| PUT passes/:passTypeIdentifier/:serialNumber/values | Updates the placeholder values values of the Wallet pass |
| PUT passes/:passTypeIdentifier/:serialNumber/value/:placeholderName | Updates the value of a single placeholder of the Wallet pass |
| Resource | Description |
|---|---|
| GET passes/:passTypeIdentifier/:serialNumber/images | Returns all images of the Wallet pass (template images not included) |
| DELETE passes/:passTypeIdentifier/:serialNumber/images | Deletes all images of the Wallet pass (template images not included) |
| GET passes/:passTypeIdentifier/:serialNumber/images/:type | Returns all images with the given type of the Wallet pass (template images not included) |
| DELETE passes/:passTypeIdentifier/:serialNumber/images/:type | Deletes all images with the given type of the Wallet pass (template images not included) |
| GET passes/:passTypeIdentifier/:serialNumber/images/:type/:resolution | Returns the image with the given type and resolution of the Wallet pass (template images not included) |
| POST passes/:passTypeIdentifier/:serialNumber/images/:type/:resolution | Creates or updates the image with the given type and resolution of the Wallet pass |
| DELETE passes/:passTypeIdentifier/:serialNumber/images/:type/:resolution | Deletes the image with the given type and resolution of the Wallet pass (template images not included) |
| Resource | Description |
|---|---|
| GET passes/:passTypeIdentifier/:serialNumber/status | Get the status of the Wallet pass |
| PUT passes/:passTypeIdentifier/:serialNumber/status | Updates the status the Wallet pass |
| Resource | Description |
|---|---|
| GET passes/:passTypeIdentifier/:serialNumber/price | Get the custom price of the Wallet pass |
| PUT passes/:passTypeIdentifier/:serialNumber/price | Updates the custom price of the Wallet pass |
| DELETE passes/:passTypeIdentifier/:serialNumber/price | Delete the custom price of the Wallet pass |
| Resource | Description |
|---|---|
| GET templates | Returns descriptions of all created pass templates |
| POST templates | Creates a new pass template |
| GET templates/:id | Shows a pass template |
| PUT templates/:id | Updates the template |
| DELETE templates/:id | Deletes the template |
| GET templates/:id/url | Returns a short link to the pass template |
| Resource | Description |
|---|---|
| POST templates/:id/pass (Variant 1) | Creates a pass from the pass templates with values |
| POST templates/:id/pass (Variant 2) | Creates a pass from the pass templates with values and images |
| POST templates/names/:name/pass (Variant 1) | Creates a pass from the pass template with the given name using the supplied values |
| POST templates/names/:name/pass (Variant 2) | Creates a pass from the pass template with the given name using the supplied values and images |
| Resource | Description |
|---|---|
| GET templates/:id/images | Returns all images of the pass template |
| DELETE templates/:id/images | Deletes all images of the pass template |
| GET templates/:id/images/:type | Returns all images with the given type of the pass template |
| DELETE templates/:id/images/:type | Deletes all images with the given type of the pass template |
| GET templates/:id/images/:type/:resolution | Returns the image with the given type and resolution of the pass template |
| POST templates/:id/images/:type/:resolution | Creates or updates the image with the given type and resolution of the pass template |
| DELETE templates/:id/images/:type/:resolution | Deletes the image with the given type and resolution of the pass template |
| Resource | Description |
|---|---|
| GET templates/:id/actions | Returns the pass template actions |
| PUT templates/:id/actions | Updates the pass template actions |
| Resource | Description |
|---|---|
| GET templates/:id/branding | Returns the pass template branding settings |
| PUT templates/:id/branding | Updates the pass template branding settings |
| PUT templates/:id/branding/footer/image | Updates the branding footer image |
| DELETE templates/:id/branding/footer/image | Deletes the branding footer image |
| Resource | Description |
|---|---|
| GET templates/:id/restrictions | Returns the pass template distribution restrictions |
| PUT templates/:id/restrictions | Updates the pass template distribution restrictions |
| Resource | Description |
|---|---|
| GET templates/:id/payment | Returns the pass template payment settings |
| PUT templates/:id/payment | Updates the pass template payment settings |
| Resource | Description |
|---|---|
| GET passtypes | Returns all available pass type ids |
| GET passtypes/:id | Shows a pass type id |
| Resource | Description |
|---|---|
| GET scanners | Returns all created scanners |
| POST scanners | Creates a new scanner |
| GET scanners/:id | Shows a scanner |
| PUT scanners/:id | Updates the scanner |
| DELETE scanners/:id | Deletes the scanner |
