GET v1/BusinessEntity/{businessEntityUid}/Products/ProductVariants/{productVariantId}

Request Information

URI Parameters

Name	Description	Type	Additional information
businessEntityUid		string	Required
productVariantId		integer	Required

Body Parameters

None.

Response Information

Resource Description

Mindbody.Contracts.Products.Models.Products.Edit.ProductVariant

Name	Type	Additional information
Id	integer	Required
SubscriberVariantIds	Collection of integer	None.
ActivateAllSites	boolean	None.
Discontinue	boolean	None.
ColorId	integer	None.
SizeId	integer	None.
Barcode	string	Max length: 50
ActiveLocations	Collection of string	None.
ImageGuid	globally unique identifier	None.
SupplierId	integer	None.
RevCategoryId	integer	None.
RevSubCategoryId	integer	None.
RevCategorySecondaryId	integer	None.
StandardCommission	Mindbody.Contracts.Products.Models.Products.CommissionInformation	None.
PromotionalCommission	Mindbody.Contracts.Products.Models.Products.CommissionInformation	None.
RetailPrice	decimal number	Range: inclusive between 0 and 9999999.99
WholesaleCost	decimal number	Range: inclusive between 0 and 9999999.99
EnabledTaxRates	Collection of boolean	None.
OnlineInfo	Mindbody.Contracts.Products.Models.Products.OnlineInformation	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "SubscriberVariantIds": [
    1,
    2
  ],
  "ActivateAllSites": true,
  "Discontinue": true,
  "ColorId": 1,
  "SizeId": 1,
  "Barcode": "sample string 3",
  "ActiveLocations": [
    "sample string 1",
    "sample string 2"
  ],
  "ImageGuid": "b3058295-b5da-43e8-93d3-ad507148d141",
  "SupplierId": 1,
  "RevCategoryId": 1,
  "RevSubCategoryId": 1,
  "RevCategorySecondaryId": 1,
  "StandardCommission": {
    "CommissionRateType": "Flat",
    "CommissionValue": 1.0,
    "UseStaffPayRate": true
  },
  "PromotionalCommission": {
    "CommissionRateType": "Flat",
    "CommissionValue": 1.0,
    "UseStaffPayRate": true
  },
  "RetailPrice": 1.0,
  "WholesaleCost": 1.0,
  "EnabledTaxRates": [
    true,
    true
  ],
  "OnlineInfo": {
    "Enabled": true,
    "Price": 1.0,
    "Description": "sample string 1",
    "ShippingWeight": 1.0
  }
}

application/xml, text/xml

Sample:

<ProductVariant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="Mindbody.Contract.Products">
  <EnabledTaxRates xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:boolean>true</d2p1:boolean>
    <d2p1:boolean>true</d2p1:boolean>
  </EnabledTaxRates>
  <EnabledTaxRatesRequested>true</EnabledTaxRatesRequested>
  <ImageGuid>b3058295-b5da-43e8-93d3-ad507148d141</ImageGuid>
  <ImageGuidRequested>true</ImageGuidRequested>
  <OnlineInfo>
    <Description>sample string 1</Description>
    <Enabled>true</Enabled>
    <Price>1</Price>
    <ShippingWeight>1</ShippingWeight>
  </OnlineInfo>
  <OnlineInfoRequested>true</OnlineInfoRequested>
  <PromotionalCommission>
    <CommissionRateType>Flat</CommissionRateType>
    <CommissionValue>1</CommissionValue>
    <UseStaffPayRate>true</UseStaffPayRate>
  </PromotionalCommission>
  <PromotionalCommissionRequested>true</PromotionalCommissionRequested>
  <RetailPrice>1</RetailPrice>
  <RevCategoryId>1</RevCategoryId>
  <RevCategorySecondaryId>1</RevCategorySecondaryId>
  <RevCategorySecondaryIdRequested>true</RevCategorySecondaryIdRequested>
  <RevSubCategoryId>1</RevSubCategoryId>
  <RevSubCategoryIdRequested>true</RevSubCategoryIdRequested>
  <StandardCommission>
    <CommissionRateType>Flat</CommissionRateType>
    <CommissionValue>1</CommissionValue>
    <UseStaffPayRate>true</UseStaffPayRate>
  </StandardCommission>
  <StandardCommissionRequested>true</StandardCommissionRequested>
  <SupplierId>1</SupplierId>
  <SupplierIdRequested>true</SupplierIdRequested>
  <WholesaleCost>1</WholesaleCost>
  <WholesaleCostRequested>true</WholesaleCostRequested>
  <ActiveLocations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ActiveLocations>
  <Barcode>sample string 3</Barcode>
  <BarcodeRequested>true</BarcodeRequested>
  <ColorId>1</ColorId>
  <SizeId>1</SizeId>
  <ActivateAllSites>true</ActivateAllSites>
  <Discontinue>true</Discontinue>
  <Id>1</Id>
  <SubscriberVariantIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SubscriberVariantIds>
</ProductVariant>

multipart/form-data

Sample:

<ProductVariant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="Mindbody.Contract.Products"><EnabledTaxRates xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"><d2p1:boolean>true</d2p1:boolean><d2p1:boolean>true</d2p1:boolean></EnabledTaxRates><EnabledTaxRatesRequested>true</EnabledTaxRatesRequested><ImageGuid>b3058295-b5da-43e8-93d3-ad507148d141</ImageGuid><ImageGuidRequested>true</ImageGuidRequested><OnlineInfo><Description>sample string 1</Description><Enabled>true</Enabled><Price>1</Price><ShippingWeight>1</ShippingWeight></OnlineInfo><OnlineInfoRequested>true</OnlineInfoRequested><PromotionalCommission><CommissionRateType>Flat</CommissionRateType><CommissionValue>1</CommissionValue><UseStaffPayRate>true</UseStaffPayRate></PromotionalCommission><PromotionalCommissionRequested>true</PromotionalCommissionRequested><RetailPrice>1</RetailPrice><RevCategoryId>1</RevCategoryId><RevCategorySecondaryId>1</RevCategorySecondaryId><RevCategorySecondaryIdRequested>true</RevCategorySecondaryIdRequested><RevSubCategoryId>1</RevSubCategoryId><RevSubCategoryIdRequested>true</RevSubCategoryIdRequested><StandardCommission><CommissionRateType>Flat</CommissionRateType><CommissionValue>1</CommissionValue><UseStaffPayRate>true</UseStaffPayRate></StandardCommission><StandardCommissionRequested>true</StandardCommissionRequested><SupplierId>1</SupplierId><SupplierIdRequested>true</SupplierIdRequested><WholesaleCost>1</WholesaleCost><WholesaleCostRequested>true</WholesaleCostRequested><ActiveLocations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></ActiveLocations><Barcode>sample string 3</Barcode><BarcodeRequested>true</BarcodeRequested><ColorId>1</ColorId><SizeId>1</SizeId><ActivateAllSites>true</ActivateAllSites><Discontinue>true</Discontinue><Id>1</Id><SubscriberVariantIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:int>1</d2p1:int><d2p1:int>2</d2p1:int></SubscriberVariantIds></ProductVariant>