developer:soap-1.3:methods:getproductcategory

Soap API v1.3

getProductCategory

Retrieve all data for a single product category

Description

This method retrieves the ProductCategory object for the product category specified by ProductCateogryRefNum. The ProductCategoryRefNum is the gateway assigned unique product category identifier that was returned by ProductCategory object is returned.

See also addProductCategory

Syntax

ProductCategory getProductCategory ( ueSecurityToken Token,string ProductCategoryRefNum)

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and retrieve the custom fields.
string ProductCategoryRefNum Gateway assigned product category ID used to pull product category details

Return Value

ProductCategory Returns a Product Category object containing fields and their values.

Exceptions

The following exceptions (errors) are applicable to this method.

Code Message Advice
41006 Product Category Not Found Product category specified by ProductCategoryRefNum was not found. Make sure the number stored is not truncated or rounded.

Examples

PHP

For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.

<?php

VB

   Dim catRefNum As String
        catRefNum = "9001169815"
 
        Dim category As usaepay.ProductCategory
        category = client.getProductCategory(token, catRefNum)
        MsgBox(category.Name)

.NET C#

string catRefNum = "9001169810";
 
            try
            {
                usaepay.ProductCategory category = client.getProductCategory(token, catRefNum);
                MessageBox.Show(string.Concat(category.Name));
            }
            catch (Exception err)
            {
                MessageBox.Show(err.Message);
            }

XML

Request:

 

Response:

 

Change History

Version Change
1.3 Method added in this release
developer/soap-1.3/methods/getproductcategory.txt · Last modified: 2010/10/12 16:30 by irina

Page Tools