Interface service Web REST

GET events/{idOrUrlKey}

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

Retourne une liste de produits 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 Event

URL de la ressource

https://ecommerce.dexero.com/service/rest/2/marchand/catalogue/events/{idOrUrlKey}.format

Paramètres

Paramètre Description
idOrUrlKey Le numéro d'identification système ou la clé url.
Exemple de valeur : 30
locale Langue de retour de l'événement
Exemple de valeur : fr, en
product_image_size Grandeur de l'image de produit retourné
Exemple de valeur : 80 , 80x90

Exemple de requête

https://ecommerce.dexero.com/service/rest/2/merchand/catalogue/events/2.xml

Exemple de réponse

XML JSON
{
  "event" : {
    "id" : 2,
    "name" : "Test event checkin",
    "url" : "http:\/\/ecommerce.dexero.com\/shopping\/testforms\/testforms\/event\/test_event_checkin\/Detail.view",
    "url_key" : "test_event_checkin",
    "available_places" : -14,
    "sold_places" : 24,
    "description_short" : "Performing Arts, Comedy",
    "start_date" : "2012-04-19T14:00:00-04:00",
    "end_date" : "2012-04-19T20:00:00-04:00",
    "timezone" : "America\/Montreal",
    "capacity" : 10,
    "logo" : "http:\/\/ecommerce.dexero.com\/repository\/testforms\/testforms\/logo\/logo_2.png",
    "venue" : {
      "title" : "Players Theatre",
      "address" : "McGill Student Services Building",
      "address_2" : "3480 McTavish, 3rd Floor",
      "city" : "Montreal",
      "iso_country" : "CA",
      "iso_region" : "CA-QC",
      "phone_number" : "",
      "phone_number_2" : "",
      "postal_code" : "H3A-1X9",
      "map_point_url" : "http:\/\/maps.google.com\/maps?q=H3A-1X9&hl=en&ll=45.503189,-73.576984&spn=0.022017,0.055747&sll=37.0625,-95.677068&sspn=50.51141,114.169922&hnear=Montreal,+Quebec+H3A+1X9,+Canada&t=m&z=15"
    },
    "products" : {
      "product" : [
        {
          "id" : 15643,
          "sku" : "test_shipping_weight",
          "identifier" : "test_shipping_weight",
          "name" : "Test shipping weight EN",
          "currency" : "CAD",
          "description_short" : "",
          "description_full" : "<br>",
          "type" : "regular",
          "price" : "800.00",
          "rebate_price" : "800.00",
          "is_active" : true,
          "is_buyable" : true,
          "is_shippable" : true,
          "is_featured_new" : true,
          "weight" : 10,
          "length" : 12,
          "width" : 2,
          "height" : 50,
          "in_promotion" : false,
          "parent_product_id" : 0,
          "is_managed_inventory" : false,
          "number_remaining" : 0,
          "number_sold" : 5
        },
        {
          "id" : 15659,
          "sku" : "product_test_event_checkin",
          "identifier" : "product_test_event_checkin",
          "name" : "Product Test event checkin",
          "currency" : "CAD",
          "description_short" : "",
          "description_full" : "<br>",
          "type" : "event",
          "price" : "15.00",
          "rebate_price" : "15.00",
          "is_active" : true,
          "is_buyable" : true,
          "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
        },
        {
          "id" : 15677,
          "sku" : "test_promotion",
          "identifier" : "test_promotion",
          "name" : "Test promotion",
          "currency" : "CAD",
          "description_short" : "",
          "description_full" : "<div id=\"lipsum\">\n<p>\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi ipsum \nvelit, pellentesque bibendum scelerisque vitae, facilisis non turpis. \nDuis nec augue purus, vitae dictum odio. Sed et leo sed dolor hendrerit \nconvallis. Sed orci arcu, venenatis vitae facilisis eu, iaculis non \nnisl. Aenean a egestas est. Curabitur condimentum malesuada nisi at \nconsequat. Praesent eu lectus augue, sed eleifend eros. Proin \ncondimentum convallis quam, a blandit ligula tempor id.\n<\/p>\n<p>\nAliquam erat volutpat. Etiam urna purus, sollicitudin at semper eu, \negestas sit amet enim. Praesent quis malesuada nisl. Suspendisse tortor \ndui, tempus et hendrerit vel, vehicula vel ligula. Morbi vitae felis \ndiam. Vivamus risus justo, interdum in mollis hendrerit, tempus eget \nest. Suspendisse rutrum sapien ut nunc sodales gravida. Fusce risus \nurna, varius a iaculis vel, pharetra at ipsum. Pellentesque commodo \nvestibulum adipiscing. Donec pulvinar tincidunt venenatis.\n<\/p>\n<p>\nVestibulum auctor libero id sem fringilla ut consequat leo euismod. \nPhasellus at neque neque. Sed non fermentum sapien. Sed quis sagittis \nnisl. Nulla aliquam placerat interdum. Fusce id lorem dolor. Sed enim \nmi, ornare nec pharetra quis, congue eu eros. Maecenas pretium placerat \nultricies. Donec non urna nibh. Maecenas vitae odio quis tellus sodales \niaculis. Sed neque mauris, convallis ac aliquet vitae, rhoncus sit amet \ntellus. Cras quis tincidunt neque. Integer consequat accumsan nulla, ac \ndictum est malesuada sed. Suspendisse vel dignissim neque. Etiam \nvenenatis, risus sed egestas luctus, leo nisi placerat augue, vel \naccumsan ligula sapien nec turpis. <br><\/p><ul><li>Item 1<br><\/li><li>Item 2<br><\/li><li>Item 3<br><\/li><\/ul>\n<p>\nDonec turpis tellus, suscipit nec sollicitudin eu, eleifend eu libero. \nDuis dapibus sapien sollicitudin erat venenatis fringilla ullamcorper \nnibh sollicitudin. Ut turpis nunc, tristique quis luctus non, blandit \nnon lectus. Mauris aliquet elit ac eros dignissim in pharetra quam \nfringilla. Donec orci eros, tristique in tempus quis, vehicula nec \nligula. Morbi aliquet rhoncus euismod. Mauris auctor eros eget nisi \nelementum eu vehicula tellus gravida. Aliquam aliquet egestas \nadipiscing. Phasellus pellentesque pellentesque dolor in sollicitudin. \nPellentesque a ante quis lacus fermentum lobortis et eget enim.\n<\/p>\n<p>\nPhasellus non quam odio. In ipsum neque, mollis quis laoreet sed, \nadipiscing sed nunc. Cras sed enim diam. Cras sed nulla vel purus \nconvallis facilisis in auctor quam. Phasellus venenatis semper \nfermentum. Curabitur lacinia tincidunt arcu in varius. Aliquam placerat \ndiam a urna dignissim euismod. Phasellus ultricies orci sit amet eros \nvehicula sed fermentum magna ullamcorper.\n<\/p><\/div>",
          "type" : "regular",
          "price" : "15.00",
          "rebate_price" : "12.00",
          "is_active" : true,
          "is_buyable" : true,
          "is_shippable" : false,
          "is_featured_new" : false,
          "weight" : 0,
          "length" : 0,
          "width" : 0,
          "height" : 0,
          "in_promotion" : true,
          "parent_product_id" : 0,
          "is_managed_inventory" : false,
          "number_remaining" : 0,
          "number_sold" : 0
        }
      ]
    }
  }
}

Objet de réponse "Event"

Champ Type de donnée Description
id long Le numéro d'identification unique de l'événement . L'ID est généré automatiquement et ne peut pas être changé .
name string Le nom de l'événement.
url string L'adresse URL du détail de l'événement
url_key string La clé url "identifiant unique"
available_places int Le nombre de places disponibles.
sold_places int Le nombre de places vendues.
description_short string La description courte de l'événement.
description_full text La description complète de l'événement.
start_date Date ISO-8601 Date de début.
end_date Date ISO-8601 Date de fin.
timezone string Le fuseau horaire de l'événement.
capacity int Le nombre maximal de participants.
logo string L'adresse url du logo.
venue EventVenue Lieu de l'événement.
products list<Product> La liste des produits reliés à l'événement

Objet de réponse "EventVenue"

Champ Type de donnée Description
title string Le titre du lieu.
address string L'adresse ligne 1.
address_2 string L'adresse ligne 2.
city string La ville.
iso_country string Le code iso de pays.
iso_region string Le code iso de la région.
phone_number string Le numéro de téléphone.
phone_number_2 string Le deuxième numéro de téléphone.
postal_code string Le code postale.
fax_number string Le numéro de fax.
map_point_url string URL de la carte Google.