Skip to content
RE-ZIP API Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Guides
Getting started
The HTTP Request
The HTTP Responses
OpenAPI Docs
Voucher integration
Vouchers
Webhooks
News
January 2026 Deprication Notices
Me Scope API
Overview
Operations
Get current authenticated user
Register a new user (send email verification)
Delete current user
Update the authenticated user's profile
Create an access token
Activate account or email-change
List current user's agreements
Delete me agreement
Accept user agreement
Update email (initiate verification)
Verify email address with OTP
Get MFA auth state
Generate MFA TOTP provisioning QR code
Toggle MFA requirement for the authenticated user
Delete MFA secret
Send MFA OTP
Request MFA reset OTP
Verify MFA passcode
Look up packaging by barcode
Scan packaging for reward
Update password
Request a password reset
List rewards for the authenticated user
Get reward for user
Delete me reward
Send reward voucher by email
Exchange ticket reward for voucher
List ticket reward exchange options
Shops Scope API
Overview
Operations
Create shop
Get shop
Delete shop
Update shop
List shop agreements
Create shop agreement
Get shop agreement
Delete shop agreement
Patch shop agreement
Replace permissions for shop agreement
List personal access tokens for agreement
Create personal access token for agreement
Delete personal access token
Refresh a personal access token
List files for a shop account
Upload file (deprecated multipart)
Redirect to file by id
Update shop file (deprecated multipart)
Delete shop file
Get file info
Redirect to file by type
Redirect to file by type
Presign upload URL
Finish file upload
Redirect to shop logo
Upload shop logo
List shop orders
Create shop order
Get shop order
Get time-bucketed order line quantity sums for a shop
List permission groups for a shop
Create permission group
Get permission group detail
Delete permission group
Fuzzy name search for permission groups
Replace permission group permissions
Attach user agreement to permission group
Detach user agreement from permission group
List products for a shop
Get shop activity map
Get shop reporting statistics
Scan type summary grouped by SKU
Get shop settings
Update shop settings
Get shop default voucher
Set shop default voucher
Delete shop default voucher
Get shop ordering settings
List vouchers for a shop
Create voucher
Get voucher
Delete voucher
List voucher batches
Create voucher batch
Get voucher batch
Delete voucher batch
Update voucher batch
Bulk add voucher codes
Pluck a voucher from a batch
Get voucher batch usage
List voucher pools
Create voucher pool
Get voucher pool
Delete voucher pool
List webhooks for a shop
Create webhook
Get webhook
Delete webhook
Update webhook
Partners Scope API
Overview
Operations
Get partner
Delete partner
Update partner
List partner agreements
Create partner agreement
Get partner agreement
Delete partner agreement
Patch partner agreement
Replace permissions for partner agreement
List personal access tokens for agreement
Create personal access token for agreement
Delete personal access token
Refresh a personal access token
List files for an account
Upload account file
Redirect to file by id
Update file (deprecated multipart upload)
Delete partner file
Get file info
Redirect to file by type
Get file by type and reference
Issue a presigned PUT URL for a throwaway upload key
Finish file upload
List partner locations
Create partner location
Get partner location
Delete partner location
Update partner location
List partner location stations
Create packaging station
Get partner location station
Delete partner location station
Update a packaging station
List packaging bundles for a station
List storage units for a station
Get stock at partner location
List storage units for a partner location
Create storage unit for partner location
Get storage unit
Delete storage unit
Update a storage unit
Add packaging bundle to storage unit
Remove packaging from storage unit
Bulk remove packaging from storage unit
Redirect to logo
Upload logo (deprecated multipart-free path)
List partner orders
Create partner order
Get partner order
Update partner order state
Fulfill order
Create order from storage unit
Get time-bucketed order quantity for partner
List partner packaging
Get partner packaging
Update packaging condition
Get packaging bundle
Delete packaging bundle
Create packaging bundle
Add barcodes to packaging bundle
Remove barcode from packaging bundle
Discard packaging
Lookup packaging by barcode
List permission groups for a partner
Create permission group
Get permission group detail
Delete permission group
Fuzzy name search for permission groups
Replace permission group permissions
Attach user agreement to permission group
Detach user agreement from permission group
List partner products
Update partner product
Activity map
Partner reporting statistics
List partner scans
Scan type summary grouped by SKU
Get partner ordering settings
Update partner ordering settings
Delete partner ordering settings
List partner storage unit templates
Create storage unit template
Get storage unit template
Delete storage unit template
Update storage unit template
List partner shops
Create shop for partner
Get partner shop
Delete partner shop
Update partner shop
Create volatile shop agreement
Delete volatile shop agreement
List shop assortment
Upsert shop assortment entry
Get shop assortment entry
Delete shop assortment
Update shop assortment
Get shop ordering settings
Update shop ordering settings
List webhooks for an account
Create webhook
Get webhook
Delete webhook
Update webhook
DropPoints Scope API
Overview
Operations
Create drop point
Get drop point
Delete drop point
Update drop point
List drop point agreements
Create drop point agreement
Get drop point agreement
Delete drop point agreement
Patch drop point agreement
Replace permissions for drop point agreement
List personal access tokens for agreement
Create personal access token for agreement
Delete personal access token
Refresh a personal access token
List drop point locations
Create drop point location
Get drop point location
Delete drop point location
Update drop point location
Update drop point settings
Get drop point location by barcode
Find nearby drop point locations
GitHub
Select theme
Dark
Light
Auto
OpenAPI Docs
Our OpenAPI definitions can be downloaded here
Me
Shops
DropPoints
Partners