POST v1/BusinessEntity/{businessEntityUid}/Products/Products/Search
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
businessEntityUid | string |
Required |
Body Parameters
Mindbody.Contracts.Products.Models.Search.Request.ProductSearchRequestName | Description | Type | Additional information |
---|---|---|---|
From | integer |
None. |
|
Size | integer |
None. |
|
Filter | Mindbody.Contracts.Products.Models.Search.Request.ProductSearchRequestFilter |
None. |
|
AggregatesWanted | Collection of 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 ] }, "AggregatesWanted": [ "sample string 1", "sample string 2" ], "SortBy": "sample string 3", "IsAscending": true }
application/xml, text/xml
Sample:
<ProductSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contracts.Products.Models.Search.Request"> <AggregatesWanted xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </AggregatesWanted> <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> <Size>2</Size> <SortBy>sample string 3</SortBy> </ProductSearchRequest>
multipart/form-data
Sample:
<ProductSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contracts.Products.Models.Search.Request"><AggregatesWanted xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></AggregatesWanted><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><Size>2</Size><SortBy>sample string 3</SortBy></ProductSearchRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Mindbody.Contracts.Products.Models.Search.Response.ProductSearchResultName | Description | Type | Additional information |
---|---|---|---|
Total | integer |
None. |
|
Products | Collection of Mindbody.Contracts.Products.Models.Search.Response.SearchProduct |
None. |
|
AggregateList | Collection of Mindbody.Contracts.Products.Models.Search.Response.SearchAggregate |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
multipart/form-data
Sample:
Sample not available.