Back to all updates

over 6 years ago

Using the Context.IO receipt parsing feature

Hi devs!

If you’re considering using receipt parsing for your app, here’s some additional information to help you get started.

NOTE: The receipt parsing feature is currently in private beta. We are giving advanced access to anyone participating in the Context.IO App Challenge. Please treat all results and findings in regard to receipt parsing as confidential and do not share it outside of your engineering team.

What does it do?

The beta receipt parsing feature will identify an online purchase receipt within an email body and return consistent structured data about the purchase. You have the ability to identify new receipt emails as they arrive, as well as historical emails.

How does it work?

After you’ve added a source and created a webhook (instructions below), receipts will be identified based on the subject line. We will parse the data and return a JSON response object with the details of the order. Receipts that are attachments will not work.

If you’d like to see which fields are returned as part of the response object and some examples, just email support@context.io.

Which merchants are covered?

We can identify receipts from thousands of top online merchants, covering a wide range of retailers from eBay to ThinkGeek to American Girl, and including categories like:

  • Superstores
  • Books, stationery, and photos
  • Clothing, shoes, and apparel
  • Deals, sales, and overstock
  • Food, flowers, jewelry, and gifts
  • Health and beauty
  • Home and office
  • Sports and outdoors
  • Toys, kids, and baby

If you have questions about a specific merchant, please email support@context.io.

How can I use receipt parsing in my app?

When you’re designing your app, remember you’ll need to deliver a valuable experience in order for most consumers to feel comfortable granting you access to their email accounts. That being said, app usage grew 76% in 2014, and shopping apps were one of the leading categories.

This part is of course up to you, but we have a few quick suggestions on how to create value for users:

  • Receipt organization
  • Purchase visualizer
  • New product discovery
  • Product reviews
  • Price comparisons
  • Taxes and expenses
  • Social sharing
  • Streamlined online shopping experience

 How do I start testing?

If you want to receive webhook notifications for all historical emails in addition to all new emails, then you need to use the following setup order:

  1. POST account
  2. POST webhook (filter_parsed_receipts=1 as a parameter to the POST to /2.0/accounts/:account_id/webhooks)
  3. POST source

 If you'd like to receive notifications only when a new receipt arrives in the user's inbox:

  1. Create the account and add a source (email address associated with the account)
  2. Then create a webhook to receive notifications: POST webhook (filter_parsed_receipts=1 as a parameter to the POST to /2.0/accounts/:account_id/webhooks)

Feedback

As with any beta, your feedback is crucial. If you have any questions, comments, or suggestions, please send them to support@context.io. We’d love to hear your input!

Un regard approfondi sur l’analyse des reçus

Bonjour tout le monde!

Si vous considérez l’utilisation de l’analyse des reçus pour votre application, voici quelques renseignements supplémentaires pour vous aider à commencer.

NOTA: La fonction d’analyse des reçus est actuellement en beta privé. Nous offrons l’accès prioritaire à quiconque participe au hackathon ChallengePost. Veuillez considérer comme confidentiels tous les résultats et découvertes concernant l’analyse des reçus et ne les partagez pas en dehors de votre équipe d’ingénierie.

Que fait cette fonction?

La fonction d’analyse des reçus identifie un reçu d’achat en ligne dans le corps d’un courriel et récupère les données structurées au sujet de l’achat. Vous pouvez identifier les nouveaux courriels de reçus au fur et à mesure qu’ils rentrent et aussi analyser les courriels dans votre historique.

Comment ça marche?

Lorsque vous avez ajouté une source et que vous avez créé un webhook (instructions ci-dessous), les reçus sont identifiés en fonction du suject du courriel. Nous analysons les données et nous retournons un objet de réponse JSON contenant les détails de l’achat. Les reçus envoyés en pièce jointe ne pourront pas être analysés.

Si vous voulez savoir quels champs seront retournés dans l’objet de réponse et des exemples, envoyez un courriel à l’adresse support@context.io.

À quels commerçants cela s’applique-t-il?

Nous pouvons identifier des reçus provenant de milliers des plus gros commerçants en ligne, de eBay à ThinkGeek à American Girl, avec des catégories comme :

  • Supermarchés
  • Livres, papeterie et photos
  • Vêtements, chaussures, équipement
  • Affaires, ventes et surplus
  • Nourriture, fleurs, bijoux et cadeaux
  • Santé et cosmétiques
  • Domicile et bureau
  • Sports et extérieur
  • Jouets, enfants et bébés

Si vous avez des questions au sujet d’un commerçant en particulier, communiquez avec support@context.io.

Comment puis-je utiliser l’analyse des reçus dans mon application?

Lorsque vous concevez votre application, rappelez-vous que vous devrez assurer une expérience intéressante pour que les consommateurs se sentent à l’aise de vous donner accès à leur compte courriel. Cela dit, l’utilisation des applications a augmenté de 76 % en 2014, avec les applications de magasinage en tête de file (article en anglais). Cette partie dépend de vous, bien sûr, mais nous avons quelques suggestions rapides pour créer de la valeur aux yeux de vos utilisateurs :

  • Organisation des reçus
  • Visualisation des achats
  • Découverte de nouveaux produits
  • Critiques de produits
  • Comparaisons de prix
  • Taxes et dépenses
  • Partage sur les réseaux sociaux
  • Expérience de magasinage en ligne simplifiée

Comment puis-je commencer l’essai?

Si vous voulez recevoir les notifications de webhook pour tous les courriels de votre historique ainsi que pour tous les courriels entrants, vous devez suivre l’ordre d’installation suivant :

  1. POST account
  2. POST webhook (filter_parsed_receipts=1 en tant que parameter à l’appel POST à /2.0/accounts/:account_id/webhooks)
  3. POST source

Si vous voulez recevoir des notifications seulement lorsqu’un nouveau reçu entre dans votre boîte de courriels :

  1. Créez le compte et ajoutez une source (courriel associé avec le compte)
  2. Créez un webhook afin de recevoir des notifications: POST webhook (filter_parsed_receipts=1 en tant que parameter à l’appel POST à /2.0/accounts/:account_id/webhooks)

Rétroaction

Comme pour tous les beta, votre rétroaction est cruciale. Si vous avez des questions, des commentaires ou des suggestions, veuillez les faire parvenir à support@context.io. Nous avons hâte d’entendre ce que vous en dites.