POST Catalog/RelatedSales

Gets which other Products are usually bought together with the provided product.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ProductID	integer	Required
NumberOfResults	integer	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ProductID": 1,
  "NumberOfResults": 2,
  "Lang": "sample string 3",
  "StoreID": 4
}

application/xml, text/xml

Sample:

<GetRelatedSalesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Catalog">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">sample string 3</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">4</StoreID>
  <NumberOfResults>2</NumberOfResults>
  <ProductID>1</ProductID>
</GetRelatedSalesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The ProductIDs

Collection of ProductSearch

Name	Description	Type	Additional information
ID		integer	None.
Score	Number of results of this products after a filter operation	integer	None.
StoreID		integer	None.
Created		date	None.
Discontinued		date	None.
PublishFrom		date	None.
Reference		string	Required
Name		string	Required
ShortDescription		string	None.
Description		string	None.
Quantity	Aggregates product variation Stocks. Total is corrected with OutOfStockQuantity	decimal number	None.
ShippingTime		decimal number	None.
NotSell	This product is not for sell	boolean	None.
Slug		string	None.
ProviderName	Not null if allowed by store config	string	None.
BrandName		string	None.
CollectionName		string	None.
ConditionName		string	None.
ClassificationIDs		Collection of integer	None.
StoreManufacture	if true , this product belongs to the store manufacturer	boolean	None.
TitleTag	Seo Title Tag	string	None.
MetaDescription	Seo MetaDescription	string	None.
ImageURL		string	None.
Images		Collection of ItemImage	None.
AttributeIDs	List of attributes applicable to this product nested variations	Collection of AttributeID	None.
Promotion		PromotionItem	None.
Promotions		Collection of PromotionItem	None.
VariationAttributes	Combination of attributes applying to each product variation ID	Dictionary of integer [key] and Collection of integer [value]	None.
SalesStockPolicyID		integer	None.
Weight		decimal number	None.
Dimensions		Dimensions	None.
MinimumOrderQuantity	Minimum quantity that must be placed in each order	decimal number	None.
MaximumOrderQuantity	Maximum quantity that can be placed in each order; 0 = no limit	decimal number	None.
OrderQuantityStep	Sets the number of items that have to be grouped together to place an Order	decimal number	None.
IsComposite		boolean	None.
Features			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.