Produits

GET /firms/{FIRM_ID}/products.xml

liste des produits, par groupe de 30 résultats

Paramètres optionnels : page

Réponse

<?xml version="1.0" encoding="UTF-8"?>
<products type="array">
  <pagination>
    <current_page>1</current_page>
    <total_pages>1</total_pages>
  </pagination>
  <product>
    <id>125</id>
    <ref>MONAE-3</ref>
    <title>Abonnement MonAE - 3 mois</title>
    <unit_price>7.5</unit_price>
    <api_custom nil="true"></api_custom>
    <api_id nil="true"></api_id>
    <nature>2</nature>
  </product>
  <product>
    <id>126</id>
    <ref>MONAE-12</ref>
    <title>Abonnement MonAE - 12 mois</title>
    <unit_price>25.0</unit_price>
    <api_custom nil="true"></api_custom>
    <api_id nil="true"></api_id>
    <nature>2</nature>
  </product>
</products>

GET /firms/{FIRM_ID}/product/{ID}.xml

Affiche le détail du produit n° ID

Réponse

<?xml version="1.0" encoding="UTF-8"?>
<product>
  <id>125</id>
  <ref>MONAE-3</ref>
  <title>Abonnement MonAE - 3 mois</title>
  <unit_price>7.5</unit_price>
  <api_custom nil="true"></api_custom>
  <api_id nil="true"></api_id>
  <nature>2</nature>
</product>

POST /firms/{FIRM_ID}/products.xml

Création d’un nouveau produit. On obtient en retour le code XML du produit créé, avec l’ID qui lui a été attribué

Requête

Les deux champs api_custom (chaine) et api_id(entier) sont deux champs libres que vous pouvez utiliser à votre convenance pour stocker les informations que vous souhaitez.

<?xml version="1.0" encoding="UTF-8"?>
<product>
  <api_custom>MY CUSTOM STRING</api_custom>
  <api_id>MY CUSTOM ID</api_id>
  <ref>MONAE-24</ref>
  <title>Abonnement MonAE - 24 mois</title>
  <unit_price>50.0</unit_price>
  <nature>2</nature>
</product>

Réponse

Status: 201 Created
Location: /firms/{FIRM_ID}/products/#{new-product-id}.xml

<product>
  ...
</product>

PUT /firms/{FIRM_ID}/products/#{ID}.xml

Mise à jour d’un produit existant.

Requête

Les deux champs api_custom (chaine) et api_id(entier) sont deux champs libres que vous pouvez utiliser à votre convenance pour stocker les informations que vous souhaitez.

<product>
  <id>125</id>
  <ref>MONAE-ABO-3</ref>
  <title>Abonnement MonAE - 3 mois</title>
  <unit_price>15</unit_price>
  <api_custom>CUSTOM_SUBSCRIPTION</api_custom>
  <api_id>152</api_id>
  <nature>2</nature>
</product>

Réponse

Status: 200 OK

DELETE /firms/{FIRM_ID}/products/#{ID}.xml

Supprime le produit identifié par son ID. Cette opération ne supprime pas les lignes de facturation associées à ce produit.

Réponse

Status: 200 OK