Authenticate
The end point /authentication-service provides a method for verification scanned barcode (1D/2D). Mobile application sends scanned information and additional information about an user and a place of scanning
Default widgets document
{
"id": "default_widgets",
"en": {
"age_constraints": [
{
"popup": {
"cancel": "Ok",
"icon": "action",
"text": "This product is not available for your age group.",
"title": "Product information is not available"
}
}
],
"default_images": [
{
"url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png"
}
],
"default_timeline_images": {
"add_photo": "https://cdn.shping.com/2018/9/7/60bbc846-2192-4806-8faf-bb69c5bb2a18.png"
},
"empty": [
{
"popup": {
"cancel": "Ok",
"icon": "action",
"text": "Sorry, this product information is not available for you. Try to scan another product's barcode.",
"title": "Product information is not available"
}
}
],
"error": [
{
"popup": {
"cancel": "Ok",
"icon": "action",
"text": "We don't have information about this product in our database yet. Try to scan another barcode.",
"title": "Oops!"
}
}
]
},
"ru": {
"age_constraints": [
{
"popup": {
"cancel": "Ok",
"icon": "action",
"text": "This product is not available for your age group.",
"title": "Product information is not available"
}
}
],
"default_images": [
{
"url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png"
}
],
"default_timeline_images": {
"add_photo": "https://cdn.shping.com/2018/9/7/60bbc846-2192-4806-8faf-bb69c5bb2a18.png"
},
"empty": [
{
"popup": {
"cancel": "Ok",
"icon": "action",
"text": "Извините, информация по этому продукту недоступна для Вас. Попробуйте отсканировать другой продукт.",
"title": "Информация недоступна"
}
}
],
"error": [
{
"popup": {
"cancel": "Ok",
"icon": "action",
"text": "У нас нет информации по этому продукту. Попробуйте отсканировать другой!",
"title": "Упс!"
}
}
]
},
"st_ts_wr": "2021-10-07T13:58:14Z",
"type": "system_doc",
"zh": {
"age_constraints": [
{
"popup": {
"cancel": "Ok",
"icon": "action",
"text": "This product is not available for your age group.",
"title": "Product information is not available"
}
}
],
"default_images": [
{
"url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png"
}
],
"default_timeline_images": {
"add_photo": "https://cdn.shping.com/2018/9/7/60bbc846-2192-4806-8faf-bb69c5bb2a18.png"
},
"empty": [
{
"popup": {
"cancel": "好的",
"icon": "action",
"text": "对不起，当前无该产品信息，请尝试扫描其他产品的条码。",
"title": "当前无产品信息"
}
}
],
"error": [
{
"popup": {
"cancel": "好的",
"icon": "action",
"text": "数据库里没有该产品的信息，请尝试扫其他的码。",
"title": "对不起！"
}
}
]
}
}
Default brands document
{
"_id": "brands",
"brands": [
{
"id": "1",
"ait_id": "1",
"name": "Jumbo Ugg",
"logo": "https://cdn.shping.com/2017/6/29/5e8ab9c2-c4ac-4ee9-ab05-a9726c64c13f-jumbo.png"
},
{
"id": "2",
"ait_id": "7726",
"name": "A2 Milk",
"logo": "https://cdn.shping.com/2017/6/29/b9117234-0252-4fee-b2d3-4049204747f8-a2milk.png"
},
{
"id": "3",
"ait_id": "10696",
"name": "TW STEEL™",
"logo": "https://cdn.shping.com/2017/6/29/57433cb1-aa93-4f82-9bd6-749d04c21552-twsteel.png"
},
{
"id": "4",
"ait_id": "14310",
"name": "Norco Milk",
"logo": "https://cdn.shping.com/2017/6/29/38ca8faf-2749-4378-9466-5c1ca366abb3-norco.png"
},
{
"id": "5",
"ait_id": "14719",
"name": "Koalabi Australia",
"logo": "https://cdn.shping.com/2017/6/29/fed44083-7e7e-4fef-8370-76b1fde04c75-koalabi.png"
}
],
"type": "public_doc"
}
Prices capture
GET /authentication-service/price/:country/:gtin?api_key=:api_key
Parameters
| Name | Type | Description |
|---|---|---|
| gtin | string | Required: Gtin |
| country | string | Required: Country code |
| api_key | string | Required: API key |
Participant must be GTIN owner
Example Request
https://dev-api.shping.com/authentication-service/price/036/0000093542982?api_key=1ecf0f19-c3ec-4447-8f5e-c47ce625ce3d
Example Response
{
"id": "00000093542982",
"name": "Leggo's Tomato Paste",
"prices": [
{
"city": "city_melbourne",
"country": "036",
"currency": "AUD",
"currency_label": "$",
"is_expired": false,
"owner": "urn:authenticateit:participant:111111111111116",
"product_name": "Leggo's Tomato Paste 375g",
"reference_url": null,
"retailer": "retailer_iga",
"state": "state_victoria",
"ts": "2020-04-29T19:55:01Z",
"value": 3.93
},
{
"city": "city_melbourne",
"country": "036",
"currency": "AUD",
"currency_label": "$",
"discount_value": 3.15,
"is_expired": true,
"owner": "urn:authenticateit:participant:111111111111115",
"product_name": "Organic Tomato Paste",
"reference_url": "https://shop.coles.com.au/a/national/product/gut-health-white",
"retailer": "retailer_coles",
"state": "state_victoria",
"ts": "2019-09-25T05:07:20Z",
"value": 4.00
},
{
"city": "city_melbourne",
"country": "036",
"currency": "AUD",
"currency_label": "$",
"is_expired": false,
"owner": "urn:authenticateit:participant:111111111111114",
"price_per_unit": {
"price": 3.25,
"quantity": 1,
"unit": "each"
},
"product_name": "Leggo's Tomato Paste",
"reference_url": "https://www.woolworths.com.au/shop/productdetails/192161/all-natural-bakery-bars-slice-oat-almond-apricot",
"retailer": "retailer_superpharmacy",
"state": "state_victoria",
"ts": "2021-01-13T15:59:53Z",
"value": 3.25
}
]
}
Preview
GET /authentication-service/preview/:code
Parameters
| Name | Type | Description |
|---|---|---|
| code | string | Required: Scanned code |
Example Response
{
"add_contributor_coins": 0,
"add_contributor_widgets": false,
"brand_id": null,
"country": "036",
"data": [],
"event_ts": "2022-10-19T23:41:43Z",
"image": "https://dev-cdn.shping.com/2022/10/19/d1b14cc6-63ea-4a04-af7b-e0511e2f63f1.jpeg",
"language": "en",
"logo": "https://dev-cdn.shping.com/2022/2/15/718cfc65-b758-4cc1-b61d-4ce60ef6e433.png",
"owner": "urn:authenticateit:participant:1",
"partner_brand": false,
"product_id": "08889888898891",
"product_name": "Test",
"product_type": "gtin",
"scan_id": "8a27d023-bd57-4af8-9639-6244de3ca5c2",
"ts": "2022-10-19T23:41:43Z",
"user_id": "urn:authenticateit:user:email:shping:9cf92a52-e708-4d45-a7f5-53ed475c1c3c"
}
Example Response
{
"add_contributor_coins": "9282460000000000000",
"add_contributor_widgets": true,
"brand_id": null,
"country": "036",
"data": [
{
"id": "c54acb57-d60e-4e70-8daf-4bf71b60ab84",
"popup": {
"cancel": "Not Now",
"icon": "action",
"ok": "Add Product",
"text": "We don’t have any info in our database. Add photos of the product to earn Shping coins: 9.28246",
"title": "Hey! You’ve discovered a new product"
}
},
{
"id": "e3da2781-75af-4c0f-9872-53d19c12828e",
"input_data": {
"field": "required",
"help": "Take a photo of the front of the product",
"item": "front_view",
"name": "Take a photo of the front of the product",
"type": "image"
},
"type": "contributor_info"
},
{
"id": "51d494cf-7af8-48ba-aa80-3438651cf3cc",
"input_data": {
"field": "required",
"help": "Now, take a photo of the back of the product",
"item": "back_view",
"name": "Now, take a photo of the back of the product",
"type": "image"
},
"type": "contributor_info"
},
{
"id": "8d47fa7e-9213-4004-bf32-895f518947ee",
"input_data": {
"field": "optional",
"help": "Take photo of the right side, if it has any info",
"item": "right_view",
"name": "Take photo of the right side, if it has any info",
"type": "image"
},
"type": "contributor_info"
},
{
"id": "d6d009f0-0bee-4145-a8b2-ac29d307f931",
"input_data": {
"field": "optional",
"help": "Take photo of the left side, if it has any info",
"item": "left_view",
"name": "Take photo of the left side, if it has any info",
"type": "image"
},
"type": "contributor_info"
},
{
"id": "2d4870c9-352c-4e5f-952b-b8fb675566c0",
"input_data": {
"field": "optional",
"help": "Take photo of the top side, if it has any info",
"item": "top_view",
"name": "Take photo of the top side, if it has any info",
"type": "image"
},
"type": "contributor_info"
},
{
"id": "6f778a93-277b-43a6-9664-c57e0f620403",
"input_data": {
"field": "optional",
"help": "Take photo of the bottom side, if it has any info",
"item": "bottom_view",
"name": "Take photo of the bottom side, if it has any info",
"type": "image"
},
"type": "contributor_info"
},
{
"id": "1856f9c1-18fb-46fb-88fd-35505a0afb37",
"input_data": {
"field": "optional",
"help": "Add close-up photo of ingredients, if any",
"item": "materials_view",
"name": "Add close-up photo of ingredients, if any",
"type": "image"
},
"type": "contributor_info"
},
{
"id": "a599fe17-d205-4e82-86d5-c4ccf9c55887",
"input_data": {
"field": "optional",
"help": "Add close-up photo of nutritional info, if any",
"item": "nutrition_view",
"name": "Add close-up photo of nutritional info, if any",
"type": "image"
},
"type": "contributor_info"
},
{
"id": "63e3edc8-2987-41e9-9967-444220b59165",
"input_data": {
"field": "optional",
"help": "Add close-up photo of instructions or directions for use, if any",
"item": "instructions_view",
"name": "Add close-up photo of instructions or directions for use, if any",
"type": "image"
},
"type": "contributor_info"
}
],
"event_ts": "2022-10-20T05:43:42Z",
"image": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png",
"language": "en",
"logo": null,
"no_product": true,
"owner": null,
"partner_brand": false,
"product_id": "08889888898860",
"product_name": null,
"product_type": "gtin",
"scan_id": "3ead5a09-36cd-4bfc-8e2a-75c5be1096f3",
"ts": "2022-10-20T05:43:42Z",
"user_id": "urn:authenticateit:user:email:shping:9cf92a52-e708-4d45-a7f5-53ed475c1c3c"
}
Example Response. Code is not GTIN
{
"error": "The code is not supported.",
"error_data": [
"93524170004271"
],
"error_id": "authentication-code_not_supported",
"error_object": null
}
Capture
POST /authentication-service/capture
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| code | string | Scanned code |
| source | string | Source stream |
| language | string | Mobile app's UI language |
| country | string | Country ISO |
| latitude | string | Required: GPS latitude |
| longitude | string | Required: GPS longitude |
| accuracy | string | Required: GPS accuracy (in metres) |
| delay | string | Required: GPS coordinates delay (in seconds) |
| brand_id | string | Brand ID |
| sn | string | Product serial number |
| sn | string | Product serial number |
| include_ift | boolean | Include IFT result |
details widget contains async loadable data flags.details.has_reviews - gtin has reviewsdetails.ibm_food_trust_connected - Gtin owner has connected IFT
Example Response. include_ift=true
With locations_trace_image widget in success status
{
"add_contributor_widgets": false,
"data": [
{
"id": "e7afd72e-2e07-4d03-bfe8-b4900da2ba2a",
"image": [
{
"url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png"
}
],
"type": "default"
},
{
"id": "68af44f9-c3db-4092-bd9b-e9af1a0c1716",
"title": {
"text": "Hello Vita"
}
},
{
"id": "40e9011d-fa08-4317-ae3d-7f891bc54806",
"locations_trace": {
"days_since_production": 10.5,
"days_since_production_datetime": "2023-02-27T02:19:26Z",
"days_to_expiration": 15,
"days_to_expiration_datetime": "2023-03-01T02:19:26Z",
"locations": [
{
"city": "Melbourne",
"country_code": "036",
"entitlement_mode": "linked",
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_farm_1",
"latitude": "-37.844158072288145",
"location_type_id": "FARM",
"location_type_name": "Farm",
"longitude": "144.8828975734826",
"org_id": "22e257c3-2e32-4575-a866-f4964568b0e1",
"party_name": "Salmon Farm 1",
"party_role_code": "FARM",
"postal_code": "3015",
"state": "VIC",
"street_address": "1 Market St, Newport"
},
{
"city": "Warragul",
"country_code": "036",
"entitlement_mode": "linked",
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_lab_1",
"latitude": "-38.1671271",
"location_type_id": "LABORATORY",
"location_type_name": "Laboratory",
"longitude": "145.9270458",
"org_id": "22e257c3-2e32-4575-a866-f4964568b0e1",
"party_name": "Salmon lab 1",
"party_role_code": "LABORATORY",
"postal_code": "3820",
"state": "VIC",
"street_address": "21 Burke St"
},
{
"city": "Wyndham Vale",
"country_code": "036",
"entitlement_mode": "linked",
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_store_1",
"latitude": "-37.8879916",
"location_type_id": "STORE",
"location_type_name": "Store",
"longitude": "144.5907392",
"org_id": "22e257c3-2e32-4575-a866-f4964568b0e1",
"party_name": "Salmon store 1",
"party_role_code": "STORE",
"postal_code": "3024",
"state": "VIC",
"street_address": "205 Greens Rd"
},
{
"city": "Tallarook",
"country_code": "036",
"entitlement_mode": "linked",
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_warehouse_1",
"latitude": "-37.0947252",
"location_type_id": "WAREHOUSE_AND_OR_DEPOT",
"location_type_name": "Warehouse and or depot",
"longitude": "145.102748",
"org_id": "22e257c3-2e32-4575-a866-f4964568b0e1",
"party_name": "Salmon warehouse 1",
"party_role_code": "WAREHOUSE_AND_OR_DEPOT",
"postal_code": "3659",
"state": "VIC",
"street_address": "44 Main Rd"
}
],
"locations_trace": [
{
"destination_location": null,
"event_time": "2023-01-31T21:17:00.000Z",
"event_type": "commission",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:commissioning",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_farm_1",
"step_name": "Commissioning"
},
{
"destination_location": null,
"event_time": "2023-02-01T01:18:00.000Z",
"event_type": "observation",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:shipping",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_farm_1",
"step_name": "Shipping"
},
{
"destination_location": null,
"event_time": "2023-02-01T02:20:00.000Z",
"event_type": "observation",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:receiving",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_farm_1",
"step_name": "Receiving"
},
{
"destination_location": null,
"event_time": "2023-02-02T23:20:00.000Z",
"event_type": "observation",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:shipping",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_warehouse_1",
"step_name": "Shipping"
},
{
"destination_location": null,
"event_time": "2023-02-03T09:21:00.000Z",
"event_type": "observation",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:receiving",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_warehouse_1",
"step_name": "Receiving"
},
{
"destination_location": null,
"event_time": "2023-02-03T23:22:00.000Z",
"event_type": "observation",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:shipping",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_lab_1",
"step_name": "Shipping"
},
{
"destination_location": null,
"event_time": "2023-02-04T07:22:00.000Z",
"event_type": "observation",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:receiving",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_store_1",
"step_name": "Receiving"
}
],
"source": "ibm_food_trust",
"static_image_url": "https://dev-cdn.shping.com/2023/2/17/1f26356b-afab-4a29-beda-b3ace4e5a736.png",
"static_image_url_height": 1008,
"static_image_url_width": 1368
}
},
{
"id": "d5abbb31-99ad-4c82-ba90-e0df661f36f5",
"locations_trace_image": {
"locations_trace_external_url": null,
"locations_trace_image": [
{
"hash": "5bbf6502aa1b84d4b4c52959e9556b7e3ad48ce3",
"height": 800,
"locations_trace_image_size": "800x800",
"status": "success",
"url": "https://dev-cdn.shping.com/2023/2/15/5bbf6502aa1b84d4b4c52959e9556b7e3ad48ce3",
"width": 800
}
],
"locations_trace_source_lists": {
"5bbf6502aa1b84d4b4c52959e9556b7e3ad48ce3": [
{
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_farm_1",
"latitude": "-37.844158072288145",
"longitude": "144.8828975734826",
"party_role_code": "FARM"
},
{
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_warehouse_1",
"latitude": "-37.0947252",
"longitude": "145.102748",
"party_role_code": "WAREHOUSE_AND_OR_DEPOT"
},
{
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_lab_1",
"latitude": "-38.1671271",
"longitude": "145.9270458",
"party_role_code": "LABORATORY"
},
{
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_store_1",
"latitude": "-37.8879916",
"longitude": "144.5907392",
"party_role_code": "STORE"
}
]
},
"source": "ibm_food_trust",
"static_image_url": "https://dev-cdn.shping.com/2023/2/17/7b6c4343-b590-4311-85f4-344518e53542.png",
"static_image_url_height": 291,
"static_image_url_width": 582,
"status": "success"
}
},
{
"id": "ade83936-8504-47ff-a6d6-21ac21d3939f",
"temperature_logs": {
"static_image_url": "https://dev-cdn.shping.com/2023/2/17/fad3766b-d48a-4b66-a1d3-dd9f8dd69bf4.png",
"static_image_url_height": 976,
"static_image_url_width": 1432,
"temperature_aggregation": "days",
"temperature_logs": [
{
"id": "0ebda32c-ef6a-4a2d-b22c-7133b03501aa",
"list": [
{
"ts": "2023-02-03T00:00:00Z",
"value": 6.211538461538462
}
],
"location_ids": [
"urn:ibm:ift:location:loc:9068674652462.salmon_warehouse_1"
],
"ts": "2023-02-03T09:21:00Z"
},
{
"id": "c47492c1-4602-4f02-9fe9-7e768181082f",
"list": [
{
"ts": "2023-02-04T00:00:00Z",
"value": 7.1454545454545455
},
{
"ts": "2023-02-05T00:00:00Z",
"value": 5.979591836734694
}
],
"location_ids": [
"urn:ibm:ift:location:loc:9068674652462.salmon_store_1"
],
"ts": "2023-02-04T07:22:00Z"
}
],
"unit_of_measure": "CEL"
}
},
{
"id": "372f3d47-5718-4cd2-a4fe-2d7ecfe835ed",
"temperature_exceptions": {
"maximum_temperature_threshold": 11,
"minimum_temperature_threshold": 3,
"static_image_url": "https://dev-cdn.shping.com/2023/2/17/22150b12-c598-4a90-9ca7-c47641ee7bcf.png",
"static_image_url_height": 1028,
"static_image_url_width": 1432,
"temperature_exceptions": [
{
"id": "40c3b414-abfd-4b75-b9e5-79c5348d58e8",
"list": [
{
"ts": "2023-02-03T09:21:00Z",
"value": 10
},
{
"ts": "2023-02-03T09:30:00Z",
"value": 10
},
{
"ts": "2023-02-03T09:40:00Z",
"value": 10
},
{
"ts": "2023-02-03T09:50:00Z",
"value": 10
},
{
"orig_value": 14,
"ts": "2023-02-03T10:00:00Z",
"value": 11
},
{
"ts": "2023-02-03T10:10:00Z",
"value": 10
},
{
"ts": "2023-02-03T10:20:00Z",
"value": 10
},
{
"orig_value": 14,
"ts": "2023-02-03T10:30:00Z",
"value": 11
},
{
"ts": "2023-02-03T10:40:00Z",
"value": 10
},
{
"ts": "2023-02-03T10:50:00Z",
"value": 10
},
{
"in_exception": "above",
"ts": "2023-02-03T11:00:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-03T11:10:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-03T11:20:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-03T11:30:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-03T11:40:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-03T11:50:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-03T12:00:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-03T12:10:00Z",
"value": 15
},
{
"in_exception": "below",
"ts": "2023-02-03T12:20:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-03T12:30:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-03T12:40:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-03T12:50:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-03T13:00:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-03T13:10:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-03T13:20:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-03T13:30:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-03T13:40:00Z",
"value": 0
},
{
"ts": "2023-02-03T13:50:00Z",
"value": 10
},
{
"ts": "2023-02-03T14:00:00Z",
"value": 10
},
{
"orig_value": 0,
"ts": "2023-02-03T14:10:00Z",
"value": 3
},
{
"ts": "2023-02-03T14:20:00Z",
"value": 10
},
{
"orig_value": 0,
"ts": "2023-02-03T14:30:00Z",
"value": 3
},
{
"ts": "2023-02-03T14:40:00Z",
"value": 10
},
{
"ts": "2023-02-03T14:50:00Z",
"value": 10
},
{
"ts": "2023-02-03T15:00:00Z",
"value": 10
},
{
"in_exception": "below",
"ts": "2023-02-03T15:10:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-03T15:20:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-03T15:30:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-03T15:40:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-03T15:50:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-03T16:00:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-03T16:10:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-03T16:20:00Z",
"value": -10
},
{
"ts": "2023-02-03T16:30:00Z",
"value": 10
},
{
"ts": "2023-02-03T16:40:00Z",
"value": 10
},
{
"ts": "2023-02-03T16:50:00Z",
"value": 10
},
{
"in_exception": "above",
"ts": "2023-02-03T17:00:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-03T17:10:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-03T17:20:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-03T17:30:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-03T17:40:00Z",
"value": 15
},
{
"ts": "2023-02-03T17:50:00Z",
"value": 10
}
],
"location_ids": [
"urn:ibm:ift:location:loc:9068674652462.salmon_warehouse_1"
],
"ts": "2023-02-03T09:21:00Z"
},
{
"id": "bfdaaaef-947b-4588-80f3-858dfaad02f3",
"list": [
{
"orig_value": 20,
"ts": "2023-02-04T09:21:00Z",
"value": 11
},
{
"ts": "2023-02-04T09:30:00Z",
"value": 10
},
{
"ts": "2023-02-04T09:40:00Z",
"value": 10
},
{
"ts": "2023-02-04T09:50:00Z",
"value": 10
},
{
"orig_value": 14,
"ts": "2023-02-04T10:00:00Z",
"value": 11
},
{
"ts": "2023-02-04T10:10:00Z",
"value": 10
},
{
"ts": "2023-02-04T10:20:00Z",
"value": 10
},
{
"orig_value": 14,
"ts": "2023-02-04T10:30:00Z",
"value": 11
},
{
"ts": "2023-02-04T10:40:00Z",
"value": 10
},
{
"ts": "2023-02-04T10:50:00Z",
"value": 10
},
{
"in_exception": "above",
"ts": "2023-02-04T11:00:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-04T11:10:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-04T11:20:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-04T11:30:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-04T11:40:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-04T11:50:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-04T12:00:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-04T12:10:00Z",
"value": 15
},
{
"in_exception": "below",
"ts": "2023-02-04T12:20:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-04T12:30:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-04T12:40:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-04T12:50:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-04T13:00:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-04T13:10:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-04T13:20:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-04T13:30:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-04T13:40:00Z",
"value": 0
},
{
"ts": "2023-02-04T13:50:00Z",
"value": 10
},
{
"ts": "2023-02-04T14:00:00Z",
"value": 10
},
{
"orig_value": 0,
"ts": "2023-02-04T14:10:00Z",
"value": 3
},
{
"ts": "2023-02-04T14:20:00Z",
"value": 10
},
{
"orig_value": 0,
"ts": "2023-02-04T14:30:00Z",
"value": 3
},
{
"ts": "2023-02-04T14:40:00Z",
"value": 10
},
{
"ts": "2023-02-04T14:50:00Z",
"value": 10
},
{
"ts": "2023-02-04T15:00:00Z",
"value": 10
},
{
"in_exception": "below",
"ts": "2023-02-04T15:10:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-04T15:20:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-04T15:30:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-04T15:40:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-04T15:50:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-04T16:00:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-04T16:10:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-04T16:20:00Z",
"value": -10
},
{
"ts": "2023-02-04T16:30:00Z",
"value": 10
},
{
"ts": "2023-02-04T16:40:00Z",
"value": 10
},
{
"ts": "2023-02-04T16:50:00Z",
"value": 10
},
{
"in_exception": "above",
"ts": "2023-02-04T17:00:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-04T17:10:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-04T17:20:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-04T17:30:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-04T17:40:00Z",
"value": 15
},
{
"ts": "2023-02-04T17:50:00Z",
"value": 10
}
],
"location_ids": [
"urn:ibm:ift:location:loc:9068674652462.salmon_store_1"
],
"ts": "2023-02-04T07:22:00Z"
},
{
"id": "d10e560b-b44d-4528-8302-7fdb82d063eb",
"list": [
{
"in_exception": "above",
"ts": "2023-02-04T17:40:00Z",
"value": 20
},
{
"in_exception": "above",
"ts": "2023-02-04T17:50:00Z",
"value": 20
},
{
"in_exception": "above",
"ts": "2023-02-04T18:00:00Z",
"value": 20
},
{
"ts": "2023-02-05T09:50:00Z",
"value": 10
},
{
"orig_value": 14,
"ts": "2023-02-05T10:00:00Z",
"value": 11
},
{
"ts": "2023-02-05T10:10:00Z",
"value": 10
},
{
"ts": "2023-02-05T10:20:00Z",
"value": 10
},
{
"orig_value": 14,
"ts": "2023-02-05T10:30:00Z",
"value": 11
},
{
"ts": "2023-02-05T10:40:00Z",
"value": 10
},
{
"ts": "2023-02-05T10:50:00Z",
"value": 10
},
{
"in_exception": "above",
"ts": "2023-02-05T11:00:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-05T11:10:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-05T11:20:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-05T11:30:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-05T11:40:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-05T11:50:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-05T12:00:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-05T12:10:00Z",
"value": 15
},
{
"in_exception": "below",
"ts": "2023-02-05T12:20:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-05T12:30:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-05T12:40:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-05T12:50:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-05T13:00:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-05T13:10:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-05T13:20:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-05T13:30:00Z",
"value": 0
},
{
"in_exception": "below",
"ts": "2023-02-05T13:40:00Z",
"value": 0
},
{
"ts": "2023-02-05T13:50:00Z",
"value": 10
},
{
"ts": "2023-02-05T14:00:00Z",
"value": 10
},
{
"orig_value": 0,
"ts": "2023-02-05T14:10:00Z",
"value": 3
},
{
"ts": "2023-02-05T14:20:00Z",
"value": 10
},
{
"orig_value": 0,
"ts": "2023-02-05T14:30:00Z",
"value": 3
},
{
"ts": "2023-02-05T14:40:00Z",
"value": 10
},
{
"ts": "2023-02-05T14:50:00Z",
"value": 10
},
{
"ts": "2023-02-05T15:00:00Z",
"value": 10
},
{
"in_exception": "below",
"ts": "2023-02-05T15:10:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-05T15:20:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-05T15:30:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-05T15:40:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-05T15:50:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-05T16:00:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-05T16:10:00Z",
"value": -10
},
{
"in_exception": "below",
"ts": "2023-02-05T16:20:00Z",
"value": -10
},
{
"ts": "2023-02-05T16:30:00Z",
"value": 10
},
{
"ts": "2023-02-05T16:40:00Z",
"value": 10
},
{
"ts": "2023-02-05T16:50:00Z",
"value": 10
},
{
"in_exception": "above",
"ts": "2023-02-05T17:00:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-05T17:10:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-05T17:20:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-05T17:30:00Z",
"value": 15
},
{
"in_exception": "above",
"ts": "2023-02-05T17:40:00Z",
"value": 15
},
{
"ts": "2023-02-05T17:50:00Z",
"value": 10
}
],
"location_ids": [
"urn:ibm:ift:location:loc:9068674652462.salmon_store_1"
],
"ts": "2023-02-05T07:22:00Z"
}
]
}
}
],
"event_ts": "2023-02-22T00:50:13Z",
"event_ts2": "2023-02-22T00:50:13.720636951Z",
"owner_id": "urn:authenticateit:participant:735879621218619",
"owner_logo": "https://dev-cdn.shping.com/2019/3/28/5e1eb1a7-7d38-4d09-bace-a586cb0fc326.png",
"product_id": "urn:epc:class:lgtin:0498765.043223.hello_lot_1",
"product_name": "Hello Vita",
"scan_id": "9a130883-cc84-4098-a7f6-9a9c08a64960",
"unknown_product": false
}
Example Response. include_ift=true
With locations_trace_image widget in pending status
{
"add_contributor_widgets": false,
"data": [
{
"id": "5043276d-808f-4351-9afb-343e8ebb7eff",
"image": [
{
"url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png"
}
],
"type": "default"
},
{
"id": "a642fd20-5b80-46f7-b5a1-b06ec00238ad",
"title": {
"text": "Hello Vita"
}
},
{
"id": "f2887009-6701-4abd-9eed-b0b4a5b718ed",
"locations_trace": {
"days_since_production": null,
"days_to_expiration": null,
"locations": [
{
"city": "Melbourne",
"country_code": "036",
"entitlement_mode": "linked",
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_farm_1",
"latitude": "-37.844158072288145",
"location_type_id": "FARM",
"location_type_name": "Farm",
"longitude": "144.8828975734826",
"org_id": "22e257c3-2e32-4575-a866-f4964568b0e1",
"party_name": "Salmon Farm 1",
"party_role_code": "FARM",
"postal_code": "3015",
"state": "VIC",
"street_address": "1 Market St, Newport"
},
{
"city": "Warragul",
"country_code": "036",
"entitlement_mode": "linked",
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_lab_1",
"latitude": "-38.1671271",
"location_type_id": "LABORATORY",
"location_type_name": "Laboratory",
"longitude": "145.9270458",
"org_id": "22e257c3-2e32-4575-a866-f4964568b0e1",
"party_name": "Salmon lab 1",
"party_role_code": "LABORATORY",
"postal_code": "3820",
"state": "VIC",
"street_address": "21 Burke St"
},
{
"city": "Wyndham Vale",
"country_code": "036",
"entitlement_mode": "linked",
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_store_1",
"latitude": "-37.8879916",
"location_type_id": "STORE",
"location_type_name": "Store",
"longitude": "144.5907392",
"org_id": "22e257c3-2e32-4575-a866-f4964568b0e1",
"party_name": "Salmon store 1",
"party_role_code": "STORE",
"postal_code": "3024",
"state": "VIC",
"street_address": "205 Greens Rd"
},
{
"city": "Tallarook",
"country_code": "036",
"entitlement_mode": "linked",
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_warehouse_1",
"latitude": "-37.0947252",
"location_type_id": "WAREHOUSE_AND_OR_DEPOT",
"location_type_name": "Warehouse and or depot",
"longitude": "145.102748",
"org_id": "22e257c3-2e32-4575-a866-f4964568b0e1",
"party_name": "Salmon warehouse 1",
"party_role_code": "WAREHOUSE_AND_OR_DEPOT",
"postal_code": "3659",
"state": "VIC",
"street_address": "44 Main Rd"
}
],
"locations_trace": [
{
"destination_location": null,
"event_time": "2023-01-31T21:17:00.000Z",
"event_type": "commission",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:commissioning",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_farm_1",
"step_name": "Commissioning"
},
{
"destination_location": null,
"event_time": "2023-02-01T01:18:00.000Z",
"event_type": "observation",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:shipping",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_farm_1",
"step_name": "Shipping"
},
{
"destination_location": null,
"event_time": "2023-02-01T02:20:00.000Z",
"event_type": "observation",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:receiving",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_farm_1",
"step_name": "Receiving"
},
{
"destination_location": null,
"event_time": "2023-02-02T23:20:00.000Z",
"event_type": "observation",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:shipping",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_warehouse_1",
"step_name": "Shipping"
},
{
"destination_location": null,
"event_time": "2023-02-03T09:21:00.000Z",
"event_type": "observation",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:receiving",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_warehouse_1",
"step_name": "Receiving"
},
{
"destination_location": null,
"event_time": "2023-02-03T23:22:00.000Z",
"event_type": "observation",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:shipping",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_lab_1",
"step_name": "Shipping"
},
{
"destination_location": null,
"event_time": "2023-02-04T07:22:00.000Z",
"event_type": "observation",
"source_location": null,
"step": "urn:epcglobal:cbv:bizstep:receiving",
"step_location": "urn:ibm:ift:location:loc:9068674652462.salmon_store_1",
"step_name": "Receiving"
}
],
"source": "ibm_food_trust"
}
},
{
"id": "b1063593-f2ae-41b0-9a02-6a87ddaa04ea",
"locations_trace_image": {
"locations_trace_external_url": null,
"locations_trace_image": [
{
"hash": "5bbf6502aa1b84d4b4c52959e9556b7e3ad48ce3",
"locations_trace_image_size": "800x800",
"status": "pending",
"height": 800,
"width": 800,
"url": null
}
],
"locations_trace_source_lists": {
"5bbf6502aa1b84d4b4c52959e9556b7e3ad48ce3": [
{
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_farm_1",
"latitude": "-37.844158072288145",
"longitude": "144.8828975734826",
"party_role_code": "FARM"
},
{
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_warehouse_1",
"latitude": "-37.0947252",
"longitude": "145.102748",
"party_role_code": "WAREHOUSE_AND_OR_DEPOT"
},
{
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_lab_1",
"latitude": "-38.1671271",
"longitude": "145.9270458",
"party_role_code": "LABORATORY"
},
{
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_store_1",
"latitude": "-37.8879916",
"longitude": "144.5907392",
"party_role_code": "STORE"
}
]
},
"source": "ibm_food_trust",
"status": "pending"
}
},
{
"id": "ade83936-8504-47ff-a6d6-21ac21d3939f",
"temperature_logs": {
"static_image_url": "https://dev-cdn.shping.com/2023/2/17/fad3766b-d48a-4b66-a1d3-dd9f8dd69bf4.png",
"static_image_url_height": 976,
"static_image_url_width": 1432,
"temperature_aggregation": "days",
"temperature_logs": [
{
"id": "0ebda32c-ef6a-4a2d-b22c-7133b03501aa",
"list": [
{
"ts": "2023-02-03T00:00:00Z",
"value": 6.211538461538462
}
],
"location_ids": [
"urn:ibm:ift:location:loc:9068674652462.salmon_warehouse_1"
],
"ts": "2023-02-03T09:21:00Z"
},
{
"id": "c47492c1-4602-4f02-9fe9-7e768181082f",
"list": [
{
"ts": "2023-02-04T00:00:00Z",
"value": 7.1454545454545455
},
{
"ts": "2023-02-05T00:00:00Z",
"value": 5.979591836734694
}
],
"location_ids": [
"urn:ibm:ift:location:loc:9068674652462.salmon_store_1"
],
"ts": "2023-02-04T07:22:00Z"
}
],
"unit_of_measure": "CEL"
}
}
],
"event_ts": "2023-01-11T05:09:51Z",
"event_ts2": "2023-01-11T05:09:51.621452037Z",
"owner_id": "urn:authenticateit:participant:735879621218609",
"owner_logo": "https://dev-cdn.shping.com/2019/3/28/5e1eb1a7-7d38-4d09-bace-a586cb0fc326.png",
"product_id": "01093000001921652112345678901",
"product_name": "All Natural Bakery Bars Slice Oat Almond & Apricot",
"scan_id": "a00392cd-5f71-4f2e-baac-f69fe03f2425",
"unknown_product": false
}
Example Response
{
"data": [
{
"id": "8cfa5976-854e-41de-b5d2-dcf59878da06",
"rating": {
"enable": true,
"max": 5,
"participants": 2,
"rating": "4.5",
"sorry_msg": "Sorry, we can't accept your assessment :( ",
"success_msg": "Thank you for your opinion!"
}
},
{
"add_image": {
"message": "Add a nice photo of this product"
},
"id": "27d643b2-3069-436b-8bb8-96760f6d5fd1"
},
{
"id": "df53e006-54fd-4a8f-a874-6184f7d619c9",
"popup": {
"cancel": "Not now",
"icon": "message",
"ok": "Add product",
"text": "We don't have information about this product in our DB. Complete product's details to earn **50 points**.",
"title": "You discovered a new product"
}
},
{
"id": "07b59707-21e2-4f18-9c61-ef7879c1118d",
"title": {
"text": "Nike Men's KB Mentality II"
}
},
{
"header": {
"text": "How it works?"
},
"id": "91c7d1d6-37ed-4d9a-a440-45b102271724"
},
{
"id": "530e9979-a4fb-48d3-903f-d4bcd185e8ac",
"coins": "150000123131000",
"text": {
"markdown": true,
"text": "Bla-bla-bla.",
"title": "Traceability & Serialisation Platform"
}
},
{
"id": "e2390b79-16d2-4b6c-8f35-32403c9fb585",
"image": [
{
"url": "https://services.authenticateit.com/upload/991be8ee/2fb7-4392-9f20-b2d272b0faea.jpeg"
},
{
"url": "https://services.authenticateit.com/upload/991be8ee/6788-7868-6786-bc9900900086.jpeg"
}
]
},
{
"id": "bf5aab61-d43e-4a32-869b-3b3a086cd7a1",
"link": {
"text": "Brand web site",
"url": "http://www.koalabi.com.au"
}
},
{
"id": "756513f6-d13f-4528-a885-9580f5a62071",
"coins": 1500000,
"video": {
"preview": "https://services.authenticateit.com/upload/991be8ee/movie.jpg",
"title": "Video",
"url": "https://dev-test-cdn.shping.com.s3.amazonaws.com/2017/4/26/9d511476-ba7f-4b90-9895-7c3ad02c40d3-20100709_002.mp4"
}
},
{
"id": "e2778b4f-ed48-4263-bcc8-ce608599a32b",
"nutrition_info": {
"ingredients": [
{
"allergen": false,
"description": "long text description of the ingredient",
"group": "vitamins",
"name": "Витамин С/Аскорбиновая кислота (в форме кальция аскорбата) 110 мг 120",
"nano": false
},
{
"allergen": false,
"description": "long text description of the ingredient",
"group": "other",
"name": "Rice",
"nano": false
}
],
"nutrition_staff": [
{
"less_than": false,
"name": "Protein",
"rdi": 64,
"unit": "g",
"value": 10
},
{
"less_than": false,
"name": "Fat, total",
"nutrition_staff": [
{
"less_than": true,
"name": "Saturated",
"nutrition_staff": [
{
"less_than": false,
"name": "Omega 3",
"unit": "g",
"value": 1
}
],
"unit": "g",
"value": 0.1
},
{
"less_than": false,
"name": "Omega 3",
"unit": "g",
"value": 1
}
],
"unit": "g",
"value": 2
}
],
"package_size": 1000,
"package_unit": "ml",
"serving_energy": 100,
"serving_size": 200,
"title": "Nutrition Facts"
}
},
{
"certificates": {
"list": [
{
"gdti": "urn:epc:id:gdti:9212345.00002.009114953628221",
"expired": false,
"img_url": "https://services.authenticateit.com/upload/20160831/asureq.png"
},
{
"gdti": "urn:epc:id:gdti:9212345.00002.059612365017382",
"expired": true,
"img_url": "https://services.authenticateit.com/upload/20160831/aco.png"
}
],
"title": "Certificates"
},
"id": "a33be556-6d66-4f47-9ca2-d5ed1b601df8"
},
{
"follow_fb": {
"text": "Follow us",
"url": "https://www.facebook.com/NorcoMilk/"
},
"id": "e994ab9a-5637-4318-9c45-70b9622248a3",
"coins": 35000000
},
{
"follow_fb": {
"text": "Follow us",
"url": "https://www.facebook1.com/NorcoMilk/"
},
"id": "5fb3ea70-4253-4cae-8722-b69dc3ac8477",
"coins": 35131312
},
{
"email": {
"subject": "I have a question",
"text": "Email to support",
"to": "support@authenticateit.com"
},
"id": "779a4031-237e-4ed6-9d7b-1e1511fba843"
},
{
"id": "a230c6b3-1bd5-4f99-8ef8-8992968db466",
"phone": {
"text": "We are waiting your call",
"to": "+61123456789"
}
},
{
"id": "1501ca54-282a-46d9-af6c-65124e752a06",
"coins": "1500000000000",
"video": {
"height": 480,
"preview": "https://services.authenticateit.com/upload/991be8ee/movie.jpg",
"title": "Video",
"url": "https://dev-test-cdn.shping.com.s3.amazonaws.com/2017/4/26/1fe6501e-7ea2-4e99-a0f8-481ac3f24274-20100709_002.mp4",
"width": 848
}
},
{
"id": "89a8d600-057d-481c-8777-852a6466a41e",
"rewards_summary": {
"coins": "2700000000000000"
}
},
{
"competitions": [
{
"coins": "1000000000000000000",
"description": "Simple Competition",
"id": "urn:authenticateit:competition:888582780739927"
},
{
"coins": "1000000000000000000",
"description": "Simple Competition",
"id": "urn:authenticateit:competition:928818499119058",
"t&c_link": "https://www.shping.com"
},
{
"description": "Simple Competition",
"id": "urn:authenticateit:competition:928818499119058",
"t&c_link": "https://www.shping.com"
}
],
"id": "8676d170-e04e-40e6-b421-0bde4f76225f"
},
{
"id": "e19db81c-962a-440b-b1a6-b4bf7e44a8b0",
"text": {
"markdown": false,
"text": "klene",
"title": "Brand"
},
"type": "imported_retailer"
},
{
"id": "02933978-5282-461f-972b-e6170d411085",
"text": {
"markdown": false,
"text": "50g",
"title": "Package Size"
},
"type": "imported_retailer"
},
{
"id": "f961f3ba-6fa2-49c2-9ce0-5cbef58c70bd",
"prices": [
{
"city": "Мельбурн",
"country": "036",
"currency": "AUD",
"currency_label": "$",
"is_expired": false,
"price_per_unit": {
"price": 1.23,
"quantity": 100,
"unit": "g"
},
"product_name": "Herbert Adams Rolls Flaky Cheese & Spinach",
"retailer": "Woolworths",
"state": "Виктория",
"ts": "2020-12-26T15:27:14Z",
"value": 5.4
},
{
"city": "Мельбурн",
"country": "036",
"currency": "AUD",
"currency_label": "$",
"discount_value": 4.3,
"is_expired": true,
"price_per_unit": {
"price": 0.98,
"quantity": 100,
"unit": "g"
},
"product_name": "Frozen Cheese & Spinach Rolls 2 pack",
"retailer": "Coles",
"state": "Виктория",
"ts": "2021-03-30T07:25:38Z",
"value": 5.4
},
{
"city": "Мельбурн",
"country": "036",
"currency": "AUD",
"currency_label": "$",
"discount_value": 4.99,
"is_expired": false,
"product_name": "Herbert Adams Gourmet Vegetarian Delights Cream Cheese & Spinach Savoury Rolls 2x440g",
"retailer": "IGA",
"state": "Виктория",
"ts": "2019-10-03T09:56:17Z",
"value": 5.29
}
]
},
{
"id": "76d6a84f-d6f3-442c-9e8b-d8954756dfa8",
"similar_products_prices": [
{
"prices": [
{
"city": "Мельбурн",
"country": "036",
"currency": "AUD",
"currency_label": "$",
"discount_value": 2.5,
"is_expired": true,
"price_per_unit": {
"price": 10,
"quantity": 1,
"unit": "kg"
},
"product_name": "Middle Bacon",
"retailer": "Coles",
"state": "Виктория",
"ts": "2021-03-30T07:52:41Z",
"value": 3.25
}
],
"product_id": "09311594026354",
"product_name": "Primo Middle Bacon Deli (4)"
}
]
}
],
"event_ts": "2017-05-12T05:00:06Z",
"product_name": "test_name",
"scan_id": "7c94359d-3e67-4155-b2b6-52af234342f6",
"event_ts2": "2019-03-30T15:32:10.712300429Z",
"owner_logo": "https://dev-cdn.shping.com/2019/1/28/5efe62a4-db8c-47ab-94ea-3f43e8cd62e7.jpg",
"product_id": "09212345000015",
"product_reviews_rate": 4.4,
"owner_id": "urn:authenticateit:participant:735879621218609",
"unknown_product": false,
"source": "A",
"add_contributor_widgets": false
}
Example Response. Examples of text widgets with sub_type option and made_in widget
{
"add_contributor_widgets": false,
"data": [
{
"id": "79e55009-9d8d-44c7-8c2c-3ce2caecb5cc",
"image": [
{
"url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png"
}
],
"type": "default"
},
{
"coins": 0,
"id": "af0bf496-3770-48db-96db-52d2780addbd",
"rewards_summary": {
"coins": "309000000000000000000",
"main_summary": true
}
},
{
"id": "ae794e49-7ffc-4aff-a705-d6d2f6d64b8a",
"title": {
"text": "Test"
}
},
{
"coins": "12000000000000000000",
"id": "f0176567-eca8-4a55-a27d-1e857580ffcf",
"start_review": {
"description": "Add the review to earn 12 coins",
"img": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png",
"title": "Add review and earn coins"
}
},
{
"id": "335f5dc9-1bc7-4baa-bf7a-cdcd5861aaed",
"location": {}
},
{
"coins": "297000000000000000000",
"id": "1ba50031-7efb-4cc1-ab97-49aeb07b3e59",
"send_scan_location": {}
},
{
"details": {
"has_reviews": true,
"ibm_food_trust_connected": true
},
"id": "71f0cf4e-1151-473c-90e0-650e5d032593"
},
{
"id": "aa492a24-13dc-48bb-b88b-3b31d1297e2a",
"private": false,
"text": {
"markdown": false,
"text": "Text without type",
"title": "Title without type"
},
"type": "brand"
},
{
"id": "1a8b90cf-c595-4d72-8be2-4de9ca28d9d6",
"private": false,
"text": {
"markdown": false,
"text": "Text without type 1",
"title": "Title without type 1"
},
"type": "brand"
},
{
"id": "8bb5ce35-e6ca-4f8b-93e6-16dba374ed39",
"private": false,
"text": {
"markdown": false,
"sub_type": "instruction",
"text": "Text wit type 1",
"title": "Title with type 1"
},
"type": "brand"
},
{
"id": "2deedd1c-4180-472b-81e0-c86b7f4bc2e3",
"private": false,
"text": {
"markdown": false,
"sub_type": "warning",
"text": "Text wit type 2",
"title": "Title with type 2"
},
"type": "brand"
},
{
"id": "6ff6fbd2-1c8a-47e4-97b2-01dd8271de72",
"private": false,
"text": {
"markdown": false,
"sub_type": "company_name",
"text": "Text wit type 3",
"title": "Title with type 3"
},
"type": "brand"
},
{
"id": "34f2990b-64ec-4b9a-9019-51270c4e6446",
"made_in": {
"country": "036"
},
"private": false,
"type": "brand"
},
{
"id": "196684f8-9e07-4a6c-aa0d-0e0241d43c8e",
"private": false,
"text": {
"markdown": false,
"text": "Text without type imported_retailer 1",
"title": "Title without type imported_retailer 1"
},
"type": "imported_retailer"
},
{
"id": "7164a89b-23ed-4393-9866-c5373722e93d",
"private": false,
"text": {
"markdown": false,
"sub_type": "instruction",
"text": "Text wit type imported_retailer 1",
"title": "Title with type imported_retailer 1"
},
"type": "imported_retailer"
},
{
"id": "aa0ef72d-b51f-4381-9b33-a164193ca50e",
"private": false,
"text": {
"markdown": false,
"sub_type": "warning",
"text": "Text wit type imported_retailer 2",
"title": "Title with type imported_retailer 2"
},
"type": "imported_retailer"
},
{
"id": "aba740f2-3faf-4eff-9a5d-bc985c129bd1",
"private": false,
"text": {
"markdown": false,
"sub_type": "company_name",
"text": "Text with type imported_retailer 3",
"title": "Title with type imported_retailer 3"
},
"type": "imported_retailer"
}
],
"event_ts": "2020-04-03T07:57:58Z",
"event_ts2": "2020-04-03T07:57:58.832978383Z",
"owner_logo": "https://dev-cdn.shping.com/2019/3/28/5e1eb1a7-7d38-4d09-bace-a586cb0fc326.png",
"product_id": "00498765432233",
"product_name": "Test",
"owner_id": "urn:authenticateit:participant:735879621218609",
"product_reviews_rate": 3.375,
"scan_id": "0907e419-ca9f-4527-9080-4b902e5aa081",
"unknown_product": false
}
Example Response. Product data info has been restricted by user age
Responce data could contains two additional parameters age_constraints and user_age.age_constraints - parameter shown that the product has been restricted by age for the user. It is always pos_integer.user_age - user's age (null or pos_integer). If user_age=null it means that the user haven't birthdate in profile.
Constraints works only for organic scans.
{
"age_constraints": 18,
"data": [
{
"id": "a103f5bc-7cd3-4115-8bf3-809e9b245c96",
"popup": {
"cancel": "Ok",
"icon": "action",
"text": "This product is not available for your age group.",
"title": "Product information is not available"
}
}
],
"event_ts": "2021-10-08T09:24:50Z",
"event_ts2": "2021-10-08T09:24:50.684494395Z",
"owner_id": "urn:authenticateit:participant:1",
"owner_logo": "https://dev-cdn.shping.com/2019/1/25/7a2f0607-3876-4e07-961f-99f19acf3098.jpg",
"product_id": "09300711798915",
"product_name": "STREPSILS DETTOL-NUROFEN-LEMSIP DISPLAY UNIT EARLY SIGN METCASH BIN 21 EM 1ea x 1",
"product_reviews_rate": 0,
"scan_id": "15c0308e-2ffe-469e-b97b-d60ad94e92f8",
"source": "S",
"unknown_product": false,
"user_age": null
}
Asynchronous сapture
POST /authentication-service/capture/async
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| data | list | Required: List of scanned data |
Example Request
{
"data": [
{
"code": "00000020156220",
"language": "en",
"country": "036",
"latitude": "1",
"longitude": "1",
"accuracy": "1",
"delay": "1",
"id": "123-123-123-abc"
},
{
"code": "09212345111117",
"language": "en",
"country": "036",
"latitude": "1",
"longitude": "1",
"accuracy": "1",
"delay": "1",
"id": "abc-123-123-abc"
}
]
}
Widgets of attached GDTI document
There may be some non-inline GDTI widgets returned as authentication
result. Widgets from such attachment GDTIs should be explicitly
requested with this API. Request must contain valid scan_id (in the
URL) and gdti. The provided gdti must match one of the non-inline
GDTI widgets in authentication result of scan_id.
POST /authentication-service/capture/:scan_id/attachment
Parameters
| Name | Type | Description |
|---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
gdti |
string | Non-inline GDTI found in some of the scan widgets. |
Example Response
{
"data": [
{
"id": "0bbb60ea-180d-498e-b9bd-29b3f02b1651",
"text": {
"markdown": false,
"text": "HAHAHA RU",
"title": "TEXT RU"
},
"type": "brand"
},
{
"id": "84496444-fb47-4334-a98a-84e91fb1eebf",
"title": {
"text": "TITLE RU"
},
"type": "brand"
}
]
}
Get my scans
GET /authentication-service/my-scans
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| scan_id | string | optional if you want get info for one scan |
| widget_ids | string | Optional widget IDs (comma separated) |
Example Response
[
{
"event_ts": "2018-12-12T03:43:43Z",
"image_url": "https://dev-cdn.shping.com/2018/11/19/7f2f42d4-2563-4497-a406-e2b25bdc13cb.jpg",
"product_name": "Test",
"scan_id": "90b3ccf0-ed6d-4be6-8036-e458019adc2f"
},
{
"event_ts": "2018-12-12T02:26:45Z",
"image_url": "https://dev-cdn.shping.com/2018/11/26/3226508H.jpg",
"product_name": "Варенье Ратибор Черника 400г",
"scan_id": "b85401fb-2819-4405-81e5-e508e9b0040e"
}
]
Read scan data by scan_id and widget_ids
Example Response
{
"data": [
{
"id": "1c6d434c-2cdf-4788-99ef-f2bdfad76aee",
"locations_trace_image": {
"locations_trace_external_url": null,
"locations_trace_image": [
{
"hash": "5bbf6502aa1b84d4b4c52959e9556b7e3ad48ce3",
"locations_trace_image_size": "800x800",
"status": "success",
"height": 800,
"width": 800,
"url": "https://dev-cdn.shping.com/2023/2/15/5bbf6502aa1b84d4b4c52959e9556b7e3ad48ce3"
}
],
"locations_trace_source_lists": {
"5bbf6502aa1b84d4b4c52959e9556b7e3ad48ce3": [
{
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_farm_1",
"latitude": "-37.844158072288145",
"longitude": "144.8828975734826",
"party_role_code": "FARM"
},
{
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_warehouse_1",
"latitude": "-37.0947252",
"longitude": "145.102748",
"party_role_code": "WAREHOUSE_AND_OR_DEPOT"
},
{
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_lab_1",
"latitude": "-38.1671271",
"longitude": "145.9270458",
"party_role_code": "LABORATORY"
},
{
"id": "urn:ibm:ift:location:loc:9068674652462.salmon_store_1",
"latitude": "-37.8879916",
"longitude": "144.5907392",
"party_role_code": "STORE"
}
]
},
"source": "ibm_food_trust",
"status": "success"
}
}
],
"scan_id": "a233c66c-fc0a-450d-b372-eb44c6e4d22f"
}
Read scan by scan_id. Scan with attached rewards campaign. 24 scan coins, 3 text coins for every 1 widget, the total is 9 coins. 33 coins in summary.
Example Response
{
"data": [
{
"id": "bb861bfe-08ab-4f31-88be-474453ae6620",
"image": [
{
"url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png"
}
],
"type": "default"
},
{
"coins": "24000000000000000000",
"id": "fe3bbb19-cb56-4d98-8af1-e8fca8b10bbf",
"rewards_summary": {
"coins": "33000000000000000000"
}
},
{
"id": "372d8395-6cba-4e25-ae91-ca10c5e71e68",
"title": {
"text": "TTTT comp"
}
},
{
"details": {
"has_reviews": false
},
"id": "21c128e7-5bbe-4c27-96f9-482971f8991f"
},
{
"coins": "3000000000000000000",
"id": "2f3f71bd-264e-48e9-88ed-68bd0fe8ccab",
"text": {
"markdown": false,
"text": "Text1 body",
"title": "Text1"
},
"type": "brand"
},
{
"coins": "3000000000000000000",
"id": "17db3b4f-82dd-4eab-9ef4-02d73ed7ea99",
"text": {
"markdown": false,
"text": "Text2 body",
"title": "Text2"
},
"type": "brand"
},
{
"coins": "3000000000000000000",
"id": "dfb8eceb-c311-4b94-9cc3-0b0c3460fb6b",
"text": {
"markdown": false,
"text": "Text3 body",
"title": "Text3"
},
"type": "brand"
},
{
"id": "78ef603a-a0bf-48ed-9025-e84783fdfb1b",
"live_chat": {
"cid": "urn:authenticateit:participant:735879621218609",
"text": "Click here to start a support chat",
"type": "brand"
},
"type": "brand"
}
],
"event_ts": "2018-12-12T03:47:17Z",
"product_name": "TTTT comp",
"owner_id": "urn:authenticateit:participant:735879621218609",
"scan_id": "cfb8b9de-e56a-4935-a74a-e96398b8bbb3"
}
Read scan by scan_id. Scan with attached rewards campaign. 3 text coins for every 1 widget, the total is 9 coins. 33 summary coins and 24 earned (for the scan)
Example Response
{
"data": [
{
"id": "bb861bfe-08ab-4f31-88be-474453ae6620",
"image": [
{
"url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png"
}
],
"type": "default"
},
{
"id": "fe3bbb19-cb56-4d98-8af1-e8fca8b10bbf",
"rewards_summary": {
"coins": "33000000000000000000",
"earned_coins": "24000000000000000000"
}
},
{
"id": "372d8395-6cba-4e25-ae91-ca10c5e71e68",
"title": {
"text": "TTTT comp"
}
},
{
"details": {
"has_reviews": false
},
"id": "21c128e7-5bbe-4c27-96f9-482971f8991f"
},
{
"coins": "3000000000000000000",
"id": "2f3f71bd-264e-48e9-88ed-68bd0fe8ccab",
"text": {
"markdown": false,
"text": "Text1 body",
"title": "Text1"
},
"type": "brand"
},
{
"coins": "3000000000000000000",
"id": "17db3b4f-82dd-4eab-9ef4-02d73ed7ea99",
"text": {
"markdown": false,
"text": "Text2 body",
"title": "Text2"
},
"type": "brand"
},
{
"coins": "3000000000000000000",
"id": "dfb8eceb-c311-4b94-9cc3-0b0c3460fb6b",
"text": {
"markdown": false,
"text": "Text3 body",
"title": "Text3"
},
"type": "brand"
},
{
"id": "78ef603a-a0bf-48ed-9025-e84783fdfb1b",
"live_chat": {
"cid": "urn:authenticateit:participant:735879621218609",
"text": "Click here to start a support chat",
"type": "brand"
},
"type": "brand"
}
],
"event_ts": "2018-12-12T03:47:17Z",
"product_name": "TTTT comp",
"scan_id": "cfb8b9de-e56a-4935-a74a-e96398b8bbb3"
}
Read scan by scan_id. Summary coins is 33 and earned is 33. All coins were earned
Example Response
{
"data": [
{
"id": "bb861bfe-08ab-4f31-88be-474453ae6620",
"image": [
{
"url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png"
}
],
"type": "default"
},
{
"id": "fe3bbb19-cb56-4d98-8af1-e8fca8b10bbf",
"rewards_summary": {
"coins": "33000000000000000000",
"earned_coins": "33000000000000000000"
}
},
{
"id": "372d8395-6cba-4e25-ae91-ca10c5e71e68",
"title": {
"text": "TTTT comp"
}
},
{
"details": {
"has_reviews": false
},
"id": "21c128e7-5bbe-4c27-96f9-482971f8991f"
},
{
"id": "2f3f71bd-264e-48e9-88ed-68bd0fe8ccab",
"text": {
"markdown": false,
"text": "Text1 body",
"title": "Text1"
},
"type": "brand"
},
{
"id": "17db3b4f-82dd-4eab-9ef4-02d73ed7ea99",
"text": {
"markdown": false,
"text": "Text2 body",
"title": "Text2"
},
"type": "brand"
},
{
"id": "dfb8eceb-c311-4b94-9cc3-0b0c3460fb6b",
"text": {
"markdown": false,
"text": "Text3 body",
"title": "Text3"
},
"type": "brand"
},
{
"id": "78ef603a-a0bf-48ed-9025-e84783fdfb1b",
"live_chat": {
"cid": "urn:authenticateit:participant:735879621218609",
"text": "Click here to start a support chat",
"type": "brand"
},
"type": "brand"
}
],
"event_ts": "2018-12-12T03:47:17Z",
"product_name": "TTTT comp",
"scan_id": "cfb8b9de-e56a-4935-a74a-e96398b8bbb3"
}
Product information sections
Each section has the following format: {“
{
"_id": "default_gitn_widgets",
"error": [
{
"text": {
"text": "Product not found!",
"title": "Product not found"
}
}
],
"empty": [
{
"text": {
"text": "Product was found! Sorry but the data for you are closed",
"title": "Closed data"
}
}
],
"type": "system_doc"
}
Product Ownership Status
POST /authentication-service/product_owner
Parameters
| Name | Type | Description |
|---|---|---|
| code | string | Required: Product identifier (GTIN or EAN) |
Example Request
{
"code": "010327487230899221_ilFi<9LsuMt9\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4="
}
Example Response
{
"brands": [],
"company_prefix": "3274872",
"gtin": "03274872308992",
"product": {
"brand": null,
"data": [
{
"id": "8e4871fc-cb8a-450b-b0e3-dfb4d18ea99e",
"image": [
{
"url": "https://dev-cdn.shping.com/2019/6/24/97b9f0bc-b770-4c74-85a5-911f6f3243dc"
}
],
"type": "imported_retailer"
},
{
"id": "4ef6fb9a-fcbb-4dfd-9183-953d78d90578",
"title": {
"text": "Givenchy Khol Couture Waterproof Retractable Eyeliner - # 03 Turquoise 0.3g/0.01oz"
}
},
{
"details": {
"has_reviews": false
},
"id": "de7110a9-6c7b-4bd2-ac2a-dcae7049c11e"
},
{
"id": "eabf1725-39d4-407c-8b09-8a67a277924e",
"text": {
"markdown": false,
"text": "doc_number",
"title": "doc"
},
"type": "brand"
},
{
"id": "577dd00e-7298-488f-881a-0c7be53fe29b",
"text": {
"markdown": false,
"text": "P082923",
"title": "SKU"
},
"type": "brand"
},
{
"id": "4c0526f9-61a1-428f-bdcd-0397edebfa92",
"text": {
"markdown": false,
"text": "Health & Beauty",
"title": "Product Category"
},
"type": "imported_retailer"
}
],
"has_owner": true,
"id": "urn:epc:id:sgtin:3274872.030899._ilFi<9LsuMt9",
"name": "Givenchy Khol Couture Waterproof Retractable Eyeliner - # 03 Turquoise 0.3g/0.01oz"
}
}
Product preview
POST /authentication-service/product_preview
Parameters
| Name | Type | Description |
|---|---|---|
| code | string | Product identifier |
| country | string | Country code |
| language | string | Language code |
| age | number | Age (positive integer) |
| gender | string | Gender type |
| reg_type | string | "email" or "facebook" |
Example Request
{
"code":"010327487230899221_ilFi<9LsuMt9\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4=",
"country":"036",
"language":"en",
"age":24,
"reg_type":"email",
"gender":"other"
}
Example Response
{
"brands": [],
"company_prefix": "3274872",
"gtin": "03274872308992",
"product": {
"brand": null,
"data": [
{
"id": "85f41644-1589-4401-b1bc-f432dbae86db",
"image": [
{
"url": "https://dev-cdn.shping.com/2019/6/24/97b9f0bc-b770-4c74-85a5-911f6f3243dc"
}
],
"type": "imported_retailer"
},
{
"id": "99cfe4fb-258f-42b2-a63b-07c7882f8723",
"title": {
"text": "Givenchy Khol Couture Waterproof Retractable Eyeliner - # 03 Turquoise 0.3g/0.01oz"
}
},
{
"details": {
"has_reviews": false
},
"id": "7ea0399b-00ed-4bf2-9fd0-15ce3e927036"
},
{
"id": "106b2227-8496-48f3-bb52-54db34a5083d",
"text": {
"markdown": false,
"text": "P082923",
"title": "SKU"
},
"type": "brand"
},
{
"id": "74778ffb-c869-40d1-850f-256abe150c1f",
"text": {
"markdown": false,
"text": "Health & Beauty",
"title": "Product Category"
},
"type": "imported_retailer"
}
],
"has_owner": true,
"id": "urn:epc:id:sgtin:3274872.030899._ilFi<9LsuMt9",
"name": "Givenchy Khol Couture Waterproof Retractable Eyeliner - # 03 Turquoise 0.3g/0.01oz"
}
}
Logging user actions
POST /authentication-service/action
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| scan_id | string | Scan ID |
| actions | array::objects | Required User action List. Is must be a list of widgets IDs if scan_id is presented in request |
| source | string | Source object ("timeline" only supported) |
Action object
| Name | Type | Description |
|---|---|---|
| id | string | Widget ID |
| visited | array | Optional array with IDs of social_networks widgets links |
{
"actions": [
{
"id": "7980bf29-7d44-4160-9925-f45598a75312"
},
{
"id": "7980bf29-7d44-4160-9925-f45598a7531b",
"visited": [
"648dda27-c0ed-4f38-b51c-2aec63f792a6",
"a4986418-bbbd-43f6-9f0c-3c53a4fc3419"
]
}
],
"source": "timeline",
"scan_id": "b8278356-fc3c-431f-baff-2fc0f904f03f"
}
Authenticity workflow
Checking is possible if authenticity status in the result of scanned SGTIN/LGTIN
contains field action with workflow: authenticity_check
Example
{"status": {
"action": {
"text": "Verify authenticity of your purchase",
"workflow": "authenticity_check"
},
"icon": "unknown",
"info": ""
}
Get list of locations by scan_id
POST /locations/get
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| scan_id | string | Required: Scan id |
| page | number | Page (non negative integer) |
| limit | number | Limit value (limit>0) |
| search | string | Search string |
Example Request
{
"scan_id":"44cb7b6b-bee1-4192-91cb-e71317b2b510",
"search":"Моск",
"page":1,
"limit":1
}
Example Response
{
"count": 2,
"data": [
{
"accuracy": 800,
"address": "Авиамоторная 12",
"city": "Москва",
"country": "643",
"id": "urn:authenticateit:business_location:6eb696b2-0b4a-46b1-ab07-c71b1af43601",
"latitude": 55752901,
"longitude": 37713958,
"name": "Distributor 2 Авиамоторная",
"owner": "urn:authenticateit:participant:712173541792827",
"post_code": null,
"state": null,
"sub_site_type": "215",
"type": "business_location"
}
]
}
Set location for scanned SGTIN/LGTIN
PUT /locations/set
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| scan_id | string | Required: Scan id |
| location | string or null | Location id |
Example Request - scan will be marked as authentic
{
"scan_id":"44cb7b6b-bee1-4192-91cb-e71317b2b510",
"location":"urn:authenticateit:business_location:6eb696b2-0b4a-46b1-ab07-c71b1af43601"
}
Example Request - scan will be marked as not authentic
{
"scan_id":"44cb7b6b-bee1-4192-91cb-e71317b2b510",
"location":null
}
Trigger data workflow
Example of returned data of capture method
{
"data": [
{
"id": "bca3796c-e86d-4675-ae86-ff3fc9c1dcac",
"popup": {
"cancel": "Cancel",
"icon": "action",
"ok": "OK",
"text": "We've got your information about the product. It is waiting a review and approval",
"title": "Information about the product waiting a review"
}
}
],
"event_ts": "2018-07-08T12:17:38Z",
"product_name": "Торт \"Надежда\"",
"scan_id": "3152547d-9ce1-4161-992b-7f7151fb0249",
"trigger_data": [
{
"id": "af2adce7-7e6f-4be3-96a6-a4885eb67ba0",
"result": [
{
"id": "bca3796c-e86d-4675-ae86-ff3fc9c1dcac",
"popup": {
"cancel": "Cancel",
"icon": "action",
"ok": "OK",
"text": "We've got your information about the product. It is waiting a review and approval",
"title": "Information about the product waiting a review"
}
}
],
"type": "contributor"
},
{
"country": "036",
"id": "ebe38544-f8b2-477a-b6db-d68f0420229d",
"result": [
{
"id": "4ac3cee5-e812-4992-be55-1cfadb053d77",
"image": [
{
"url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png"
}
],
"type": "default"
},
{
"id": "bc44231c-9917-4702-a61d-11db1c427312",
"title": {
"text": "Торт \"Надежда\""
}
},
{
"id": "f02c4a96-e07d-4bd4-8197-7ecef599bd8f",
"status": {
"description": "According to Shping database",
"icon": "not_recalled",
"info": "25393777790007798768",
"title": "Not recalled"
}
},
{
"details": {
"has_reviews": false
},
"id": "1f6b4023-e902-4cb1-8125-bca9d2995439"
},
{
"id": "74decc6e-f4a9-4f12-bfea-59b01411a4bc",
"text": {
"text": "123",
"title": "123"
},
"type": "brand"
},
{
"id": "c0df32c9-19da-493d-a121-9eaf7c9ba026",
"live_chat": {
"cid": "urn:authenticateit:participant:331756080046055",
"text": "Click here to start a support chat",
"type": "brand"
},
"type": "brand"
}
],
"type": "country"
},
{
"id": "af83703e-f00c-4737-ae46-618f0e6ae6fc",
"language": "en",
"result": [
{
"id": "98375c1f-0915-4c8e-9e50-65998daefa79",
"image": [
{
"url": "https://cdn.shping.com/2018/1/28/a759926f-0826-4d90-9d62-61aa4d202d56.png"
}
],
"type": "default"
},
{
"id": "9f506064-fea8-4ce7-8e54-177cdfefb6d9",
"title": {
"text": "Торт \"Надежда\""
}
},
{
"id": "9e4c4050-ae25-4689-985b-02a93dbd5881",
"status": {
"description": "According to Shping database",
"icon": "not_recalled",
"info": "25393777790007798768",
"title": "Not recalled"
}
},
{
"details": {
"has_reviews": false
},
"id": "020a5981-fc43-4211-9e88-95ecea141068"
},
{
"id": "b5b841e1-554c-42df-ad5c-27477269f3ec",
"text": {
"text": "123",
"title": "123"
},
"type": "brand"
},
{
"id": "312a9e20-5e62-498b-a856-57ae30e7580b",
"live_chat": {
"cid": "urn:authenticateit:participant:331756080046055",
"text": "Click here to start a support chat",
"type": "brand"
},
"type": "brand"
},
{
"id": "7ff5efd8-5bab-4adf-8c72-2d9aae8e654e",
"text": {
"text": "123555555",
"title": "1235555"
},
"type": "expert"
},
{
"id": "463d1ae2-ed50-46d7-b183-28687e99e830",
"live_chat": {
"cid": "urn:authenticateit:participant:1",
"text": "Click here to start a support chat",
"type": "expert"
},
"type": "expert"
}
],
"type": "language"
}
]
}
The trigger_data contains a list of results data by requested country, language or offering for adding data. The section will be added to reply if exact match by country and by language is not found. Actually all data in data field must be ignored if trigger_data is presented in reply. The body of the widget is the list of objects with different types and ids.
{
"trigger_data": [
{
"id": "86e49834-94be-4195-ac8b-3345b0363446",
"result": [],
"type": "contributor"
},
{
"country": "036",
"id": "691f8da9-9ed6-49c1-9be5-38784e5a3b5e",
"result": [],
"type": "country"
},
{
"id": "8da558e8-edc3-42dc-91de-3c6aed512b32",
"language": "en",
"result": [],
"type": "language"
}
]
}
As that different results may be connected to different rewards campaigns, the app after selected section by the user must send the request as described below.
Set trigger result data
POST /action/trigger
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| scan_id | string | Required: Scan id |
| id | string | Required: Selected section id |
Example Request
{
"scan_id":"1a620bc4-e112-48a8-ab4e-9b50e96cc1a7",
"id":"691f8da9-9ed6-49c1-9be5-38784e5a3b5e"
}
List of scanned brands
Get list of scanned brands
GET /brands
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
`
Example Response
{
"brands": [
{
"allow_shoutouts": true,
"brand": "DEVP3"
},
{
"allow_shoutouts": true,
"brand": "ZippityElfBrand"
}
]
}
Set rules for brand
PUT /brands
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| brands | body | Required: List of brands |
Example Request
{
"brands": [
{
"allow_shoutouts": false,
"brand": "DEVP3"
},
{
"allow_shoutouts": true,
"brand": "ZippityElfBrand"
}
]
}
Example Response
{
"brands": [
{
"allow_shoutouts": false,
"brand": "DEVP3"
},
{
"allow_shoutouts": true,
"brand": "ZippityElfBrand"
}
]
}
Click to scan
This feature used for scanning by link. Participant generates the link by special code and sends it to the user, the user by click on link runs the app and after that app send the request for scanning special code.
Generate link code
POST /capture_link
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| code | body | Required: Code e.g. GTIN |
| expiry_datetime | body | Datetime |
Example Request
{
"code":"09212345000145",
"expiry_datetime":"2018-12-31T23:59:59Z"
}
Example Response
{
"code": "09212345000145",
"expiry_datetime": "2018-12-31T23:59:59Z",
"id": "9945911b-c00d-42cf-a1d9-1c2633b458e8",
"link": "https://dev-api.shping.com/authentication-service/capture_link/get/9945911b-c00d-42cf-a1d9-1c2633b458e8",
"participant": "urn:authenticateit:participant:735879621218609",
"ts": "2018-10-25T00:28:08Z",
"type": "capture_link"
}
Read list of links
GET /capture_link
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| id | body | Read link data by id |
| expiry_datetime_from | body | Datetime from filter |
| expiry_datetime_to | body | Datetime to filter |
| code | body | Code filter |
| offset | body | Greater or equal to 0 |
| limit | body | Greater or equal to 1 |
Example Response
{
"count": 1,
"data": [
{
"code": "09212345000145",
"expiry_datetime": "2019-12-31T23:59:59Z",
"id": "8ef956e6-8007-4eff-9bbe-dacdd6351ffd",
"link": "https://dev-api.shping.com/authentication-service/capture_link/get/8ef956e6-8007-4eff-9bbe-dacdd6351ffd",
"ts": "2018-10-25T00:37:59Z"
}
]
}
Example Response
{
"code": "09212345000145",
"expiry_datetime": "2018-12-31T23:59:59Z",
"id": "9945911b-c00d-42cf-a1d9-1c2633b458e8",
"link": "https://dev-api.shping.com/authentication-service/capture_link/get/9945911b-c00d-42cf-a1d9-1c2633b458e8",
"participant": "urn:authenticateit:participant:735879621218609",
"ts": "2018-10-25T00:28:08Z"
}
Remove links
PUT /capture_link
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| ids | body | Required: List of IDs |
Example Request
{
"ids" :
[
"01377b82-0c44-4460-9823-c8173f0e71f0",
"9945911b-c00d-42cf-a1d9-1c2633b458e8"
]
}
Get code by link's UUID
GET /capture_link/get/code/:uuid
Parameters
| Name | Type | Description |
|---|---|---|
| uuid | body | Required: ID |
Example Response
{
"code": "00498765432998"
}
Set scan location
Set scan location widget
Example of send_scan_location widget. By this widget, user can set location for the product.
{
"coins": "12000000000000000000",
"id": "cc45a7c0-09fa-4c13-9668-73fd9a9a62e9",
"send_scan_location": {}
}
Update scan location widget
Example of scan_location widget. With action element.
{
"id": "e28844ba-60e6-41da-aa0e-36e66edf2e80",
"scan_location": {
"action": "change_location",
"id": "5f2fae41cf7b3f91d29809e49bffbb94af01bcbc",
"name": "7-Eleven Spencer Street"
}
}
Get list of locations
POST /scan/locations/get
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| scan_id | string | Scan ID |
| language | string | Language code |
| latitude | string | Latitude |
| longitude | string | Longitude |
| query | string | Text request |
| pagetoken | string | next_page_token in response |
scan_id or couple of latitude and longitude is required in request.
Example Request
{
"scan_id": "359a84f4-affb-4a0e-b5a6-b08209bb65f1",
"query": "7 eleven"
}
{
"language": "en",
"latitude": "-37838097",
"longitude": "144974741"
}
Example Response
{
"next_page_token": "CrQCJQEAADSX1ehntdgORzasOoD9wKKmIpPtt3s1Fk5eV448cqigREmrmeolxIhxrtBJwqzDZ2Tp-zyD-aLDy6iP5-0m6AceKduss7dZqMnApc-zJ7ZpkNog4AIOuGKUZbGIozWV7W1YeDufUSMURAiJxCk3mPG0jFVUlnF76CrH9HYPUwBbsHPzajsVfbQbm_3Rqr9r8LJO5XPbylcUw2Gvx5sNrzI9yNLmiX2tl3pue7M2bj4vvrazwnUhf7EWY7iyxgUgIYgqZeSwWky70iHXsM_CHuGBDrK1P0e6cgJPWu4sj4eFQoC5i0L023vFFkvgFWU7NGiMJfyYCaXkufuUVHK-tXzXw-5HYyUw9K7juiiPjAC25sl7ziDG8HV5oi2DcbTY541H-PllSS9fDbgSsJc8YYESEKEZYPYEF1oKhWLZiebxur8aFPjifuLWHr1pEQC3ie3atzKOkne3",
"results": [
{
"distance": 1972,
"id": "b9b72ff83b7c7f193214996608680bb1cd206657",
"name": "7-Eleven Yarraville"
},
{
"distance": 3287,
"id": "e79646c0c540ad635342e5794b60d941f2ca1e92",
"name": "7-Eleven Footscray West"
},
{
"distance": 3711,
"id": "0ed7b15d393768ea003f65d40ead3184c7e00ca8",
"name": "7-Eleven Flemington"
},
{
"distance": 3838,
"id": "c992df70ce894d1bec6900e05a8409709fbc1ba3",
"name": "7-Eleven Flemington"
},
{
"distance": 3952,
"id": "8fd0dc8ae92d9c85b608985d9188d3c65ffd744f",
"name": "7-Eleven Nth Melbourne"
},
{
"distance": 4654,
"id": "5f2fae41cf7b3f91d29809e49bffbb94af01bcbc",
"name": "7-Eleven Spencer Street"
},
{
"distance": 4867,
"id": "d6f795640a5f2155d07bd5fc74622be2d6956e15",
"name": "7-Eleven Vic Market"
}
]
}
Set location
POST /scan/locations
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| id | string or NULL | Required: Location ID |
| scan_id | string | Required: Scan ID |
Example Request
{
"scan_id": "359a84f4-affb-4a0e-b5a6-b08209bb65f1",
"id": "5f2fae41cf7b3f91d29809e49bffbb94af01bcbc"
}
Example Response
{
"accuracy": "0",
"country": "643",
"id": "5f2fae41cf7b3f91d29809e49bffbb94af01bcbc",
"language": "ru",
"latitude": "-37783990",
"longitude": "144775499",
"name": "7-Eleven Spencer Street",
"product_id": "00498765432998",
"scan_id": "359a84f4-affb-4a0e-b5a6-b08209bb65f1",
"ts": "2019-03-14T03:32:49Z"
}
Update location
PUT /scan/locations
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| id | body | Required: New location ID |
Example Request
{
"scan_id": "359a84f4-affb-4a0e-b5a6-b08209bb65f1",
"id": "c60c1e52b57dc20dced9df108634a47c01c94b45"
}
Example Response
{
"accuracy": "0",
"country": "643",
"id": "c60c1e52b57dc20dced9df108634a47c01c94b45",
"language": "ru",
"latitude": "-37783990",
"longitude": "144775499",
"name": "Coles Central Square",
"product_id": "00498765432998",
"scan_id": "359a84f4-affb-4a0e-b5a6-b08209bb65f1",
"ts": "2019-03-14T03:40:35Z"
}
Competitions
Example of widget competitions
{
"competitions": [
{
"coins": "1000000000000000000",
"description": "Simple Competition",
"id": "urn:authenticateit:competition:888582780739927"
},
{
"coins": "1000000000000000000",
"description": "Simple Competition",
"id": "urn:authenticateit:competition:928818499119058",
"t&c_link": "https://www.shping.com"
},
{
"description": "Simple Competition",
"id": "urn:authenticateit:competition:928818499119058",
"t&c_link": "https://www.shping.com"
}
],
"id": "8676d170-e04e-40e6-b421-0bde4f76225f"
}
Take part in the competition
POST /authentication-service/action/competition/submit
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required Session's ticket |
| scan_id | string | Required Scan ID |
| id | string | Required Competition ID |
Example Request
{
"scan_id": "d0493aab-2973-411b-9bf9-29d4e00c2efa",
"id":"urn:authenticateit:competition:928818499119058"
}