> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetPackage # Package: resellers # Namespace: Packages # Method link: https://dev.wix.com/docs/api-reference/account-level/resellers/packages-and-product-instances/get-package.md ## Introduction 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. --- ## REST API ### Schema ``` Method: getPackage Description: Retrieves a package. You must pass the GUID 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. URL: https://www.wixapis.com/resellers/v1/packages/{id} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: id Method parameters: param name: id | type: none | required: true Return type: GetPackageResponse - name: package | type: Package | description: Retrieved package. - name: id | type: string | description: Package GUID. - name: accountId | type: string | description: Wix account GUID. See [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis.md) for more details. - name: externalId | type: string | description: External reference. For example, an external subscription GUID. This field isn't validated by Wix. Max: 100 characters - name: productInstances | type: array | description: Product instances that are included in the package. Min: 1 product instance Max: 1000 product instances - ONE-OF: - name: billingInfo | type: Cycle | description: Billing information for the contract between the reseller and Wix. - name: type | type: CycleDescriptorType | description: Payment type. - enum: - ONE_TIME: The reseller pays Wix in a single payment. - RECURRING: The reseller pays Wix on a recurring schedule. - name: cycleDuration | type: Interval | description: Duration of the billing cycle. Available only for `RECURRING` payments. - name: unit | type: IntervalUnit | description: Unit of the billing cycle. - enum: - DAY: Day - WEEK: Week - MONTH: Month - YEAR: Year - name: count | type: integer | description: Count of units that make up the billing cycle. - name: instanceId | type: string | description: GUID of the instance of the resold Wix service. **Note:** Differs from the `catalogProductId`. Allows you to identify different instances of the same product in a package. - name: siteId | type: string | description: GUID of the Wix site that the product instance is assigned to. See the [Query Sites API](https://dev.wix.com/api/rest/account-level-apis/sites/query-sites) for more information. - name: catalogProductId | type: string | description: Product GUID, as defined in the Wix Premium Product Catalog. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more details about available Wix services. - name: status | type: Status | description: Status of the product instance. - enum: - PENDING: The product instance isn't yet available to the customer. - ENABLED: The customer can use the product instance. - CANCELED: The product instance isn't any longer available to the customer. - FAILED: The product instance couldn't be delivered successfully and has never been available to the customer. - AWAITING_ACTION: The product instance isn't yet available to the customer, because an external provider or the customer must take an action. - name: failure | type: FailureReason | description: Failure object. Only present for status `FAILED`. Describes why the product instance `FAILED`. - name: code | type: FailureReasonCode | description: Failure code. - enum: - DELIVERY_TIMEOUT: The product instance couldn't be created because the Resellers API timed out. - EXTERNAL_FAILURE: The product instance couldn't be created because an external process failed. - name: message | type: string | description: Failure message. - name: createdDate | type: string | description: Date and time the product instance was created. - name: updatedDate | type: string | description: Date and time the product instance was last updated. - name: countryCode | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. Specifies where customers can claim vouchers that may come with the product. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) to get more information about vouchers and supported locations. - name: expirationDate | type: string | description: Date and time the product instance expires in `YYYY-MM-DDThh:mm:ss.sssZ` format. Used only for instances that don't auto renew at the end of the current billing cycle. - name: discountCode | type: string | description: Discount code indicating that the reseller provisioned the product instance during a sale. Wix doesn't guarantee that a discount code reduces the price between Wix and the reseller, even when it's valid. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more information. Max: 25 characters - name: referenceProductInstanceId | type: string | description: GUID of a different product instance that you can use to offer your customers time-limited free access to an additional product or service. For example, Wix offers a 1-year free domain registration to all customers who purchase a Premium plan. The referenced product instance must have either status `"PENDING"` or `"ACTIVE"`. You can use each product instance only a single time as reference instance. - name: createdDate | type: string | description: Date and time the package was created. - name: updatedDate | type: string | description: Date and time the package was last updated. ``` ### Examples ### Retrieve a package ```curl curl -X GET \ 'https://www.wixapis.com/resellers/v1/packages/828b98fb-7114-4b3c-90fd-8d0db76aa72b' \ -H 'wix-account-id: ' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.resellers.Packages.getPackage(_id) Description: Retrieves a package. You must pass the GUID 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. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: _id Method parameters: param name: _id | type: string | description: Package GUID. | required: true Return type: PROMISE - name: _id | type: string | description: Package GUID. - name: accountId | type: string | description: Wix account GUID. See [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis.md) for more details. - name: externalId | type: string | description: External reference. For example, an external subscription GUID. This field isn't validated by Wix. Max: 100 characters - name: productInstances | type: array | description: Product instances that are included in the package. Min: 1 product instance Max: 1000 product instances - ONE-OF: - name: billingInfo | type: Cycle | description: Billing information for the contract between the reseller and Wix. - name: type | type: CycleDescriptorType | description: Payment type. - enum: - ONE_TIME: The reseller pays Wix in a single payment. - RECURRING: The reseller pays Wix on a recurring schedule. - name: cycleDuration | type: Interval | description: Duration of the billing cycle. Available only for `RECURRING` payments. - name: unit | type: IntervalUnit | description: Unit of the billing cycle. - enum: - DAY: Day - WEEK: Week - MONTH: Month - YEAR: Year - name: count | type: integer | description: Count of units that make up the billing cycle. - name: instanceId | type: string | description: GUID of the instance of the resold Wix service. **Note:** Differs from the `catalogProductId`. Allows you to identify different instances of the same product in a package. - name: siteId | type: string | description: GUID of the Wix site that the product instance is assigned to. See the [Query Sites API](https://dev.wix.com/api/rest/account-level-apis/sites/query-sites) for more information. - name: catalogProductId | type: string | description: Product GUID, as defined in the Wix Premium Product Catalog. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more details about available Wix services. - name: status | type: Status | description: Status of the product instance. - enum: - PENDING: The product instance isn't yet available to the customer. - ENABLED: The customer can use the product instance. - CANCELED: The product instance isn't any longer available to the customer. - FAILED: The product instance couldn't be delivered successfully and has never been available to the customer. - AWAITING_ACTION: The product instance isn't yet available to the customer, because an external provider or the customer must take an action. - name: failure | type: FailureReason | description: Failure object. Only present for status `FAILED`. Describes why the product instance `FAILED`. - name: code | type: FailureReasonCode | description: Failure code. - enum: - DELIVERY_TIMEOUT: The product instance couldn't be created because the Resellers API timed out. - EXTERNAL_FAILURE: The product instance couldn't be created because an external process failed. - name: message | type: string | description: Failure message. - name: _createdDate | type: Date | description: Date and time the product instance was created. - name: _updatedDate | type: Date | description: Date and time the product instance was last updated. - name: countryCode | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. Specifies where customers can claim vouchers that may come with the product. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) to get more information about vouchers and supported locations. - name: expirationDate | type: Date | description: Date and time the product instance expires in `YYYY-MM-DDThh:mm:ss.sssZ` format. Used only for instances that don't auto renew at the end of the current billing cycle. - name: discountCode | type: string | description: Discount code indicating that the reseller provisioned the product instance during a sale. Wix doesn't guarantee that a discount code reduces the price between Wix and the reseller, even when it's valid. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more information. Max: 25 characters - name: referenceProductInstanceId | type: string | description: GUID of a different product instance that you can use to offer your customers time-limited free access to an additional product or service. For example, Wix offers a 1-year free domain registration to all customers who purchase a Premium plan. The referenced product instance must have either status `"PENDING"` or `"ACTIVE"`. You can use each product instance only a single time as reference instance. - name: _createdDate | type: Date | description: Date and time the package was created. - name: _updatedDate | type: Date | description: Date and time the package was last updated. ``` ### Examples ### Get a package with an API key ```javascript import { createClient, ApiKeyStrategy } from "@wix/sdk"; import { packages } from "@wix/packages"; const wixClient = createClient({ modules: { packages }, auth: ApiKeyStrategy({ apiKey: "MY-API-KEY", }), }); async function getPackage(id) { const response = await packages.getPackage(id); } ``` ### getPackage (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { packages } from '@wix/packages'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { packages }, // Include the auth strategy and host as relevant }); async function getPackage(_id) { const response = await myWixClient.packages.getPackage(_id); }; ``` ---