catalog

Create a new product

Changed on
post/v2/catalog/product

Request

  • Base URL: https://api.abby.fr
  • URL: https://api.abby.fr/v2/catalog/product
  • Auth: HTTP bearer

Request body

type'sale_of_goods' | 'service_delivery' | 'commercial_or_craft_services' | 'sale_of_manufactured_goods' | 'disbursement' required
unit'unit' | 'gram' | 'hour' | 'day' | 'week' | 'fixed_rate' | 'year' | 'character' | 'line' | 'license' | 'article' | 'month' | 'kilogram' | 'kilometer' | 'liter' | 'batch' | 'meter' | 'square_meter' | 'cubic_meter' | 'linear_meter' | 'person' | 'ton' | 'word' | 'page' | 'leaflet' | 'paragraph' | 'minute' | 'overnight_stay' required
designationstring required

The name or title of the product

amountInCentsnumber

The price of the product in cents

purchasePricenumber

The purchase price of the product in cents

productMarginnumber

The margin of the product in percentage

lockUnitPriceboolean

Whether the unit price is locked or not calculating from purchase price and product margin

taxesIncludedboolean

Whether the amount includes taxes

vatCode'FR_210' | 'FR_550' | 'FR_850' | 'FR_1000' | 'FR_2000' | 'FR_00HT' | 'FR_00UE' | 'FR_0HUE'
isDeliveryOfGoodboolean

Whether the product involves delivery of a physical good

descriptionstring

Detailed description of the product

referencestring

Product reference or SKU

stocknumber

The stock quantity

Example request

{
  "designation": "Premium Widget",
  "amountInCents": 1999,
  "purchasePrice": 1000,
  "productMargin": 10,
  "lockUnitPrice": true,
  "taxesIncluded": true,
  "isDeliveryOfGood": true,
  "description": "High-quality widget for various applications",
  "reference": "WIDGET-001",
  "stock": 20
}

Response

idstring required
type'sale_of_goods' | 'service_delivery' | 'commercial_or_craft_services' | 'sale_of_manufactured_goods' | 'disbursement' required
unit'unit' | 'gram' | 'hour' | 'day' | 'week' | 'fixed_rate' | 'year' | 'character' | 'line' | 'license' | 'article' | 'month' | 'kilogram' | 'kilometer' | 'liter' | 'batch' | 'meter' | 'square_meter' | 'cubic_meter' | 'linear_meter' | 'person' | 'ton' | 'word' | 'page' | 'leaflet' | 'paragraph' | 'minute' | 'overnight_stay' required
designationstring required

Name or title of the product

descriptionstring nullable

Detailed description of the product

referencestring nullable

Product reference code

vatCode'FR_210' | 'FR_550' | 'FR_850' | 'FR_1000' | 'FR_2000' | 'FR_00HT' | 'FR_00UE' | 'FR_0HUE' required
personalServiceActivity'GARDE_ENFANT_HANDICAPE' | 'ACCOMPAGNEMENT_ENFANT_HANDICAPE' | 'AIDE_HUMAINE' | 'CONDUITE_VEHICULE_PERSONNEL' | 'AIDE_AU_DEPLACEMENT' | 'ENTRETIEN_DE_LA_MAISON' | 'JARDINAGE' | 'BRICOLAGE' | 'GARDE_ENFANT_PLUS_DE_6_ANS' | 'SOUTIEN_SCOLAIRE_COURS_A_DOMICILE' | 'SOIN_ESTHETIQUE_A_DOMICILE' | 'PREPARATION_REPAS_A_DOMICILE' | 'LIVRAISON_REPAS_A_DOMICILE' | 'COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE' | 'LIVRAISON_COURSES_A_DOMICILE' | 'ASSISTANCE_INFORMATIQUE' | 'SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES' | 'MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE' | 'ASSISTANCE_ADMINISTRATIVE' | 'ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS' | 'TELEASSISTANCE' | 'INTERPRETE_LANGUE_DES_SIGNES' | 'CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE' | 'ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE' | 'ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE' | 'COORDINATION_ET_GESTION' | 'DIVERS_NON_ELIGIBLE'
isDeliveryOfGoodboolean required

Indicates if the product involves delivery of physical goods

taxesIncludedboolean required

Indicates if the prices include taxes

purchasePricenumber

Purchase price per unit without taxes

productMarginnumber

Product margin

lockUnitPriceboolean

Indicates if the unit price is locked

unitPricenumber required

Price per unit without taxes

priceWithoutTaxesnumber required

Total price without taxes

vatAmountnumber required

VAT amount

priceWithTaxesnumber required

Total price including taxes

stocknumber required

Stock

Changes

    • breaking

      removed the enum value 1.00 of the request property ////

    • breaking

      removed the enum value 1.00 of the request property ////

    • breaking

      removed the enum value 10.00 of the request property ////

    • breaking

      removed the enum value 11.00 of the request property ////

    • breaking

      removed the enum value 12.00 of the request property ////

    • breaking

      removed the enum value 13.00 of the request property ////

    • breaking

      removed the enum value 14.00 of the request property ////

    • breaking

      removed the enum value 15.00 of the request property ////

    • breaking

      removed the enum value 16.00 of the request property ////

    • breaking

      removed the enum value 17.00 of the request property ////

    • breaking

      removed the enum value 18.00 of the request property ////

    • breaking

      removed the enum value 19.00 of the request property ////

    • breaking

      removed the enum value 2.00 of the request property ////

    • breaking

      removed the enum value 2.00 of the request property ////

    • breaking

      removed the enum value 20.00 of the request property ////

    • breaking

      removed the enum value 21.00 of the request property ////

    • breaking

      removed the enum value 22.00 of the request property ////

    • breaking

      removed the enum value 23.00 of the request property ////

    • breaking

      removed the enum value 24.00 of the request property ////

    • breaking

      removed the enum value 25.00 of the request property ////

    • breaking

      removed the enum value 26.00 of the request property ////

    • breaking

      removed the enum value 27.00 of the request property ////

    • breaking

      removed the enum value 28.00 of the request property ////

    • breaking

      removed the enum value 3.00 of the request property ////

    • breaking

      removed the enum value 3.00 of the request property ////

    • breaking

      removed the enum value 4.00 of the request property ////

    • breaking

      removed the enum value 4.00 of the request property ////

    • breaking

      removed the enum value 5.00 of the request property ////

    • breaking

      removed the enum value 5.00 of the request property ////

    • breaking

      removed the enum value 6.00 of the request property ////

    • breaking

      removed the enum value 7.00 of the request property ////

    • breaking

      removed the enum value 8.00 of the request property ////

    • breaking

      removed the enum value 9.00 of the request property ////

    • breaking

      the //// request property type changed from number to string

    • breaking

      the //// request property type changed from number to string

    • breaking

      the //// response's property type changed from number to string for status

    • breaking

      the //// response's property type changed from number to string for status

    • warning

      added the new article enum value to the //// response property for the response status

    • warning

      added the new batch enum value to the //// response property for the response status

    • warning

      added the new character enum value to the //// response property for the response status

    • warning

      added the new commercial_or_craft_services enum value to the //// response property for the response status

    • warning

      added the new cubic_meter enum value to the //// response property for the response status

    • warning

      added the new day enum value to the //// response property for the response status

    • warning

      added the new disbursement enum value to the //// response property for the response status

    • warning

      added the new fixed_rate enum value to the //// response property for the response status

    • warning

      added the new gram enum value to the //// response property for the response status

    • warning

      added the new hour enum value to the //// response property for the response status

    • warning

      added the new kilogram enum value to the //// response property for the response status

    • warning

      added the new kilometer enum value to the //// response property for the response status

    • warning

      added the new leaflet enum value to the //// response property for the response status

    • warning

      added the new license enum value to the //// response property for the response status

    • warning

      added the new line enum value to the //// response property for the response status

    • warning

      added the new linear_meter enum value to the //// response property for the response status

    • warning

      added the new liter enum value to the //// response property for the response status

    • warning

      added the new meter enum value to the //// response property for the response status

    • warning

      added the new minute enum value to the //// response property for the response status

    • warning

      added the new month enum value to the //// response property for the response status

    • warning

      added the new overnight_stay enum value to the //// response property for the response status

    • warning

      added the new page enum value to the //// response property for the response status

    • warning

      added the new paragraph enum value to the //// response property for the response status

    • warning

      added the new person enum value to the //// response property for the response status

    • warning

      added the new sale_of_goods enum value to the //// response property for the response status

    • warning

      added the new sale_of_manufactured_goods enum value to the //// response property for the response status

    • warning

      added the new service_delivery enum value to the //// response property for the response status

    • warning

      added the new square_meter enum value to the //// response property for the response status

    • warning

      added the new ton enum value to the //// response property for the response status

    • warning

      added the new unit enum value to the //// response property for the response status

    • warning

      added the new week enum value to the //// response property for the response status

    • warning

      added the new word enum value to the //// response property for the response status

    • warning

      added the new year enum value to the //// response property for the response status

    • info

      added the new article enum value to the request property ////

    • info

      added the new batch enum value to the request property ////

    • info

      added the new character enum value to the request property ////

    • info

      added the new commercial_or_craft_services enum value to the request property ////

    • info

      added the new cubic_meter enum value to the request property ////

    • info

      added the new day enum value to the request property ////

    • info

      added the new disbursement enum value to the request property ////

    • info

      added the new fixed_rate enum value to the request property ////

    • info

      added the new gram enum value to the request property ////

    • info

      added the new hour enum value to the request property ////

    • info

      added the new kilogram enum value to the request property ////

    • info

      added the new kilometer enum value to the request property ////

    • info

      added the new leaflet enum value to the request property ////

    • info

      added the new license enum value to the request property ////

    • info

      added the new line enum value to the request property ////

    • info

      added the new linear_meter enum value to the request property ////

    • info

      added the new liter enum value to the request property ////

    • info

      added the new meter enum value to the request property ////

    • info

      added the new minute enum value to the request property ////

    • info

      added the new month enum value to the request property ////

    • info

      added the new overnight_stay enum value to the request property ////

    • info

      added the new page enum value to the request property ////

    • info

      added the new paragraph enum value to the request property ////

    • info

      added the new person enum value to the request property ////

    • info

      added the new sale_of_goods enum value to the request property ////

    • info

      added the new sale_of_manufactured_goods enum value to the request property ////

    • info

      added the new service_delivery enum value to the request property ////

    • info

      added the new square_meter enum value to the request property ////

    • info

      added the new ton enum value to the request property ////

    • info

      added the new unit enum value to the request property ////

    • info

      added the new week enum value to the request property ////

    • info

      added the new word enum value to the request property ////

    • info

      added the new year enum value to the request property ////

    • info

      removed the 1.00 enum value from the //// response property for the response status

    • info

      removed the 1.00 enum value from the //// response property for the response status

    • info

      removed the 10.00 enum value from the //// response property for the response status

    • info

      removed the 11.00 enum value from the //// response property for the response status

    • info

      removed the 12.00 enum value from the //// response property for the response status

    • info

      removed the 13.00 enum value from the //// response property for the response status

    • info

      removed the 14.00 enum value from the //// response property for the response status

    • info

      removed the 15.00 enum value from the //// response property for the response status

    • info

      removed the 16.00 enum value from the //// response property for the response status

    • info

      removed the 17.00 enum value from the //// response property for the response status

    • info

      removed the 18.00 enum value from the //// response property for the response status

    • info

      removed the 19.00 enum value from the //// response property for the response status

    • info

      removed the 2.00 enum value from the //// response property for the response status

    • info

      removed the 2.00 enum value from the //// response property for the response status

    • info

      removed the 20.00 enum value from the //// response property for the response status

    • info

      removed the 21.00 enum value from the //// response property for the response status

    • info

      removed the 22.00 enum value from the //// response property for the response status

    • info

      removed the 23.00 enum value from the //// response property for the response status

    • info

      removed the 24.00 enum value from the //// response property for the response status

    • info

      removed the 25.00 enum value from the //// response property for the response status

    • info

      removed the 26.00 enum value from the //// response property for the response status

    • info

      removed the 27.00 enum value from the //// response property for the response status

    • info

      removed the 28.00 enum value from the //// response property for the response status

    • info

      removed the 3.00 enum value from the //// response property for the response status

    • info

      removed the 3.00 enum value from the //// response property for the response status

    • info

      removed the 4.00 enum value from the //// response property for the response status

    • info

      removed the 4.00 enum value from the //// response property for the response status

    • info

      removed the 5.00 enum value from the //// response property for the response status

    • info

      removed the 5.00 enum value from the //// response property for the response status

    • info

      removed the 6.00 enum value from the //// response property for the response status

    • info

      removed the 7.00 enum value from the //// response property for the response status

    • info

      removed the 8.00 enum value from the //// response property for the response status

    • info

      removed the 9.00 enum value from the //// response property for the response status