Product.fetchByMerchantEntitlementId

The fetchByMerchantEntitlementId method returns one or more Product objects whose entitlement ID assigned by you (merchantEntitlementId) matches the input. For example, call this method in response to a customer request for a list of all your products that offer a certain privilege on your site.

Input

srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call. Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response. merchantEntitlementId: your entitlement ID (merchantEntitlementId), which serves as the search criterion.

Output

return: an object of type Return that indicates the success or failure of the call. products: an array of one or more Product objects whose entitlement ID assigned by you (merchantEntitlementId) matches the input.

Returns

In addition to those listed in The Return Object, this call returns:

Return Code	Return String
`400`	`Must specify entitlement id.`
`404`	`Could not load product for entitlement id input-merchant-EntitlementId.`

Example

// Create a SOAP caller product object
$prod = new Product();

$response = $prod->fetchByMerchantEntitlementId
      ('PremiumVideoContentAccess');

if($response['returnCode'] == 200) {
   $fetchedProducts = $response['data']->products;

   // process fetched products here
   if ($fetchedProducts != null) {
      foreach ($fetchedProducts as $fetchedProd) {
         // process a fetched product here
      }
   }
}

Parent topic:Product Methods

Home

Guides

APIs

Input

Output

Returns

Example

​Input

​Output

​Returns

​Example

Input

Output

Returns

Example