Skip to main content

Tags API

1. Overview​

The Jakamo Tags API is an XML based API over HTTPS/REST. With the Jakamo Tags API tags can be added to claims and purchase orders. See more detailed description about Tags and Tag groups from the Jakamo User Guide.

Tags API is available only if your company has also PO API or Claim API in use!

2. Authorization​

The Tags API requires Claim API integration or Purchase Order API integration. Consequently, the Tags API uses either Claim API's or Order API's authentication.

Preferred method for authentication towards Jakamo APIs is OAuth2.0, but basic authentication is still supported. If you are using basic authentication for Order integration or Claim integration in use, consider changing to OAuth2.0. Find step-by-step instructions on how to move from basic authentication to OAuth2.0.

3. Tags API endpoints​

Jakamo environmentHTTP requestJakamo API endpoint
Test environmentPOSThttps://demo.thejakamo.com/api/tags/add
Production environmentPOSThttps://www.thejakamo.com/api/tags/add

4. Example request​

In this example, tags Tag one, Tag two and Tag three are added to purchase order in Jakamo.


    <TagList>
        <!-- Indicates the type of item the tags are to be added. One of "claim", "order". -->
        <ItemType>order</ItemType>
        <!-- ID to identify the item the teags are to be added. For claims this is matched to "Claim id" and for orders this is matched to "Purchase order number". -->
        <ID>PO 882</ID>
        <!-- List of tags to be added. Each <Tag>-element is considered as one tag. -->
        <Tags>
            <Tag>Tag one</Tag>
            <Tag>Tag two</Tag>
            <Tag>Tag three</Tag>
        </Tags>
    </TagList>

Help & Support

Didn't you find what you were looking for? Send an email to Jakamo support (support@thejakamo.com) and we will help you.