Shoppinglists

A service which allows to manage user shoppinglists. All Shoppinglists endpoints have path prefix /shoppinglists-service.

GetShoppinglist

Get user shoppinglist list.

GET /shoppinglists-service/user/shoppinglist

After first request from user creates shoppinglist with required type.

Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
excluder_product string Optional: excluder product gtin
Example Response
{
  "shoppinglists": {
    "required": [
      {
        "_id": "53e49d0e-b0b1-4cc2-b385-71ee3bb09547",
        "name": "This Week",
        "is_required": true,
        "owner": {
          "_id": "urn:authenticateit:user:email:email@mail.com",
          "name": "User name",
          "image": "https://dev-cdn.shping.com/2019/9/29/94ba1ae0-6f90-40f7-9b96-1a6ec09d0793"
        },
        "shared_with": [],
        "type": "shoppinglist",
        "created_at": "2020-08-10T08:54:41.723Z",
        "products_amount": 23,
        "role": "owner"
      }
    ],
    "custom": [
      {
        "_id": "537e7e9c-793c-4a47-9b84-c1d9bb1bf7b8",
        "name": "Milana1",
        "owner": {
          "_id": "urn:authenticateit:user:email:email@mail.com",
          "name": "User name",
          "image": "https://dev-cdn.shping.com/2019/9/29/94ba1ae0-6f90-40f7-9b96-1a6ec09d0793"
        },
        "shared_with": [
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "403-7cc723b337313606dc8dd08bd9489261",
            "image": "https://dev-cdn.shping.com/2019/9/26/fdc48e2c-971a-42fe-a4a3-253c7ba68171",
            "role": "guest"
          }
        ],
        "type": "shoppinglist",
        "created_at": "2020-08-10T10:03:47.051Z",
        "products_amount": 5,
        "role": "owner"
      },
      {
        "_id": "f28a89ff-04b8-43f6-873c-67f96dc6d749",
        "name": "Milana2",
        "owner": {
          "_id": "urn:authenticateit:user:email:email@mail.com",
          "name": "User name",
          "image": "https://dev-cdn.shping.com/2019/9/29/94ba1ae0-6f90-40f7-9b96-1a6ec09d0793"
        },
        "shared_with": [
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "403-7cc723b337313606dc8dd08bd9489261",
            "image": "https://dev-cdn.shping.com/2019/9/26/fdc48e2c-971a-42fe-a4a3-253c7ba68171",
            "role": "default"
          }
        ],
        "type": "shoppinglist",
        "created_at": "2020-08-10T10:04:02.035Z",
        "products_amount": 0,
        "role": "owner"
      },
      {
        "_id": "a3987567-f202-47ed-b0ed-030d794d2c82",
        "name": "Milana3",
        "owner": {
          "_id": "urn:authenticateit:user:email:email@mail.com",
          "name": "User name",
          "image": "https://dev-cdn.shping.com/2019/9/29/94ba1ae0-6f90-40f7-9b96-1a6ec09d0793"
        },
        "shared_with": [
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "403-7cc723b337313606dc8dd08bd9489261",
            "image": "https://dev-cdn.shping.com/2019/9/26/fdc48e2c-971a-42fe-a4a3-253c7ba68171",
            "role": "default"
          },
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "23-1d22248f2fe1ef0a3961dada967ed24e",
            "image": "https://dev-cdn.shping.com/2019/10/31/c5d10ad6-2ab6-407b-ae86-c629bbad7516",
            "role": "default"
          }
        ],
        "type": "shoppinglist",
        "created_at": "2020-08-10T10:04:12.659Z",
        "products_amount": 0,
        "role": "owner"
      },
      {
        "_id": "2cd032db-ee72-43bc-addf-369ce1cf6c8c",
        "name": "Milana sent tru skype",
        "owner": {
          "_id": "urn:authenticateit:user:email:email@mail.com",
          "name": "User name",
          "image": "https://dev-cdn.shping.com/2019/9/29/94ba1ae0-6f90-40f7-9b96-1a6ec09d0793"
        },
        "shared_with": [
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "23-1d22248f2fe1ef0a3961dada967ed24e",
            "image": "https://dev-cdn.shping.com/2019/10/31/c5d10ad6-2ab6-407b-ae86-c629bbad7516",
            "role": "default"
          }
        ],
        "type": "shoppinglist",
        "created_at": "2020-08-13T13:09:00.355Z",
        "products_amount": 0,
        "role": "owner"
      },
      {
        "_id": "1775f249-d1e0-4c88-a116-49704b73c6ef",
        "name": "Milana5",
        "owner": {
          "_id": "urn:authenticateit:user:email:email@mail.com",
          "name": "User name",
          "image": "https://dev-cdn.shping.com/2019/9/29/94ba1ae0-6f90-40f7-9b96-1a6ec09d0793"
        },
        "shared_with": [],
        "type": "shoppinglist",
        "created_at": "2020-08-13T13:09:19.387Z",
        "products_amount": 0,
        "role": "owner"
      }
    ],
    "shared": [
      {
        "_id": "33f3f774-f90c-4afe-9544-40ef92d98e3d",
        "name": "AE1",
        "owner": {
          "_id": "urn:authenticateit:user:email:email@mail.com",
          "name": "User name",
          "image": "https://dev-cdn.shping.com/2019/9/26/fdc48e2c-971a-42fe-a4a3-253c7ba68171"
        },
        "shared_with": [
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "585-8e0147a49fdd6ce80718e8e1e24bcbf5",
            "image": "https://dev-cdn.shping.com/2019/5/7/b625a6a1-c37f-4211-9805-dfe9108f7034",
            "role": "default"
          },
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "76-fdb9e44009a562ce56a13d879ad85ed0",
            "image": "https://dev-cdn.shping.com/2020/7/22/95e664ff-01c4-4891-8182-0c841be1c0a0",
            "role": "default"
          },
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "381-8bd07089a67658596a0dc1a3f51f23a2",
            "image": "https://dev-cdn.shping.com/2019/9/29/94ba1ae0-6f90-40f7-9b96-1a6ec09d0793",
            "role": "default"
          },
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "23-1d22248f2fe1ef0a3961dada967ed24e",
            "image": "https://dev-cdn.shping.com/2019/10/31/c5d10ad6-2ab6-407b-ae86-c629bbad7516",
            "role": "default"
          },
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "68-57d70928354e2ae2db1176682c934ec5",
            "image": "https://dev-cdn.shping.com/2019/10/15/4c20bdc5-6f43-4ea5-a589-e8c6fe86d3e2",
            "role": "default"
          }
        ],
        "type": "shoppinglist",
        "created_at": "2020-08-13T11:46:45.543Z",
        "products_amount": 0,
        "role": "default"
      },
      {
        "_id": "114b5641-2a2a-4269-88f9-f1deef4b6bc6",
        "name": "AE2",
        "owner": {
          "_id": "urn:authenticateit:user:email:email@mail.com",
          "name": "User name",
          "image": "https://dev-cdn.shping.com/2019/9/26/fdc48e2c-971a-42fe-a4a3-253c7ba68171"
        },
        "shared_with": [
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "381-8bd07089a67658596a0dc1a3f51f23a2",
            "image": "https://dev-cdn.shping.com/2019/9/29/94ba1ae0-6f90-40f7-9b96-1a6ec09d0793",
            "role": "default"
          }
        ],
        "type": "shoppinglist",
        "created_at": "2020-08-13T11:47:11.215Z",
        "products_amount": 0,
        "role": "default"
      },
      {
        "_id": "2f15200f-cbc6-4a2f-80b3-513555dac73e",
        "name": "This Week",
        "is_required": true,
        "owner": {
          "_id": "urn:authenticateit:user:email:email@mail.com",
          "name": "User name",
          "image": "https://dev-cdn.shping.com/2019/10/31/51ef1b00-4dfa-4cc3-9298-26e469eb5fb9"
        },
        "shared_with": [
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "23-1d22248f2fe1ef0a3961dada967ed24e",
            "image": "https://dev-cdn.shping.com/2019/10/31/c5d10ad6-2ab6-407b-ae86-c629bbad7516",
            "role": "default"
          },
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "381-8bd07089a67658596a0dc1a3f51f23a2",
            "image": "https://dev-cdn.shping.com/2019/9/29/94ba1ae0-6f90-40f7-9b96-1a6ec09d0793",
            "role": "default"
          }
        ],
        "type": "shoppinglist",
        "created_at": "2020-08-16T15:46:34.765Z",
        "products_amount": 0,
        "role": "default"
      },
      {
        "_id": "3a135cd3-e18e-470c-b543-4aa83fbb090e",
        "name": "Via4",
        "owner": {
          "_id": "urn:authenticateit:user:email:email@mail.com",
          "name": "User name",
          "image": "https://dev-cdn.shping.com/2019/10/31/c5d10ad6-2ab6-407b-ae86-c629bbad7516"
        },
        "shared_with": [
          {
            "_id": "urn:authenticateit:user:email:email@mail.com",
            "name": "User name",
            "_rev": "381-8bd07089a67658596a0dc1a3f51f23a2",
            "image": "https://dev-cdn.shping.com/2019/9/29/94ba1ae0-6f90-40f7-9b96-1a6ec09d0793",
            "role": "default"
          }
        ],
        "type": "shoppinglist",
        "created_at": "2020-08-17T11:32:04.068Z",
        "products_amount": 0,
        "role": "default"
      }
    ]
  }
}

Add new shoppinglist

Add new user shoppinglist.

POST /shoppinglists-service/user/shoppinglist
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
name string Required: shoppinglist name
Example body
{
    "name": "test name"
}
Example Response
{
    "result": "Shopping list has been created"
}

Delete shoppinglist

Delete user shoppinglist.

DELETE /shoppinglists-service/user/shoppinglist
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
id string Required: user shoppinglist id (uuid)
Example body
{
    "id": "e2af5961-e74d-41ca-a998-a782a7a90807"
}
Example Response
{
    "result": "Shoppinglist with id dff5f8ce-d238-4b8b-97c0-fd5c9c9b6301 has been deleted."
}

Required shoppinglists can't be deleted. If shoppinglist with id in request body has field is_required it return error.

{
    "error": "Shoppinglist with id a51a9c37-0222-4e1d-904d-94ba6bbb3089 is required and can't be deleted",
    "error_data": null,
    "error_id": "receipts-del_receipt",
    "error_object": null
}

Copy shoppinglist

We can copy a shopping list to a new one (Custom lists), all products are copied, all permissions are copied

POST /shoppinglists-service/user/shoppinglist/copy
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
id string Required: user shoppinglist id (uuid)
name string Optional: New shoppinglist name
Example body
{
    "id": "e2af5961-e74d-41ca-a998-a782a7a90807",
    "name": "New shoppinglist name"
}
Example Response
{
    "id": "dff5f8ce-d238-4b8b-97c0-fd5c9c9b6301"
}

Rename shoppinglist

Rename user shoppinglist.

Shoppinglists with required type can't be renamed.

PUT /shoppinglists-service/user/shoppinglist
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
id string Required: user shoppinglist id (uuid)
name string Required: shoppinglist name
Example body
{
    "name": "test name",
    "id": "e2af5961-e74d-41ca-a998-a782a7a90807"
}
Example Response
{
    "result": "Shoppinglist with id dff5f8ce-d238-4b8b-97c0-fd5c9c9b6301 has been renamed."
}

Required shoppinglists can't be renamed. If shoppinglist with id in request body has field is_required it return error.

{
    "error": "Shoppinglist with id a51a9c37-0222-4e1d-904d-94ba6bbb3089 is required and can't be renamed",
    "error_data": null,
    "error_id": "shoppinglists-rename_shoppinglist",
    "error_object": null
}

Only owner or user with admin role can rename shoppinglist. If user has no permission to rename shoppinglist it returns error.

{
    "error": "You dont't have permission to rename this shoppinglist",
    "error_data": null,
    "error_id": "shoppinglists-rename_shoppinglist",
    "error_object": null
}

Share shoppinglist with buddy

Share user's shoppinglist with buddy.

POST /shoppinglists-service/user/shoppinglist/sharing
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string Required: user shoppinglist id (uuid)
buddies_id Array of strings Required: buddies ids list id
Example body
{
    "buddies_id": ["email@gmail.com"],
    "list_id": "e2af5961-e74d-41ca-a998-a782a7a90807"
}
Example Response
{
    "result": "Shopping list with id 28e341a0-4d58-4b8c-8a4e-4dc716a12ddf has been shared."
}

If shoppinglist has been already shared to buddy it returns error.

{
    "error": "Shopping list with id 7041e11b-3de7-41e8-8377-cd62ad0cc300 has already been shared to this user.",
    "error_data": null,
    "error_id": "shoppinglists-shareShoppinglistWithBuddy",
    "error_object": null
}

Delete shoppinglist sharing with buddy

Delete buddy from list of users with whom shoppunglist is shared.

DELETE /shoppinglists-service/user/shoppinglist/sharing
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string Required: user shoppinglist id (uuid)
buddy_id string Required: buddy id
Example body
{
    "buddy_id": "email@gmail.com",
    "list_id": "e2af5961-e74d-41ca-a998-a782a7a90807"
}
Example Response
{
    "result": "Shopping list with id 7041e11b-3de7-41e8-8377-cd62ad0cc300 is no more shared to this user."
}

If shoppinglist has not been shared to buddy it returns error.

{
    "error": "Shoppinglist with id 7041e11b-3de7-41e8-8377-cd62ad0cc300 has not been shared to this user.",
    "error_data": null,
    "error_id": "shoppinglists-deleteSharing",
    "error_object": null
}

Create sharing url

Create sharing url for shoppinglist.

POST /shoppinglists-service/user/shoppinglist/sharing/link
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
id string Required: user shoppinglist id (uuid)
{
    "id": "e2af5961-e74d-41ca-a998-a782a7a90807"
}
Example Response
{
    "url": "https://test-shping.app.link/7XUJjaLaV7"
}

Share shoppinglist by invitation code

Add to user's shared shoppinglists another one by invitation code

POST /shoppinglists-service/user/shoppinglist/invitation
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
invitation_code string Required: invitation code from url params
Example body
{
    "invitation_code": "575374152462501"
}
Example Response
{
    "result": "Shopping list with id 4c9a2e46-dd74-4b83-9e66-da2602d73134 has been shared with you."
}

If user is owner of the shoppinglist it returns an error.

{
    "error": "Shopping list can be shared with owner",
    "error_data": null,
    "error_id": "shoppinglists-self-sharing",
    "error_object": null
}

If the shoppinglist has already been shared with user it returns an error.

{
    "error": "This shopping list has already been shared with you",
    "error_data": null,
    "error_id": "shoppinglists-re-sharing",
    "error_object": null
}

Set user role for shoppinglist

Set user's role for shared shoppinglist.

PUT /shoppinglists-service/user/shoppinglist/role
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string Required: shoppinglist id (uuid)
user_id string Required: id of user to whom list is shared
role string Required: user's role (one of: guest, default, admin)
Example body
{
    "user_id": "email@gmail.com",
    "list_id": "e2af5961-e74d-41ca-a998-a782a7a90807",
    "role": "admin"
}
Example Response
{
    "result": "Role has been changed."
}

If shoppinglist has not been shared to user it returns error.

{
    "error": "Shopping list with id 7041e11b-3de7-41e8-8377-cd62ad0cc300 is not shared to this user.",
    "error_data": null,
    "error_id": "shoppinglists-changeRole",
    "error_object": null
}

Only owner of shoppinglist can manage user roles for it. If other user try to change role it returns error.

{
    "error": "You dont't have permission to manage this shopping list's roles",
    "error_data": null,
    "error_id": "shoppinglists-changeRole",
    "error_object": null
}

Add product

Add product to shoppinglist.

POST /shoppinglists-service/user/shoppinglist/product
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
lists_ids array of strings Optional: array of shoppinglists ids(uuid)
list_id string Optional: shoppinglists id(uuid)
product_id string Required: product id (uuid)
name string Optional: custom product name
params object Optional: product parameters (position, amount, purchase_frequency, added_by,unit)

One of "lists_ids" or "list_id" is required. If both are passed "lists_ids" is priority.

Example body
{
    "lists_ids": [
        "168659c6-a110-4b73-bfc5-209619b7dd78",
        "a0927558-9fda-4b82-ab1c-84192d4233fd",
        "ab3d38ee-d8ea-4178-9d02-a0cb17b4e7e4"
    ],
    "product_id": "00000772091930",
    "params": {
        "position": 3,
        "added_by": "urn:authenticateit:user:email:system@authenticateit.com",
        "amount": 2,
        "purchase_frequency": "weekly", 
        "unit":"ml"
    }
}

Users can add custom product using param "name".

Example Response
{
    "result": "Product has been added to shopping lists"
}

Users with role "guest" can't add products to shoppinglist. If guest try to add product to shoppinglist it returns error.

{
    "error": "You dont't have permission to add products to this shopping list",
    "error_data": null,
    "error_id": "shoppinglists-addProducts",
    "error_object": null
}

Delete product

Delete product from shoppinglist.

DELETE /shoppinglists-service/user/shoppinglist/product
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string Required: shoppinglist id (uuid)
product_id string Required: product id (uuid)
Example body
{
    "list_id": "8a674d4a-d1fc-4728-90de-f904eb96f6c7",
    "product_id": "00000772091930"
}
Example Response
{
    "result": "Product has been deleted from shopping list", 
    "position": 29
}

Users with role "guest" can't delete products to shoppinglist. Users with role "defailt" can delete only products that were added by themselves. If user who has no rights try to delete product it returns error.

{
    "error": "You dont't have permission to delete this product from this shopping list",
    "error_data": null,
    "error_id": "shoppinglists-delProducts",
    "error_object": null
}

If there are no product_id in shoppinglist with list_id it returns error.

{
    "error": "There are no this product in this shopping list",
    "error_data": null,
    "error_id": "shoppinglists-delProducts",
    "error_object": null
}

Delete occasional product

Delete occasional product from shoppinglist.

DELETE /shoppinglists-service/user/product/occasional
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string Required: shoppinglist id (uuid)
product_id string Required: product id (uuid)
Example body
{
    "list_id": "8a674d4a-d1fc-4728-90de-f904eb96f6c7",
    "product_id": "00000772091930"
}
Example Response
{
    "result": "Occasional product deleted"
}

If product exist in shopping-list it returns error.

{
    "error": "you cannot delete this product while it is in the shopping-list",
    "error_data": null,
    "error_id": "shoppinglists-deleteOccasionalProduct",
    "error_object": null
}
{
    "error": "no occasional products in this shopping-list",
    "error_data": null,
    "error_id": "shoppinglists-deleteOccasionalProduct",
    "error_object": null
}

Search products in entire database.

POST /shoppinglists-service/user/shoppinglist/search
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string Required: id of shoppinglist
search_string string Optional: string for search
sort_by string Optional: ("name_desc","name_asc","price_desc","price_asc", "popularity_asc", "popularity_desc")
categories array Optional: filtration by array of category id
attributes array Optional: filtration by array of attribute ids
page_number number Optional: default: 1
page_size number Optional: default: 50
filter array Optional: filtration by types of filters
discount_value object Optional: filtration by size of discount (from, to)
retailers array Optional: filtration by array of retailers

available filters:

  • specials - used to show only discount products
  • booster - used to show only booster products
  • partners_brand - used to show products from partner brands

discount_value structure:

"discount_value": {
"from": int,
"to": int
}

if we want to set discount from 50% to 100% we should set from=50, to=100

Example body
{
    "search_string": "bitsy",
    "list_id": "8a674d4a-d1fc-4728-90de-f904eb96f6c7" 
}

Returns list of products. Special Sorting Rules are used to find the first 3 records (highlited_products), while the rest are sorted in alphabetical order. If products array is empty it means that selected products have no prices docs in dev couchDB.

Example Response
{
    "retailers": [
        {
            "id": "urn:authenticateit:participant:111111111111133",
            "name": "Import participant MyDeal"
        },
        {
            "id": "urn:authenticateit:participant:111111111111115",
            "name": "Import participant Coles",
            "logo": "https://dev-cdn.shping.com/2020/9/18/bb4f9033-ca16-4c95-a820-276373660680.png"
        },
        {
            "id": "urn:authenticateit:participant:111111111111132",
            "name": "Import participant FairPrice"
        },
        {
            "id": "urn:authenticateit:participant:111111111111131",
            "name": "Import participant Chemist Warehouse"
        }
    ],
    "products": [
        {
            "product_id": "00888731089583",
            "product_name": "Mel Dreamed by Melissa Women's Mel Open Boot US", 
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 65.99,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/0c0b8537-2347-4df3-ab00-13fe808f8c28"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/1d688040-f049-464c-a823-c87a97c972c1"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/c439fda2-8ba7-4d96-9e63-856769174042"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/0837d734-4538-4bb8-9d44-32367e533f7e"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/1402db7b-2550-4c58-a9e0-1833deecafb9"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/f2bf17ad-6919-445d-b64c-d44ea382da00"
                        }
                    ],
                    "retailer_id": "urn:authenticateit:participant:111111111111133"
                }
            ],
            "price_discount_percentage": 0,
            "age_from": 18,
            "attributes": [],
            "highlited": true
        },
        {
            "product_id": "00889698134606",
            "product_name": "Despicable Me 3 I Heart Gru Mel US Exclusive Pop!", 
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 33.95,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/61cd97bf-c053-46c4-a733-9df3256d8a1c"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/c587653d-be44-41e3-9bae-2ef3e3dce1da"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/f9035e94-a3a0-4117-bbf4-5b1b6d936647"
                        }
                    ],
                    "retailer_id": "urn:authenticateit:participant:111111111111133"
                }
            ],
            "attributes": [],
            "highlited": true
        },
        {
            "product_id": "04060507267982",
            "product_name": "Adidas Heather Colour Block Polo - Navy Mel./White",  
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 69.99,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/26a4b059-b8b2-42d0-9927-e085de29f9e0"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/59acf1b2-e3b7-4e79-86ad-ddad3e010d15"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/dc4b7cb2-a82a-4deb-8252-71acbb6692ab"
                        }
                    ],
                    "discount_value": 39.99,
                    "retailer_id": "urn:authenticateit:participant:111111111111133"
                }
            ],
            "attributes": [],
            "highlited": true
        },
        {
            "product_id": "09780062560995",
            "product_name": "Funny Man : Mel Brooks", 
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 69.99,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/94ee0cbd-0e10-491a-86bc-484f83ecb200"
                        }
                    ],
                    "discount_value": 51.95,
                    "retailer_id": "urn:authenticateit:participant:111111111111133"
                }
            ],
            "price_discount_percentage": 25.77,
            "attributes": []
        },
        {
            "product_id": "09312628040100",
            "product_name": "Mel Nat Almond Spread",
            "price_per_unit": {
                "price": 3.58,
                "quantity": 100,
                "unit": "g"
            }, 
             "units": [
                {
                    "value": "mg"

                },
                {
                    "value": "g",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 8.95,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/5/15/87a6cdee-54e0-48fd-a804-7ef3d7555c89"
                        }
                    ],
                    "price_per_unit": {
                        "price": 3.58,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111115"
                }
            ],
            "price_discount_percentage": 0,
            "attributes": []
        },
        {
            "product_id": "09312628040117",
            "product_name": "Mel Nat Cashew Spread", 
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 8.95,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/5/15/4b6e925d-9626-4a55-855b-64c934aada0a"
                        }
                    ],
                    "retailer_id": "urn:authenticateit:participant:111111111111115"
                }
            ],
            "price_discount_percentage": 0,
            "attributes": []
        },
        {
            "product_id": "09312628260867",
            "product_name": "Mel Unrefined Coconut Oil", 
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "SGD",
                    "currency_label": "$",
                    "value": 17.6,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/10/24/834b65f7-1cfc-486f-8256-c8acc8ecc9ed"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/10/24/a1cf590f-458c-40dd-b34c-7998d178773c"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/10/24/30026738-f051-4492-805f-a147bf228bfc"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/10/24/a7da7161-59f6-47b1-8a7f-06f1f0764dd0"
                        }
                    ],
                    "retailer_id": "urn:authenticateit:participant:111111111111132"
                },
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 7.95,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/8/22/901f3034-c69e-4bb2-9954-95312ce214e3"
                        }
                    ],
                    "discount_value": 6.99,
                    "retailer_id": "urn:authenticateit:participant:111111111111131"
                }
            ],
            "price_discount_percentage": 12.07
        }
    ], 
    "categories": [
        "3f27f971-016c-4a43-a2c3-5fe612db50e1",
        "e49c4ebe-0ea6-43f0-be50-fcd8f32be691",
        "7e273540-7763-43f2-95b0-22ed1afc01b3",
        "3fa37915-6fa9-49b7-aae0-e6c21288884f",
        "ad7393da-e49e-4a25-8465-d8cf7c0eff1e"
    ],
    "products_count": 96,
    "pages_count": 2
}

Get filter summary

counts size of products from search with implemented filters

POST /shoppinglists-service/user/shoppinglist/search/summary
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
search_string string Optional: string for matching product names
categories array Optional: filtration by array of category id
attributes array Optional: filtration by array of attribute ids
filter array Optional: filtration by types of filters
discount_value object Optional: filtration by size of discount (from, to)
retailers array Optional: filtration by array of retailers

available filters:

  • specials - used to show only discount products

discount_value structure:

"discount_value": {
  "from": int,
  "to": int
}

if we want to set discount from 50% to 100% we should set from=50, to=100

Example body
{
  "search_string": "Nature's Gift Meal Time Loaf",
  "filter": ["specials"]
}
Example Response
{
    "result": {
        "count": 21114
    }
}

Change units type

Сhanges the product measurement units.

PUT /shoppinglists-service/user/shoppinglist/product/unit
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string Required: shoppinglist id (uuid)
product_id string Required: product id
unit string Required: type of unit of product
Example body
{
    "list_id": "168659c6-a110-4b73-bfc5-209619b7dd78",
    "product_id": "09329982016849",
    "unit": "l"
}
Example Response
{
    "result": "Product unit has been changed"
}

If there are no product_id in shoppinglist with list_id it returns error.

{
    "error": "There are no this product in this shoppinglist",
    "error_data": null,
    "error_id": "shoppinglists-ChangeProductAmount",
    "error_object": null
}

Set products measure

Сhanges the product measurement units.

PUT /shoppinglists-service/user/shoppinglist/product/measure
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string Required: shoppinglist id (uuid)
product_id string Required: product id
unit string Optional: type of unit of product
amount string Optional: amount of products
Example body
{
    "list_id": "168659c6-a110-4b73-bfc5-209619b7dd78",
    "product_id": "09329982016849",
    "unit": "l",
    "amount": 5
}
Example Response
{
  "result": "Product measure has been changed"
}

If there are no product_id in shoppinglist with list_id it returns error.

{
    "error": "There are no this product in this shoppinglist",
    "error_data": null,
    "error_id": "shoppinglists-ChangeProductAmount",
    "error_object": null
}

Adjust number of units of product

Adjust number of units of product in shoppinglist.

PUT /shoppinglists-service/user/shoppinglist/product/amount
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string Required: shoppinglist id (uuid)
product_id string Required: product id
amount string Required: number of units of product
Example body
{
    "product_id": "00817579012811",
    "list_id": "e2af5961-e74d-41ca-a998-a782a7a90807",
    "amount": "5"
}
Example Response
{
    "result": "Product amount has been changed"
}

If there are no product_id in shoppinglist with list_id it returns error.

{
    "error": "There are no this product in this shoppinglist",
    "error_data": null,
    "error_id": "shoppinglists-ChangeProductAmount",
    "error_object": null
}

Change product bought in

Allows to specify where the product was purchased

POST /shoppinglists-service/user/shoppinglist/product/bought-in
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string Required: shoppinglist id (uuid)
product_id string Required: product id
retailer_id string Optional: retailer id
is_bought boolean Required: is_bought
Example body
{
    "list_id": "168659c6-a110-4b73-bfc5-209619b7dd78",
    "retailer_id": "urn:authenticateit:participant:735879621218609",
    "product_id": "09329982016849",
    "is_bought": true
}
Example Response

If 'is_bought' property is true, 'bought_in' property will be created or changed. If 'is_bought' property is true, 'bought_in' property required

{
    "result": "'Bought in' property changed to urn:authenticateit:participant:735879621218609"
}

If 'is_bought' property is false, 'bought_in' property will be deleted.

{
    "result": "'Bought in' property deleted"
}

Reset products bought in

Allows you to reset bought_in property of each product in the shopping list

PUT /shoppinglists-service/user/shoppinglist/reset
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string(param) Required: shoppinglist id (uuid)
Example Response
{
    "result": "shopping list reseted"
}

If list_id parameter missed it returns error.

{
    "error": "Missed required param 'list_id'",
    "error_data": null,
    "error_id": "shoppinglists-missed params",
    "error_object": null
}

Change purchase frequency of product

A user can change purchase frequency from default (for this task Weekly is default value)

PUT /shoppinglists-service/user/shoppinglist/product/purchase-frequency
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string Required: shoppinglist id (uuid)
product_id string Required: product id
purchase_frequency string Required: purchase frequency of product (one of: "weekly", "occasional_buys", "scheduled")
dates array of strings Optional: dates
Example body
{
    "user_id": "email@gmail.com",
    "list_id": "e2af5961-e74d-41ca-a998-a782a7a90807",
    "purchase_frequency": "weekly",
    "dates": [
        {
            "year": "2020",
            "month": "10",
            "week": "4"
        }
    ]
}
Example Response
{
    "result": "Purchase frequency has been changed"
}

if the frequency of purchases is scheduled, but the dates parameter is missing it returns error.

{
    "error": "Param 'dates' required for 'scheduled purchase frequency'",
    "error_data": null,
    "error_id": "shoppinglists-missed params",
    "error_object": null
}

If there are no product_id in shoppinglist with list_id it returns error.

{
    "error": "There are no this product in this shopping list",
    "error_data": null,
    "error_id": "shoppinglists-changePurchaseFrequency",
    "error_object": null
}

Get product's scheduled dates

A user can get product's scheduled dates

GET /shoppinglists-service/user/shoppinglist/product/dates
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string (get param) Required: shoppinglist id (uuid)
product_id string (get param) Required: product id
Example body
{
    "product_id": "09310885115708",
    "list_id": "168659c6-a110-4b73-bfc5-209619b7dd78"
}
Example Response
{
    "result": [
        {
            "year": "2022",
            "month": "3",
            "week": "2"
        }
    ]
}

If there are no product_id or list_id in request it returns error.

{
    "error": "Missed required param 'product_id' or 'list_id",
    "error_data": null,
    "error_id": "shoppinglists-missed params",
    "error_object": null
}

Get attributes

Get list of attributes of products.

GET /shoppinglists-service/attributes
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
Example Response
{
    "result": [
        {
            "name": "Organic",
            "id": "aac11b66-807c-49e7-a27e-939969855751"
        },
        {
            "name": "Low Fat",
            "id": "44781039-af2d-4986-be2d-afac2c363bf3"
        },
        {
            "name": "Lactose free",
            "id": "be7194dc-06e3-4bd1-91db-5eb04be9a8b5"
        },
        {
            "name": "Australian made",
            "id": "86e9e12f-aed1-476c-a62e-2fd19bbce713"
        },
        {
            "name": "Free range",
            "id": "8f42ece8-8853-4052-a85b-92df163c7004"
        },
        {
            "name": "Halal",
            "id": "f15fc677-faa9-41d6-85b9-0a7d8d133dfb"
        }
    ]
}

Get categories

Get list of categories of products.

GET /shoppinglists-service/categories
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
category_id string(get param) Optional: category id
Example body
{
    "category_id": "80584457-5e7e-4021-adfa-9f7ef071d373"
}

If "category_id" field was not passed to the request, a list of first level categories is returned

Example Response
{
    "result": [
        {
            "name": "Bread & Bakery",
            "id": "80584457-5e7e-4021-adfa-9f7ef071d373"
        },
        {
            "name": "Meat, Seafood & Deli",
            "id": "e3058cbb-ec46-4dea-acef-4dc658576947"
        },
        {
            "name": "Fruit & Veg",
            "id": "9c6358b1-5719-487a-88bc-b823b36b02fa"
        },
        {
            "name": "Dairy & Eggs",
            "id": "d50dc365-b34c-4d8d-a38a-483551f0054c"
        },
        {
            "name": "Drinks",
            "id": "21d94b4f-d76e-46a2-befd-503e6b08ab39"
        }
    ]
}

If "category_id" field was passed to the request, an object of category with list of it's sub categories is returned

Example Response
{
    "result": [
        {
            "id": "dafb471a-9793-4c9b-9fc7-adbc31791213",
            "name": "Instore bakery"
        },
        {
            "id": "46eb270e-5107-4564-bca1-7d080303a71f",
            "name": "Packaged"
        }
    ]
}

Get all categories

Get all existing categories.

GET /shoppinglists-service/allcategories
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
Example Response
{
  "categories": [
    {
      "id": "9843075d-3a9c-4852-bad4-a85200f59f30",
      "name": "Tea & Coffee",
      "level": 1
    },
    {
      "id": "28f16e02-af8c-4e5d-9d6c-5d1e955e54dd",
      "name": "Tea",
      "level": 1
    },
    {
      "id": "ffef5e0f-0faa-425a-b67a-18c0fb7e86b0",
      "name": "green-tea",
      "level": 1
    },
    {
      "id": "a7a88572-899e-4260-9d5a-ee44a191ed47",
      "name": "Black Tea",
      "level": 1
    },
    {
      "id": "1e63f8cb-7392-40d4-a2d8-d277c62dc950",
      "name": "grey-tea",
      "level": 1
    },
    {
      "id": "1e13c620-8c0d-4747-a287-a7112c5746ea",
      "name": "Red tea",
      "level": 1
    },
    {
      "id": "c6d1d084-ee36-4678-b244-e098af7c6710",
      "name": "Meat",
      "level": 1
    },
    {
      "id": "73eac49f-c9fd-4334-865d-fed19265011c",
      "name": "Convenience Meals",
      "level": 2
    },
    {
      "id": "56ea6764-7ca0-4e82-86e4-e53adf879a44",
      "name": "Turkey",
      "level": 2
    },
    {
      "id": "512bdedd-883e-484a-9ccc-4d60d2155ae2",
      "name": "Birds",
      "level": 2
    },
    {
      "id": "48184c2a-600b-4d74-bf8d-d80baec5e72b",
      "name": "Health Foods",
      "level": 2
    },
    {
      "id": "f5df1e18-4d81-47b1-8b16-3087052eae3a",
      "name": "Nappies & Wipes",
      "level": 2
    },
    {
      "id": "8897d5f9-4ef1-4c12-813c-e66c6d9ed7e2",
      "name": "Fruit",
      "level": 2
    },
    {
      "id": "a686c1ab-1f45-4c68-9070-7ff49f156d48",
      "name": "Health Foods",
      "level": 2
    },
    {
      "id": "8bb52cb0-d559-4e39-b324-1d1375568cb5",
      "name": "Party Food",
      "level": 2
    },
    {
      "id": "891c7097-24d0-47bf-ad84-6a4e25294b64",
      "name": "Desserts",
      "level": 2
    },
    {
      "id": "f1b296ef-ffb5-4f19-bd9d-d30451c18f46",
      "name": "Deserts",
      "level": 2
    },
    {
      "id": "d95f530c-9df4-4df1-a6d5-d5a36314eb79",
      "name": "Mince",
      "level": 2
    },
    {
      "id": "01043d64-e415-4938-a763-e26f1df90e8a",
      "name": "Fish & Seafod",
      "level": 2
    },
    {
      "id": "1c3a478c-d772-48a8-8bac-6a74f62c781c",
      "name": "Chips & Wedges",
      "level": 2
    },
    {
      "id": "d617c48d-e2db-44c0-95fc-66c99d20b77b",
      "name": "Baby Food",
      "level": 2
    },
    {
      "id": "4314e065-7130-44cc-b80e-788d0b186080",
      "name": "Iced Tea",
      "level": 2
    },
    {
      "id": "3be463c3-91cf-4107-b649-4b8983909b87",
      "name": "Cleaning",
      "level": 2
    },
    {
      "id": "e3528c37-8e97-44d5-a776-89bb6b4330e9",
      "name": "Cheeses",
      "level": 2
    },
    {
      "id": "ad0c0df9-b420-4dc5-aeca-a5fffcc94022",
      "name": "Pork",
      "level": 2
    },
    {
      "id": "18785599-981f-4c48-8df6-2226122bcf14",
      "name": "Formula",
      "level": 2
    },
    {
      "id": "6e233c8e-2fc6-49aa-99d5-75e95b3fd0ee",
      "name": "Non Alcoholic",
      "level": 2
    },
    {
      "id": "d041b7c5-8e6e-49f5-a078-7dc2d100df2b",
      "name": "Baking",
      "level": 2
    },
    {
      "id": "e01b8d4c-d185-42e4-bd89-5ebeffcbeb18",
      "name": "Icecream",
      "level": 2
    },
    {
      "id": "4ba8bfc9-2d70-46be-a265-48888c7d6ec7",
      "name": "Tea",
      "level": 2
    },
    {
      "id": "97bfb6ac-5a05-4763-9f99-1ce21ba7e2a7",
      "name": "Deli Meat",
      "level": 2
    },
    {
      "id": "7943480e-2a21-4ac5-8eb6-d28d125ec927",
      "name": "Deserts",
      "level": 2
    },
    {
      "id": "a03ad295-4765-4644-b63f-ed4e642c90a2",
      "name": "Pizza",
      "level": 2
    },
    {
      "id": "3a85a863-7bc1-4680-b321-e6d8754b7cb6",
      "name": "Lamb",
      "level": 2
    },
    {
      "id": "e896cfef-bac6-409f-adf5-3ba359eae7a7",
      "name": "Chips & Wedges",
      "level": 2
    },
    {
      "id": "cb0df8d0-e4df-4a89-aca9-42d3e59c21f7",
      "name": "Formula",
      "level": 2
    },
    {
      "id": "97cc471e-f89e-405f-9701-8d2211d59918",
      "name": "wings & Nuggets",
      "level": 2
    },
    {
      "id": "3ff6e7a6-cf33-465d-8a58-af695c3742e6",
      "name": "Chicken Pieces",
      "level": 2
    },
    {
      "id": "ba17252c-6bfd-41c6-8ac2-d80afe2eeb23",
      "name": "Quinoa",
      "level": 3
    },
    {
      "id": "aece9f34-ef3a-46d3-9334-c480296ed5e6",
      "name": "Cookies & Biscuits",
      "level": 3
    },
    {
      "id": "959ebf88-4745-4204-9e94-ba9bc53e2c93",
      "name": "Polenta & Other Grains",
      "level": 3
    },
    {
      "id": "84bafa3b-ef78-4391-8c23-fa772642f67b",
      "name": "Lactose free Milk",
      "level": 3
    },
    {
      "id": "810ff367-a17b-4dca-8e07-e4203db012f9",
      "name": "Juices",
      "level": 3
    },
    {
      "id": "3c1df387-527b-4754-9685-2135372b05cd",
      "name": "Crackers",
      "level": 3
    },
    {
      "id": "d4aace2b-b192-4105-9902-c5e3b902b8f2",
      "name": "Tomato & BBQ Sauce",
      "level": 3
    },
    {
      "id": "c80d0515-49d7-47f5-849f-5f5162625e61",
      "name": "Frozen Yoghurt",
      "level": 3
    }
  ]
}

Add categories

Assign categories to product.

POST /shoppinglists-service/categories/product

Category can be assigned by id or by name.

Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
gtin string Required: gtin
category_id string Optional: category id
category_name string Optional: category name
trust string Optional: return doc instead of current participant

Required either category_id or category_name

Example body
{
    "gtin": "06713910111127",
    "category_name": "Free range"
}

One of "category_id" or "category_name" fields has to be passed to the request.

Example Response
{
    "result": "Category has been added"
}

Delete categories

Delete categories from product.

DELETE /shoppinglists-service/categories/product

Category can be deleted by id or by name.

Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
gtin string Required: gtin
category_id string Optional: category id
category_name string Optional: category name
trust string Optional: return doc instead of current participant

Required either category_id or category_name

Example body
{
    "gtin": "06713910111127",
    "category_name": "Free range"
}

One of "category_id" or "category_name" fields has to be passed to the request.

Example Response
{
    "result": "Category has been deleted"
}

Get products by category

Get list of products by category

GET /shoppinglists-service/categories/product
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
category_id string (get param) Required: category id
Example Response
{
    "retailers": [
        {
            "id": "urn:authenticateit:participant:111111111111111",
            "name": "Import participant Woolworts",
            "logo": "https://dev-cdn.shping.com/2020/9/18/8479df1a-b943-4045-883f-c63ef4432979.jpg"
        },
        {
            "id": "urn:authenticateit:participant:111111111111115",
            "name": "Import participant Coles",
            "logo": "https://dev-cdn.shping.com/2020/9/18/bb4f9033-ca16-4c95-a820-276373660680.png"
        }
    ],
    "products": [
        {
            "product_id": "09340078000009",
            "product_name": "Sonoma Country White Sourdough",
            "price_per_unit": {
                "price": 1.17,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 7.5,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/921a4fa1-40c1-4b2d-83cb-5d248a3d2d79"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/dfb6d7ac-3ccb-4891-a727-6885bf2dd65c"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/c1db7712-5423-4dde-98e7-02adbf7d3488"
                        }
                    ],
                    "price_per_unit": {
                        "price": 1.17,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": 640,
            "serving_size": 128,
            "package_unit": "g",
            "attributes": [],
            "category": {
                "id": "6518f435-5fff-45b0-94f2-4c2b2f8d1fab",
                "name": "Bread"
            }
        },
        {
            "product_id": "09310023144676",
            "product_name": "Sourdough Bread",
            "price_per_unit": {
                "price": 0.6,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 3.9,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/24acd66b-83db-4ec6-9230-d3141c8af09b"
                        }
                    ],
                    "price_per_unit": {
                        "price": 0.6,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                },
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 3.9,
                    "image": [],
                    "price_per_unit": {
                        "price": 0.6,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111115"
                }
            ],
            "package_size": 650,
            "serving_size": 72,
            "package_unit": "g",
            "attributes": []
        },
        {
            "product_id": "09316595683728",
            "product_name": "The Famous Homemade Almond Biscotti",
            "price_per_unit": {
                "price": 4.67,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "g",
                    "selected": true
                },
                {
                    "value": "kg"
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 7,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2020/7/23/750f20c5-f0b0-42ec-b359-73a09f901332"
                        }
                    ],
                    "price_per_unit": {
                        "price": 4.67,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": []
        },
        {
            "product_id": "09324499000114",
            "product_name": "WW ISB White Mud Cake",
            "price_per_unit": {
                "price": 0.8,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 4.8,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/5/25/1b73768b-5b9f-40c2-9ce1-858540e457a7"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/11ddfefc-0d7c-4f77-821c-78aee655d3c5"
                        }
                    ],
                    "price_per_unit": {
                        "price": 0.8,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": 600,
            "serving_size": 100,
            "package_unit": "g",
            "attributes": []
        },
        {
            "product_id": "00283273000001",
            "product_name": "Woolworths Bread White Extra Soft Loaf",
            "price_per_unit": {
                "price": 0.29,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "g",
                    "selected": true
                },
                {
                    "value": "kg"
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 2,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/83d82c95-2e62-465b-887a-721e4872c7d9"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/68eef776-21b1-4bf5-90b8-24e9a5bccd10"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/af1aac53-a557-401a-864b-aabbc4c5d0be"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/35f5e2a3-15a2-4c1c-8f40-15cd4ef52464"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/bdf4434e-88ad-4c76-ba8d-4651a84ae856"
                        }
                    ],
                    "price_per_unit": {
                        "price": 0.29,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": [],
            "category": {
                "id": "fdb66a4a-19a9-4ad6-a767-f7e487afd18a",
                "name": "Bread & Bakery"
            }
        },
        {
            "product_id": "09340078000009",
            "product_name": "Sonoma Country White Sourdough",
            "price_per_unit": {
                "price": 1.17,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 7.5,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/921a4fa1-40c1-4b2d-83cb-5d248a3d2d79"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/dfb6d7ac-3ccb-4891-a727-6885bf2dd65c"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/c1db7712-5423-4dde-98e7-02adbf7d3488"
                        }
                    ],
                    "price_per_unit": {
                        "price": 1.17,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": 640,
            "serving_size": 128,
            "package_unit": "g",
            "attributes": [],
            "category": {
                "id": "6518f435-5fff-45b0-94f2-4c2b2f8d1fab",
                "name": "Bread"
            }
        },
        {
            "product_id": "09316595683728",
            "product_name": "The Famous Homemade Almond Biscotti",
            "price_per_unit": {
                "price": 4.67,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "g",
                    "selected": true
                },
                {
                    "value": "kg"
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 7,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2020/7/23/750f20c5-f0b0-42ec-b359-73a09f901332"
                        }
                    ],
                    "price_per_unit": {
                        "price": 4.67,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": []
        },
        {
            "product_id": "00289239000009",
            "product_name": "Woolworths Mini Donut Chocolate Hazelnut",
            "price_per_unit": {
                "price": 0.67,
                "quantity": 1,
                "unit": "each"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 2,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/5/25/2332d2af-a81c-45e7-ae20-9677ded20aaa"
                        }
                    ],
                    "price_per_unit": {
                        "price": 0.67,
                        "quantity": 1,
                        "unit": "each"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": []
        },
        {
            "product_id": "09310023144676",
            "product_name": "Sourdough Bread",
            "price_per_unit": {
                "price": 0.6,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 3.9,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/24acd66b-83db-4ec6-9230-d3141c8af09b"
                        }
                    ],
                    "price_per_unit": {
                        "price": 0.6,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                },
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 3.9,
                    "image": [],
                    "price_per_unit": {
                        "price": 0.6,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111115"
                }
            ],
            "package_size": 650,
            "serving_size": 72,
            "package_unit": "g",
            "attributes": []
        },
        {
            "product_id": "09324499000114",
            "product_name": "WW ISB White Mud Cake",
            "price_per_unit": {
                "price": 0.8,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 4.8,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/5/25/1b73768b-5b9f-40c2-9ce1-858540e457a7"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/11ddfefc-0d7c-4f77-821c-78aee655d3c5"
                        }
                    ],
                    "price_per_unit": {
                        "price": 0.8,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": 600,
            "serving_size": 100,
            "package_unit": "g",
            "attributes": []
        },
        {
            "product_id": "00283273000001",
            "product_name": "Woolworths Bread White Extra Soft Loaf",
            "price_per_unit": {
                "price": 0.29,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "g",
                    "selected": true
                },
                {
                    "value": "kg"
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 2,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/83d82c95-2e62-465b-887a-721e4872c7d9"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/68eef776-21b1-4bf5-90b8-24e9a5bccd10"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/af1aac53-a557-401a-864b-aabbc4c5d0be"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/35f5e2a3-15a2-4c1c-8f40-15cd4ef52464"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/bdf4434e-88ad-4c76-ba8d-4651a84ae856"
                        }
                    ],
                    "price_per_unit": {
                        "price": 0.29,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": [],
            "category": {
                "id": "fdb66a4a-19a9-4ad6-a767-f7e487afd18a",
                "name": "Bread & Bakery"
            }
        },
        {
            "product_id": "00289239000009",
            "product_name": "Woolworths Mini Donut Chocolate Hazelnut",
            "price_per_unit": {
                "price": 0.67,
                "quantity": 1,
                "unit": "each"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 2,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/5/25/2332d2af-a81c-45e7-ae20-9677ded20aaa"
                        }
                    ],
                    "price_per_unit": {
                        "price": 0.67,
                        "quantity": 1,
                        "unit": "each"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": []
        },
        {
            "product_id": "09300633065577",
            "product_name": "Woolworths Butter Cake",
            "price_per_unit": {
                "price": 1,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 4.5,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/f3bbb9cc-f9e4-485b-98ae-1f1e3db9788b"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/6fc44a92-3990-4e2f-8d6b-18c3d56b8316"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/a5d06c49-a7d9-4990-ba96-1e1cbbee96df"
                        }
                    ],
                    "price_per_unit": {
                        "price": 1,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": 450,
            "serving_size": 56,
            "package_unit": "g",
            "attributes": [],
            "category": {
                "id": "ef6d9651-ff89-44e0-8430-f9d2d2b6e8c1",
                "name": "Bakery Cakes"
            }
        },
        {
            "product_id": "09340078000009",
            "product_name": "Sonoma Country White Sourdough",
            "price_per_unit": {
                "price": 1.17,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 7.5,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/921a4fa1-40c1-4b2d-83cb-5d248a3d2d79"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/dfb6d7ac-3ccb-4891-a727-6885bf2dd65c"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/c1db7712-5423-4dde-98e7-02adbf7d3488"
                        }
                    ],
                    "price_per_unit": {
                        "price": 1.17,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": 640,
            "serving_size": 128,
            "package_unit": "g",
            "attributes": [],
            "category": {
                "id": "6518f435-5fff-45b0-94f2-4c2b2f8d1fab",
                "name": "Bread"
            }
        },
        {
            "product_id": "09300633065577",
            "product_name": "Woolworths Butter Cake",
            "price_per_unit": {
                "price": 1,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 4.5,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/f3bbb9cc-f9e4-485b-98ae-1f1e3db9788b"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/6fc44a92-3990-4e2f-8d6b-18c3d56b8316"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/a5d06c49-a7d9-4990-ba96-1e1cbbee96df"
                        }
                    ],
                    "price_per_unit": {
                        "price": 1,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": 450,
            "serving_size": 56,
            "package_unit": "g",
            "attributes": [],
            "category": {
                "id": "ef6d9651-ff89-44e0-8430-f9d2d2b6e8c1",
                "name": "Bakery Cakes"
            }
        },
        {
            "product_id": "00283273000001",
            "product_name": "Woolworths Bread White Extra Soft Loaf",
            "price_per_unit": {
                "price": 0.29,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "g",
                    "selected": true
                },
                {
                    "value": "kg"
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 2,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/83d82c95-2e62-465b-887a-721e4872c7d9"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/68eef776-21b1-4bf5-90b8-24e9a5bccd10"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/af1aac53-a557-401a-864b-aabbc4c5d0be"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/35f5e2a3-15a2-4c1c-8f40-15cd4ef52464"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/bdf4434e-88ad-4c76-ba8d-4651a84ae856"
                        }
                    ],
                    "price_per_unit": {
                        "price": 0.29,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": [],
            "category": {
                "id": "fdb66a4a-19a9-4ad6-a767-f7e487afd18a",
                "name": "Bread & Bakery"
            }
        },
        {
            "product_id": "00289239000009",
            "product_name": "Woolworths Mini Donut Chocolate Hazelnut",
            "price_per_unit": {
                "price": 0.67,
                "quantity": 1,
                "unit": "each"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 2,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/5/25/2332d2af-a81c-45e7-ae20-9677ded20aaa"
                        }
                    ],
                    "price_per_unit": {
                        "price": 0.67,
                        "quantity": 1,
                        "unit": "each"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": []
        },
        {
            "product_id": "09300633065577",
            "product_name": "Woolworths Butter Cake",
            "price_per_unit": {
                "price": 1,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 4.5,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/f3bbb9cc-f9e4-485b-98ae-1f1e3db9788b"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/6fc44a92-3990-4e2f-8d6b-18c3d56b8316"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/a5d06c49-a7d9-4990-ba96-1e1cbbee96df"
                        }
                    ],
                    "price_per_unit": {
                        "price": 1,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": 450,
            "serving_size": 56,
            "package_unit": "g",
            "attributes": [],
            "category": {
                "id": "ef6d9651-ff89-44e0-8430-f9d2d2b6e8c1",
                "name": "Bakery Cakes"
            }
        },
        {
            "product_id": "09310023144676",
            "product_name": "Sourdough Bread",
            "price_per_unit": {
                "price": 0.6,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 3.9,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/24acd66b-83db-4ec6-9230-d3141c8af09b"
                        }
                    ],
                    "price_per_unit": {
                        "price": 0.6,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                },
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 3.9,
                    "image": [],
                    "price_per_unit": {
                        "price": 0.6,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111115"
                }
            ],
            "package_size": 650,
            "serving_size": 72,
            "package_unit": "g",
            "attributes": []
        },
        {
            "product_id": "09316595683728",
            "product_name": "The Famous Homemade Almond Biscotti",
            "price_per_unit": {
                "price": 4.67,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "g",
                    "selected": true
                },
                {
                    "value": "kg"
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 7,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2020/7/23/750f20c5-f0b0-42ec-b359-73a09f901332"
                        }
                    ],
                    "price_per_unit": {
                        "price": 4.67,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": []
        },
        {
            "product_id": "09324499000114",
            "product_name": "WW ISB White Mud Cake",
            "price_per_unit": {
                "price": 0.8,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 4.8,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/5/25/1b73768b-5b9f-40c2-9ce1-858540e457a7"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/11ddfefc-0d7c-4f77-821c-78aee655d3c5"
                        }
                    ],
                    "price_per_unit": {
                        "price": 0.8,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": 600,
            "serving_size": 100,
            "package_unit": "g",
            "attributes": []
        },
        {
            "product_id": "09340078000009",
            "product_name": "Sonoma Country White Sourdough",
            "price_per_unit": {
                "price": 1.17,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 7.5,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/921a4fa1-40c1-4b2d-83cb-5d248a3d2d79"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/dfb6d7ac-3ccb-4891-a727-6885bf2dd65c"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/c1db7712-5423-4dde-98e7-02adbf7d3488"
                        }
                    ],
                    "price_per_unit": {
                        "price": 1.17,
                        "quantity": 100,
                        "unit": "g"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": 640,
            "serving_size": 128,
            "package_unit": "g",
            "attributes": [],
            "category": {
                "id": "6518f435-5fff-45b0-94f2-4c2b2f8d1fab",
                "name": "Bread"
            }
        }
    ]
}

Get products by purchase frequency

Get list of products by purchase frequency

GET /shoppinglists-service/user/shoppinglist/products
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string (get param) Required: shopping list id
type string (get param) Required: purchase frequency type (scheduled or occasional_buys or recently_used)
Example Response
{
    "retailers": [
        {
            "id": "urn:authenticateit:participant:111111111111111",
            "name": "Import participant Woolworts",
            "logo": "https://dev-cdn.shping.com/2020/9/18/8479df1a-b943-4045-883f-c63ef4432979.jpg"
        },
        {
            "id": "urn:authenticateit:participant:735879621218609",
            "name": "Иван Васильев",
            "logo": "https://dev-cdn.shping.com/2019/3/28/5e1eb1a7-7d38-4d09-bace-a586cb0fc326.png"
        },
        {
            "id": "urn:authenticateit:participant:111111111111115",
            "name": "Import participant Coles",
            "logo": "https://dev-cdn.shping.com/2020/9/18/bb4f9033-ca16-4c95-a820-276373660680.png"
        },
        {
            "id": "urn:authenticateit:participant:111111111111133",
            "name": "Import participant MyDeal"
        }
    ],
    "products": [
        {
            "product_id": "12345678901011",
            "product_name": "Coockies",
            "amount": 1,
            "added_by": "urn:authenticateit:user:email:system@authenticateit.com",
            "units": [
                {
                    "value": "each"
                },
                {
                    "value": "g",
                    "selected": true
                },
                {
                    "value": "kg"
                },
                {
                    "value": "ml"
                },
                {
                    "value": "l"
                }
            ],
            "is_custom": true
        },
        {
            "product_id": "09319900011001",
            "product_name": "Fresh Carrots",
            "price_per_unit": {
                "price": 2,
                "quantity": 1,
                "unit": "kg"
            },
            "units": [
                {
                    "value": "g",
                    "selected": true
                },
                {
                    "value": "kg"
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 2,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/a0ed564d-2810-4bf9-93d8-e55f6b02ed3a"
                        }
                    ],
                    "price_per_unit": {
                        "price": 2,
                        "quantity": 1,
                        "unit": "kg"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": [],
            "category": {
                "id": "68020d0f-8ed2-46ed-987f-e78a84e9d95b",
                "name": "Veg"
            },
            "position": 11
        },
        {
            "product_id": "09329982016849",
            "product_name": "Somersby Apple Cider Premium European Cider 4.5% 6 X 330ml",
            "price_per_unit": {
                "price": 1.01,
                "quantity": 100,
                "unit": "ml"
            },
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 21.5,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/5/25/f5c806af-502c-468b-bd4f-bbf2369d9478"
                        }
                    ],
                    "discount_value": 16,
                    "retailer_id": "urn:authenticateit:participant:735879621218609"
                },
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 20,
                    "image": [],
                    "price_per_unit": {
                        "price": 1.01,
                        "quantity": 100,
                        "unit": "ml"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111115"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": [],
            "position": 12
        },
        {
            "product_id": "00000772091930",
            "product_name": "Melissa & Doug - Itsy-Bitsy Spider Soft Activity Book",
            "units": [
                {
                    "value": "each",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 29.95,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/556a37ba-c368-4b60-9659-c02397344c6a"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/875921ee-c27a-4ecf-b240-cd5fb481165d"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/52d202b7-b912-481c-a5ee-f44dceaa422f"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/f64fa995-65ee-4a6d-b830-d472d824b06f"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/78a5de3f-d35f-443a-bc20-e671800f95ea"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/11/27/4d3d3912-c0fc-41a9-a087-22dfb498afb4"
                        }
                    ],
                    "discount_value": 24.95,
                    "retailer_id": "urn:authenticateit:participant:111111111111133"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": [],
            "position": 13
        },
        {
            "product_id": "99876543210987654321",
            "product_name": "Something tasty",
            "amount": 1,
            "added_by": "urn:authenticateit:user:email:system@authenticateit.com",
            "units": [
                {
                    "value": "each"
                },
                {
                    "value": "g"
                },
                {
                    "value": "kg"
                },
                {
                    "value": "ml"
                },
                {
                    "value": "l",
                    "selected": true
                }
            ],
            "is_custom": true
        },
        {
            "product_id": "093299820168495533",
            "product_name": "newwwwwwwwww",
            "amount": 2, 
            "position": 13,
            "added_by": "urn:authenticateit:user:email:system@authenticateit.com",
            "units": [
                {
                    "value": "each"
                },
                {
                    "value": "g"
                },
                {
                    "value": "kg"
                },
                {
                    "value": "ml",
                    "selected": true
                },
                {
                    "value": "l"
                }
            ],
            "is_custom": true
        },
        {
            "product_id": "0932998201684955",
            "product_name": "4444",
            "amount": 2, 
            "position": 13,
            "added_by": "urn:authenticateit:user:email:system@authenticateit.com",
            "units": [
                {
                    "value": "each"
                },
                {
                    "value": "g"
                },
                {
                    "value": "kg"
                },
                {
                    "value": "ml",
                    "selected": true
                },
                {
                    "value": "l"
                }
            ],
            "is_custom": true
        }
    ],
    "attributes": [
        {
            "name": "Organic",
            "id": "aac11b66-807c-49e7-a27e-939969855751"
        },
        {
            "name": "Low Fat",
            "id": "44781039-af2d-4986-be2d-afac2c363bf3"
        },
        {
            "name": "Lactose free",
            "id": "be7194dc-06e3-4bd1-91db-5eb04be9a8b5"
        },
        {
            "name": "Australian made",
            "id": "86e9e12f-aed1-476c-a62e-2fd19bbce713"
        },
        {
            "name": "Free range",
            "id": "8f42ece8-8853-4052-a85b-92df163c7004"
        },
        {
            "name": "Halal",
            "id": "f15fc677-faa9-41d6-85b9-0a7d8d133dfb"
        }
    ]
}

Get all products

Get list of all user's shopping lists products, retailers, categories, attributes. Returns only top categories

GET /shoppinglists-service/user/allproducts
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
Example Response
{
  "retailers": [
    {
      "id": "urn:authenticateit:participant:111111111111111",
      "name": "Coles",
      "logo": "https://dev-cdn.shping.com/2020/9/18/8479df1a-b943-4045-883f-c63ef4432979.jpg"
    }
  ],
  "products": [
    {
      "product_id": "ff91166d-9fb2-468c-8c8e-d1d78f24c743",
      "product_name": "twsttt",
      "amount": 1,
      "position": null,
      "purchase_frequency": "weekly",
      "added_by": "urn:authenticateit:user:email:mail@mail.com",
      "units": [
        {
          "selected": true,
          "value": "each"
        }
      ],
      "is_custom": true
    },
    {
      "product_id": "00728795373405",
      "product_name": "Pharma Freak Test Freak-testosterone Booster",
      "price_per_unit": {
        "unit": "each",
        "quantity": 100,
        "price": 58.33
      },
      "units": [
        {
          "value": "each",
          "selected": true
        }
      ],
      "prices": [
        {
          "currency": "AUD",
          "currency_label": "$",
          "value": 70,
          "image": [
            {
              "url": "https://dev-cdn.shping.com/2019/12/30/fbe13c87-33e2-4a49-973c-4e1027a314de"
            }
          ],
          "price_per_unit": {
            "unit": "each",
            "quantity": 100,
            "price": 58.33
          },
          "is_expired": true,
          "retailer_id": "urn:authenticateit:participant:111111111111111"
        }
      ],
      "package_size": null,
      "serving_size": null,
      "package_unit": null,
      "attributes": [],
      "categories": [
        "f4de9f65-f6e0-4779-a5d3-df74c30d82c6",
        "0abaf3fe-5cbb-4cb8-83a8-20513c367c09",
        "43ddb799-3c7a-4281-8ea9-c952a4947f47"
      ],
      "amount": 5,
      "main_category": "f4de9f65-f6e0-4779-a5d3-df74c30d82c6"
    },
    {
      "product_id": "09341903000867",
      "product_name": "Stone & Wood Cloud Catcher Pale Ale Bottles",
      "units": [
        {
          "value": "each",
          "selected": true
        }
      ],
      "prices": [
        {
          "currency": "AUD",
          "currency_label": "$",
          "value": 78,
          "image": [
            {
              "url": "https://dev-cdn.shping.com/2019/7/25/cc9a94dd-a701-4fb2-ada7-a910c477a81f"
            }
          ],
          "is_expired": true,
          "retailer_id": "urn:authenticateit:participant:111111111111111"
        }
      ],
      "package_size": null,
      "serving_size": null,
      "package_unit": null,
      "attributes": [],
      "categories": [
        "b825001b-f725-4eb2-88b8-5835a5a0acce",
        "97e73158-9eab-4a31-9d46-d035ba917a23",
        "23504a1b-4f5d-46ed-88fd-c923fdc0c11e"
      ],
      "amount": 1,
      "main_category": "b825001b-f725-4eb2-88b8-5835a5a0acce"
    },
    {
      "product_id": "7c45883e-da4d-486a-a29c-709845bc09be",
      "product_name": "hi",
      "amount": 2,
      "position": 1,
      "purchase_frequency": "weekly",
      "added_by": "urn:authenticateit:user:email:mail@mail.com",
      "units": [
        {
          "selected": true,
          "value": "each"
        }
      ],
      "is_custom": true
    }
  ],
  "categories": [
    {
      "id": "ffef5e0f-0faa-425a-b67a-18c0fb7e86b0",
      "name": "green-tea",
      "level": 1
    },
    {
      "id": "cc022a4c-d680-4e5e-8943-6653cb5eda02",
      "name": "Sauce",
      "level": 1
    },
    {
      "id": "a7a88572-899e-4260-9d5a-ee44a191ed47",
      "name": "Black Tea",
      "level": 1
    },
    {
      "id": "9843075d-3a9c-4852-bad4-a85200f59f30",
      "name": "Tea & Coffee",
      "level": 1
    },
    {
      "id": "88a74479-fe1c-4e9e-b68f-a193aa17482b",
      "name": "Oils & Vinegar",
      "level": 1
    },
    {
      "id": "28f16e02-af8c-4e5d-9d6c-5d1e955e54dd",
      "name": "Tea",
      "level": 1
    },
    {
      "id": "1e63f8cb-7392-40d4-a2d8-d277c62dc950",
      "name": "grey-tea",
      "level": 1
    },
    {
      "id": "1e13c620-8c0d-4747-a287-a7112c5746ea",
      "name": "Red tea",
      "level": 1
    },
    {
      "id": "c6d1d084-ee36-4678-b244-e098af7c6710",
      "name": "Meat",
      "level": 1
    },
    {
      "id": "98229a63-e605-4b3c-ba10-e7c23c80aee0",
      "name": "Snacks & Confectionary",
      "level": 1
    },
    {
      "id": "82a9b193-8a96-40e0-b424-c2975e8fcb37",
      "name": "Shampoo & Conditioner",
      "level": 1
    },
    {
      "id": "48659bac-15dc-4ced-b4c1-5d88ab7aaf95",
      "name": "Drinks",
      "level": 1
    },
    {
      "id": "3b27cee1-16d6-4ab0-9473-687c37fe9712",
      "name": "Seafood & Deli",
      "level": 1
    },
    {
      "id": "bda5e271-3dcf-4f34-83a4-fc561542479e",
      "name": "Pet",
      "level": 1
    },
    {
      "id": "2dea9814-12f5-4943-9a1d-c3e0b3c2fab8",
      "name": "Pantry",
      "level": 1
    },
    {
      "id": "032e4e4f-ae85-470c-9bcf-75fa483fbd81",
      "name": "Dairy & Eggs",
      "level": 1
    },
    {
      "id": "a16d996a-c060-4957-9b98-26c5b1242a45",
      "name": "Milk",
      "level": 1
    },
    {
      "id": "89bda8d1-00c3-4aeb-93d5-38b11962bd5e",
      "name": "Baby",
      "level": 1
    },
    {
      "id": "cc592951-980b-4c96-8506-aac51eff83ff",
      "name": "Health & Beauty",
      "level": 1
    },
    {
      "id": "9c7e9dfd-152d-4908-a6d6-042d25030e23",
      "name": "Household",
      "level": 1
    },
    {
      "id": "268f18cb-4086-4b74-b05a-8632b4d473a9",
      "name": "Frozen",
      "level": 1
    },
    {
      "id": "cf284a35-c93e-414d-9991-3e2811b9537e",
      "name": "Fruit & Veg",
      "level": 1
    },
    {
      "id": "f338cd2d-5356-4e19-b38e-ed0ff940c47f",
      "name": "Seafood & Deli",
      "level": 1
    },
    {
      "id": "41e00ede-2ec6-4528-b972-ccd8c2293d9f",
      "name": "Bread & Bakery",
      "level": 1
    },
    {
      "id": "e1668270-082d-4928-872a-7978b5d6713c",
      "name": "Baby",
      "level": 1
    },
    {
      "id": "ccac61cd-4082-4b15-89eb-5d67eefdc5f7",
      "name": "Meat",
      "level": 1
    },
    {
      "id": "34f9d725-cb9f-46a2-9244-623c9c6f746d",
      "name": "Pantry",
      "level": 1
    },
    {
      "id": "d820d123-793d-4c9f-b4e2-034a76a12159",
      "name": "Pet",
      "level": 1
    },
    {
      "id": "d6b00f2f-28f9-4f9b-9fa9-fd32f15ab76e",
      "name": "Frozen",
      "level": 1
    },
    {
      "id": "40eb25c3-120e-475f-9678-dc25184b5668",
      "name": "Drinks",
      "level": 1
    },
    {
      "id": "4bb2b8f0-d302-4081-81fb-d3ed9fb72e7d",
      "name": "Dairy & Eggs",
      "level": 1
    },
    {
      "id": "b825001b-f725-4eb2-88b8-5835a5a0acce",
      "name": "Liquor",
      "level": 1
    },
    {
      "id": "424a2263-29a7-447f-8714-3e22b860d68f",
      "name": "Household",
      "level": 1
    },
    {
      "id": "f4de9f65-f6e0-4779-a5d3-df74c30d82c6",
      "name": "Health & Beauty",
      "level": 1
    },
    {
      "id": "adbfdf79-d3fa-4679-8816-bcfcff03da97",
      "name": "Pantry",
      "level": 1
    }
  ],
  "attributes": []
}

Get products in shopping list

Get list of products, retailers, categories, attributes in shopping list. Returns only top categories

GET /shoppinglists-service/user/shoppinglist/product-list
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
list_id string (get param) Required: shopping list id
Example Response
{
    "retailers": [
        {
            "id": "urn:authenticateit:participant:111111111111111",
            "name": "Import participant Woolworts",
            "logo": "https://dev-cdn.shping.com/2020/9/18/8479df1a-b943-4045-883f-c63ef4432979.jpg"
        },
        {
            "id": "urn:authenticateit:participant:111111111111132",
            "name": "Import participant FairPrice"
        },
        {
            "id": "urn:authenticateit:participant:111111111111115",
            "name": "Import participant Coles",
            "logo": "https://dev-cdn.shping.com/2020/9/18/bb4f9033-ca16-4c95-a820-276373660680.png"
        },
        {
            "id": "urn:authenticateit:participant:735879621218609",
            "name": "Иван Васильев",
            "logo": "https://dev-cdn.shping.com/2019/3/28/5e1eb1a7-7d38-4d09-bace-a586cb0fc326.png"
        }
    ],
    "users": [
        {
            "id": "urn:authenticateit:user:email:system@authenticateit.com",
            "name": "Женя  Козин",
            "image": "https://dev-cdn.shping.com/2019/10/18/5b6a79d1-f1bb-446e-8216-edb22726c4be"
        }
    ],
    "products": [
        {
            "product_id": "09310885115708",
            "product_name": "Mayvers Super Spread Original 280g",
            "price_per_unit": {
                "price": 1.16,
                "quantity": 100,
                "unit": "g"
            },
            "units": [
                {
                    "value": "g",
                    "selected": true
                },
                {
                    "value": "kg"
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 6.5,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/c8120e53-54f2-467a-918b-f9ff6437a158"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/cbba049b-288e-4e7e-9ee1-7855e4696184"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/c43567f1-3933-4114-a91f-d03125cff95c"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/03bae239-1f54-4985-96d5-d9b9d66e44df"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/6/19/94773a3f-7121-4a24-a97c-dfca0731f797"
                        }
                    ],
                    "discount_value": 3.25,
                    "retailer_id": "urn:authenticateit:participant:111111111111111"
                },
                {
                    "currency": "SGD",
                    "currency_label": "$",
                    "value": 10.5,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/10/24/b2867938-9a16-4cf4-b814-f37dc407b9e1"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/10/24/2eb6fc6f-0bd1-4f18-bb7f-416032d02cab"
                        },
                        {
                            "url": "https://dev-cdn.shping.com/2019/10/24/831be811-f927-4777-bbc7-417abf911f69"
                        }
                    ],
                    "discount_value": 4.5,
                    "retailer_id": "urn:authenticateit:participant:111111111111132"
                },
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 6.5,
                    "image": [],
                    "retailer_id": "urn:authenticateit:participant:111111111111115"
                }
            ], 
            "package_size": 490,
            "serving_size": 122,
            "package_unit": "g",
            "attributes": [],
            "amount": 1,
            "purchase_frequency": "scheduled",
            "added_by": "urn:authenticateit:user:email:system@authenticateit.com",
            "sheduled_dates": [
                {
                    "year": "2022",
                    "month": "10",
                    "week": "1"
                },
                {
                    "year": "2020",
                    "month": "10",
                    "week": "5"
                },
                {
                    "year": "2020",
                    "month": "11",
                    "week": "4"
                }
            ]
        },
        {
            "product_id": "09329982016849",
            "product_name": "Somersby Apple Cider Premium European Cider 4.5% 6 X 330ml",
            "price_per_unit": {
                "price": 1.01,
                "quantity": 100,
                "unit": "ml"
            },
            "units": [
                {
                    "value": "ml"
                },
                {
                    "value": "l",
                    "selected": true
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 21.5,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/5/25/f5c806af-502c-468b-bd4f-bbf2369d9478"
                        }
                    ],
                    "discount_value": 16,
                    "retailer_id": "urn:authenticateit:participant:735879621218609"
                },
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 20,
                    "image": [],
                    "price_per_unit": {
                        "price": 1.01,
                        "quantity": 100,
                        "unit": "ml"
                    },
                    "retailer_id": "urn:authenticateit:participant:111111111111115"
                }
            ], 
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": [],
            "amount": 4,
            "purchase_frequency": "weekly",
            "added_by": "urn:authenticateit:user:email:system@authenticateit.com",
            "bought_in": "urn:authenticateit:participant:111111111111115"
        },
        {
            "product_id": "09300601031184",
            "product_name": "Chicken Flavour Noodle Snacks 12 pack",
            "units": [
                {
                    "value": "each"
                }
            ],
            "prices": [
                {
                    "currency": "AUD",
                    "currency_label": "$",
                    "value": 2.85,
                    "image": [
                        {
                            "url": "https://dev-cdn.shping.com/2019/5/15/60bb6769-34b8-4d92-b3cf-cf097b2ecb65"
                        }
                    ],
                    "retailer_id": "urn:authenticateit:participant:111111111111115"
                }
            ],
            "package_size": null,
            "serving_size": null,
            "package_unit": null,
            "attributes": [],
            "amount": 4,
            "purchase_frequency": "weekly",
            "added_by": "urn:authenticateit:user:email:system@authenticateit.com",
            "bought_in": "urn:authenticateit:participant:111111111111115"
        },
        {
            "name": "Something tasty",
            "amount": 1,
            "purchase_frequency": "weekly",
            "added_by": "urn:authenticateit:user:email:system@authenticateit.com",
            "is_custom": true
        },
        {
            "name": "scissors",
            "amount": 5,
            "purchase_frequency": "scheduled",
            "added_by": "urn:authenticateit:user:email:system@authenticateit.com",
            "is_custom": true
        }
    ],
    "categories": [
        {
            "name": "Bread & Bakery",
            "id": "fdb66a4a-19a9-4ad6-a767-f7e487afd18a"
        },
        {
            "name": "Meat, Seafood & Deli",
            "id": "0ca7636a-5ced-4eea-a807-37eab2a341dd"
        },
        {
            "name": "Fruit & Veg",
            "id": "b90c0f02-b264-4ce0-b952-f1068f298493"
        },
        {
            "name": "Dairy & Eggs",
            "id": "8d264c76-4b11-4f76-9e4d-d6576fa64da1"
        },
        {
            "name": "Drinks",
            "id": "1e7fb3d0-cd18-4898-ae57-fe11ab7c04f5"
        }
    ],
    "attributes": [
        {
            "name": "Organic",
            "id": "aac11b66-807c-49e7-a27e-939969855751"
        },
        {
            "name": "Low Fat",
            "id": "44781039-af2d-4986-be2d-afac2c363bf3"
        },
        {
            "name": "Lactose free",
            "id": "be7194dc-06e3-4bd1-91db-5eb04be9a8b5"
        },
        {
            "name": "Australian made",
            "id": "86e9e12f-aed1-476c-a62e-2fd19bbce713"
        },
        {
            "name": "Free range",
            "id": "8f42ece8-8853-4052-a85b-92df163c7004"
        },
        {
            "name": "Halal",
            "id": "f15fc677-faa9-41d6-85b9-0a7d8d133dfb"
        }
    ]
}

Add attribute

Assign attribute to product.

POST /shoppinglists-service/attributes/product

Attribute can be assigned by id or by name.

Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
gtin string Required: gtin
attribute_id string Optional: attribute id
attribute_name string Optional: attribute name
trust string Optional: return doc instead of current participant

Required either attribute_id or attribute_name

Example body
{
    "gtin": "06713910111127",
    "attribute_id": "21d94b4f-d76e-46a2-befd-503e6b08ab39"
}

One of "attribute_id" or "attribute_name" fields has to be passed to the request.

Example Response
{
    "result": "Attribute has been added"
}

Delete attribute

Delete attribute from product.

DELETE /shoppinglists-service/attributes/product

Attribute can be deleted by id or by name.

Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
gtin string Required: gtin
attribute_id string Optional: attribute id
attribute_name string Optional: attribute name
trust string Optional: return doc instead of current participant

Required either attribute_id or attribute_name

Example body
{
    "gtin": "06713910111127",
    "attribute_id": "21d94b4f-d76e-46a2-befd-503e6b08ab39"
}

One of "attribute_id" or "attribute_name" fields has to be passed to the request.

Example Response
{
    "result": "Attribute has been deleted"
}

Get retailers

GET /shoppinglists-service/user/shoppinglist/product/retailers
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
default query Optional: Send only default retailers
Example Response
{
    "retailers": [
        {
            "id": "urn:authenticateit:participant:111111111111146",
            "name": "David Jones"
        },
        {
            "id": "urn:authenticateit:participant:111111111111115",
            "name": "Coles"
        },
        {
            "id": "urn:authenticateit:participant:111111111111111",
            "name": "Coles2",
            "logo": "https://dev-cdn.shping.com/2020/9/18/8479df1a-b943-4045-883f-c63ef4432979.jpg"
        },
        {
            "id": "urn:authenticateit:participant:111111111111133",
            "name": "MyDeal"
        },
        {
            "id": "urn:authenticateit:participant:111111111111132",
            "name": "FairPrice"
        },
        {
            "id": "urn:authenticateit:participant:111111111111134",
            "name": "Home Timber & Hardware"
        },
        {
            "id": "urn:authenticateit:participant:111111111111122",
            "name": "Spotlight"
        },
        {
            "id": "urn:authenticateit:participant:111111111111116",
            "name": "IGA",
            "logo": "https://dev-cdn.shping.com/2020/11/30/50af227c-adad-40d0-9981-99257c6f5ba2.png"
        },
        {
            "id": "urn:authenticateit:participant:111111111111130",
            "name": "EAMART"
        },
        {
            "id": "urn:authenticateit:participant:111111111111131",
            "name": "Chemist Warehouse"
        },
        {
            "id": "urn:authenticateit:participant:111111111111120",
            "name": "Mitre 10"
        },
        {
            "id": "urn:authenticateit:participant:111111111111112",
            "name": "Superpharmacy"
        },
        {
            "id": "urn:authenticateit:participant:111111111111118",
            "name": "Amcal"
        },
        {
            "id": "urn:authenticateit:participant:111111111111114",
            "name": "JB Hi-Fi"
        },
        {
            "id": "urn:authenticateit:participant:111111111111117",
            "name": "Target"
        },
        {
            "id": "urn:authenticateit:participant:111111111111124",
            "name": "Kogan"
        },
        {
            "id": "urn:authenticateit:participant:111111111111121",
            "name": "Pharmacy Direct"
        },
        {
            "id": "urn:authenticateit:participant:111111111111125",
            "name": "Officeworks"
        },
        {
            "id": "urn:authenticateit:participant:111111111111123",
            "name": "Harvey Norman"
        },
        {
            "id": "urn:authenticateit:participant:111111111111127",
            "name": "BIG W"
        },
        {
            "id": "urn:authenticateit:participant:111111111111128",
            "name": "Clinique"
        },
        {
            "id": "urn:authenticateit:participant:111111111111113",
            "name": "Estee Lauder"
        },
        {
            "id": "urn:authenticateit:participant:111111111111119",
            "name": "Lancome"
        },
        {
            "id": "urn:authenticateit:participant:111111111111129",
            "name": "Giorgio Armani Beauty"
        },
        {
            "id": "urn:authenticateit:participant:111111111111126",
            "name": "MAC Cosmetics"
        },
        {
            "id": "urn:authenticateit:participant:1",
            "name": "Authenticateit Pty Ltd",
            "logo": "https://dev-cdn.shping.com/2019/1/25/7a2f0607-3876-4e07-961f-99f19acf3098.jpg"
        }
    ]
}

Get ADs

POST /shoppinglists-service/advertisement
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
id uuid (body) Optional: Exact ad id
offset number (body) Optional: ads pagination, default = 0
limit number (body) Optional: ads res max size, default = 10
category array (body) Optional: filter by categories
gtin array (body) Optional: filter by gtins
status string (body) Optional: filter active/incative
name string (body) Optional: filter by name
owner array (body) Optional: filter by participants

Filter priorities:

  1. Id
  2. Name, Owner, Status
  3. Category
  4. Gtin
Example Response
{
    "result": [
        {
            "_id": "urn:authenticateit:shopping_list_ad:c875eb68-ed15-4a63-bde8-f71b163391f5",
            "_rev": "11-32a39b75fdde961e9a894fe42d282d74",
            "name": "sup",
            "status": "active",
            "owner": "urn:authenticateit:participant:1",
            "ad_type": "top_category_ad",
            "image": [
                {
                    "url": "link"
                }
            ],
            "audience": [
                {
                    "location": {
                        "postcode": "13336",
                        "country": "Australia",
                        "state": "Melbourne"
                    },
                    "gender": "all",
                    "max_age": 50,
                    "min_age": 18,
                    "user_levels": [
                        "bronze",
                        "gold"
                    ],
                    "language": [
                        "ru-RU",
                        "en-GB"
                    ]
                }
            ],
            "info_type": [
                "learn_more",
                "add2list"
            ],
            "target_categories": [
                "015f2cb7-c37e-4c1c-a2ce-4e0a56e14a69"
            ],
            "target_keywords": [
                "Milk"
            ],
            "weight": 1,
            "type": "shopping_list_ad",
            "products": [
                "09387951101194",
                "09350004000218",
                "09378050154747"
            ]
        }
    ],
    "total": 1
}

Create AD

PUT /shoppinglists-service/advertisement
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
name string (body) Optional: ad's name
status string (body) Optional: active/incative
owner string (body) Optional: participant
ad_type string (body) Required: ad type
image array (body) Optional: hero images
audience array (body) Optional: ad's audiences
target_gtin string (body) Optional: ad's gtin
full_range_gtin array (body) Optional: ad's gtins
info_type array (body) Optional: ad's info types
target_categories array (body) Optional: ad's categories
target_keywords array (body) Optional: ad's keywords
weight int (body) Optional: ad's weight (only for system users)

ad_types = top_category_ad, top_category_listing, top_keyword_ad, top_keyword_listing, main_page_ad info_types = "add2list", "full_range", "learn_more", can't be both full_range and learn_more audience structure:

json{
    "location": [{
        "postcode": "13336",
        "country": "Australia",
        "state": "Melbourne"
    }],
    "gender": ["all", "male", "female", "other"],
    "max_age": 50,
    "min_age": 18,
    "user_levels": [
        "basic", 
        "bronze", 
        "silver", 
        "gold", 
        "platinum"
    ],
    "language": [
        "ru-RU",
        "en-GB"
    ]
}
Example Response
{
    "result": "Ad added",
    "ad": {
        "ok": true,
        "id": "urn:authenticateit:shopping_list_ad:c2bee87b-aa09-4023-b2b6-f2c1feea356e",
        "rev": "1-c1bb1122ffc745481462dff9b4c448ff"
    }
}

Update AD

PATCH /shoppinglists-service/advertisement
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
id uuid (body) Required: ad's id
name string (body) One_of: ad's name
status string (body) One_of: active/incative
owner string (body) One_of: participant
ad_type string (body) One_of: ad type
image array (body) One_of: hero images
audience array (body) One_of: ad's audiences
target_gtin string (body) One_of: ad's gtin
full_range_gtins array (body) One_of: ad's gtins
info_type array (body) One_of: ad's info types
target_categories array (body) One_of: ad's categories
target_keywords array (body) One_of: ad's keywords
weight int (body) Optional: ad's weight (only for system users)

ad_types = top_category_ad, top_category_listing, top_keyword_ad, top_keyword_listing, main_page_ad types = "add2list", "full_range", "learn_more", can't be both full_range and learn_more

audience structure:

[
  {
    "location": {
      "postcode": "13336",
      "country": "Australia",
      "state": "Melbourne"
    },
    "gender": [
      "all",
      "male",
      "female",
      "other"
    ],
    "max_age": 50,
    "min_age": 18,
    "user_levels": [
      "basic",
      "bronze",
      "silver",
      "gold",
      "platinum"
    ],
    "language": [
      "ru-RU",
      "en-GB"
    ]
  }
]
Example Response
{
    "result": "Ad updated",
    "ad": {
        "ok": true,
        "id": "urn:authenticateit:shopping_list_ad:c2bee87b-aa09-4023-b2b6-f2c1feea356e",
        "rev": "8-c4635bc47cd9a9037b28e817162c8076"
    }
}

Delete AD

DELETE /shoppinglists-service/advertisement
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
id uuid (body) Required: Exact ad id
Example Response
{
    "result": "Ad deleted",
    "ad": {
        "ok": true,
        "id": "urn:authenticateit:shopping_list_ad:c2bee87b-aa09-4023-b2b6-f2c1feea356e",
        "rev": "9-1d37ce9f870e43cf775b35501cf4b93f"
    }
}

Get AD Settings

GET /shoppinglists-service/advertisement/settings/:participant_id
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket

participant_id is optional, if not present user's participant will be used

Example Response
{
    "result": {
        "_id": "urn:authenticateit:participant:1@ad",
        "_rev": "1-76f107383afc980143ad416c529509f7",
        "display_options": {
            "system_settings": {
                "category_top_ad": false,
                "category_top_listing": false,
                "keyword_top_ad": false,
                "keyword_top_listing": false,
                "main_page_ad": false
            },
            "participant_settings": {
                "category_top_ad": true,
                "category_top_listing": false,
                "keyword_top_ad": false,
                "keyword_top_listing": true,
                "main_page_ad": true
            }
        },
        "type": "participant_ad"
    }
}

Update AD Settings

POST /shoppinglists-service/advertisement/settings/:participant_id
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
type string (body) Required: type of settings - system_settings or participant_settings
settings object (body) Optional:

participant_id is optional, if not present user's participant will be used settings structure:

{
    "category_top_ad": boolean,
    "category_top_listing": boolean,
    "keyword_top_ad": boolean,
    "keyword_top_listing": boolean,
    "main_page_ad": boolean,
}
Example Response
{
    "result": "Ad settings updated",
    "settings": {
        "ok": true,
        "id": "urn:authenticateit:participant:1@ad",
        "rev": "3-99f35e5840e66e761a896c9162a19d99"
    }
}

results matching ""

    No results matching ""