GET /timeline-service/timeline

Parameters

update_ts parameter can be applied only for head chunk (request without id parameter).

Records with type coins could contains action field with values described below.

SET_PRODUCTS - user can attach gtins for recognized receipt (Read recognized receipt data list and then Set gtins to product names
SET_PRODUCTS_PENDING - gtins has been attached by user and currently in progress state (SET_PRODUCTS -> SET_PRODUCTS_PENDING)
SET_RETAILER - user can attach retailer for receipt (Get retailers list and then Set receipt retailer)

GOTO_RETAILER - Go to retailer folder

Coin booster notification

{
    "claim_id": "00000000-0000-0000-0000-000000000000",
    "coins": "61150000000000000000",
    "header": "Your Coin Booster rewards have arrived",
    "image_type": "coin-booster",
    "publish_ts": "2023-09-11T08:42:25Z",
    "status": "approved",
    "text": "Look at you go! You earned <b>61.15 coins</b> for purchasing Homestyle Low Carb Loaf <b>coin booster item</b>.",
    "ts": "2023-09-11T08:42:25Z",
    "type": "coins",
    "use_header": true
}

Receipt notification message. Pending

{
    "claim_id": "383c51e1-7b2c-4f6e-a431-f3b62bc4e316",
    "coins": "6000000000000000000",
    "publish_ts": "2023-08-21T06:44:39Z",
    "receipt_id": "abff4e0b-fd44-4c1e-9246-40b77309bf54",
    "scan_id": null,
    "status": "pending",
    "text": "Your 6 coins were added and are awaiting review. ",
    "ts": "2023-08-21T06:44:39Z",
    "type": "coins"
}

Receipt notification message. Success

{
    "action": "GOTO_RETAILER",
    "claim_id": "e1f31e6e-4b46-491e-b7d9-3d869a62888d",
    "coins": "6000000000000000000",
    "header": "Receipt uploaded!",
    "image_type": "receipt-ok",
    "publish_ts": "2023-08-21T07:33:21Z",
    "receipt_id": "2187db37-9399-4d49-afa3-ed2f05dd64e0",
    "retailer": "kmart",
    "scan_id": null,
    "status": "approved",
    "text": "Receipt Kmart successfully uploaded and stored. Click to view it in the Kmart folder.",
    "ts": "2023-08-21T07:33:21Z",
    "type": "coins", 
    "retailer_name": "Kmart",
    "use_header": true
}

Receipt notification message. Duplicate

{
    "action": "GOTO_RETAILER",
    "claim_id": "383c51e1-7b2c-4f6e-a431-f3b62bc4e316",
    "coins": "6000000000000000000",
    "header": "Receipt uploaded!",
    "image_type": "receipt-warning",
    "publish_ts": "2023-08-21T06:46:49Z",
    "receipt_id": "abff4e0b-fd44-4c1e-9246-40b77309bf54",
    "retailer": "kmart",
    "scan_id": null,
    "status": "rejected",
    "text": "Receipt 01212338114502203141534081002600 successfully uploaded and can be found in the Kmart folder. </br>Oops! No rewards granted this time as this receipt has already been uploaded previously",
    "ts": "2023-08-21T06:46:49Z",
    "type": "coins", 
    "retailer_name": "Kmart",
    "use_header": true
}

Receipt notification message. Old

{
    "action": "GOTO_RETAILER",
    "claim_id": "2b3671e3-8fc2-4a64-8cd5-ce66fee4e0ec",
    "coins": "6000000000000000000",
    "header": "Receipt uploaded!",
    "image_type": "receipt-ok",
    "publish_ts": "2023-08-21T07:26:41Z",
    "receipt_id": "457ff2fa-15f1-424a-85e8-1dde69ab6305",
    "retailer": "kmart",
    "scan_id": null,
    "status": "rejected",
    "text": "Receipt 01212338114502203141534081002600 successfully uploaded and can be found in the Kmart folder. </br>Oops! No rewards granted this time. Purchase date is outside the 5-day term. Don't worry, you can earn rewards on your next purchase!",
    "ts": "2023-08-21T07:26:41Z",
    "type": "coins", 
    "retailer_name": "Kmart",
    "use_header": true
}

Receipt notification message. Not recognized

{
    "claim_id": "b5726fd7-d8b9-4864-ae4a-b2f777e7ecc9",
    "coins": "6000000000000000000",
    "header": "Receipt uploaded!",
    "image_type": "receipt-warning",
    "publish_ts": "2023-08-21T07:21:21Z",
    "receipt_id": "12a4f013-dbe8-4377-8704-4665c1ccdc0c",
    "retailer": "",
    "scan_id": null,
    "status": "rejected",
    "text": "Oops! We couldn't recognize your receipt. Please try uploading again with good lighting, on a flat surface, and capture the full receipt. Check out our video tutorial on Receipt Uploads in Profile tab for more help.",
    "ts": "2023-08-21T07:21:21Z",
    "type": "coins", 
    "retailer_name": "",
    "use_header": true
}

Receipt notification message. Items mapping

{
    "action": "SET_PRODUCTS",
    "claim_id": "e1f31e6e-4b46-491e-b7d9-3d869a62888d",
    "coins": "35118525021949075",
    "group_id": "receipt_product_coins",
    "header": "Receipt Items Rewards",
    "image_type": "receipt-products",
    "publish_ts": "2023-08-21T07:33:21Z",
    "receipt_id": "2187db37-9399-4d49-afa3-ed2f05dd64e0",
    "retailer": "kmart",
    "scan_id": null,
    "status": "approved",
    "text": "Kmart receipt: 01212338114502203141534081002600 Dated 14/03/2022</br>1 out of 5 products have been recognised and rewarded.</br>To claim rewards for the unrecognised products <u>click here</u>",
    "ts": "2023-08-21T07:33:21Z",
    "type": "coins", 
    "retailer_name": "Kmart",
    "use_header": true
}

{
    "action": "SET_PRODUCTS_PENDING",
    "claim_id": "e1f31e6e-4b46-491e-b7d9-3d869a62888d",
    "coins": "35118525021949075",
    "group_id": "receipt_product_coins",
    "header": "Receipt Items Rewards",
    "image_type": "receipt-products",
    "publish_ts": "2023-08-21T07:33:21Z",
    "receipt_id": "2187db37-9399-4d49-afa3-ed2f05dd64e0",
    "retailer": "kmart",
    "scan_id": null,
    "status": "approved",
    "text": "Kmart receipt: 01212338114502203141534081002600 Dated 14/03/2022</br>1 out of 5 products have been recognised and rewarded.</br>To claim rewards for the unrecognised products <u>click here</u>",
    "ts": "2023-08-21T07:33:21Z",
    "type": "coins", 
    "retailer_name": "Kmart",
    "use_header": true
}

Receipt notification message. Items mapping complete

{
    "action": "GOTO_RETAILER",
    "claim_id": "e1f31e6e-4b46-491e-b7d9-3d869a62888d",
    "coins": "35118525021949075",
    "group_id": "receipt_product_coins",
    "header": "Receipt Items Rewards",
    "image_type": "receipt-products",
    "publish_ts": "2023-08-21T07:46:01Z",
    "receipt_id": "2187db37-9399-4d49-afa3-ed2f05dd64e0",
    "retailer": "kmart",
    "scan_id": null,
    "status": "approved",
    "text": "Kmart receipt: 01212338114502203141534081002600 Dated 14/03/2022</br>1 out of 1 products have been recognised and rewarded.",
    "ts": "2023-08-21T07:46:01Z",
    "type": "coins", 
    "retailer_name": "Kmart",
    "use_header": true
}

Example Response

{
  "id": "4eb1752fdd36a3415bce036478002b49",
  "records": [
        {
            "coins": "34110000000000000000",
            "publish_ts": "2023-05-18T02:22:41Z",
            "status": "approved",
            "text": "Look at you go! You earned 34.11 coins for watching <b>Phone</b>.",
            "ts": "2023-05-18T02:22:41Z",
            "tutorial_id": "967a611e-3e54-49c2-aa7d-02228a21b491",
            "type": "coins",
            "video_title": "Phone"
        },
        {
            "coins": "36810000000000000000",
            "is_initial_record": true,
            "publish_ts": "2023-05-31T06:18:40Z",
            "ts": "2023-05-31T06:18:40.425847613Z",
            "tutorial_id": "967a611e-3e54-49c2-aa7d-02228a21b491",
            "type": "video_tutorial",
            "video": {
                "description": "Phone description",
                "main_video": {
                    "height": 1080,
                    "type": "VIDEO",
                    "url": "https://dev-cdn.shping.com/2023/5/16/5961f7b2-258e-4d87-a550-f03914496c1f.mp4",
                    "width": 1920
                },
                "preview_image": {
                    "height": 1080,
                    "type": "IMAGE",
                    "url": "https://dev-cdn.shping.com/2023/5/16/86580078-bc4c-4a95-a752-8a82dc3ff79b.png",
                    "width": 1920
                },
                "title": "Phone"
            }
        },
        {
            "amount_value": 1000,
            "coins": "244100800000000000000",
            "currency": "aud",
            "currency_symbol": "$",
            "loyalty_program_image_small": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
            "loyalty_program_name": "NovaStore",
            "publish_ts": "2023-05-02T03:16:15Z",
            "session_id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
            "status": "approved",
            "sub_type": "retail_connect_rebate",
            "text": "A credit of 244.1008 SHPING loyalty rebate for the purchase of $10.00 at NovaStore",
            "ts": "2023-05-02T03:16:15Z",
            "type": "coins"
        },
        {
            "brand_id": null,
            "brand_logo": null,
            "brand_name": null,
            "coins": 0,
            "contributor_widgets": false,
            "earned_coins": 0,
            "expires_at": "2023-02-08T00:16:24Z",
            "expires_in": 84416,
            "featured_scan": true,
            "image_url": "https://cdn.shping.com/2018/9/7/60bbc846-2192-4806-8faf-bb69c5bb2a18.png",
            "max_coins": "426619880000000000000",
            "owner_id": "urn:authenticateit:participant:735879621218609",
            "owner_logo": "https://dev-cdn.shping.com/2019/3/28/5e1eb1a7-7d38-4d09-bace-a586cb0fc326.png",
            "product_id": "09300462069166",
            "product_name": "Test 1",
            "product_reviews_rate": 0,
            "publish_ts": "2023-02-07T00:16:24Z",
            "scan_id": "ad77794a-6e6c-43bd-a17d-720ac0a6c023",
            "source": "B",
            "text": "Test FP",
            "ts": "2023-02-07T00:16:05.410039741Z",
            "type": "scan"
        },
        {
           "action": "manual_receipt_sharing",
           "action_id": "348b19d6-45bd-4fb1-8ef7-1a953c9d933e",
           "action_inc": -3.4482758620689773,
           "action_ts": "2022-10-06T09:08:29Z",
           "karma_value": 29,
           "text": "Due to upload of the same receipt by a multiple users",
           "ts": "2022-10-06T09:08:33Z",
           "type": "karma_notification"
       },
       {
            "action": "manual_receipt_sharing",
            "action_id": "ea87be4d-c9d4-4e8f-a02c-4d9c52821e7d",
            "action_inc": -5.555555555555555,
            "action_ts": "2022-09-26T03:20:04Z",
            "karma_value": 9.5,
            "text": "Due to upload of the same receipt by a multiple users",
            "ts": "2022-09-26T03:20:12Z",
            "type": "karma_notification"
        },
       {
           "claim_id": "17a4d1db-26c3-458d-8244-b32189a322bc",
           "coins": "1000000000000000000",
           "receipt_id": "ef3cb92b-1692-4fa8-878d-6dcd97d57d00",
           "scan_id": null,
           "status": "pending",
           "text": "Your 1 coins were added and are awaiting review. ",
           "ts": "2022-01-18T12:01:54Z",
           "type": "coins"
       },
       {
           "action": "SET_PRODUCTS",
           "claim_id": "97a4d1db-26c3-458d-8244-b32189a322bc",
           "coins": "88260000000000000000",
           "receipt_id": "9f3cb92b-1692-4fa8-878d-6dcd97d57d00",
           "scan_id": null,
           "status": "approved",
           "text": "We have successfully recognised and processed 2/5 products on your coles receipt number #n1. You have been rewarded 88.26 coins for 2 products. To claim rewards for the unrecognised product, click here.",
           "ts": "2022-01-18T12:05:03Z",
           "type": "coins"
       },
       {
           "action": "SET_PRODUCTS_PENDING",
           "claim_id": "f1442a2a-0fe7-4150-ba3e-710b248b85d7",
           "coins": "44000000000000000000",
           "scan_id": null,
           "receipt_id": "8f3cb92b-1692-4fa8-878d-6dcd97d57d00",
           "status": "approved",
           "text": "We have successfully recognised and processed 1/4 products on your coles receipt number #n1. You have been rewarded 44 coins for 1 products. To claim rewards for the unrecognised product, click here.",
           "ts": "2021-07-31T07:47:03Z",
           "type": "coins"
       },
       {
           "claim_id": "d4e76981-954e-4be9-8a5c-94c8f18b492f",
           "coins": "22000000000000000000",
           "scan_id": null,
           "status": "pending",
           "text": "Thanks! Your request to add a new store for receipt recognition has been received. Once complete your receipt will be processed and relevant rewards credited to your account where possible.",
           "ts": "2021-06-17T10:37:09Z",
           "type": "coins"
       },
       {
           "action": "SET_RETAILER",
           "claim_id": "13340acf-2be1-4c4d-9226-b0ad1d8ae4c2",
           "coins": "22000000000000000000",
           "scan_id": null,
           "status": "pending",
           "text": "Unfortunately, we did not recognise your receipt. By clicking here you can add this store so we can recognise receipts in future.",
           "ts": "2021-06-17T09:20:33Z",
           "type": "coins"
       },
       {
           "brand_id": null,
           "brand_logo": null,
           "brand_name": null,
           "coins": "65000000000000000000",
           "contributor_widgets": false,
           "earned_coins": "65000000000000000000",
           "featured_scan": false,
           "image_url": "https://dev-cdn.shping.com/2020/7/17/31bd5c87-ba34-4fcb-a8e6-87ddd9c8b840.png",
           "max_coins": "572000000000000000000",
           "owner_id": "urn:authenticateit:participant:735879621218609",
           "owner_logo": "https://dev-cdn.shping.com/2019/3/28/5e1eb1a7-7d38-4d09-bace-a586cb0fc326.png",
           "product_id": "09300462114453",
           "product_name": "John West Salmon Tempters Soy Garlic & Sesame",
           "scan_id": "14634464-f0d9-4510-bbf0-08dc276109a6",
           "source": "A",
           "text": "John West Salmon Tempters Soy Garlic & Sesame",
           "ts": "2020-11-20T15:19:50.030564007Z",
           "type": "scan"
       },
       {
            "claim_id": "531c75c0-2ae7-42f7-8832-db5e1fe2eae4",
            "coins": "5000000000000000000",
            "header": "Uh-oh. Your review didn’t make the cut",
            "scan_id": "7e94953a-a957-4d75-9d5f-c62320ebe75a",
            "status": "rejected",
            "text": "Take a look at our review guidelines and have another go. http://info.shping.com/review-posting-guidelines",
            "ts": "2019-03-04T06:21:15Z",
            "type": "coins"
        },
       {
            "review": {
                "comments": [
                    {
                        "id": "19102d53-b62c-4108-ac2f-9678d41b9449",
                        "participant_id": "urn:authenticateit:participant:735879621218609",
                        "text": "test comment",
                        "ts": "2020-12-15T16:09:44Z",
                        "update_ts": "2020-12-16T14:19:23Z",
                        "user_id": "urn:authenticateit:user:email:ethertest3@mailinator.com"
                    }
                ],
                "counters": {
                    "dislikes": 0,
                    "likes": 0
                },
                "custody": "urn:authenticateit:participant:735879621218609",
                "data": {
                    "images": [],
                    "images_orig": null,
                    "rate": 3,
                    "text": "Textbox\nwow\n\nQestion\nQestion?\nAns1\n\nPleas answer\nHow?\nNot bad\n\nQ2\nHow2\nBad"
                },
                "id": "urn:authenticateit:review_doc:579161783059881",
                "owner": {
                    "first_name": "User1",
                    "last_name": "User2",
                    "level": "basic",
                    "photo": "https://dev-cdn.shping.com/2020/3/25/319ab447-ba9c-4c4c-9787-53b0c69fc516",
                    "reviews_karma": 0
                },
                "product": {
                    "counters": {
                        "user_reviews": 1,
                        "user_reviews_rate": 3,
                        "user_scans": 2
                    },
                    "id": "09310047209320",
                    "name": "ETA MAYONNAISE EZYGRIP 3.5KG"
                },
                "rich_data": [
                    {
                        "id": "d943bef9-d641-4c4a-8190-d10dd5b34a81",
                        "text": "Some text",
                        "title": "Some text",
                        "type": "text"
                    },
                    {
                        "coin_weight": 0.16666,
                        "id": "061b8af0-597e-4d6c-bb56-767f697efabb",
                        "text": "wow",
                        "title": "Textbox",
                        "type": "textbox"
                    },
                    {
                        "coin_weight": 0.16666,
                        "id": "20fafb6e-f9b2-452b-8b5a-27c37f64aa05",
                        "rating": 3,
                        "title": "Rate1",
                        "type": "rating"
                    },
                    {
                        "coin_weight": 0.16667,
                        "id": "adf5f90c-5306-4b6b-b704-3d3a27dc974c",
                        "rating": 3,
                        "title": "Rate2",
                        "type": "rating"
                    },
                    {
                        "answer_index": 0,
                        "answers": [
                            {
                                "answer": "Ans1"
                            },
                            {
                                "answer": "Ans2"
                            }
                        ],
                        "choice": "single",
                        "coin_weight": 0.16667,
                        "id": "911014d7-9fb8-4c04-ba13-b1c2b3a25606",
                        "question": "Qestion?",
                        "title": "Qestion",
                        "type": "question"
                    },
                    {
                        "answer_index": [
                            1
                        ],
                        "answers": [
                            {
                                "answer": "Good"
                            },
                            {
                                "answer": "Not bad"
                            },
                            {
                                "answer": "Great"
                            },
                            {
                                "answer": "Bad"
                            },
                            {
                                "answer": "None"
                            }
                        ],
                        "choice": "multiple",
                        "coin_weight": 0.16667,
                        "id": "2eb15316-2aff-4f19-af4f-329bd4ff3290",
                        "question": "How?",
                        "title": "Pleas answer",
                        "type": "question"
                    },
                    {
                        "answer_index": 1,
                        "answers": [
                            {
                                "answer": "Good"
                            },
                            {
                                "answer": "Bad"
                            }
                        ],
                        "choice": "single",
                        "coin_weight": 0.16667,
                        "id": "6b7a1ce8-5f67-459d-8c86-339c9f0bd1b4",
                        "question": "How2",
                        "title": "Q2",
                        "type": "question"
                    }
                ],
                "user_like_option": "none"
            },
            "scan_id": "09da9558-9272-4a6e-b866-4259a43100bc",
            "source": "F",
            "ts": "2020-11-20T10:44:35Z",
            "type": "review"
       },
       {
            "review": {
                "comments": [],
                "custody": "urn:authenticateit:participant:735879621218609",
                "counters": {
                    "dislikes": 0,
                    "likes": 0
                },
                "data": {
                    "rate": 3,
                    "text": "Textbox\nHaha text1\n\nQestion\nQestion?\nAns2"
                },
                "id": "urn:authenticateit:review_doc:451300149399836",
                "owner": {
                    "first_name": "501",
                    "last_name": "501",
                    "level": "basic",
                    "photo": "https://dev-cdn.shping.com/2020/4/27/b08cdf92-4d2d-44e7-8a9a-f1235254b6b5",
                    "reviews_karma": 0
                },
                "product": {
                    "counters": {
                        "user_reviews": 16,
                        "user_reviews_rate": 3.375,
                        "user_scans": 224
                    },
                    "id": "00498765432233",
                    "name": "Test"
                },
                "rich_data": [
                    {
                        "id": "a7877a69-d8a3-4b47-bb95-3a8dfc00c9a4",
                        "text": "Some text",
                        "title": "Some text",
                        "type": "text"
                    },
                    {
                        "coin_weight": 0.25,
                        "id": "8604782d-ad2a-4d49-992f-7c39f92a85d4",
                        "text": "Haha text1",
                        "title": "Textbox",
                        "type": "textbox"
                    },
                    {
                        "coin_weight": 0.25,
                        "id": "9520f933-1d07-4a91-88eb-2a7f0f786191",
                        "rating": 3,
                        "title": "Rate1",
                        "type": "rating"
                    },
                    {
                        "coin_weight": 0.25,
                        "id": "7f600489-a4db-4f0c-9b4c-52f829894d34",
                        "rating": 5,
                        "title": "Rate2",
                        "type": "rating"
                    },
                    {
                        "answer_index": 1,
                        "answers": [
                            {
                                "answer": "Ans1"
                            },
                            {
                                "answer": "Ans2"
                            }
                        ],
                        "choice": "single",
                        "coin_weight": 0.25,
                        "id": "70a811d7-afa9-4d78-87b5-c10917635cea",
                        "question": "Qestion?",
                        "title": "Qestion",
                        "type": "question"
                    }
                ],
                "user_like_option": "none"
            },
            "scan_id": "01765615-9dcb-4f8c-80ef-344d1f9206f8",
            "ts": "2020-04-27T08:39:55Z",
            "type": "review"
       },
       {
           "claim_id": "8c8c34cb-c03a-4905-969e-ce7a765c0899",
           "coins": "5000000000000000000",
           "scan_id": "c5460863-e15b-40c7-abf1-8f1b21214f4c",
           "status": "approved",
           "text": "Earned from <b>System campaign</b> per scan and view info of <b>Bellagio Wine Bianco 750ml</b>.",
           "ts": "2018-03-15T13:03:05Z",
           "type": "coins"
       },
       {
            "coins": "34000000000000000000",
            "contributor_widgets": false,
            "earned_coins": "34000000000000000000",
            "featured_scan": false,
            "image_url": "https://dev-cdn.shping.com/2018/7/11/86efd4a7-e4ba-461f-bf99-cb8f6aed97e3.jpg",
            "max_coins": "39000000000000000000",
            "owner_logo": "https://dev-cdn.shping.com/2019/1/28/5efe62a4-db8c-47ab-94ea-3f43e8cd62e7.jpg",
            "product_id": "09212345000015",
            "product_name": "Calculator  My",
            "product_reviews_rate": 4.4,
            "scan_id": "cdd8f214-967f-411f-b05f-15ac5ebc8185",
            "owner_id": "urn:authenticateit:participant:735879621218609",
            "text": "Calculator  My",
            "ts": "2019-03-30T15:32:10.712300429Z",
            "type": "scan"
       },
       {
            "brand_id": null,
            "brand_logo": null,
            "brand_name": null,
            "coins": "23000000000000000000",
            "contributor_widgets": false,
            "earned_coins": "23000000000000000000",
            "featured_scan": true,
            "image_url": "https://dev-cdn.shping.com/2020/7/17/31bd5c87-ba34-4fcb-a8e6-87ddd9c8b840.png",
            "max_coins": "35000000000000000000",
            "owner_id": "urn:authenticateit:participant:735879621218609",
            "owner_logo": "https://dev-cdn.shping.com/2019/3/28/5e1eb1a7-7d38-4d09-bace-a586cb0fc326.png",
            "product_id": "09334992011609",
            "product_name": "Knauf Accuhat Top Hat 50/15 1.15bmt 6000 Qty 1",
            "product_reviews_rate": 0,
            "scan_id": "28cf166e-ee18-48b1-a234-a1f833a50ebb",
            "source": null,
            "text": "Knauf Accuhat Top Hat 50/15 1.15bmt 6000 Qty 1",
            "ts": "2020-11-19T13:16:58.100188000Z",
            "type": "scan"
        },
       {
           "rule_id": "scan_interval",
           "scan_id": "c5460863-e15b-40c7-abf1-8f1b21214f4c",
           "campaign_id": "urn:authenticateit:campaign:006501147548377",
           "is_blocked_notification": true,
           "text": "You have been temporarily blocked from earning coins for 1 hour",
           "ts": "2018-03-15T12:01:42Z",
           "type": "notification"
       },
       {
           "text": "65 65 poked you: \"Hey, you are my Shping Buddy. Please scan more so we could faster get our rewards!\"",
           "ts": "2018-01-18T22:07:55Z",
           "type": "notification"
       }
  ],
  "update_ts": "2019-03-06T04:17:38Z",
  "next": "4eb1752fdd36a3415bce0364780032aa"
}

Update initial timeline entry for the specified set of countries. To update default entry set countries to null or don't specify countries.

POST /timeline-service/timeline/initial/entries/update

Parameters

Example Request

{
  "countries": [
    "036",
    "643"
  ],
  "messages": [
    {
      "en": "Message 1, English text.",
      "ru": "Сообщение 1, русский текст."
    },
    "Message 2, English text only."
  ],
  "gtins": [
    "09000000009998",
    "09212345000008"
  ]
}

Example Response

{
  "countries": [
    "036",
    "643"
  ],
  "gtins": [
    "09000000009998",
    "09212345000008"
  ],
  "messages": [
    {
      "en": "Message 1, English text.",
      "ru": "Сообщение 1, русский текст."
    },
    "Message 2, English text only."
  ]
}

Read initial timeline entry for the specified set of countries. If countries is unspecified or null, default entry for all countries will be read.

POST /timeline-service/timeline/initial/entries/read

Parameters

Example Request

{
  "countries": [
    "643",
    "036"
  ]
}

Example Response

{
  "countries": [
    "036",
    "643"
  ],
  "gtins": [
    "09000000009998",
    "09212345000008"
  ],
  "messages": [
    {
      "language": "en",
      "text": "English text."
    },
    {
      "language": "ru",
      "text": "Русский текст."
    }
  ]
}

Read all initial timeline entries. List of all available entries will be returned.

GET /timeline-service/timeline/initial/entries

Parameters

Example Response

[
  {
    "countries": null,
    "gtins": [],
    "messages": [
      {
        "language": "en",
        "text": "English text."
      }
    ]
  },
  {
    "countries": [
      "036",
      "643"
    ],
    "gtins": [
      "09000000009998",
      "09212345000008"
    ],
    "messages": [
      {
        "language": "en",
        "text": "English text."
      },
      {
        "language": "ru",
        "text": "Русский текст."
      }
    ]
  }
]

Delete initial timeline entry for the specified set of countries.

POST /timeline-service/timeline/initial/entries/delete

Parameters

Example Request

{
  "countries": [
    "036",
    "643"
  ]
}

Gather data for initial timeline for the specified country and language. Response will contain the list of records (notification and scan records for initial timeline) and the list of emulated scans.

This API is accessible by unregistered users.

GET /timeline-service/timeline/initial

Parameters

Example Response

{
  "records": [
    {
      "text": "English text.",
      "ts": "2019-03-06T06:30:40Z",
      "type": "notification"
    },
    {
      "coins": 0,
      "earned_coins": 0,
      "image_url": "https://demo.authenticateit.com/upload/2014/12/03/95f2ae87-0f18-4ce3-93a9-890c0ef9dfbe.jpg",
      "max_coins": 0,
      "product_name": "Test Recalled Product",
      "scan_id": "2bdd12f5-6a41-43e2-a8ce-b59e8ecf0379",
      "text": "Test Recalled Product",
      "ts": "2019-03-06T06:30:40Z",
      "type": "scan"
    }
  ],
  "scans": [
    {
      "data": [
        {
          "id": "5cfb55a1-e47b-4e76-8959-5293288505cc",
          "image": [
            {
              "url": "https://demo.authenticateit.com/upload/2014/12/03/95f2ae87-0f18-4ce3-93a9-890c0ef9dfbe.jpg"
            },
            {
              "url": "https://cdn.shping.com/2018/12/10/2fb7-4392-9f20-b2d272b0faea.jpeg"
            }
          ],
          "type": "contributor"
        },
        {
          "id": "ffe17a9b-9527-422d-8602-f8c88c849931",
          "title": {
            "text": "Test Recalled Product"
          }
        },
        {
          "id": "61651382-5ea0-423f-a930-2dfe86fa3541",
          "text": {
            "markdown": false,
            "text": "gerber legendary blades-gerber bear grylls parang machete",
            "title": "Name"
          }
        }
      ],
      "event_ts": "2019-03-06T06:30:40Z",
      "product_name": "Test Recalled Product",
      "scan_id": "2bdd12f5-6a41-43e2-a8ce-b59e8ecf0379"
    }
  ]
}

GET /timeline-service/fp

Parameters

The booster can be activated by the rewards_service method

Example Response

{
    "boosters": [
        {
            "source": null,
            "activated": true,
            "activated_ts": "2023-06-27T11:23:29Z",
            "purchases_limit_per_user": 100,
            "earned_coins": 0,
            "owner_id": "urn:authenticateit:participant:111111111111115",
            "start_date": "2023-06-26",
            "product_name": "Flake Chocolate Bar",
            "scan_id": null,
            "booster_id": "urn:authenticateit:booster:233250563946525",
            "item_price": 23,
            "product_id": "00000093061759",
            "price_currency_label": "$",
            "price": 0.0,
            "type": "scan",
            "text": "Flake Chocolate Bar",
            "brand_name": null,
            "owner_logo": "http://dev-cdn.shping.com/2022/1/25/0fedebb2-6542-450d-ab40-dba37f6a59fd.png",
            "percents": 0,
            "int_id": "2719e294-7cc5-4dbb-badc-f8f58aa9b27a",
            "max_coins": 0,
            "retailers": [
                {
                    "id": "coles",
                    "logo": "http://dev-cdn.shping.com/2022/1/25/0fedebb2-6542-450d-ab40-dba37f6a59fd.png",
                    "name": "Coles",
                    "participant_id": "urn:authenticateit:participant:111111111111115"
                },
                {
                    "id": "iga",
                    "logo": "https://dev-cdn.shping.com/2020/11/30/50af227c-adad-40d0-9981-99257c6f5ba2.png",
                    "name": "IGA",
                    "participant_id": "urn:authenticateit:participant:111111111111116"
                }
            ],
            "price_rrp": 23,
            "partner_brand": false,
            "price_is_rrp": true,
            "image_url": "https://dev-cdn.shping.com/2019/5/15/69c76082-da94-4985-b5db-ccbf8d7ffd77",
            "end_date": "2023-07-31",
            "ts": "2023-06-28T02:22:04Z",
            "featured_scan": false,
            "price_currency": "AUD",
            "brand_id": null,
            "contributor_widgets": false,
            "coins": "326800000000000000000",
            "campaign_type": "coin_booster",
            "brand_logo": null
        },
        {
            "booster_id": "urn:authenticateit:booster:154598716059798",
            "activated": false,
            "activated_ts": "0000-01-01T00:00:00Z",
            "purchases_limit_per_user": null,
            "campaign_type": "cashout_booster",
            "retailers": [],
            "brand_id": null,
            "brand_logo": null,
            "brand_name": null,
            "coins": 0,
            "contributor_widgets": false,
            "earned_coins": 0,
            "end_date": "2029-01-30",
            "featured_scan": false,
            "image_url": "https://dev-cdn.shping.com/2021/12/6/4dbcd657-0be8-4f23-81e7-b07efdbbe2d5",
            "int_id": "fdb79aa8-0405-478b-8a49-294a9ec5701a",
            "max_coins": 0,
            "owner_id": "urn:authenticateit:participant:111111111111115",
            "owner_logo": null,
            "partner_brand": false,
            "percents": 50,
            "product_id": "00000090693564",
            "product_name": "Lemon Juice",
            "scan_id": null,
            "source": null,
            "start_date": "2020-08-08",
            "text": "Lemon Juice",
            "ts": "2022-06-02T07:44:07Z",
            "type": "scan",
            "price": 1.0,
            "price_currency": "AUD",
            "price_currency_label": "$",
            "price_is_rrp": true
        },
        {
            "booster_id": "urn:authenticateit:booster:498023397264744",
            "activated": false,
            "activated_ts": "0000-01-01T00:00:00Z",
            "purchases_limit_per_user": 1,
            "retailers": [],
            "brand_id": null,
            "brand_logo": null,
            "brand_name": null,
            "campaign_type": "cashout_booster",
            "coins": 0,
            "contributor_widgets": false,
            "earned_coins": 0,
            "end_date": "2029-01-30",
            "featured_scan": false,
            "image_url": "https://dev-cdn.shping.com/2022/3/2/COLG-9300632075461-1.jpg",
            "int_id": "80f9ceb9-2b75-459c-8a03-c8853c372a08",
            "max_coins": 0,
            "owner_id": "urn:authenticateit:participant:735879621218609",
            "owner_logo": "https://dev-cdn.shping.com/2019/3/28/5e1eb1a7-7d38-4d09-bace-a586cb0fc326.png",
            "partner_brand": true,
            "percents": 10,
            "product_id": "09300632075461",
            "product_name": "Palmolive Ultra Strength Concentrate Dishwashing Liquid, 750mL, Gentle Care, Hypoallergenic, Dermatologist Tested, With Aloe Vera Extracts",
            "scan_id": null,
            "source": null,
            "start_date": "2020-08-08",
            "text": "Palmolive Ultra Strength Concentrate Dishwashing Liquid, 750mL, Gentle Care, Hypoallergenic, Dermatologist Tested, With Aloe Vera Extracts",
            "ts": "2022-06-02T07:44:07Z",
            "type": "scan",
            "price": 1.22,
            "price_currency": "AUD",
            "price_currency_label": "$",
            "price_is_rrp": false
        }
    ],
    "fp_records": [
        {
            "brand_id": null,
            "brand_logo": null,
            "brand_name": null,
            "coins": 0,
            "contributor_widgets": false,
            "earned_coins": 0,
            "expires_at": "2023-02-08T00:39:58Z",
            "expires_in": 85566,
            "featured_scan": true,
            "image_url": "https://dev-cdn.shping.com/2019/5/15/a7bfab79-cf48-405c-b25f-9137574da952",
            "max_coins": "414000000000000000000",
            "owner_id": "urn:authenticateit:participant:735879621218609",
            "owner_logo": "https://dev-cdn.shping.com/2019/3/28/5e1eb1a7-7d38-4d09-bace-a586cb0fc326.png",
            "product_id": "09300601007837",
            "product_name": "Extra Mild Olive Oil",
            "product_reviews_rate": 0,
            "publish_ts": "2023-02-07T00:39:58Z",
            "scan_id": "04962601-2932-47f3-9a3d-711446ce6ce3",
            "source": "B",
            "text": "Extra Mild Olive Oil",
            "ts": "2023-02-07T00:39:56.326157116Z",
            "type": "scan"
        },
        {
            "brand_id": null,
            "brand_logo": null,
            "brand_name": null,
            "coins": 0,
            "contributor_widgets": false,
            "earned_coins": 0,
            "featured_scan": true,
            "image_url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png",
            "max_coins": "4313000000000000000000",
            "owner_id": "urn:authenticateit:participant:102065929367721",
            "owner_logo": null,
            "product_id": "00000000000130",
            "product_name": "130LSB",
            "scan_id": "e99f7d41-cabd-4377-bbcf-df2b3717fb67",
            "source": "B",
            "text": "130LSB",
            "ts": "2021-02-15T13:28:13.222760051Z",
            "type": "scan"
        }
    ],
    "specials": [
        {
            "brand_id": "Gigi",
            "brand_logo": null,
            "brand_name": "Gigi",
            "coins": 0,
            "contributor_widgets": false,
            "earned_coins": 0,
            "featured_scan": true,
            "image_url": "https://dev-cdn.shping.com/2019/3/5/e8da4361-0b05-44fb-afee-775c0179116c.jpg",
            "max_coins": "3456050000000000000000",
            "owner_id": "urn:authenticateit:participant:144740048309944",
            "owner_logo": "https://dev-cdn.shping.com/2019/1/29/df145f0f-7d7b-4311-8713-aa1d5a7d20a0.jpg",
            "product_id": "02933451676549",
            "product_name": "Увелка",
            "scan_id": "35b599f6-d715-4acf-847f-d1439916c752",
            "source": "B",
            "special_id": "15fe1d45-8a03-4f32-be39-e43cdf5d9091",
            "text": "Увелка",
            "ts": "2021-02-17T11:08:37.786221153Z",
            "type": "scan"
        },
        {
            "brand_id": null,
            "brand_logo": null,
            "brand_name": null,
            "coins": 0,
            "contributor_widgets": false,
            "earned_coins": 0,
            "featured_scan": true,
            "image_url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png",
            "max_coins": "216050000000000000000",
            "owner_id": "urn:authenticateit:participant:144740048309944",
            "owner_logo": "https://dev-cdn.shping.com/2019/1/29/df145f0f-7d7b-4311-8713-aa1d5a7d20a0.jpg",
            "product_id": "02933451323245",
            "product_name": "45mm steel case 3 hands date black dial steel bracelet",
            "scan_id": "17615a5a-c6c5-4776-b660-6ed8d627088f",
            "source": "B",
            "special_id": "15fe1d45-8a03-4f32-be39-e43cdf5d9091",
            "text": "45mm steel case 3 hands date black dial steel bracelet",
            "ts": "2021-02-17T11:08:37.185378883Z",
            "type": "scan"
        }
    ]
}