API : paniers abandonnés

Voici la documentation pour accéder aux paniers abandonnés via notre API REST.

GET /carts/abandoned

Cette méthode retourne tous les paniers abandonnés avec une limite de pagination de 25 et un décalage par défaut de 0.

URL de la ressource

GET https://app.snipcart.com/api/carts/abandoned

En-têtes

Nom	Valeur	Obligatoire?	Description
Accept	application/json	Oui	Notre API n'accepte que le type de contenu application/json, vous devez donc toujours spécifier l'en-tête Accept: application/json dans chaque requête que vous effectuez.

Paramètres

Nom	Obligatoire?	Type	Description
limit	Non	int	Nombre maximum de résultats à récupérer à chaque requête. La valeur par défaut est 20.
continuationToken	Non	int	Jeton reçu d'une requête antérieure, qui doit être passé pour obtenir les prochains résultats pour cette requête particulière.
timeRange	Non	string	Un critère d'intervalle de temps pour la collection (les valeurs peuvent être : `Anytime`, `LessThan4Hours`, `LessThanADay`, `LessThanAWeek`, `LessThanAMonth`).
minimalValue	Non	int	Vous pouvez spécifier une valeur minimale pour vos requêtes, les paniers abandonnés dont le montant total est inférieur à cette valeur ne seront pas retournés.
email	Non	string	Vous pouvez spécifier un courriel à votre requête, les paniers abandonnés avec une valeur de courriel différente ne seront pas retournés.
productId	Non	string	Vous pouvez spécifier un identifiant de produit à vos requêtes, les paniers abandonnés ne contenant pas le produit associé ne seront pas retournés.

Pagination

Chaque requête retourne la propriété booléenne hasMoreResults. Lorsque hasMoreResults est true, un jeton sera retourné dans la propriété continuationToken. Ce jeton doit être passé dans une requête suivante pour obtenir les prochains résultats pour cette requête particulière.

Exemple de requête

curl -H "Accept: application/json" \
    https://app.snipcart.com/api/carts/abandoned?offset=0&limit=50&timeRange=LessThan4Hours \
    -u {API_KEY}:

Exemple de réponse

{
  "minimalValue": null,
  "timeRange": "LessThan4Hours",
  "email": null,
  "productId": null,
  "totalItems": 1,
  "offset": 0,
  "limit": 25,
  "hasMoreResults": true,
  "continuationToken": "Cart|9rZW4iOiIrUklEOkVsaG1BTjRFel...",
  "items": [
    {
      "token": "5e6e8393-c02c-4a44-a054-6dc8356bab66",
      "email": "geeks@snipcart.com",
      "mode": "Test",
      "status": "InProgress",
      "shipToBillingAddress": true,
      "billingAddress": {
        "fullName": "Geeks",
        "firstName": null,
        "name": "Geeks",
        "company": "Snipcart",
        "address1": "226 Rue Saint-Joseph Est",
        "address2": "",
        "city": ", Ville de Québec",
        "country": "CA",
        "postalCode": "G1K3A9",
        "province": "QC",
        "phone": "(555)555-5555"
      },
      "modificationDate": "2016-11-08T17:15:12.827Z",
      "shippingAddress": {
        "fullName": "Geeks",
        "firstName": null,
        "name": "Geeks",
        "company": "Snipcart",
        "address1": "226 Rue Saint-Joseph Est",
        "address2": "",
        "city": ", Ville de Québec",
        "country": "CA",
        "postalCode": "G1K3A9",
        "province": "QC",
        "phone": "(555)555-5555"
      },
      "completionDate": null,
      "invoiceNumber": "",
      "shippingInformation": {
        "provider": null,
        "fees": 10,
        "method": "Fast custom shipping"
      },
      "paymentMethod": 0,
      "summary": {
        "subtotal": 20,
        "taxableTotal": 20,
        "total": 30,
        "paymentMethod": 0,
        "taxes": [],
        "adjustedTotal": 30
      },
      "metadata": {},
      "items": [
        {
          "uniqueId": "0fe3b1d4-3334-4d34-9722-a4d59f529190",
          "token": "5e6e8393-c02c-4a44-a054-6dc8356bab66",
          "id": "42",
          "name": "The Geek Shirt",
          "price": 20,
          "description": "Be the coolest geek in town with this awesome shirt.",
          "url": "https://snipcart.com/",
          "image": "http://i.imgur.com/BbCiBGg.png",
          "quantity": 1,
          "minQuantity": null,
          "maxQuantity": null,
          "stackable": true,
          "shippable": true,
          "taxable": true,
          "taxes": [],
          "customFields": [],
          "duplicatable": false,
          "alternatePrices": {},
          "dimensions": {
            "width": null,
            "height": null,
            "length": null,
            "weight": 20
          },
          "unitPrice": 20,
          "totalPrice": 20,
          "addedOn": "2016-11-08T17:15:13.517Z"
        },
        ...
      ],
      "discounts": [],
      "customFields": [],
      "plans": [],
      "refunds": [],
      "currency": "cad",
      "totalWeight": 20,
      "total": 30
    },
    ...
  ]
}

GET /carts/abandoned/{token}

Cette méthode retourne un panier abandonné particulier.

URL de la ressource

GET https://app.snipcart.com/api/carts/abandoned/{token}

En-têtes

Nom	Valeur	Obligatoire?	Description
Accept	application/json	Oui	Notre API n'accepte que le type de contenu application/json, vous devez donc toujours spécifier l'en-tête Accept: application/json dans chaque requête que vous effectuez.

Paramètres

Nom	Obligatoire?	Type	Description
token	Oui	Guid	Le jeton unique de la commande.

Exemple de requête

curl -H "Accept: application/json" \
    https://app.snipcart.com/api/carts/abandoned/35cb24c1-00d5-4b26-a16d-4a99bcde8ea3 \
    -u {API_KEY}:

Exemple de réponse

{
  "token": "35cb24c1-00d5-4b26-a16d-4a99bcde8ea3",
  "email": "fdsfsdfdsfdsfsdfs@gmail.com",
  "mode": "Test",
  "status": "InProgress",
  "shipToBillingAddress": true,
  "billingAddress": {
    "fullName": "Geeks",
    "firstName": null,
    "name": "Geeks",
    "company": "Snipcart",
    "address1": "226 Rue Saint-Joseph Est",
    "address2": "",
    "city": ", Ville de Québec",
    "country": "CA",
    "postalCode": "G1K3A9",
    "province": "QC",
    "phone": "(555)555-5555"
  },
  "modificationDate": "2016-11-08T17:48:23.997Z",
  "shippingAddress": {
    "fullName": "Geeks",
    "firstName": null,
    "name": "Geeks",
    "company": "Snipcart",
    "address1": "226 Rue Saint-Joseph Est",
    "address2": "",
    "city": ", Ville de Québec",
    "country": "CA",
    "postalCode": "G1K3A9",
    "province": "QC",
    "phone": "(555)555-5555"
  },
  "completionDate": null,
  "invoiceNumber": "",
  "shippingInformation": {
    "provider": null,
    "fees": 10,
    "method": "Fast custom shipping"
  },
  "paymentMethod": 0,
  "summary": {
    "subtotal": 20,
    "taxableTotal": 20,
    "total": 30,
    "paymentMethod": 0,
    "taxes": [],
    "adjustedTotal": 30
  },
  "metadata": {},
  "items": [
    {
      "uniqueId": "27ab2f3e-1a03-4b23-9407-65d940b182ea",
      "token": "35cb24c1-00d5-4b26-a16d-4a99bcde8ea3",
      "id": "42",
      "name": "The Geek Shirt",
      "price": 20,
      "description": "Be the coolest geek in town with this awesome shirt.",
      "url": "https://snipcart.com/",
      "image": "http://i.imgur.com/BbCiBGg.png",
      "quantity": 1,
      "minQuantity": null,
      "maxQuantity": null,
      "stackable": true,
      "shippable": true,
      "taxable": true,
      "taxes": [],
      "customFields": [],
      "duplicatable": false,
      "alternatePrices": {},
      "dimensions": {
        "width": null,
        "height": null,
        "length": null,
        "weight": 20
      },
      "unitPrice": 20,
      "totalPrice": 20,
      "addedOn": "2016-11-08T17:48:25.01Z"
    },
    ...
  ],
  "discounts": [],
  "customFields": [],
  "plans": [],
  "refunds": [],
  "currency": "cad",
  "totalWeight": 20,
  "total": 30
}