Products

Authentication ↑

The API key for the connecting user can be provided in one of the following ways:

  • As password of the Basic HTTP Authorization header of the request (with empty username).

  • As content of the user element (child of the root element) of the XML in the request. (Unless it concerns a GET request)

>>>

GET /api/v1/products.xml
Returns a list of all products

Example request to server ↑

curl -X GET https://xmlagri.qcone.com/api/v1/products.xml --user :api_key

Example request to server with base_product_id ↑

curl -i -X GET https://xmlagri.qcone.com/api/v1/products.xml?base_product_id=88 --user :api_key

Example response from server ↑

<?xml version="1.0" encoding="UTF-8"?>
<products>
  <product>
    <id>1</id>
    <name>Apricots</name>
    <base_product_id />
    <survey_method>weight</survey_method>
  </product>
  <product>
    <id>2</id>
    <name>Cherries</name>
    <base_product_id />
    <survey_method>count</survey_method>
  </product>
</products>

Params

Param name Description
base_product_id
optional

Filter by base_product_id

Validations:

  • Must be a number.