POST v1/BusinessEntity/{businessEntityUid}/Products/ProductVariants/Search

Request Information

URI Parameters

Name	Description	Type	Additional information
businessEntityUid		string	Required

Body Parameters

Mindbody.Contracts.Products.Models.Search.Request.ProductVariantSearchRequest

Name	Type	Additional information
From	integer	None.
Size	integer	None.
Filter	Mindbody.Contracts.Products.Models.Search.Request.ProductSearchRequestFilter	None.
ProductName	string	None.
VariantName	string	None.
SortBy	string	None.
IsAscending	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "From": 1,
  "Size": 2,
  "Filter": {
    "Prefix": "sample string 1",
    "Terms": [
      "sample string 1",
      "sample string 2"
    ],
    "Territories": [
      {
        "Name": "sample string 1",
        "Subscribers": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "Name": "sample string 1",
        "Subscribers": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "ProductRevenueCategories": [
      {
        "Name": "sample string 1",
        "RevenueSubcategories": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "Name": "sample string 1",
        "RevenueSubcategories": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "Suppliers": [
      "sample string 1",
      "sample string 2"
    ],
    "IncludeDiscontinued": true,
    "SubscriberIdList": [
      1,
      2
    ],
    "TerritoryIdList": [
      1,
      2
    ],
    "LocationIdList": [
      1,
      2
    ]
  },
  "ProductName": "sample string 3",
  "VariantName": "sample string 4",
  "SortBy": "sample string 5",
  "IsAscending": true
}

application/xml, text/xml

Sample:

<ProductVariantSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contracts.Products.Models.Search.Request">
  <Filter>
    <IncludeDiscontinued>true</IncludeDiscontinued>
    <LocationIdList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </LocationIdList>
    <Prefix>sample string 1</Prefix>
    <ProductRevenueCategories>
      <SearchProductRevenueCategory>
        <Name>sample string 1</Name>
        <RevenueSubcategories xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </RevenueSubcategories>
      </SearchProductRevenueCategory>
      <SearchProductRevenueCategory>
        <Name>sample string 1</Name>
        <RevenueSubcategories xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </RevenueSubcategories>
      </SearchProductRevenueCategory>
    </ProductRevenueCategories>
    <SubscriberIdList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </SubscriberIdList>
    <Suppliers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Suppliers>
    <Terms xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Terms>
    <Territories xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mindbody.Contracts.Products.Models.Search">
      <d3p1:SearchTerritory>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Subscribers xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:Subscribers>
      </d3p1:SearchTerritory>
      <d3p1:SearchTerritory>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Subscribers xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:Subscribers>
      </d3p1:SearchTerritory>
    </Territories>
    <TerritoryIdList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </TerritoryIdList>
  </Filter>
  <From>1</From>
  <IsAscending>true</IsAscending>
  <ProductName>sample string 3</ProductName>
  <Size>2</Size>
  <SortBy>sample string 5</SortBy>
  <VariantName>sample string 4</VariantName>
</ProductVariantSearchRequest>

multipart/form-data

Sample:

<ProductVariantSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contracts.Products.Models.Search.Request"><Filter><IncludeDiscontinued>true</IncludeDiscontinued><LocationIdList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:int>1</d3p1:int><d3p1:int>2</d3p1:int></LocationIdList><Prefix>sample string 1</Prefix><ProductRevenueCategories><SearchProductRevenueCategory><Name>sample string 1</Name><RevenueSubcategories xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d5p1:string>sample string 1</d5p1:string><d5p1:string>sample string 2</d5p1:string></RevenueSubcategories></SearchProductRevenueCategory><SearchProductRevenueCategory><Name>sample string 1</Name><RevenueSubcategories xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d5p1:string>sample string 1</d5p1:string><d5p1:string>sample string 2</d5p1:string></RevenueSubcategories></SearchProductRevenueCategory></ProductRevenueCategories><SubscriberIdList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:int>1</d3p1:int><d3p1:int>2</d3p1:int></SubscriberIdList><Suppliers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:string>sample string 1</d3p1:string><d3p1:string>sample string 2</d3p1:string></Suppliers><Terms xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:string>sample string 1</d3p1:string><d3p1:string>sample string 2</d3p1:string></Terms><Territories xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mindbody.Contracts.Products.Models.Search"><d3p1:SearchTerritory><d3p1:Name>sample string 1</d3p1:Name><d3p1:Subscribers xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d5p1:string>sample string 1</d5p1:string><d5p1:string>sample string 2</d5p1:string></d3p1:Subscribers></d3p1:SearchTerritory><d3p1:SearchTerritory><d3p1:Name>sample string 1</d3p1:Name><d3p1:Subscribers xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d5p1:string>sample string 1</d5p1:string><d5p1:string>sample string 2</d5p1:string></d3p1:Subscribers></d3p1:SearchTerritory></Territories><TerritoryIdList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:int>1</d3p1:int><d3p1:int>2</d3p1:int></TerritoryIdList></Filter><From>1</From><IsAscending>true</IsAscending><ProductName>sample string 3</ProductName><Size>2</Size><SortBy>sample string 5</SortBy><VariantName>sample string 4</VariantName></ProductVariantSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Mindbody.Contracts.Products.Models.Search.Response.VariantSearchResult

Name	Description	Type	Additional information
Total		integer	None.
Variants		Collection of Mindbody.Contracts.Products.Models.Search.Response.SearchVariant	None.

Response Formats

application/json, text/json

Sample:

{
  "Total": 1,
  "Variants": [
    {
      "Id": 1,
      "VariantName": "sample string 2",
      "LocationCount": 3,
      "Subscriber": "sample string 4",
      "ProductRevenueCategory": "sample string 5",
      "Supplier": "sample string 6",
      "Barcode": "sample string 7",
      "Discontinued": true,
      "RetailPrice": 9.1,
      "WholesaleCost": 10.1,
      "CreateDate": "2025-04-01T03:10:12.5664081-07:00"
    },
    {
      "Id": 1,
      "VariantName": "sample string 2",
      "LocationCount": 3,
      "Subscriber": "sample string 4",
      "ProductRevenueCategory": "sample string 5",
      "Supplier": "sample string 6",
      "Barcode": "sample string 7",
      "Discontinued": true,
      "RetailPrice": 9.1,
      "WholesaleCost": 10.1,
      "CreateDate": "2025-04-01T03:10:12.5664081-07:00"
    }
  ]
}

application/xml, text/xml

Sample:

<VariantSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contracts.Products.Models.Search.Response">
  <Total>1</Total>
  <Variants>
    <SearchVariant>
      <Barcode>sample string 7</Barcode>
      <CreateDate>2025-04-01T03:10:12.5664081-07:00</CreateDate>
      <Discontinued>true</Discontinued>
      <Id>1</Id>
      <LocationCount>3</LocationCount>
      <ProductRevenueCategory>sample string 5</ProductRevenueCategory>
      <RetailPrice>9.1</RetailPrice>
      <Subscriber>sample string 4</Subscriber>
      <Supplier>sample string 6</Supplier>
      <VariantName>sample string 2</VariantName>
      <WholesaleCost>10.1</WholesaleCost>
    </SearchVariant>
    <SearchVariant>
      <Barcode>sample string 7</Barcode>
      <CreateDate>2025-04-01T03:10:12.5664081-07:00</CreateDate>
      <Discontinued>true</Discontinued>
      <Id>1</Id>
      <LocationCount>3</LocationCount>
      <ProductRevenueCategory>sample string 5</ProductRevenueCategory>
      <RetailPrice>9.1</RetailPrice>
      <Subscriber>sample string 4</Subscriber>
      <Supplier>sample string 6</Supplier>
      <VariantName>sample string 2</VariantName>
      <WholesaleCost>10.1</WholesaleCost>
    </SearchVariant>
  </Variants>
</VariantSearchResult>

multipart/form-data

Sample:

<VariantSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contracts.Products.Models.Search.Response"><Total>1</Total><Variants><SearchVariant><Barcode>sample string 7</Barcode><CreateDate>2025-04-01T03:10:12.5664081-07:00</CreateDate><Discontinued>true</Discontinued><Id>1</Id><LocationCount>3</LocationCount><ProductRevenueCategory>sample string 5</ProductRevenueCategory><RetailPrice>9.1</RetailPrice><Subscriber>sample string 4</Subscriber><Supplier>sample string 6</Supplier><VariantName>sample string 2</VariantName><WholesaleCost>10.1</WholesaleCost></SearchVariant><SearchVariant><Barcode>sample string 7</Barcode><CreateDate>2025-04-01T03:10:12.5664081-07:00</CreateDate><Discontinued>true</Discontinued><Id>1</Id><LocationCount>3</LocationCount><ProductRevenueCategory>sample string 5</ProductRevenueCategory><RetailPrice>9.1</RetailPrice><Subscriber>sample string 4</Subscriber><Supplier>sample string 6</Supplier><VariantName>sample string 2</VariantName><WholesaleCost>10.1</WholesaleCost></SearchVariant></Variants></VariantSearchResult>