API Reference

for your "Catalog of products"

Find here the list of actions to apply on the objects, and the data reference for this object.




What is a customer product ?

A customer_product is an item from the catalog of products you sell.




Getting the products list

GET /customer_products.xml

Returns all products, page by page
Add a page parameter to navigate




Getting a single product

GET /customer_products/#{id}.xml

Returns a single product, identified by its id




Creating a new product

POST /customer_products.xml

Creates a new product, and returns the product data




Updating an existing product

PUT /customer_products/#{id}.xml

Updates some fields of an existing product




Deleting an existing product

DELETE /customer_products/#{id}.xml

Deletes the product identified by its id




Object data

<customer_product>
 <id>id of this product</id>
 <reference>your reference</reference>
 <is_active>0 if not active, 1 if active</is_active>
 <name>name</name>
 <description>description</description>
 <notes_internal>some private notes</notes_internal>
 <price>price without tax</price>
 <vat_id>id of vat (see below)</vat_id>
 <product_category_id>id in your own typology of products you sell</product_category_id>
</customer_product>




Possible values of vat_id

  • 222 for 2.1%

  • 223 for 5.5%

  • 224 for 19.6%

  • 225 for no VAT

  • 529 for 19%

  • 543 for 8.5%

  • 544 for 21%

  • 545 for 7.6%

  • 546 for 16%

  • 551 for 15%

  • 552 for 10%

  • 553 for 3%

  • 567 for 18%

  • 569 for 8.5% NPR

  • 607 for 20%

  • 615 for 6%