Retrieve product information by code
Last updated: 11-Apr-2017
Rate this article:
Overview
Extract information about a product from the Avangate system using its unique ID and the code of the pricing list to which it is assigned to.
Requirements
Parameters
| Parameter | Type/Description |
|---|---|
| sessionID | Required (string) |
| Session identifier, which is the output of the Login method. An exception will be thrown if the values are incorrect. | |
| productCode | Required (string) |
| The unique product identifier from your system. | |
| pricingListCode | Required (string) |
| The unique identifier of the pricing list. |
Response
| Parameter | Type/Description |
|---|---|
| ProductInfo | Complet object |
| Complex object containing arrays of SimpleProduct and PriceOptions objects. |
Request
<?php
require ('PATH_TO_AUTH'); // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/02Authentication
require ('PATH_TO_SET_PARTNER'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/Partner/00Set_partner
$productCode = 'YOUR_PRODUCT_CODE';
$pricingListCode = 'YOUR_PRICING_LIST_CODE';
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'getProductByCode',
'params' => array($sessionID, $productCode, $pricingListCode)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));
Errors
| Error | Description |
|---|---|
|
INVALID_PARTNER |
No partner is set. |
|
INVALID_PRODUCT |
Provide a valid product ID. |
|
INVALID_PRICING_LIST_CODE |
Provide a valid pricing list code. |
|
PARTNER_PRICING_LISTS_NOT_FOUND |
There are no pricing lists with the provided code. |
|
PRODUCT_NOT_FOUND |
There is no product with this ID in the given pricing list. |
Rate this article:
