Produits

Les produits peuvent être manipulés à travers l'objet ncProduct dans l'API.

L'objet ncProduct

Le produit récupéré via l'API est un objet comprenant les méthodes suivantes :
Guid : L'identifiant du compte
Label : Le libellé du produit
Catproduct : La catégorie du produit
StockMin : Le stock minimum
Comments : Les commentaires du produit
eShopURL : L'URL de la fiche produit dans la boutique en ligne
Prht : Prix de revient (float)
Margin : Marge HT (float)
Ht : Montant HT (float)
Ttc : Montant TTC (float)
Regroup : Regroupement du Produit (Valeur de la liste Regroupement de Koban)
Classification : Classification du Produit (Valeur de la liste Classification de Koban)
Vat : Valeur de la TVA (une entrée doit correspondre dans la liste des Taux de TVA)
Unit : Code de l'unité du produit
IsSelling : Définit si le produit est en vente ou non (booléen)
Reference : La référence du produit
Declinaisons : Les déclinaisons possibles sur le produit. Chaque déclinaison est décomposée de la façon suivante :

• Guid : L'identifiant de la déclinaison
• Label : Le libellé de la déclinaison
• Values : La liste des valeurs possibles (couple Guid/Label)

MoreFields : Liste des valeurs de champ supplémentaire (de la forme [{FieldId:'', Value:''}, {FieldId:'', Value:''}, ...])
DCreated : Timestamp UNIX pour la date de création
Chaque objet dispose également d'une propriété Updated spécifiant la dernière date de modification. Enfin les informations de montant sont également présentes.

Méthodes disponibles

• GET https://app-koban.com/api/v1/ncProduct/GetSearch
  

  Renvoie la liste des produits correspondant à un paramètre de recherche

  Paramètres :
  • search : Valeur de recherche
  
  
• GET https://app-koban.com/api/v1/ncProduct/GetSearchForStock
  

  Renvoie la liste des produits gérés en stock et correspondant à un paramètre de recherche

  Paramètres :
  • search : Valeur de recherche
  
  
• GET https://app-koban.com/api/v1/ncProduct/GetOne
  

  Renvoie la définition d'un produit

  Paramètres :
  • id : Guid du produit
  
  
• GET https://app-koban.com/api/v1/ncProduct/GetUpdated Tester
  

  Renvoie la liste des produits créés ou modifiés depuis une date de référence

  Paramètres :
  • updated : date timestamp UNIX. date de référence
  • l : Entier: Longueur de la liste renvoyée (pagination)
  • s : Entier: Index de départ (pagination)
  
  
• POST https://app-koban.com/api/v1/ncProduct/Many
  

  Crée ou modifie un ensemble de produits. Si un produit correspondant à la clé uniqueproperty existe, alors l'API effectue une création. Sinon l'API met à jour le produit.

  Paramètres :
  • uniqueproperty : Propriété sélectionnée pour vérifier si le produit doit être créé ou modifié. Peut prendre la valeur : Reference. L'API vérifie qu'un produit correspondant à cette clé existe. Si il existe, il effectue une modification, sinon il effectue une création
  • catproductuniqueproperty : Propriété définissant la clé de la catégorie de produit associée au produit. Peut prendre la valeur : Reference.
  • Corps de la requête : Liste des comptes en tableau d'objet ncProduct JSON
• POST https://app-koban.com/api/v1/ncProduct/PostOne
  

  Crée ou modifie un produit. Si un produit correspondant à la clé uniqueproperty existe, alors l'API effectue une création. Sinon l'API met à jour le produit.

  Paramètres :
  • uniqueproperty : Propriété sélectionnée pour vérifier si le produit doit être créé ou modifié. Peut prendre la valeur : Reference. L'API vérifie qu'un produit correspondant à cette clé existe. Si il existe, il effectue une modification, sinon il effectue une création
  • catproductuniqueproperty : Propriété définissant la clé de la catégorie de produit associée au produit. Peut prendre la valeur : Reference.
  • Corps de la requête : Objet ncProduct JSON

Revenir à la liste des méthodes