API : notifications

Les notifications sont des commentaires qui peuvent être ajoutés à une commande. Utilisez-les si vous devez suivre les modifications apportées à une commande ou tout autre élément lié à la commande que vous ne voulez pas oublier.

Les notifications peuvent également être envoyées automatiquement à vos clients.

GET /orders/{token}/notifications

Cette méthode retourne la liste des notifications appartenant à la commande.

URL de la ressource

GET https://app.snipcart.com/api/orders/{token}/notifications

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	Le nombre maximum d'éléments retournés par la requête. La valeur par défaut est 20.
offset	Non	int	Le nombre d'éléments qui seront ignorés. La valeur par défaut est 0.

Exemple de requête

curl -H "Accept: application/json" \
  https://app.snipcart.com/api/orders/{token}/notifications?limit=10&offset=0 |
  -u {API_KEY}:

Exemple de réponse

{
  "totalItems": 3,
  "offset": 0,
  "limit": 10,
  "items": [
    {
      "id": "0c3ac0bb-a94a-45c5-a4d8-a7934a7f180a",
      "creationDate": "2017-07-09T14:59:57.987Z",
      "type": "Comment",
      "deliveryMethod": "None",
      "body": "",
      "message": "Test"
    },
    {
      "id": "8a52d2c5-acbe-478d-8e96-06fbd6755efe",
      "creationDate": "2017-07-09T14:38:39.227Z",
      "type": "Comment",
      "deliveryMethod": "Email",
      "body": "Email body will appear here...",
      "message": "Test",
      "subject": "Information regarding your order SNIP4962 on Snipcart.",
      "sentOn": "2017-07-09T14:38:39.947Z"
    },
    {
      "id": "e013a0d8-dbc2-45dc-85e5-900c0ce55da7",
      "creationDate": "2017-06-07T19:09:29Z",
      "type": "Invoice",
      "deliveryMethod": "Email",
      "body": "Invoice HTML will appear here...",
      "subject": "Order SNIP4962 on Snipcart",
      "sentOn": "2017-06-07T19:09:31.933Z"
    }
  ]
}

POST /orders/{token}/notifications

Cette méthode crée une nouvelle notification sur la commande spécifiée. En fonction de la valeur de deliveryMethod, cette notification peut être envoyée au client ou rester privée pour un usage interne.

URL de la ressource

POST https://app.snipcart.com/api/orders/{token}/notifications

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.
Content-Type	application/json	Oui	Le corps de la requête doit être JSON, nous spécifions donc le type de contenu.

Paramètres

Nom	Obligatoire?	Type	Description
type	Oui	enum	Le type de notification, peut être : Comment, OrderStatusChanged, OrderShipped, TrackingNumber ou Invoice. Utiliser Comment si vous souhaitez envoyer des informations à votre client, les autres types généreront des courriels automatiques.
deliveryMethod	Oui	enum	Peut être Email si vous voulez que la notification soit envoyée par courriel ou None pour la garder privée.
message	Cela dépend*	string	Le message de la notification. *Facultatif lorsqu'utilisé avec le type TrackingNumber

Exemple de requête

curl https://app.snipcart.com/api/orders/{token}/notifications
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -u {API_KEY}: \
  - d "{message: 'This is a test', type: 'Comment', deliveryMethod: 'Email'}"

Exemple de réponse

{
  "id": "bff8418c-1ed2-4ba1-8b40-2a8bbf7dfadc",
  "creationDate": "2017-07-09T15:04:27.0970346Z",
  "type": "Comment",
  "deliveryMethod": "Email",
  "body": "The Email body will appear here...",
  "message": "This is a notification test",
  "subject": "Information regarding your order SNIP4962 on Snipcart.",
  "sentOn": "2017-07-09T15:04:27.4909269Z"
}