GET /firms/FIRM_ID/products.json

liste des produits, par groupe de 30 résultats.

Paramètres optionnels

• page : numéro de page
• ref : recherche partielle sur la référence produit
• title : recherche partielle sur le libellé du produit
• api_id : recherche exacte sur le champ api_id
• api_custom : recherche partielle sur le champ api_custom

Tri

Par défaut, les produits sont triés par ordre croissant de libellé.
Vous pouvez trier les résultats selon différentes méthodes en utilisant les paramètres suivants:

• sort:
  • asc: tri croissant
  • desc: tri décroissant
• order : type de tri
  • ref: tri par référence
  • created: tri par date de création d'un devis (ie date à laquelle l'enregistrement a été créé)
  • updated: tri par date de dernière modification d'un devis (ie date à laquelle l'enregistrement a été modifié pour la dernière fois)

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 https://www.facturation.pro/firms/FIRM_ID/products.json

Réponse

[{
  "api_custom": null,
  "api_id": null,
  "category_id": 4868,
  "id": 46125,
  "nature": 9,
  "ref": "PRESTASHOP",
  "title": "Developpement module Prestashop",
  "unit_price": "100.0",
  "vat": "0.200"
}, {
  "api_custom": null,
  "api_id": null,
  "category_id": 4868,
  "id": 46126,
  "nature": 9,
  "ref": "WORDPRESS",
  "title": "Developpement module Wordpress",
  "unit_price": "150.0",
  "vat": "0.200"
}]

GET /firms/FIRM_ID/products/ID.json

Affiche le détail du produit n° ID

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 https://www.facturation.pro/firms/FIRM_ID/products/1.json

Réponse

{
  "api_custom": null,
  "api_id": null,
  "category_id": 4868,
  "id": 1,
  "nature": 9,
  "ref": "PRESTASHOP",
  "title": "Developpement module Prestashop",
  "unit_price": "100.0",
  "vat": "0.200"
}

POST /firms/FIRM_ID/products.json

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

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 -H 'Content-Type: application/json; charset=utf-8' \
 -X POST \
 -d '{"ref":"PAIMENT","title":"Developpement passerelle de paiement","unit_price":200.0,"vat":0.200}' \
 https://www.facturation.pro/firms/FIRM_ID/products.json

Réponse

Status: 201 Created
Location: /firms/FIRM_ID/products/46127.json

{
  "id": 46127,
  "ref": "PAIMENT",
  "title": "Developpement passerelle de paiement",
  "unit_price": "200.0",
  "vat": "0.200"
}

PATCH /firms/FIRM_ID/products/ID.json

Mise à jour d'un produit existant.

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 -H 'Content-Type: application/json; charset=utf-8' \
 -X PATCH \
 -d '{"title":"Optimisation module Prestashop","api_custom":"CUSTOM_SHOP"}' \
 https://www.facturation.pro/firms/FIRM_ID/products/1.json

Réponse

Status: 200 OK

DELETE /firms/FIRM_ID/products/ID.json

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

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 -X DELETE \
 https://www.facturation.pro/firms/FIRM_ID/products/1.json

Réponse

Status: 200 OK