W3Block Docs
  • 🚀Start here
    • Welcome to the Docs
    • Integrated Blockchains
  • 👨‍💻Dev Docs
    • API
      • Getting Started
      • Authentication
      • Commerce API services
        • Company Administration
          • Companies (Admin)
          • Assets (Admin)
          • Tags (Admin)
          • Products (Admin)
            • Order Rules (Admin)
          • Orders (Admin)
          • Faq (Admin)
          • Webhooks (Admin)
        • Products
        • Orders
        • Webhooks
        • Faq
        • Globals
      • Key API Services
        • Authentication
        • Companies
        • Tokens
          • Contracts
            • External Contacts
            • Royalty Eligible
          • Categories
            • Subcategories
          • Token Collections
            • Token Editions
          • Metadata
        • Blockchain
        • Cloudinary
        • Integration
          • Ecommerce
            • Associate Tokens
            • Hooks
        • Users
        • Vouchers
  • 📘Knowledge Base
    • First Steps
    • FAQ
    • Glossary
Powered by GitBook
On this page
  1. Dev Docs
  2. API
  3. Key API Services

Vouchers

PreviousUsersNextFirst Steps

Last updated 2 years ago

👨‍💻
delete
Authorizations
Path parameters
idstringrequired
companyIdstringrequired
Responses
delete
curl -L \
  --request DELETE \
  --url '/{companyId}/vouchers/{id}' \
  --header 'x-w3block-api-key: YOUR_API_KEY'
401
No Content

Need user with one of these roles: superAdmin, admin

get
Authorizations
Path parameters
companyIdstringrequired
codestringrequired
Responses
get
curl -L \
  --url '/{companyId}/vouchers/{code}' \
  --header 'x-w3block-api-key: YOUR_API_KEY'
200
401
No Content
  • GET/{companyId}/vouchers
  • POST/{companyId}/vouchers
  • DELETE/{companyId}/vouchers/{id}
  • GET/{companyId}/vouchers/{code}
  • POST/{companyId}/vouchers/redeem
get
Authorizations
Path parameters
companyIdstringrequired
Query parameters
pagenumberoptionalDefault: 1
limitnumberoptionalDefault: 10
searchstringoptional
sortBystringoptional
orderBystring · enumoptionalDefault: DESCAvailable options:
enabledbooleanoptional
startDatestringoptionalExample: 2022-07-20T23:59:59.000Z
endDatestringoptionalExample: 2022-07-20T23:59:59.000Z
Responses
get
curl -L \
  --url '/{companyId}/vouchers' \
  --header 'x-w3block-api-key: YOUR_API_KEY'
401
No Content

Need user with one of these roles: superAdmin, admin

post
Authorizations
Path parameters
companyIdstringrequired
Body
codestringoptional
amountnumberoptionalDefault: 1
limitPerUsernumberoptionalDefault: 1
userIdstringoptional
whitelistIdstringoptional
tokenCollectionsobject[]required

startDatestringoptionalExample: 2022-07-20T23:59:59.000Z
endDatestringoptionalExample: 2022-07-20T23:59:59.000Z
Responses
post
curl -L \
  --request POST \
  --url '/{companyId}/vouchers' \
  --header 'x-w3block-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "text",
    "amount": 1,
    "limitPerUser": 1,
    "userId": "text",
    "whitelistId": "text",
    "tokenCollections": [
      {
        "tokenCollectionId": "123e4567-e89b-12d3-a456-426614174000",
        "tokenEditionIds": [
          []
        ]
      }
    ],
    "startDate": "2022-07-20T23:59:59.000Z",
    "endDate": "2022-07-20T23:59:59.000Z"
  }'
401
No Content

Need user with one of these roles: superAdmin, admin

post
Authorizations
Path parameters
companyIdstringrequired
Body
codestringrequired
userIdstringrequired
Responses
post
curl -L \
  --request POST \
  --url '/{companyId}/vouchers/redeem' \
  --header 'x-w3block-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "text",
    "userId": "text"
  }'
201
401
No Content