Set up invoice annotations

If you want your sellers to be able to add notes to invoices, you can enable annotations.
Annotations are a way of communicating information about an order from the seller, back to your connected ecommerce system (such as Adobe Commerce or Salesforce). For example, a seller might communicate that an order is accepted, or that an item is back-ordered or delayed.

Note that this feature requires additional setup work so you can receive the annotation details.

Once you’ve set up annotation types, you will also need to let your sellers know that annotations are active in the seller portal and how you want them used.

Add an annotation type

Once created, annotation types are visible in the order summary view in the seller portal and available to query via API.

1. Login to Marketplacer and go to Configuration > Invoice Annotation Types.
2. Select New Annotation Type.
3. Enter a name and description for the annotation. Keep the name short (under 255 characters) as it will appear as a drop-down selection to the seller.
4. Select who can view, create, edit and resolve annotations. A typical setup might be that admins and sellers can complete all actions, but customers can only view.
5. When you are finished, select Create. The annotation type is now available for all sellers to use.
6. Repeat from step 2 for any additional annotations. There is no limit to how many you can add.

Manage annotation types

You can create as many annotation types as you want, for different purposes. You might want to notify your sellers before you edit or delete them.

1. Go to Configuration > Invoice Annotation Types.
2. To edit an annotation, including permissions, select the pencil icon.
3. To delete an annotation, select the bin icon.

Example: How the annotation appears on the legacy seller portal

Example: How the annotation appears on seller portal 2.0

Receive annotations from sellers

Annotations are only effective if you set them up to sync through to your ecommerce system.

You can use webhooks, and create a query using Marketplacer’s API that syncs data back to your ecommerce system. You may need help from a technical partner or internal resource to help set this up for you. See also, Marketplacer’s API documentation.

An example query

query {
   invoices(filters: {createdSince: "2022-08-09"}) {
      edges {
         node {
            id
            legacyId
            annotations {
               id
               invoiceAnnotationType {
                  name
                  description
               }
               createdAt
               content
               resolved
               updatedAt
            }
         }
      }
   }
}