Dexero eCommerce

API REST
Introduction

Ressources
- Products
- Events
- Categories
- Orders
- Donations
  - /donations/product/{idOrNumber}/raised/
- Time
- Locales

Versions de l’API
Authentification & Autorisation

GET products/category/{id}

Mis à jour, 2012-06-19 14:28

Retourne une liste de produits qui appartiennent à la catégorie demandé et qui sont disponible dans la vue publique du catalogue.

Information sur la ressource

Taux limité ?	Non
Authentification	Facultatif
Formats de réponse	json,xml
Methodes HTTP	GET
Objet de réponse	list<Product>

URL de la ressource

https://ecommerce.dexero.com/service/rest/2/marchand/catalogue/products/category/{id}.format

Paramètres

Paramètre	Description
id	Le numéro d'identification système de la catégorie Exemple de valeur : 412
count	Indique le nombre d'enregistrements à récupérer. La valeur par défaut 20. Exemple de valeur : 30
offset	Le point de départ de décalage (basé sur 0) du premier objet à retourner dans la liste. La valeur par défaut est 0. Exemple de valeur : 20
page	La page de valeurs à récupérer. Exemple de valeur : 6
sort_key	Le champ sur lequel trier les résultats retournés. Si le champ n'est pas présent sur une entrée, la valeur de chaîne vide est utilisée. La valeur par défaut est le nom. Exemple de valeur : name , prixLow, priceHigh
sort_dir	La direction de triage des resultats. La valeur par défaut est asc. Exemple de valeur : asc, desc
locale	Langue de retour du produit Exemple de valeur : fr,en
image_size	Grandeur de l'image retourné Exemple de valeur : 80 , 80x90
include_attributes	Lorsqu'il est réglé à true ou 1, chaque produit comprendra un nœud appelé «attributes»,. Ce nœud offre une variété de valeurs spécifique à la configuration du produit. La valeur par défaut est false Exemple de valeur : true

Exemple de requête

https://ecommerce.dexero.com/service/rest/2/merchand/catalogue/products/category/1.json

Exemple de réponse

XML JSON

{
  "products" : {
    "totalResults" : 261,
    "startIndex" : 260,
    "itemsPerPage" : 20,
    "pageCount" : 14,
    "uri" : "\/ecommerce\/service\/rest\/2\/jpf\/jpf\/products.json?page=14",
    "firstpageuri" : "\/ecommerce\/service\/rest\/2\/jpf\/jpf\/products.json?page=1",
    "previouspageuri" : "\/ecommerce\/service\/rest\/2\/jpf\/jpf\/products.json?page=13",
    "lastpageuri" : "\/ecommerce\/service\/rest\/2\/jpf\/jpf\/products.json?page=14",
    "product" : {
      "id" : 15609,
      "sku" : "adsa",
      "identifier" : "eheheh",
      "name" : "hehehe",
      "currency" : "CAD",
      "type" : "grouped",
      "price" : "0.00",
      "rebate_price" : "0.00",
      "is_active" : true,
      "is_buyable" : false,
      "is_shippable" : false,
      "is_featured_new" : false,
      "weight" : 0,
      "length" : 0,
      "width" : 0,
      "height" : 0,
      "in_promotion" : false,
      "parent_product_id" : 0,
      "is_managed_inventory" : false,
      "number_remaining" : 0,
      "number_sold" : 0
    }
  }
}

Objet de réponse "Product"

Champ	Type de donnée	Description
id	long	Le numéro d'identification unique de ce produit . L'ID est généré automatiquement et ne peut pas être changé .
sku	string	Code de produit / Stock Keeping Unit ( SKU ) .
identifier	string	Le numéro d'identification unique de ce produit définie par un utilisateur.
name	string	Le nom du produit
description_short	string	La description courte du produit, qui ne contient pas de formatage HTML.
description_full	text	La description longue du produit , qui peut inclure le formatage HTML .
type	enum('regular', 'donation','grouped', 'bundle','download','event')	Type de Produit : regular - produit physique de base donation - produit de type don grouped - rassemblement de produits bundle - rassemblement de produits configurable event - produit disponible pour événements
price	decimal(20,2)	Le prix du produit
rebate_price	decimal(20,2)	Le prix du produit calculé avec les rabais
is_buyable	boolean>	Disponibilité du produit à l'achat
is_active	boolean	Détermine si le produit est actif
is_shippable	boolean	Détermine si le produit doit être expédié.
is_featured_new	boolean	Détermine si le produit est considéré comme nouveau
is_managed_inventory	boolean	Détermine si la gestion de l'inventaire est activé
weight	float(7,4)	Poids du produit qui peut être utilisé lors du calcul de frais de port
length	float(7,4)	Longueur du produit qui peut être utilisé lors du calcul de frais de port.
width	float(7,4)	Largeur du produit qui peut être utilisé lors du calcul de frais de port.
height	float(7,4)	Hauteur du produit qui peut être utilisé lors du calcul de frais de port.
in_promotion	boolean	Détermine si le produit est actuellement en promotion
image	string	Image principale du produit
parent_product_id	long	Identifiant du produit parent
child_products	array	Un table d'identifiants de produit pour lesquels le produit est le parent
number_remaining	int	La quantité restante du produit en inventaire
number_sold	int	Le nombre total de fois où ce produit a été vendu.
categories	array	Un table d'identifiants de categories auxquels le produit se rapporte
attributes	List<Attribute>	Un table d'attributs complémentaire au produit

Objet de réponse "Attribute"

Champ	Type de donnée	Description
id	long	Le numéro d'identification unique de l'attribut . L'ID est généré automatiquement et ne peut pas être changé .
identifier	string	L'identifiant unique de cet attribut définie par un utilisateur.
label	string	Le label de l'attribut
type	string	Le type d'attribut : DateTime Decimal Long Text Varchar
cross_linked	boolean	Lié aux produits du même niveau par cet attribut.
attributes	List<Value>	Les valeurs de l'attribut

Objet de réponse "Value"

Champ	Type de donnée	Description
id	long	Le numéro d'identification unique de la valeur de l'attribut . L'ID est généré automatiquement et ne peut pas être changé .
value	string	La valeur de l'attribut

Information de pagination

Propriété	Description
totalResults	Le nombre total d'éléments dans la liste.
startIndex	Le point de départ de décalage (basé sur 0) du premier objet à retourner dans la liste. La valeur par défaut est 0.
itemsPerPage	Le nombre total d'éléments par page.
pageCount	Le nombre de pages.
uri	L'URI de la page courante.
firstpageuri	L'URI de la première page.
previouspageuri	L'URI de la page précédente.
nextpageuri	L'URI de la page suivante.
lastpageuri	L'URI de la dernière page.

Interface service Web REST