How to use Commerce APIs
The Commerce APIs allow partners to create and fetch deals related to their customers with Zoom. Use these APIs to build an end-to-end customer management cycle by creating a deal pipeline, purchasing a product, getting the subscription details, and modifying them. You can also get billing information and generate a Zoom product catalog and price book. Learn how to get your credentials and create private or public applications in our Authorization Guide.
API Categories
Account Management
Account Management APIs help partners manage the end customer and generate more pipelines for the future, utilising the customers for future transactions. Use the Account APIs to extend Account Engagement and automate your workflows.
List of APIs:
| API Description | API Type |
|---|---|
| 1. Create an end-customer account. | POST |
| 2. Add contacts to an existing end customer, or your own account. | POST |
| 3. Get the list of all accounts associated with a Zoom partner or sub-reseller. | GET |
| 4. Get the account details for a Zoom partner, sub-reseller, and end customer. | GET |
Prerequisite
- Partner Authorization
Product Catalog
Product Catalog APIs enable partners to introduce and effectively manage Zoom portfolio of products that are relevant to customers, providing the lists of all the products along with their details. Use these APIs to make relevant product selection fast and accurate.
List of APIs:
| API Description | API Type |
|---|---|
| 1. Gets Zoom product catalog for a Zoom partner. | POST |
| 2. Gets the details for a product or offer ID. Each offer is identified by a unique ID. | GET |
| 3. Gets the price book in CSV or Excel format, including the list price and discounted price based on the partner type. | GET |
Prerequisite
- Partner Authorization
Deal Registration
Automate Deal registration workflows to incentivize yourself and reward partners for bringing in new business. Deal Registration APIs enable you to create & fetch product-specific deals for customers with Zoom.
List of APIs:
| API Description | API Type |
|---|---|
| 1. Create deal registration for a customer. | POST |
| 2. Get Zoom campaigns for a partner. | GET |
| 3. Gets all valid deal registrations for a partner. | GET |
| 4. Gets details for a deal registration by the deal registration number. | GET |
Prerequisite
- Partner Authorization
- Customer Account & Contact creation with Zoom
Orders
Orders APIs enable partners to create new purchases or place an order to modify an existing subscription for a customer. Use Orders APIs along with product APIs to place orders. Once the order is placed, a subscription is created or modified.
List of APIs:
| API Description | API Type |
|---|---|
| 1. Creates new subscription, trial, or amends a subscription or trial for a Zoom partner's end customers. | POST |
| 2. Gets the preview of order and subscriptions metrics for an order. | POST |
| 3. Gets all orders for a Zoom partner based on specified filters. | GET |
| 4. Gets order details by order number. | GET |
Prerequisite
- Partner Authorization
- Customer Account creation with Zoom
- Deal Registration creation is optional
Quote
Quote APIs allow partners to create new purchases or modify existing subscriptions for customers. After a quote is submitted to Zoom, it undergoes an approval process. Upon approval, partners can submit the quote for provisioning along with a Purchase Order. Partners can also use the quote API to negotiate additional discounts on the purchase.
List of APIs:
| API Description | API Type |
|---|---|
| 1. Creates new subscription, trial, or amends a subscription or trial for a Zoom partner's end customers. | POST |
| 2. Gets the preview of quote and subscription metrics for a Quote. | POST |
| 3. Gets all quotes for a Zoom partner based on specified filters. | GET |
| 4. Gets quote details by quote reference ID. | GET |
| 5. Update a quote by quote reference ID. | PATCH |
| 6. Submit an approved quote for provisioning. | PATCH |
Prerequisite
- Partner Authorization
- Customer Account creation with Zoom
- Deal Registration creation is optional
Upload/Download files
File APIs enable partners to upload and download files against quote & deal registrations.
List of APIs:
| API Description | API Type |
|---|---|
| 1. Download a file associated with a quote or deal registration. | GET |
| 2. Gets details of all files associated with a quote or deal registration. | GET |
| 3. Upload an attachment PDF file in the context of a deal registration or quote. | POST |
Prerequisite
- Partner Authorization
- Either Quote creation or Deal Registration creation with Zoom
Subscriptions
Subscription APIs are used to view the subscriptions details and list of subscription for a partner and customers.
List of APIs:
| API Description | API Type |
|---|---|
| 1. Gets a list of subscriptions for a distributor or a reseller. | GET |
| 2. Gets subscription details for a given subscription number. | GET |
| 3. Gets subscription changes or versions for a given subscription number. | GET |
Prerequisite
- Partner Authorization
- Provisioned order (Order status = Completed)
- Provisioned quote (Quote status = Completed)
Billing
Billing APIs are used to view the invoice and list of invoices associated with a partner and a customer.
List of APIs:
| API Description | API Type |
|---|---|
| 1. Gets all billing documents for a distributor or a reseller. | GET |
| 2. Gets the PDF document for the billing document ID. | GET |
| 3. Gets detailed information about a specific invoice for a distributor or a reseller. | GET |
Prerequisite
- Partner Authorization
- Active Subscription
- At least one month of the billing cycle is completed
How to register?
Distributors - The Internal Zoom Team will send an invitation email containing the registration link for the distributors. Distributors are required to complete the registration form by providing the necessary details and submit the application.
Sub-Reseller - Distributors have the option to send an invitation to their sub-resellers through the partner portal by navigating to Profile > Partner Invite. Distributors are required to complete the form details and submit the application. Sub-resellers will then be sent an invitation email containing a registration link. Upon clicking the link, they can proceed to fill in the necessary information and submit their application.
Reseller - Resellers can register themselves by submitting the application.