Synnex actions & endpoints
Last updated
Was this helpful?
Last updated
Was this helpful?
The Synnex Au Integration with Rewst delivers a robust set of actions and endpoints for interacting with Synnex Au. Below is a summary of each section, highlighting the diverse capabilities and opportunities provided through the Synnex Au Integration:
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/microsoft/checkDomainAvailability
Validates if the specified Domain is available with Microsoft.Specify the domain within the Identifier parameter of the Payload
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/microsoft/azureSubscription/suspend
Suspending AzureSubscription By using MicrosoftSubscriptionResource Object
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/bulkOrder
Allows provisioning multiple offers for same or different customers in single order. Order will be split and unique order will be generated for each offer.
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/microsoft/azureSubscription/activate
Reactivate AzureSubscription By using MicrosoftSubscriptionResponseResource object
GET api-stage.synnexb2b.com.aucloud-products/v1/marketplace/orders
Lists all the cloud orders. Can be filtered by order id, order code, created Date, Service Id and customer code.
GET api-stage.synnexb2b.com.aucloud-products/v1/marketplace/subscription/subscriptionsByAccountId/{accountId}
Get Subscriptions by providing AccountId.This API accepts Account Identifier and returns the Subscriptions under the specific account. Use sortDirection in association with sortColumnName to sort results in appropriate direction
GET api-stage.synnexb2b.com.aucloud-products/v1/marketplace/subscription/{id}
Get Subscription Details by providing SubscriptionId.This API accepts Subscription Identifier and returns the Subscription details. Use sortDirection in association with sortColumnName to sort results in appropriate direction
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/cloudAccount
Fetch list of cloud Accounts
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/microsoft/convertTrailToPaid/subscription?subscriptionId={subscriptionId}&serviceId={serviceId}
Use this API to fetch convert trial to paid offer plans. Get the subscriptionId Refer 'subscriptionId' response in Get Subscription
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/microsoft/convertTrailToPaid/subscription
Use this API to convert trial to paid. To convert paid customer's subscription, Get the subscriptionId Refer 'subscriptionId' response in Get subscriptions
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/microsoft/purchaseAddon
Purchase Microsoft Addon Plans for a base subscription.The API accepts Plan Identifier given by Get product plans
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/microsoft/subscription/autoRenewal
Use this API to enable or disable Auto Renewal of Microsoft CSP Subscription on renewal date.To fetch X-CUSTOMER-KEY - Refer “externalCustomerCompanyCode” parameter in Get customer companies
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/microsoft/subscription/cancel
Cancel the specified subscription of Microsoft.The API accepts Subscription Identifier and optionally the reason for the Cancel subscription and returns the updated status.
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/microsoft/subscription/changeQuantity
Change quantity/seats for the selected subscriptions.Get the subscriptionId Refer 'subscriptionId' response Get subscriptions
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/migration/create
Use this API to perform Create migration. Legacy subscriptions do not need to be moved to the new commerce experience, They will operate under all the original legacy commerce rules until they come to the end of their term.
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/migration/legacyplan?subscriptionId={subscriptionId}
Use this API to fetch Legacy Subscription plan providing SubscriptionId.
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/migration/validate?subscriptionId={subscriptionId}
Use this API to fetch NCE Plans providing SubscriptionId.Get the subscriptionId Refer 'subscriptionId' response in Get subscriptions
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/microsoft/subscription/suspend
Suspends the specified subscription of Microsoft.The API accepts Subscription Identifier and optionally the reason for the suspending subscription and returns the updated status.
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/microsoft/subscription/deletemanagerenewal
Use this API to delete Auto Renewal of Microsoft CSP Subscription.To fetch X-CUSTOMER-KEY - Refer “externalCustomerCompanyCode” parameter in Get customer companies
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/microsoft/subscription/activate
Activates the specified subscription of Microsoft.The API accepts Subscription Identifier and returns the updated status.
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/customerCompany
Use this API to create new End Customer
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/customerCompany
Lists all the customers and their details
GET api-stage.synnexb2b.com.au/<url_path>
Generic action for making authenticated requests against the Synnex Australia API
PUT api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/subscription/changeQuantity
Changes existing Subscription quantity. Accepts MicrosoftSubscriptionResource object for request.
PUT api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/subscription/suspend
Suspends and active. Accepts MicrosoftSubscriptionResource object as request.
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/changeRenewalSettings
Updates Renewal settings of an active subscription. Accepts ChangeRenewalSettingsResource object as request
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/checkDomainAvailability?customerDomain={customerDomain}&serviceId={serviceId}
Checks if the provided Domain is available for the purchase.
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/downgrade/changeOffer
Downgrades the existing offer for an active subscription. Accepts GoogleChangeOfferResource object as request.
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/downgrade/purchasablesku
Lists all the purchasable SKUs for downgrade for an existing active subscription.
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/startPaidService
Upgrades subscriptions from Trial to paid.
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/transfer
Transfers customer and their existing entitlements for transfer types Google Direct, Different Reseller and My own PSC
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/trasferir1toir2
Transfers the customers and their existing entitlements for transfer type Indirect Reseller 1 to Indirect Reseller 2
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/upgrade/purchasablesku
Lists all the purchasable SKUs for upgrade for an existing active subscription.
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/purchaseAddon
Places an order to purchase addon plans for an existing subscription.
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/purchasableoffers
Lists all the offers that can be changed for the existing subscription under the specified SKU.
POST api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/changeOffer
Upgrades the existing offer for an active subscription. Accepts GoogleChangeEntitlementResource object as request.
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/productPlan/addonPlans
Lists all the addon plans that are available for the purchase for an existing subscription's plan.
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/getOffersByPlanName
Lists all the offers for changing payment plan under the Plan/SKU for an existing active subscription.
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/transfer/import
Imports customer for Transfer of any transfer type and returns all transferable SKUs for the imported customer.
PUT api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/googleworkspace/subscription/activate
Activates suspended Subscription. Accepts MicrosoftSubscriptionResource object as request.
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/products
Use this API to fetch list of products available for provisioning.Products can be filtered based on Service Provider using ServiceId.Use “startingPlan” section to identify price for plan with minimum configuration
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/products/{productId}/plans
Use this API to fetch all the plans for a product.
GET api-stage.synnexb2b.com.au/cloud-products/v1/marketplace/services
Provides list of cloud Service Providers available within Synnex Cloud Platform.