Skip to main content
Vindicia Knowledge Center

Product.fetchByVid

Product.fetchByVid

Product.fetchByVid

The fetchByVid method returns a Product object whose VID matches the input.

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.

vid: the Product object’s Vindicia unique identifier, which serves as the search criterion.

Output

return: an object of type Return that indicates the success or failure of the call.

product: the Product object whose VID matches the input.

Returns

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

Return Code

Return String

400

One of the following:

  • Unable to load product by VID input-vid: error-description.
  • Must specify VID to load by!

404

Unable to load product by VID input-vid: No match.

Example

$prodVid = '079e770ca81ab5f4cd40a2dec6d4c72832ce8dd0';

// Create a SOAP caller product object

$prod = new Product();

$response = $prod->fetchByVid($prodVid);

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

$fetchedProduct = $response['data']->product;

// process fetched product here

}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top