Settings
The end point /settings-service provides methods that return common information
Get IFT facilities list
GET /settings-service/facility_types
Example Response
{
"facility_types": {
"ibm_food_trust": {
"list": [
{
"id": "EXPORTER",
"name": "Exporter"
},
{
"id": "FACTOR",
"name": "Factor"
},
{
"id": "FARM",
"marker": {
"data": "https://cdn.shping.com/2023/1/6/7a85e476-0681-4ab7-900d-1c225dc9aa6d.png",
"type": "icon"
},
"name": "Farm"
},
{
"id": "WHOLESALER",
"name": "Wholesaler"
}
],
"map_options": {
"maptype": "roadmap",
"marker": {
"data": "https://cdn.shping.com/2023/1/6/beaa891a-bcf0-4529-90e2-9bf1685b5beb.png",
"type": "icon"
},
"path": "color:0xff0000ff|weight:3",
"size": "800x800"
}
}
}
}
Get IFT bizsteps list
GET /settings-service/bizsteps
Example Response
{
"bizsteps": {
"ibm_food_trust": {
"list": [
{
"id": "urn:epcglobal:cbv:bizstep:receiving",
"name": "Receiving"
},
{
"id": "urn:epcglobal:cbv:bizstep:accepting",
"name": "Accepting"
},
{
"id": "urn:epcglobal:cbv:bizstep:arriving",
"name": "Arriving"
},
{
"id": "urn:epcglobal:cbv:bizstep:assembling",
"name": "Assembling"
},
{
"id": "urn:epcglobal:cbv:bizstep:collecting",
"name": "Collecting"
},
{
"id": "urn:epcglobal:cbv:bizstep:commissioning",
"name": "Commissioning"
},
{
"id": "urn:epcglobal:cbv:bizstep:consigning",
"name": "Consigning"
},
{
"id": "urn:epcglobal:cbv:bizstep:creating_class_instance",
"name": "Creating class instance"
},
{
"id": "urn:epcglobal:cbv:bizstep:cycle_counting",
"name": "Cycle counting"
},
{
"id": "urn:epcglobal:cbv:bizstep:decommissioning",
"name": "Decommissioning"
},
{
"id": "urn:epcglobal:cbv:bizstep:departing",
"name": "Departing"
},
{
"id": "urn:epcglobal:cbv:bizstep:destroying",
"name": "Destroying"
},
{
"id": "urn:epcglobal:cbv:bizstep:disassembling",
"name": "Disassembling"
},
{
"id": "urn:epcglobal:cbv:bizstep:dispensing",
"name": "Dispensing"
},
{
"id": "urn:epcglobal:cbv:bizstep:encoding",
"name": "Encoding"
},
{
"id": "urn:epcglobal:cbv:bizstep:entering_exiting",
"name": "Entering exiting"
},
{
"id": "urn:epcglobal:cbv:bizstep:holding",
"name": "Holding"
},
{
"id": "urn:epcglobal:cbv:bizstep:inspecting",
"name": "Inspecting"
},
{
"id": "urn:epcglobal:cbv:bizstep:installing",
"name": "Installing"
},
{
"id": "urn:epcglobal:cbv:bizstep:killing",
"name": "Killing"
},
{
"id": "urn:epcglobal:cbv:bizstep:loading",
"name": "Loading"
},
{
"id": "urn:epcglobal:cbv:bizstep:other",
"name": "Other"
},
{
"id": "urn:epcglobal:cbv:bizstep:packing",
"name": "Packing"
},
{
"id": "urn:epcglobal:cbv:bizstep:picking",
"name": "Picking"
},
{
"id": "urn:epcglobal:cbv:bizstep:receiving",
"name": "Receiving"
},
{
"id": "urn:epcglobal:cbv:bizstep:removing",
"name": "Removing"
},
{
"id": "urn:epcglobal:cbv:bizstep:repackaging",
"name": "Repackaging"
},
{
"id": "urn:epcglobal:cbv:bizstep:repairing",
"name": "Repairing"
},
{
"id": "urn:epcglobal:cbv:bizstep:replacing",
"name": "Replacing"
},
{
"id": "urn:epcglobal:cbv:bizstep:reserving",
"name": "Reserving"
},
{
"id": "urn:epcglobal:cbv:bizstep:retail_selling",
"name": "Retail selling"
},
{
"id": "urn:epcglobal:cbv:bizstep:shipping",
"name": "Shipping"
},
{
"id": "urn:epcglobal:cbv:bizstep:staging_outbound",
"name": "Staging outbound"
},
{
"id": "urn:epcglobal:cbv:bizstep:stock_taking",
"name": "Stock taking"
},
{
"id": "urn:epcglobal:cbv:bizstep:stocking",
"name": "Stocking"
},
{
"id": "urn:epcglobal:cbv:bizstep:storing",
"name": "Storing"
},
{
"id": "urn:epcglobal:cbv:bizstep:transforming",
"name": "Transforming"
},
{
"id": "urn:epcglobal:cbv:bizstep:transporting",
"name": "Transporting"
},
{
"id": "urn:epcglobal:cbv:bizstep:unloading",
"name": "Unloading"
},
{
"id": "urn:epcglobal:cbv:bizstep:unpacking",
"name": "Unpacking"
},
{
"id": "urn:epcglobal:cbv:bizstep:void_shipping",
"name": "Void shipping"
}
]
}
}
}
Get karma actions
Actions should be used for adjustment user's karma
GET /settings-service/karma/manual_actions
Example Response
{
"manual_actions": [
{
"id": "manual_duplicate_receipt_upload",
"karma_value_action": "dec",
"name": "Duplicate receipt upload"
},
{
"id": "manual_receipt_sharing",
"karma_value_action": "dec",
"name": "Receipt sharing"
},
{
"id": "manual_fake_receipt_upload",
"karma_value_action": "dec",
"name": "Fake receipt upload"
},
{
"id": "manual_fake_buddies_behaviour",
"karma_value_action": "dec",
"name": "Fake buddies behaviour"
}
]
}
Get public legal information
Get legal root information
GET /settings-service/public/legal
Parameters
| Name | Type | Description |
|---|---|---|
| id | string | Get specific version id |
Example Response. Root document
{
"id": "urn:authenticateit:legal",
"participants": [],
"sub_type": "root",
"users": [
{
"created_at": "2022-08-16T11:16:00Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "urn:authenticateit:legal:users:1660612266",
"published_at": "2022-08-16T11:16:00Z",
"published_by": "urn:authenticateit:user:email:system@authenticateit.com",
"version": "1660612266"
},
{
"created_at": "2022-08-24T08:56:29Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "urn:authenticateit:legal:users:1661331389",
"published": true,
"published_at": "2022-08-24T08:58:13Z",
"published_by": "urn:authenticateit:user:email:system@authenticateit.com",
"version": "1661331389"
}
]
}
Get legal document by id
GET /settings-service/public/legal/:id
Parameters
| Name | Type | Description |
|---|---|---|
| id | string | Get specific version id |
Example Response. Document with id urn:authenticateit:legal:users:1660612266
{
"list": [
{
"body": "<h1 class=\"main_header\">SHPING APP TERMS OF USE AGREEMENT</h1>",
"created_at": "2022-08-16T11:16:00Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "",
"id": "terms_and_conditions",
"published_at": "2022-08-16T11:16:00Z",
"published_by": "urn:authenticateit:user:email:system@authenticateit.com",
"published_by_first_name": "System1",
"published_by_last_name": "Administrator1",
"sub_type": "users_version",
"main_document_title": "SHPING APP TERMS OF USE AGREEMENT",
"title": "SHPING APP TERMS OF USE AGREEMENT",
"updated_at": "2022-08-16T04:20:37Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1660612266",
"version_id": "urn:authenticateit:legal:users:1660612266"
},
{
"body": "<h1 class=\"main_header\">SHPING APP TERMS OF USE AGREEMENT</h1>",
"created_at": "2022-08-16T11:16:00Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "",
"id": "privacy_policy",
"published_at": "2022-08-16T11:16:00Z",
"published_by": "urn:authenticateit:user:email:system@authenticateit.com",
"published_by_first_name": "System1",
"published_by_last_name": "Administrator1",
"sub_type": "users_version",
"main_document_title": "SHPING APP TERMS OF USE AGREEMENT",
"title": "SHPING APP TERMS OF USE AGREEMENT",
"updated_at": "2022-08-16T04:20:37Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1660612266",
"version_id": "urn:authenticateit:legal:users:1660612266"
},
{
"body": "<h1 class=\"main_header\">SHPING APP TERMS OF USE AGREEMENT</h1>",
"created_at": "2022-08-16T11:16:00Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "",
"id": "fair_usage_policy",
"published_at": "2022-08-16T11:16:00Z",
"published_by": "urn:authenticateit:user:email:system@authenticateit.com",
"published_by_first_name": "System1",
"published_by_last_name": "Administrator1",
"sub_type": "users_version",
"main_document_title": "SHPING APP TERMS OF USE AGREEMENT",
"title": "SHPING APP TERMS OF USE AGREEMENT",
"updated_at": "2022-08-16T04:20:37Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1660612266",
"version_id": "urn:authenticateit:legal:users:1660612266"
}
]
}
Manage legal information
Methods are available only for users with security_admin role
Get legal options
GET /settings-service/legal/options
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"participants": [
{
"id": "terms_and_conditions",
"required": true
},
{
"id": "privacy_policy",
"required": true
},
{
"id": "fair_usage_policy",
"required": true
}
],
"users": [
{
"id": "terms_and_conditions",
"required": true
},
{
"id": "privacy_policy",
"required": true
},
{
"id": "fair_usage_policy",
"required": true
}
]
}
Create new legal document
POST /settings-service/legal/documents
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| title | string | Required: Title (length from 1 to 100) |
| sub_type | string | Required: Document sub_type |
| body | list | Required: Document body |
Example Request
{
"body": [
{
"body": "Text body",
"description": "Short description",
"id": "terms_and_conditions",
"title": "Part title"
},
{
"body": "Text body",
"description": "Short description",
"id": "privacy_policy",
"title": "Part title"
},
{
"body": "Text body",
"description": "Short description",
"id": "fair_usage_policy",
"title": "Part title"
}
],
"title": "Title sample",
"sub_type": "users"
}
Example Response
{
"list": [
{
"body": "Text body",
"created_at": "2022-08-25T01:31:43Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Short description",
"id": "terms_and_conditions",
"published_by_first_name": null,
"published_by_last_name": null,
"sub_type": "users",
"title": "Part title",
"main_document_title": "Title sample",
"updated_at": "2022-08-25T01:31:43Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1661391103",
"version_id": "urn:authenticateit:legal:users:1661391103"
},
{
"body": "Text body",
"created_at": "2022-08-25T01:31:43Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Short description",
"id": "privacy_policy",
"published_by_first_name": null,
"published_by_last_name": null,
"sub_type": "users",
"title": "Part title",
"main_document_title": "Title sample",
"updated_at": "2022-08-25T01:31:43Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1661391103",
"version_id": "urn:authenticateit:legal:users:1661391103"
},
{
"body": "Text body",
"created_at": "2022-08-25T01:31:43Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Short description",
"id": "fair_usage_policy",
"published_by_first_name": null,
"published_by_last_name": null,
"sub_type": "users",
"title": "Part title",
"main_document_title": "Title sample",
"updated_at": "2022-08-25T01:31:43Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1661391103",
"version_id": "urn:authenticateit:legal:users:1661391103"
}
]
}
Update unpublished legal document
PUT /settings-service/legal/documents/:version_id
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| version_id | string | Required: Document version_id |
| title | string | Title (length from 1 to 100) |
| body | list | Document body |
Example Request
{
"body": [
{
"body": "Text body",
"description": "Short description",
"id": "terms_and_conditions",
"title": "Part title"
},
{
"body": "Text body",
"description": "Short description",
"id": "privacy_policy",
"title": "Part title"
},
{
"body": "Text body",
"description": "Short description",
"id": "fair_usage_policy",
"title": "Part title"
}
],
"title": "New main document title"
}
Example Response
{
"list": [
{
"body": "Text body",
"created_at": "2022-08-25T01:31:43Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Short description",
"id": "terms_and_conditions",
"published_by_first_name": null,
"published_by_last_name": null,
"sub_type": "users",
"title": "Part title",
"main_document_title": "New main document title",
"updated_at": "2022-08-25T01:31:43Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1661391103",
"version_id": "urn:authenticateit:legal:users:1661391103"
},
{
"body": "Text body",
"created_at": "2022-08-25T01:31:43Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Short description",
"id": "privacy_policy",
"published_by_first_name": null,
"published_by_last_name": null,
"sub_type": "users",
"title": "Part title",
"main_document_title": "New main document title",
"updated_at": "2022-08-25T01:31:43Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1661391103",
"version_id": "urn:authenticateit:legal:users:1661391103"
},
{
"body": "Text body",
"created_at": "2022-08-25T01:31:43Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Short description",
"id": "fair_usage_policy",
"published_by_first_name": null,
"published_by_last_name": null,
"sub_type": "users",
"title": "Part title",
"main_document_title": "New main document title",
"updated_at": "2022-08-25T01:31:43Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1661391103",
"version_id": "urn:authenticateit:legal:users:1661391103"
}
]
}
Read document by version_id
GET /settings-service/legal/documents/:version_id
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| version_id | string | Required: Document version_id |
Example Response
{
"list": [
{
"body": "Text body",
"created_at": "2022-08-25T01:31:43Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Short description",
"id": "terms_and_conditions",
"published_by_first_name": null,
"published_by_last_name": null,
"sub_type": "users",
"title": "Part title",
"main_document_title": "New main document title",
"updated_at": "2022-08-25T01:31:43Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1661391103",
"version_id": "urn:authenticateit:legal:users:1661391103"
},
{
"body": "Text body",
"created_at": "2022-08-25T01:31:43Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Short description",
"id": "privacy_policy",
"published_by_first_name": null,
"published_by_last_name": null,
"sub_type": "users",
"title": "Part title",
"main_document_title": "New main document title",
"updated_at": "2022-08-25T01:31:43Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1661391103",
"version_id": "urn:authenticateit:legal:users:1661391103"
},
{
"body": "Text body",
"created_at": "2022-08-25T01:31:43Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Short description",
"id": "fair_usage_policy",
"published_by_first_name": null,
"published_by_last_name": null,
"sub_type": "users",
"title": "Part title",
"main_document_title": "New main document title",
"updated_at": "2022-08-25T01:31:43Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1661391103",
"version_id": "urn:authenticateit:legal:users:1661391103"
}
]
}
Delete unpublished document
DELETE /settings-service/legal/documents/:version_id
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| version_id | string | Required: Document version_id |
Read documents
GET /settings-service/legal/documents
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| sub_type_filter | string | Filter documents by sub_type |
Example Response. Filter /settings-service/legal/documents?sub_type_filter=users,participants
{
"list": [
{
"created_at": "2022-08-25T02:08:40Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Short description",
"id": "fair_usage_policy",
"main_document_title": "Title sample",
"published_by_first_name": null,
"published_by_last_name": null,
"sub_type": "users",
"title": "Part title",
"updated_at": "2022-08-25T02:08:40Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1661393320",
"version_id": "urn:authenticateit:legal:users:1661393320"
},
{
"created_at": "2022-08-16T11:16:00Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "",
"id": "terms_and_conditions",
"main_document_title": "SHPING APP TERMS OF USE AGREEMENT",
"published_at": "2022-08-16T11:16:00Z",
"published_by": "urn:authenticateit:user:email:system@authenticateit.com",
"published_by_first_name": "System1",
"published_by_last_name": "Administrator1",
"sub_type": "users_version",
"title": "Terms And Conditions",
"updated_at": "2022-08-16T04:20:37Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1660612266",
"version_id": "urn:authenticateit:legal:users:1660612266"
},
{
"created_at": "2022-08-16T11:16:00Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "",
"id": "privacy_policy",
"main_document_title": "SHPING APP TERMS OF USE AGREEMENT",
"published_at": "2022-08-16T11:16:00Z",
"published_by": "urn:authenticateit:user:email:system@authenticateit.com",
"published_by_first_name": "System1",
"published_by_last_name": "Administrator1",
"sub_type": "users_version",
"title": "Privacy Policy",
"updated_at": "2022-08-16T04:20:37Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1660612266",
"version_id": "urn:authenticateit:legal:users:1660612266"
},
{
"created_at": "2022-08-16T11:16:00Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "",
"id": "fair_usage_policy",
"main_document_title": "SHPING APP TERMS OF USE AGREEMENT",
"published_at": "2022-08-16T11:16:00Z",
"published_by": "urn:authenticateit:user:email:system@authenticateit.com",
"published_by_first_name": "System1",
"published_by_last_name": "Administrator1",
"sub_type": "users_version",
"title": "Fair Usage Policy",
"updated_at": "2022-08-16T04:20:37Z",
"updated_by": "urn:authenticateit:user:email:system@authenticateit.com",
"updated_by_first_name": "System1",
"updated_by_last_name": "Administrator1",
"version": "1660612266",
"version_id": "urn:authenticateit:legal:users:1660612266"
}
]
}
Publish document
PUT /settings-service/legal/publish/:version_id
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| version_id | string | Required: Filter documents by sub_type |
Get welcome points
GET /settings-service/welcome-points
Example Response
Number of points that are received by a new user for scanned codes until registration
{
"points":15
}
Get countries list
GET /settings-service/countries
Example Response
{
"countries": [
{
"iso": "004",
"name": "Afghanistan"
},
{
"iso": "248",
"name": "Åland Islands"
},
{
"iso": "008",
"name": "Albania"
},
{
"iso": "012",
"name": "Algeria"
}
]
}
Get languages list
GET /settings-service/languages
Example Response
{
"languages": [
{
"code": "ar",
"name": "Arabic"
},
{
"code": "ca",
"name": "Catalan"
},
{
"code": "cs",
"name": "Czech"
},
{
"code": "da",
"name": "Danish"
},
{
"code": "de",
"name": "German"
}
]
}
Get partners list
GET /settings-service/partners
Example Response
{
"partners": [
{
"description": "Some description",
"logo": "dev-cdn.shping.com.s3.amazonaws.com/2017/5/26/1748fe4b-e5da-435a-b439-2cf351bbbc55-2000px-Converse_logo.svg_.png",
"name": "Converse"
},
{
"description": "Some description",
"logo": "http://dev-cdn.shping.com.s3.amazonaws.com/2017/5/26/acee02ed-c518-41a3-8262-2849c1e18fc1-Paulig.jpg",
"name": "Paulig coffee"
}
]
}
Get genders list
GET /settings-service/genders
Example Response
{
"genders": [
{
"name": "Male",
"type": "male"
},
{
"name": "Female",
"type": "female"
}
]
}
Get brands list
GET /settings-service/brands
Example Response
{
"brands": [
{
"ait_id": "1",
"id": "1",
"logo": "https://cdn.shping.com/2017/6/29/5e8ab9c2-c4ac-4ee9-ab05-a9726c64c13f-jumbo.png",
"name": "Jumbo Ugg"
},
{
"ait_id": "7726",
"id": "2",
"logo": "https://cdn.shping.com/2017/6/29/b9117234-0252-4fee-b2d3-4049204747f8-a2milk.png",
"name": "A2 Milk"
}
]
}
Get rewards_actions list
GET /settings-service/rewards_actions
Example Response
{
"rewards_actions": [
{
"id": "view_popup",
"text": "View popup",
"text_i18n_id": "rewards_actions-view_popup",
"text_ru": "Просмотр всплывающего окна",
"text_zh": "查看弹出消息"
},
{
"id": "view_text",
"text": "View text",
"text_i18n_id": "rewards_actions-view_text",
"text_ru": "Просмотр текста",
"text_zh": "查看文本"
},
{
"id": "view_image",
"text": "View image",
"text_i18n_id": "rewards_actions-view_image",
"text_ru": "Просмотр изображения",
"text_zh": "查看图片"
},
{
"id": "visit_link",
"text": "Visit link",
"text_i18n_id": "rewards_actions-visit_link",
"text_ru": "Переход по ссылке",
"text_zh": "访问链接"
},
{
"id": "watch_video",
"text": "Watch promo video",
"text_i18n_id": "rewards_actions-watch_video",
"text_ru": "Просмотр видео",
"text_zh": "观看宣传片"
},
{
"id": "view_status",
"text": "View status",
"text_i18n_id": "rewards_actions-view_status",
"text_ru": "Просмотр статуса проверки товара",
"text_zh": "查看状态"
},
{
"id": "view_nutrition_info",
"text": "View nutrition info",
"text_i18n_id": "rewards_actions-view_nutrition_info",
"text_ru": "Просмотр пищевой ценности",
"text_zh": "查看营养信息"
},
{
"id": "view_certificates",
"text": "View certificates",
"text_i18n_id": "rewards_actions-view_certificates",
"text_ru": "Просмотр сертификатов",
"text_zh": "查看认证"
},
{
"id": "follow_fb",
"text": "Follow on FB",
"text_i18n_id": "rewards_actions-follow_fb",
"text_ru": "Переход на страницу в FB",
"text_zh": "Facebook关注"
},
{
"id": "scan",
"text": "Scan product",
"text_i18n_id": "rewards_actions-scan",
"text_ru": "Скан товара",
"text_zh": "扫描产品"
},
{
"id": "visit_social_networks_link",
"text": "Visit social networks link",
"text_i18n_id": "rewards_actions-visit_social_networks_link",
"text_ru": "Перейти по ссылке на соцсеть",
"text_zh": "訪問社交網絡鏈接"
},
{
"condition": {
"range": "month",
"range_value": 1,
"value": 1
},
"id": "send_review",
"restrictions": false,
"text": "Send review",
"text_i18n_id": "rewards_actions-send_review",
"text_ru": "Отправка отзыва",
"text_zh": "发送评价"
},
{
"id": "send_scan_location",
"text": "Send scan location",
"text_i18n_id": "rewards_actions-send_scan_location",
"text_ru": "Установить локацию скана",
"text_zh": "訪問社交網絡鏈接"
},
{
"id": "social_networks_confirmed_follow_fb",
"text": "Confirmed Facebook Follower",
"text_i18n_id": "rewards_actions-social_networks_confirmed_follow_fb",
"text_ru": "Confirmed Facebook Follower",
"text_zh": "Confirmed Facebook Follower"
}
]
}
Get rewards_social_networks_share list
GET /settings-service/rewards_social_networks_share
Example Response
{
"rewards_social_networks_share": [
{
"id": "fb",
"text": "Share by Facebook",
"text_i18n_id": "rewards_social_networks_share-fb"
},
{
"id": "twitter",
"text": "Share by Twitter",
"text_i18n_id": "rewards_social_networks_share-twitter"
},
{
"id": "linkedin",
"text": "Share by LinkedIn",
"text_i18n_id": "rewards_social_networks_share-linkedin"
}
]
}
Get rewards_upload_receipt_options list
GET /settings-service/rewards_upload_receipt_options
Example Response
{
"rewards_upload_receipt_options": [
{
"id": "non_partner_brand_product",
"text": "Reward per partner brand products",
"text_i18n_id": "rewards_upload_receipt_options-non_partner_brand_product"
},
{
"id": "partner_brand_product",
"text": "Reward per non partner brand products",
"text_i18n_id": "rewards_upload_receipt_options-partner_brand_product"
},
{
"id": "product_mapping",
"text": "Reward per successful mapping of a product",
"text_i18n_id": "rewards_upload_receipt_options-product_mapping"
}
]
}
Get list of known GDTI document types
GET /settings-service/document_types
Example Response
{
"document_types": {
"1": {
"name": "VCard",
"widgets": [
"image",
"phone",
"text"
]
},
"3": {
"name": "Test document type",
"widgets": [
"title",
"text"
]
}
}
}
Get list of timezone codes
GET /settings-service/timezones
Example Response
{
"timezones": [
{
"dst_offset": 60,
"id": "Australia/ACT",
"utc_offset": 600
},
{
"dst_offset": 60,
"id": "Australia/Adelaide",
"utc_offset": 570
},
{
"dst_offset": 0,
"id": "Australia/Brisbane",
"utc_offset": 600
},
{
"dst_offset": 60,
"id": "Australia/Broken_Hill",
"utc_offset": 570
},
{
"dst_offset": 60,
"id": "Australia/Canberra",
"utc_offset": 600
},
{
"dst_offset": 60,
"id": "Australia/Currie",
"utc_offset": 600
},
{
"dst_offset": 0,
"id": "Australia/Darwin",
"utc_offset": 570
},
{
"dst_offset": 0,
"id": "Australia/Eucla",
"utc_offset": 525
},
{
"dst_offset": 60,
"id": "Australia/Hobart",
"utc_offset": 600
},
{
"dst_offset": 30,
"id": "Australia/LHI",
"utc_offset": 630
},
{
"dst_offset": 0,
"id": "Australia/Lindeman",
"utc_offset": 600
},
{
"dst_offset": 30,
"id": "Australia/Lord_Howe",
"utc_offset": 630
},
{
"dst_offset": 60,
"id": "Australia/Melbourne",
"utc_offset": 600
},
{
"dst_offset": 60,
"id": "Australia/NSW",
"utc_offset": 600
},
{
"dst_offset": 0,
"id": "Australia/North",
"utc_offset": 570
},
{
"dst_offset": 0,
"id": "Australia/Perth",
"utc_offset": 480
},
{
"dst_offset": 0,
"id": "Australia/Queensland",
"utc_offset": 600
},
{
"dst_offset": 60,
"id": "Australia/South",
"utc_offset": 570
},
{
"dst_offset": 60,
"id": "Australia/Sydney",
"utc_offset": 600
},
{
"dst_offset": 60,
"id": "Australia/Tasmania",
"utc_offset": 600
},
{
"dst_offset": 60,
"id": "Australia/Victoria",
"utc_offset": 600
},
{
"dst_offset": 0,
"id": "Australia/West",
"utc_offset": 480
},
{
"dst_offset": 60,
"id": "Australia/Yancowinna",
"utc_offset": 570
},
{
"dst_offset": 0,
"id": "Brazil/Acre",
"utc_offset": -300
},
{
"dst_offset": 0,
"id": "Europe/Samara",
"utc_offset": 240
},
{
"dst_offset": 0,
"id": "Europe/Moscow",
"utc_offset": 180
}
],
"version": "20200401"
}
Get dictionary of types for text widgets
GET /settings-service/text_widget_types
Example Response
{
"text_widget_types": [
{
"id": "company_details",
"name": "Company details",
"name_ru": "Сведения о компании",
"name_zh": "Company details"
},
{
"id": "warning",
"name": "Warning",
"name_ru": "Предупреждение",
"name_zh": "Warning"
},
{
"id": "instruction",
"name": "Instruction",
"name_ru": "Инструкция",
"name_zh": "Instruction"
},
{
"id": "allergen",
"name": "Allergen",
"name_ru": "Аллерген",
"name_zh": "Allergen"
}
],
"version": "20200403"
}
Get blog posts
Wrapper of hubspot/get_blog_posts method. All requested parameters (described in refer), will be passed to the target method.
List of parameters which can be used: limit, offset, archived, blog_author_id, campaign, content_group_id, created, deleted_at, name, slug, updated, state, order_by
POST /settings-service/blog-posts/get
Example Request
{
"limit": "1"
}
Example Response
{
"limit": 1,
"objects": [
{
"html_title": "What is zero party data and why is everyone talking about it?",
"publish_date": 1585698334000,
"ab_variation": false,
"composition_id": 0,
"layout_sections": {},
"publish_date_localized": {
"date": 1585698334000,
"format": "medium"
},
"title": "What is zero party data and why is everyone talking about it?",
"category": 3,
"published_at": 1585787046877,
"deleted_at": 0,
"created": 1585530118378,
"css_text": "",
"created_by_id": 5879282,
"domain": "",
"portal_id": 3320739,
"tweet_immediately": false,
"blog_author_id": 6787040095,
"absolute_url": "http://blog.shping.com/marketing/zeropartydata",
"rss_summary": "<p></p>",
"blueprint_type_id": 0,
"unpublished_at": 0,
"parent_blog": {
"html_title": "Shping | News and opinion about the future of Shopper Marketing, Consumer Engagement & Brand Protection",
"captcha_after_days": 7,
"month_filter_format": "MMMM yyyy",
"html_head_is_shared": true,
"html_footer_is_shared": true,
"deleted_at": 0,
"created": 1500523734187,
"domain": "",
"portal_id": 3320739,
"amp_logo_height": 0,
"absolute_url": "http://blog.shping.com/marketing",
"show_social_link_facebook": true,
"show_summary_in_rss": true,
"social_account_twitter": "",
"allow_comments": false,
"amp_body_color": "#404040",
"amp_body_font": "'Helvetica Neue', Helvetica, Arial, sans-serif",
"uses_default_template": false,
"slug": "marketing",
"updated": 1535075494575,
"comment_date_format": "medium",
"url_base": "blog.shping.com/marketing",
"id": 5262879919,
"public_access_rules_enabled": false,
"posts_per_rss_feed": 10,
"comment_max_thread_depth": 1,
"amp_logo_src": "",
"weekly_notification_email_id": "5262879932",
"default_notification_from_name": "",
"post_html_footer": "",
"comment_verification_text": "",
"post_html_head": "",
"item_template_is_shared": true,
"created_date_time": 1500523734187,
"root_url": "http://blog.shping.com/marketing",
"enable_google_amp_output": true,
"public_access_rules": [],
"resolved_domain": "blog.shping.com",
"listing_template_path": "generated_layouts/5454653504.html",
"subscription_form_guid": "5ccda306-0f31-422d-bb5d-69b1d6084afd",
"comment_form_guid": "0547fbf6-f0ba-4d00-9cd2-209e6f25efd3",
"category_id": 3,
"html_head": "",
"attached_stylesheets": [],
"html_keywords": [],
"email_api_subscription_id": 4391398,
"item_layout_id": 5454653504,
"amp_header_font_size": "36",
"subscription_lists_by_type": {
"daily": 114,
"instant": 113,
"monthly": 116,
"weekly": 115
},
"translations": {},
"publish_date_format": "medium",
"item_template_path": "generated_layouts/5454653504.html",
"amp_logo_alt": "",
"show_social_link_linkedin": true,
"name": "Shping Blog",
"monthly_notification_email_id": "5263183523",
"amp_custom_css": "",
"subscription_contacts_property": "blog_shping_marketing_5262879919_subscription",
"url_segments": {
"all": "all",
"archive": "archive",
"author": "author",
"page": "page",
"tag": "tag"
},
"analytics_page_id": 5262879919,
"default_group_style_id": "",
"comment_notification_emails": [],
"show_summary_in_listing": true,
"daily_notification_email_id": "5263183518",
"amp_body_font_size": "18",
"public_title": "Shping Blog",
"amp_header_font": "'Helvetica Neue', Helvetica, Arial, sans-serif",
"posts_per_listing_page": 10,
"instant_notification_email_id": "5262879928",
"use_featured_image_in_summary": true,
"label": "Shping Blog",
"amp_header_background_color": "#ffffff",
"enable_social_auto_publishing": false,
"description": "Discover the latest news and opinions from the Shping team about the future of shopper marketing, consumer engagement and brand protection.",
"listing_layout_id": 5454653504,
"html_footer": "",
"amp_header_color": "#1e1e1e",
"amp_link_color": "#416bb3",
"show_summary_in_emails": true,
"live_domain": "blog.shping.com",
"amp_logo_width": 0,
"updated_date_time": 1535075494575,
"domain_when_published": "blog.shping.com",
"show_social_link_twitter": true,
"comment_moderation": false,
"cos_object_type": "BLOG",
"close_comments_older": 0,
"default_notification_reply_to": "",
"captcha_always": false,
"comment_should_create_contact": false
},
"campaign_utm": "Request%20demo",
"flex_areas": {},
"list_template": "generated_layouts/5454653504.html",
"content_group_id": 5262879919,
"slug": "marketing/zeropartydata",
"meta": {
"html_title": "What is zero party data and why is everyone talking about it?",
"composition_id": 0,
"page_expiry_date": null,
"published_at": 1585787046877,
"tweet_immediately": false,
"rss_summary": "<p></p>",
"page_expiry_redirect_id": null,
"unpublished_at": 0,
"last_edit_update_id": null,
"campaign_utm": "Request%20demo",
"tag_ids": [
6091947709,
6092708563,
6283155835,
6380066133,
6386894160,
27751351468,
27751351471,
27751351478
],
"personas": [],
"has_user_changes": true,
"public_access_rules_enabled": false,
"placement_guids": [],
"blog_publish_instant_email_retry_count": 0,
"page_expiry_redirect_url": null,
"link_rel_canonical_url": null,
"public_access_rules": [],
"blog_publish_instant_email_task_uid": null,
"blog_post_schedule_task_uid": null,
"author_username": "maryann@shping.com",
"blog_publish_instant_email_campaign_id": null,
"page_redirected": false,
"topic_ids": [
6091947709,
6092708563,
6283155835,
6380066133,
6386894160,
27751351468,
27751351471,
27751351478
],
"post_body": "<p><!--more-->First-party data collection and activation can be challenging for marketers in data-scarce verticals such as Consumer Packaged Goods (CPG), where advertisers’ distribution partners tend to own the relationship with the end customer.</p>\n<p>As the cookie-less future becomes an imminent reality, CPG brand marketers will need to become even more obsessed with <strong>Zero Party Data</strong> than ever before. In fact, this data will be the key to unleashing real customer intelligence in the future—after all, what your customers tell you about themselves is a gold mine of information that will impact lifetime value, loyalty and churn. </p>\n<h1 style=\"font-size: 20px;\"><strong>Zero-Party Data </strong></h1>\n<p>For the uninitiated, Zero-party data is not first-party data with a 2020 rebrand. zero-party data is a class of data that is intentionally and proactively shared directly with the brand by the consumer.</p>\n<p>Zero-party data is collected directly from consumers and not by using tracking pixels, cookies or cross-device identification. Most importantly, zero-party data is accurate information, not inferred. Marketers can collect it by connecting directly with consumers and gathering the data, insights, and permissions they need to power advertising that clicks. Quite simply, it’s self-reported data like purchase intentions and preference insights to improve personalisation and help build up a picture of the consumer. As it comes directly and willingly from the consumer, there are no intermediaries or guesswork.</p>\n<p>Alas, there has always been a question of the scalability of encouraging individual consumers to supply this data, and it’s not simply a case of ask and you shall receive. Digital consumers are more scrupulous than ever when it comes to handing over their personal details and preference data. You need to offer a value exchange.</p>\n<p>To truly scale zero-party data acquisition, consumers need to be entertained, engaged and rewarded in return for their attention and preference data. Marketers can deliver this through interactive experiences that conduct research, accrue explicit opt-ins and deliver an altogether better experience with a value exchange for the consumer.</p>\n<p>Competitions, surveys, polls, quizzes, reviews or cashbacks can incorporate reward mechanics that give consumers a genuine reason to engage and submit their zero-party data. And it doesn’t always have to be a discount or red-letter prize. Exclusive content, social kudos, personalised recommendations, and loyalty schemes can also be the catalyst for the collection of opt-ins and zero-party data.</p>\n<p>Capturing consumer motivations, intentions, interests, and preferences at scale allows for truly personalised advertising. And by leveraging the right mechanics, and offering a value exchange, your customers will tell you what products they desire, what they look for in a service, and what motivates them to purchase.</p>\n<p><strong><i>Fortunately for CPG brands in Australia, shopper marketing app Shping allows for brands to connect directly with Australian shoppers to build their own Zero Party Data audiences at scale. </i></strong></p>",
"author_email": "maryann@shping.com",
"attached_stylesheets": [],
"published_by_id": 5879282,
"author_user_id": 5902965,
"page_expiry_enabled": false,
"use_featured_image": true,
"last_edit_session_id": null,
"publish_immediately": true,
"legacy_blog_tabid": null,
"enable_google_amp_output_override": false,
"cloned_from": 26473084482,
"post_summary": "<p></p>",
"rss_body": "<p><!--more-->First-party data collection and activation can be challenging for marketers in data-scarce verticals such as Consumer Packaged Goods (CPG), where advertisers’ distribution partners tend to own the relationship with the end customer.</p>\n<p>As the cookie-less future becomes an imminent reality, CPG brand marketers will need to become even more obsessed with <strong>Zero Party Data</strong> than ever before. In fact, this data will be the key to unleashing real customer intelligence in the future—after all, what your customers tell you about themselves is a gold mine of information that will impact lifetime value, loyalty and churn. </p>\n<h1 style=\"font-size: 20px;\"><strong>Zero-Party Data </strong></h1>\n<p>For the uninitiated, Zero-party data is not first-party data with a 2020 rebrand. zero-party data is a class of data that is intentionally and proactively shared directly with the brand by the consumer.</p>\n<p>Zero-party data is collected directly from consumers and not by using tracking pixels, cookies or cross-device identification. Most importantly, zero-party data is accurate information, not inferred. Marketers can collect it by connecting directly with consumers and gathering the data, insights, and permissions they need to power advertising that clicks. Quite simply, it’s self-reported data like purchase intentions and preference insights to improve personalisation and help build up a picture of the consumer. As it comes directly and willingly from the consumer, there are no intermediaries or guesswork.</p>\n<p>Alas, there has always been a question of the scalability of encouraging individual consumers to supply this data, and it’s not simply a case of ask and you shall receive. Digital consumers are more scrupulous than ever when it comes to handing over their personal details and preference data. You need to offer a value exchange.</p>\n<p>To truly scale zero-party data acquisition, consumers need to be entertained, engaged and rewarded in return for their attention and preference data. Marketers can deliver this through interactive experiences that conduct research, accrue explicit opt-ins and deliver an altogether better experience with a value exchange for the consumer.</p>\n<p>Competitions, surveys, polls, quizzes, reviews or cashbacks can incorporate reward mechanics that give consumers a genuine reason to engage and submit their zero-party data. And it doesn’t always have to be a discount or red-letter prize. Exclusive content, social kudos, personalised recommendations, and loyalty schemes can also be the catalyst for the collection of opt-ins and zero-party data.</p>\n<p>Capturing consumer motivations, intentions, interests, and preferences at scale allows for truly personalised advertising. And by leveraging the right mechanics, and offering a value exchange, your customers will tell you what products they desire, what they look for in a service, and what motivates them to purchase.</p>\n<p><strong><i>Fortunately for CPG brands in Australia, shopper marketing app Shping allows for brands to connect directly with Australian shoppers to build their own Zero Party Data audiences at scale. </i></strong></p>",
"meta_description": "What is zero party data and why is everyone talking about it?\n\n",
"blog_publish_to_social_media_task": "DONE_NOT_SENT",
"featured_image": "https://cdn2.hubspot.net/hubfs/3320739/Screen%20Shot%202020-04-02%20at%2011.23.23%20am.png",
"legacy_post_guid": "",
"campaign_name": "Request demo",
"featured_image_alt_text": ""
},
"has_content_access_rules": false,
"updated": 1585787046883,
"post_template": "generated_layouts/5454653504.html",
"tag_ids": [
6091947709,
6092708563,
6283155835,
6380066133,
6386894160,
27751351468,
27751351471,
27751351478
],
"personas": [],
"current_state": "PUBLISHED",
"has_user_changes": true,
"analytics_page_type": "blog-post",
"id": 27751013328,
"public_access_rules_enabled": false,
"tag_list": [],
"css": {},
"featured_image_length": 0,
"placement_guids": [],
"template_path": "",
"widgetcontainers": {},
"blog_publish_instant_email_retry_count": 0,
"security_state": "NONE",
"topic_names": [],
"ab": false,
"ctas": null,
"screenshot_preview_url": "https://cdn2.hubspot.net/hubshot/20/04/02/9942601f-45ce-4593-a8ea-857f0380ad42.png",
"team_perms": [],
"content_type_category_id": 3,
"post_rss_summary_featured_image": "https://cdn2.hubspot.net/hubfs/3320739/Screen%20Shot%202020-04-02%20at%2011.23.23%20am.png",
"public_access_rules": [],
"post_list_summary_featured_image": "https://cdn2.hubspot.net/hubfs/3320739/Screen%20Shot%202020-04-02%20at%2011.23.23%20am.png",
"resolved_domain": "blog.shping.com",
"topic_list": [],
"mab_variant": false,
"author_username": "joel@shping.com",
"page_redirected": false,
"upsize_featured_image": false,
"topic_ids": [
6091947709,
6092708563,
6283155835,
6380066133,
6386894160,
27751351468,
27751351471,
27751351478
],
"views": 0,
"post_body": "<p><!--more-->First-party data collection and activation can be challenging for marketers in data-scarce verticals such as Consumer Packaged Goods (CPG), where advertisers’ distribution partners tend to own the relationship with the end customer.</p>\n<p>As the cookie-less future becomes an imminent reality, CPG brand marketers will need to become even more obsessed with <strong>Zero Party Data</strong> than ever before. In fact, this data will be the key to unleashing real customer intelligence in the future—after all, what your customers tell you about themselves is a gold mine of information that will impact lifetime value, loyalty and churn. </p>\n<h1 style=\"font-size: 20px;\"><strong>Zero-Party Data </strong></h1>\n<p>For the uninitiated, Zero-party data is not first-party data with a 2020 rebrand. zero-party data is a class of data that is intentionally and proactively shared directly with the brand by the consumer.</p>\n<p>Zero-party data is collected directly from consumers and not by using tracking pixels, cookies or cross-device identification. Most importantly, zero-party data is accurate information, not inferred. Marketers can collect it by connecting directly with consumers and gathering the data, insights, and permissions they need to power advertising that clicks. Quite simply, it’s self-reported data like purchase intentions and preference insights to improve personalisation and help build up a picture of the consumer. As it comes directly and willingly from the consumer, there are no intermediaries or guesswork.</p>\n<p>Alas, there has always been a question of the scalability of encouraging individual consumers to supply this data, and it’s not simply a case of ask and you shall receive. Digital consumers are more scrupulous than ever when it comes to handing over their personal details and preference data. You need to offer a value exchange.</p>\n<p>To truly scale zero-party data acquisition, consumers need to be entertained, engaged and rewarded in return for their attention and preference data. Marketers can deliver this through interactive experiences that conduct research, accrue explicit opt-ins and deliver an altogether better experience with a value exchange for the consumer.</p>\n<p>Competitions, surveys, polls, quizzes, reviews or cashbacks can incorporate reward mechanics that give consumers a genuine reason to engage and submit their zero-party data. And it doesn’t always have to be a discount or red-letter prize. Exclusive content, social kudos, personalised recommendations, and loyalty schemes can also be the catalyst for the collection of opt-ins and zero-party data.</p>\n<p>Capturing consumer motivations, intentions, interests, and preferences at scale allows for truly personalised advertising. And by leveraging the right mechanics, and offering a value exchange, your customers will tell you what products they desire, what they look for in a service, and what motivates them to purchase.</p>\n<p><strong><i>Fortunately for CPG brands in Australia, shopper marketing app Shping allows for brands to connect directly with Australian shoppers to build their own Zero Party Data audiences at scale. </i></strong></p>",
"mab_master": false,
"subcategory": "normal_blog_post",
"user_perms": [],
"category_id": 3,
"content_type_category": 3,
"freeze_date": 1585698334000,
"attached_stylesheets": [],
"archived": false,
"published_by_id": 5879282,
"tag_names": [],
"publish_date_local_time": 1585698334000,
"is_social_publishing_enabled": false,
"is_draft": false,
"post_list_content": "<html>\n <head></head>\n <body></body>\n</html>",
"page_expiry_enabled": false,
"campaign": "b3989c44-8d1a-4e02-94b4-4e97b2606be5",
"use_featured_image": true,
"topics": [
6091947709,
6092708563,
6283155835,
6380066133,
6386894160,
27751351468,
27751351471,
27751351478
],
"state": "PUBLISHED",
"template_path_for_render": "generated_layouts/5454653504.html",
"name": "Zero Party Data",
"is_published": true,
"published_by_name": "Joel Stevenson",
"screenshot_preview_taken_at": 1585787049361,
"content_access_rule_ids": [],
"publish_immediately": true,
"blog_author": {
"avatar": "https://app.hubspot.com/settings/avatar/f2e6a0f4975e90825b702859b4730fc9",
"bio": "",
"created": 1544758245740,
"deleted_at": 0,
"display_name": "Joel Stevenson",
"email": "joel@shping.com",
"facebook": "",
"full_name": "Joel Stevenson",
"gravatar_url": "https://app.hubspot.com/settings/avatar/f2e6a0f4975e90825b702859b4730fc9",
"has_social_profiles": true,
"id": 6787040095,
"linkedin": "https://www.linkedin.com/in/joel-stevenson-8b3b6614/",
"portal_id": 3320739,
"slug": "joel-stevenson",
"translations": {},
"twitter": "",
"twitter_username": "",
"updated": 1544758245740,
"website": "www.shping.com"
},
"author": "joel@shping.com",
"analytics_page_id": "27751013328",
"published_by_email": "joel@shping.com",
"enable_google_amp_output_override": false,
"past_mab_experiment_ids": [],
"featured_image_height": 0,
"author_name": "Joel Stevenson",
"cloned_from": 26473084482,
"label": "Zero Party Data",
"post_rss_content": "<html>\n <head></head>\n <body></body>\n</html>",
"post_summary": "<p></p>",
"url": "http://blog.shping.com/marketing/zeropartydata",
"post_body_rss": "<p><!--more-->First-party data collection and activation can be challenging for marketers in data-scarce verticals such as Consumer Packaged Goods (CPG), where advertisers’ distribution partners tend to own the relationship with the end customer.</p>\n<p>As the cookie-less future becomes an imminent reality, CPG brand marketers will need to become even more obsessed with <strong>Zero Party Data</strong> than ever before. In fact, this data will be the key to unleashing real customer intelligence in the future—after all, what your customers tell you about themselves is a gold mine of information that will impact lifetime value, loyalty and churn. </p>\n<h1 style=\"font-size: 20px;\"><strong>Zero-Party Data </strong></h1>\n<p>For the uninitiated, Zero-party data is not first-party data with a 2020 rebrand. zero-party data is a class of data that is intentionally and proactively shared directly with the brand by the consumer.</p>\n<p>Zero-party data is collected directly from consumers and not by using tracking pixels, cookies or cross-device identification. Most importantly, zero-party data is accurate information, not inferred. Marketers can collect it by connecting directly with consumers and gathering the data, insights, and permissions they need to power advertising that clicks. Quite simply, it’s self-reported data like purchase intentions and preference insights to improve personalisation and help build up a picture of the consumer. As it comes directly and willingly from the consumer, there are no intermediaries or guesswork.</p>\n<p>Alas, there has always been a question of the scalability of encouraging individual consumers to supply this data, and it’s not simply a case of ask and you shall receive. Digital consumers are more scrupulous than ever when it comes to handing over their personal details and preference data. You need to offer a value exchange.</p>\n<p>To truly scale zero-party data acquisition, consumers need to be entertained, engaged and rewarded in return for their attention and preference data. Marketers can deliver this through interactive experiences that conduct research, accrue explicit opt-ins and deliver an altogether better experience with a value exchange for the consumer.</p>\n<p>Competitions, surveys, polls, quizzes, reviews or cashbacks can incorporate reward mechanics that give consumers a genuine reason to engage and submit their zero-party data. And it doesn’t always have to be a discount or red-letter prize. Exclusive content, social kudos, personalised recommendations, and loyalty schemes can also be the catalyst for the collection of opt-ins and zero-party data.</p>\n<p>Capturing consumer motivations, intentions, interests, and preferences at scale allows for truly personalised advertising. And by leveraging the right mechanics, and offering a value exchange, your customers will tell you what products they desire, what they look for in a service, and what motivates them to purchase.</p>\n<p><strong><i>Fortunately for CPG brands in Australia, shopper marketing app Shping allows for brands to connect directly with Australian shoppers to build their own Zero Party Data audiences at scale. </i></strong></p>",
"is_instant_email_enabled": true,
"rss_summary_featured_image": "https://cdn2.hubspot.net/hubfs/3320739/Screen%20Shot%202020-04-02%20at%2011.23.23%20am.png",
"currently_published": true,
"post_summary_rss": "<html>\n <head></head>\n <body></body>\n</html>",
"keywords": [],
"updated_by_id": 5879282,
"created_time": 1585530118378,
"synced_with_blog_root": true,
"is_captcha_required": true,
"translated_content": {},
"rss_body": "<p><!--more-->First-party data collection and activation can be challenging for marketers in data-scarce verticals such as Consumer Packaged Goods (CPG), where advertisers’ distribution partners tend to own the relationship with the end customer.</p>\n<p>As the cookie-less future becomes an imminent reality, CPG brand marketers will need to become even more obsessed with <strong>Zero Party Data</strong> than ever before. In fact, this data will be the key to unleashing real customer intelligence in the future—after all, what your customers tell you about themselves is a gold mine of information that will impact lifetime value, loyalty and churn. </p>\n<h1 style=\"font-size: 20px;\"><strong>Zero-Party Data </strong></h1>\n<p>For the uninitiated, Zero-party data is not first-party data with a 2020 rebrand. zero-party data is a class of data that is intentionally and proactively shared directly with the brand by the consumer.</p>\n<p>Zero-party data is collected directly from consumers and not by using tracking pixels, cookies or cross-device identification. Most importantly, zero-party data is accurate information, not inferred. Marketers can collect it by connecting directly with consumers and gathering the data, insights, and permissions they need to power advertising that clicks. Quite simply, it’s self-reported data like purchase intentions and preference insights to improve personalisation and help build up a picture of the consumer. As it comes directly and willingly from the consumer, there are no intermediaries or guesswork.</p>\n<p>Alas, there has always been a question of the scalability of encouraging individual consumers to supply this data, and it’s not simply a case of ask and you shall receive. Digital consumers are more scrupulous than ever when it comes to handing over their personal details and preference data. You need to offer a value exchange.</p>\n<p>To truly scale zero-party data acquisition, consumers need to be entertained, engaged and rewarded in return for their attention and preference data. Marketers can deliver this through interactive experiences that conduct research, accrue explicit opt-ins and deliver an altogether better experience with a value exchange for the consumer.</p>\n<p>Competitions, surveys, polls, quizzes, reviews or cashbacks can incorporate reward mechanics that give consumers a genuine reason to engage and submit their zero-party data. And it doesn’t always have to be a discount or red-letter prize. Exclusive content, social kudos, personalised recommendations, and loyalty schemes can also be the catalyst for the collection of opt-ins and zero-party data.</p>\n<p>Capturing consumer motivations, intentions, interests, and preferences at scale allows for truly personalised advertising. And by leveraging the right mechanics, and offering a value exchange, your customers will tell you what products they desire, what they look for in a service, and what motivates them to purchase.</p>\n<p><strong><i>Fortunately for CPG brands in Australia, shopper marketing app Shping allows for brands to connect directly with Australian shoppers to build their own Zero Party Data audiences at scale. </i></strong></p>",
"meta_description": "What is zero party data and why is everyone talking about it?\n\n",
"blog_post_author": {
"avatar": "https://app.hubspot.com/settings/avatar/f2e6a0f4975e90825b702859b4730fc9",
"bio": "",
"created": 1544758245740,
"deleted_at": 0,
"display_name": "Joel Stevenson",
"email": "joel@shping.com",
"facebook": "",
"full_name": "Joel Stevenson",
"gravatar_url": "https://app.hubspot.com/settings/avatar/f2e6a0f4975e90825b702859b4730fc9",
"has_social_profiles": true,
"id": 6787040095,
"linkedin": "https://www.linkedin.com/in/joel-stevenson-8b3b6614/",
"portal_id": 3320739,
"slug": "joel-stevenson",
"translations": {},
"twitter": "",
"twitter_username": "",
"updated": 1544758245740,
"website": "www.shping.com"
},
"blog_publish_to_social_media_task": "DONE_NOT_SENT",
"live_domain": "blog.shping.com",
"post_email_content": "<html>\n <head></head>\n <body></body>\n</html>",
"mab": false,
"content_group": 5262879919,
"featured_image": "https://cdn2.hubspot.net/hubfs/3320739/Screen%20Shot%202020-04-02%20at%2011.23.23%20am.png",
"post_featured_image_if_enabled": "https://cdn2.hubspot.net/hubfs/3320739/Screen%20Shot%202020-04-02%20at%2011.23.23%20am.png",
"legacy_post_guid": "",
"are_comments_allowed": false,
"published_url": "http://blog.shping.com/marketing/zeropartydata",
"processing_status": "PUBLISHED",
"campaign_name": "Request demo",
"widgets": {
"blog_comments": {
"body": {
"tag": "blog_comments",
"type": "blog_comments"
},
"child_css": {},
"css": {},
"id": "blog_comments",
"label": "blog_comments",
"name": "blog_comments",
"order": 5,
"type": "blog_comments"
},
"post_cta": {
"body": {
"guid": "c7851188-a6c2-48c9-90e4-c58f363f0462"
},
"child_css": {},
"css": {},
"id": "post_cta",
"label": "Select a CTA",
"name": "post_cta",
"order": 4,
"type": "cta"
}
},
"preview_key": "EQAWvrKx",
"featured_image_alt_text": "",
"featured_image_width": 0,
"widget_containers": {},
"page_title": "What is zero party data and why is everyone talking about it?"
}
],
"offset": 0,
"total": 53
}
Rate cards settings
GET /settings-service/rate_card_items
Card elements has following structure:
{
"<id>": {
"events": [],
"name": "<Name>"
}
}
id - element idevents - list of eventsname - element name
Example Response
{
"approved_reviews": {
"events": [
"send_review"
],
"name": "Approved Reviews"
},
"clicks": {
"events": [
"follow_fb",
"visit_link",
"visit_social_networks_link"
],
"name": "Clicks"
},
"completed_video": {
"events": [
"watch_video"
],
"name": "Completed Video"
},
"impressions_revenue": {
"events": [
"scan",
"send_scan_location",
"view_certificates",
"view_image",
"view_nutrition_info",
"view_popup",
"view_status",
"view_text"
],
"name": "Impressions Revenue"
},
"transactional_data": {
"events": [],
"name": "Transactional Data"
}
}
Get OCR retailers
GET /settings-service/retailer_ocr_ids
Parameters
| Name | Type | Description |
|---|---|---|
| with_default_value | string | Include default id=null value or not (true or false). Default false |
Example Response
{
"ocr_retailers": [
{
"id": "coles",
"name": "Coles"
}
]
}
Get retailers
GET /settings-service/retailers
Parameters
| Name | Type | Description |
|---|---|---|
| country | string | Country code |
| page | string | Next page key |
| search | string | Search query |
| only_ocr | boolean | Return retailers with OCR support only |
| include_count | boolean | Extend response with receipts counters |
| limit | pos_integer | Limit per page |
| page | string | Next page key |
Example Response.
GET /settings-service/retailers?country=036&search=co&include_count=true&limit=3&only_ocr=false
{
"list": [
{
"id": "aco_asdasdasd_test",
"logo": null,
"name": "ACO asdasdasd TEST",
"ocr": false,
"participant_id": "urn:authenticateit:participant:152455513529692",
"receipts_count": 1
},
{
"id": "aco_test",
"logo": null,
"name": "ACO TEST",
"ocr": false,
"participant_id": "urn:authenticateit:participant:666189271005034",
"receipts_count": 0
},
{
"id": "coles",
"logo": "http://dev-cdn.shping.com/2022/1/25/0fedebb2-6542-450d-ab40-dba37f6a59fd.png",
"name": "Coles",
"ocr": true,
"participant_id": "urn:authenticateit:participant:111111111111115",
"receipts_count": 13
}
],
"next_page": "import_retailer_ids:0278883f-893d-43f7-a0a0-d2029094633d"
}
Example Response.
GET /settings-service/retailers?country=036&search=co&include_count=true&limit=3&page=import_retailer_ids:0278883f-893d-43f7-a0a0-d2029094633d
{
"list": [
{
"id": "lancome",
"logo": null,
"name": "Lancome",
"ocr": false,
"participant_id": "urn:authenticateit:participant:111111111111119",
"receipts_count": 0
},
{
"id": "mac_cosmetics",
"logo": null,
"name": "MAC Cosmetics",
"ocr": false,
"participant_id": "urn:authenticateit:participant:111111111111126",
"receipts_count": 0
}
],
"next_page": null
}
Get AGT Countries
POST /settings-service/agt/countries
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| name | string | |
| iso3 | string | |
| numeric_code | string | |
| iso2 | string | |
| phonecode | string | |
| capital | string | |
| currency | string | |
| currency_name | string | |
| currency_symbol | string | |
| tld | string | |
| native | string | |
| subregion | string | |
| latitude | number | |
| longitude | number | |
| distance | number | |
| limit | non_neg_integer | |
| offset | non_neg_integer |
Example Request
{
"tz_name": "Australia",
"capital" : "canb",
"latitude": -37.8002,
"longitude": 144.8947,
"distance": 10000,
"limit": 100,
"offset": 0
}
Example Response
{
"count": 1,
"data": [
{
"capital": "Canberra",
"currency": "AUD",
"currency_name": "Australian dollar",
"currency_symbol": "$",
"distance": 1637.0260326303153,
"iso2": "AU",
"iso3": "AUS",
"latitude": -27.0,
"longitude": 133.0,
"name": "Australia",
"native": "Australia",
"numeric_code": "036",
"phonecode": "61",
"region": "Oceania",
"subregion": "Australia and New Zealand",
"tld": ".au"
}
]
}
Get AGT States
POST /settings-service/agt/states
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| country | string | Required: Country code |
| tz_name | string | |
| tz_offset | string | |
| state_code | string | |
| state_name | string | |
| subregion | string | |
| limit | non_neg_integer | |
| offset | non_neg_integer |
Example Request
{
"country": "036",
"limit" : 1,
"offset": 1
}
Example Response
{
"count": 8,
"data": [
{
"country_code": "036",
"state_code": "NSW",
"state_name": "New South Wales",
"tz_name": "Australia/Sydney",
"tz_offset": "+11:00"
}
]
}
Get AGT Postcodes
POST /settings-service/agt/postcodes
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| country | string | Required: Country code |
| state | list | |
| locality | string | |
| postcode | string | |
| latitude | number | |
| longitude | number | |
| distance | number | |
| limit | non_neg_integer | |
| offset | non_neg_integer |
Example Request
{
"country": "036",
"state": ["VIC"],
"postcode": "301",
"limit": 3,
"latitude": -37.8008,
"distance": 15,
"longitude": 144.8947,
"offset": 0
}
Example Response
{
"count": 16,
"data": [
{
"country_code": "036",
"distance": 0.0,
"latitude": -37.8008,
"locality": "FOOTSCRAY",
"longitude": 144.8947,
"postcode": "3011",
"state": "VIC"
},
{
"country_code": "036",
"distance": 0.6832172190600034,
"latitude": -37.8064,
"locality": "SEDDON",
"longitude": 144.8915,
"postcode": "3011",
"state": "VIC"
},
{
"country_code": "036",
"distance": 1.494651964055892,
"latitude": -37.8077,
"locality": "KINGSVILLE",
"longitude": 144.8801,
"postcode": "3012",
"state": "VIC"
}
]
}
Get AGT Cities
POST /settings-service/agt/cities
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| country | string | Required: Country code |
| name | string | |
| state | list | |
| latitude | number | |
| longitude | number | |
| distance | number | |
| limit | non_neg_integer | |
| offset | non_neg_integer |
Example Request
{
"country": "036",
"state": ["VIC"],
"limit": 100,
"latitude": -37.8008,
"distance": 1,
"longitude": 144.8947,
"offset": 0
}
Example Response
{
"count": 2,
"data": [
{
"country_code": "036",
"distance": 0.4740825448917134,
"latitude": -37.8,
"longitude": 144.9,
"name": "Footscray",
"state_code": "VIC"
},
{
"country_code": "036",
"distance": 0.6832970300196564,
"latitude": -37.80607,
"longitude": 144.8907,
"name": "Seddon",
"state_code": "VIC"
}
]
}
Get list of review rejection reasons
GET /settings-service/review_rejection_reasons
Example Response
{
"review_rejection_reasons": [
{
"id": "review_not_informative",
"text": "Your review was not accepted as it was not informative enough."
},
{
"id": "review_related_to_other_products",
"text": "Your review was not accepted as must only be related to a product you have used."
},
{
"id": "review_contains_inappropriate_language",
"text": "Your review was not accepted due to inappropriate language."
}
]
}