POST v1/BusinessEntity/{businessEntityUid}/Products/ProductVariants/Summary/VariantIds

Request Information

URI Parameters

Name	Description	Type	Additional information
businessEntityUid		string	Required

Body Parameters

Mindbody.Contracts.Products.Models.Search.Request.ProductVariantSummarySearchRequest

Name	Type	Additional information
From	integer	None.
Size	integer	None.
Filter	Mindbody.Contracts.Products.Models.Search.Request.ProductSearchRequestFilter	None.
ProductName	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",
  "SortBy": "sample string 4",
  "IsAscending": true
}

application/xml, text/xml

Sample:

<ProductVariantSummarySearchRequest 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 4</SortBy>
</ProductVariantSummarySearchRequest>

multipart/form-data

Sample:

<ProductVariantSummarySearchRequest 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 4</SortBy></ProductVariantSummarySearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Mindbody.Contracts.Products.Models.Search.Response.VariantIdSearchResult

Name	Description	Type	Additional information
Total		integer	None.
Variants		Collection of integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Total": 1,
  "Variants": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<VariantIdSearchResult 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 xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Variants>
</VariantIdSearchResult>

multipart/form-data

Sample:

<VariantIdSearchResult 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 xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:int>1</d2p1:int><d2p1:int>2</d2p1:int></Variants></VariantIdSearchResult>