Skip to main content
Vindicia Knowledge Center

Product.fetchByAccount

Product.fetchByAccount

Product.fetchByAccount

The fetchByAccount method returns one or more Product objects to which the Account object specified in the input is subscribed. That is, this method returns all the Product objects that are associated with the AutoBill objects that are also associated with the specified Account object.

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.

account: the Account object that serves as the search criterion. Use the merchantAccountId or VID to identify the object.

includeChildren: an optional Boolean flag that, if set to true, includes all children associated with this Account. If this flag is omitted, CashBox will interpret it as false, and will not include children in the query.

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 associated with the AutoBill objects that are also associated with the Account object specified in the input.

Returns

In addition to those listed in Standard Return Codes, this call returns:

Return Code

Return String

404

One of the following:

  • Unable to load account to search byerror-description.
  • Unable to load account by: No matches.

Example

// Create a SOAP caller product object

$prod = new Product();

// Create an Account object to fetch products by

$acct = new Account();
$acct->setMerchantAccountId('jdoe101');

$response = $prod->fetchByAccount($acct);

if($response['returnCode'] == 200) {

$fetchedProducts = $response['data']->products;

// process fetched products here

if ($fetchedProducts != null) {

foreach ($fetchedProducts as $fetchedProd) {

// process a fetched product here

}

}

}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top