Packages Object

Attributes
idstringRead-onlyformat GUID
Package ID.

accountIdstringRead-onlyformat GUID
Wix account ID. See Account Level APIs for more details.

externalIdstringmaxLength 100
External reference. For example, an external subscription ID. This field isn't validated by Wix. Max: 100 characters

productInstancesArray <ProductInstance>maxItems 1000minItems 1
Product instances that are included in the package. Min: 1 product instance Max: 1000 product instances

createdDatestringRead-onlyformat date-time
Date and time the package was created.

updatedDatestringRead-onlyformat date-time
Date and time the package was last updated.
Was this helpful?
Yes
No

PostCreate Package V2

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a package of product instances.

You must pass the relevant Wix account ID in the header of the call. In the DIY flow, we recommend to pass the customer's sub-account ID instead of your main reseller account ID.

You may also pass a Wix site ID for each product in the body of the call. If you omit the site ID, a floating product instance is created.

When Wix customers purchase a specific paid service or product, Wix may offer them time-limited free access to a different product. For example, customers get a voucher for a free 1-year domain registration when purchasing any Wix Premium plan. If you want to offer your customers the same benefit, create a package containing the original product first. Then, create a second package with the additional product. In the second Create Package call, pass the instance ID of the original product as referenceProductInstanceId. This way, Wix doesn't charge you for the additional product. Make sure that the status of the referenced product is either "PENDING" or "ACTIVE". Note that you can use each product instance only a single time as reference instance.

You need to pass a countryCode to specify where customers can claim vouchers that may come with a product. Contact the Wix B2B sales team to get information about vouchers and supported locations.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Reseller Packages
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/resellers/v2/packages

Was this helpful?
Yes
No

GetGet Package

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a package.

You must pass the ID of the Wix account that the package belongs to in the header of the call. The call fails, if the package and Wix account don't match.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Reseller Packages
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/resellers/v1/packages/{id}

Was this helpful?
Yes
No

DeleteCancel Package

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Cancels all product instances included in the package and the customer immediately looses access to the canceled functionality.

You must pass the ID of the Wix account that the package belongs to in the header of the call. The call fails, if the package and Wix account don't match.

If a canceled product instance is a requirement for another Wix service, that functionality is also no longer available to the customer. For example, if you cancel a Premium plan, a previously connected domain is automatically disconnected from the site.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Reseller Packages
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
DELETE
https://www.wixapis.com/resellers/v1/packages/{id}

Was this helpful?
Yes
No

PostQuery Packages

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of packages, given the provided paging, filtering, and sorting.

You must pass the ID of the Wix account that the packages belong to in the header of the call. The call returns packages that belong to the parent account, regardless if you pass the ID of a parent or sub-account. In case you want to retrieve only packages that belong to a sub-account, you must pass the sub-account ID as filter in the query object like this:

Copy
1
{
2
"query": {
3
"filter": {
4
"accountId": {
5
"$eq": "<SUB_ACCOUNT_ID>"
6
}
7
}
8
}
9
}

Query Packages runs with these defaults, which you can override:

  • createdDate is sorted in DESC order
  • cursorPaging.limit is 100

By default pagingMetadata.cursors are returned, unless you specifically pass query.paging.

The maximum for cursorPaging.limit is 100.

If you pass a cursor token that you have received in a previous Query Package response, passing additional sort or filter information results in an invalid cursor error. Since the received cursor token already holds all the needed information for sort and filter. Changing the sort and filter properties during the span of a cursor query isn't supported. But you can provide a different limit.

For field support for filters and sorting, see Query Packages: Supported Filters and Sorting.

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Reseller Packages
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/resellers/v1/packages/query

Was this helpful?
Yes
No

PatchAssign Product Instance To Site

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Assigns a product instance to a site.

You must pass the ID of the Wix account that the product instance belongs to in the header of the call.

The customer immediately gains access to features included in the assigned service. It's up to the reseller to decide whether assigning a product instance affects the customer’s payment.

It's possible to assign a product instance that's already assigned to a site, to a different site without unassigning it first. But if the call fails in such a situation, the product instance may either remain assigned to the original site or become unassigned. You can confirm the instance's status by retrieving the relevant package.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Reseller Packages
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
PATCH
https://www.wixapis.com/resellers/v1/packages/product-instances/{instanceId}/{siteId}

Was this helpful?
Yes
No

PatchUnassign Product Instance From Site

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Unassigns a product instance from a site.

You must pass the ID of the Wix account that the product instance belongs to in the header of the call.

The product instance becomes floating and the customer immediately looses access to features included in the unassigned service. It's up to the reseller to decide whether unassigning a product instance affects the customer’s payment.

If an unassigned product instance is a requirement for another service, that service may not be available to the customer any longer. For example, if you unassign a Combo Plan plan from a site, a previously connected domain is disconnected.

You can assign floating product instances to sites using the Assign Product Instance to Site endpoint.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Reseller Packages
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
PATCH
https://www.wixapis.com/resellers/v1/packages/product-instances/{instanceId}/unassign

Was this helpful?
Yes
No

DeleteCancel Product Instance

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Cancels a product instance.

You must pass the ID of the Wix account that the product instance belongs to in the header of the call. The call fails, if the product instance and Wix account don't match.

The customer immediately looses access to features included in the canceled service. It's up to the reseller to decide whether the adjustment affects the customer’s payment.

If a canceled service is a requirement for another service, that service may not be available to the customer any longer. For example, if you cancel a Combo Plan plan, a previously connected domain is disconnected from the site.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Reseller Packages
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
DELETE
https://www.wixapis.com/resellers/v1/packages/product-instances/{instanceId}

Was this helpful?
Yes
No

PatchAdjust Product Instance Specifications

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Upgrades or downgrades a product instance. For example, you can upgrade a customer's Business Unlimited Premium plan to Business VIP using this endpoint.

You must pass the ID of the Wix account that the product instance belongs to in the header of the call. The call fails, if the product instance and Wix account don't match.

The customer has immediate access to new features, while loosing access to features not included in the new service. It's up to the reseller to decide whether the adjustment affects the customer’s payment.

You can only exchange a product instance with a service of the same type. Contact the Wix B2B sales team for details about which services belong to the same type.

You must provide either a new catalogProductId or a new billingInfo object. The new billing cycle must be supported for the product. Contact the Wix B2B sales team for information about which billing cycles are supported for each product. If you adjust the billing cycle for a product instance with RECURRING payments, you must also provide billingInfo.cycleDuration.unit.

If a removed feature is a requirement for another service, that service may not be available to the customer any longer. For example, if you downgrade a Business Unlimited plan to Business Basic, the site owners won’t be able to use Pro eCommerce Features any longer.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Reseller Packages
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
PATCH
https://www.wixapis.com/resellers/v1/packages/product-instances/{instanceId}

Was this helpful?
Yes
No