Overview

Pass Resources

Pass Type Resources

Scanner Resources

Passes

Resource Description
GET passes Returns descriptions of all created passbook passes
GET passes/:passTypeIdentifier Returns descriptions of all passbook passes for a given Pass Type ID
GET passes/:passTypeIdentifier/:serialNumber Downloads a given passbook pass (.pkpass file including JSON, signature and images)
GET passes/:passTypeIdentifier/:serialNumber/url Returns a short link to the passbook pass
GET passes/:passTypeIdentifier/:serialNumber/passjson Returns the full passbook pass description of the given pass
POST passes/:passTypeIdentifier/:serialNumber/email Sends a given passbook pass to an email address
POST passes/:passTypeIdentifier/:serialNumber/push Sends a push update to a given passbook pass
DELETE passes/:passTypeIdentifier/:serialNumber Deletes the pass

Pass Values

Resource Description
GET passes/:passTypeIdentifier/:serialNumber/values Returns the placeholder values of the passbook pass
PUT passes/:passTypeIdentifier/:serialNumber/values Updates the placeholder values values of the passbook pass
PUT passes/:passTypeIdentifier/:serialNumber/value/:placeholderName Updates the value of a single placeholder of the passbook pass

Pass Images

Resource Description
GET passes/:passTypeIdentifier/:serialNumber/images Returns all images of the passbook pass (template images not included)
DELETE passes/:passTypeIdentifier/:serialNumber/images Deletes all images of the passbook pass (template images not included)
GET passes/:passTypeIdentifier/:serialNumber/images/:type Returns all images with the given type of the passbook pass (template images not included)
DELETE passes/:passTypeIdentifier/:serialNumber/images/:type Deletes all images with the given type of the passbook pass (template images not included)
GET passes/:passTypeIdentifier/:serialNumber/images/:type/:resolution Returns the image with the given type and resolution of the passbook 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 passbook pass
DELETE passes/:passTypeIdentifier/:serialNumber/images/:type/:resolution Deletes the image with the given type and resolution of the passbook pass (template images not included)

Pass Payment Professional

Resource Description
GET passes/:passTypeIdentifier/:serialNumber/price Get the custom price of the passbook pass
PUT passes/:passTypeIdentifier/:serialNumber/price Updates the custom price of the passbook pass
DELETE passes/:passTypeIdentifier/:serialNumber/price Delete the custom price of the passbook pass

Pass Templates

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

Pass Generation

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

Template 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

Template Branding Basic Professional

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

Template Distribution Restrictions

Resource Description
GET templates/:id/restrictions Returns the pass template distribution restrictions
PUT templates/:id/restrictions Updates the pass template distribution restrictions

Template Payment Settings Professional

Resource Description
GET templates/:id/payment Returns the pass template payment settings
PUT templates/:id/payment Updates the pass template payment settings

Pass Type IDs

Resource Description
GET passtypes Returns all available pass type ids
GET passtypes/:id Shows a pass type id

Scanners

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