Customer Meta - API documentation

Table of contents

• Install app
• API functions
  • add
  • massadd
  • delete
  • massdelete
  • getlist
• Support

Install app

1. Install app. Go here and follow instructions.

Installed app allow JavaScript developer to use API functions out of box.

App adds two options at shop metafield to "ollistsapp" namespace.

• appurl - app's URL. "shop.metafields.ollistsapp.appurl" - access option value from liquid
• iid - store token, required for authentication. "shop.metafields.ollistsapp.iid" - access option value from liquid

API functions

API functions are Javascript wraper for Shopify API customer meta field function.

add

Add one customer meta field

Request

Option	Value
Request URL	https://{{ shop.metafields.ollistsapp.appurl }}/api/add
Method	POST

Request parameter

Parameter	Description
customerid (required)	Current customer id {{ customer.id }}
iid (required)	App's token {{ shop.metafields.ollistsapp.iid }}
shop (required)	Permanent shop's domain {{ shop.permanent_domain }}
domain (required)	Primary shop's domain {{ shop.domain }}
namespace (required)	Shopify API meta field option Metafield Documentation
key (required)	Shopify API meta field option Metafield Documentation
value (required)	Shopify API meta field option Metafield Documentation
value_type (optional)	Shopify API meta field option Metafield Documentation default value: "string"

JSON response

                    {
                        "status":200,
                        "message":"Meta field added successfully"
                    }
        

massadd

Add meta field(s) to customer.

Request

Option	Value
Request URL	https://{{ shop.metafields.ollistsapp.appurl }}/api/massadd
Method	POST

Request parameter

Parameter	Description
customerid (required)	Current customer id {{ customer.id }}
iid (required)	App's token {{ shop.metafields.ollistsapp.iid }}
shop (required)	Permanent shop's domain {{ shop.permanent_domain }}
domain (required)	Primary shop's domain {{ shop.domain }}
namespace (required)	Shopify API meta field option Metafield Documentation
items	meta field(s) array of objects each object is "key": "value" value_type is "string" example items - [{"12214168322115":"zola-coat-black"},{"12214188507203":"zoulou-coat-black"}]
purge (optional)	yes - remove all existing meta fields for given customer and namespace no - merge existing meta fields with new items from current request default value - no

JSON response

                    {
                        "status":200,
                        "message":"4 meta field(s) added successfully"
                    }
        

delete

Delete one customer meta field

Request

Option	Value
Request URL	https://{{ shop.metafields.ollistsapp.appurl }}/api/delete
Method	POST

Request parameter

Parameter	Description
_method (required)	DELETE
customerid (required)	Current customer id {{ customer.id }}
iid (required)	App's token {{ shop.metafields.ollistsapp.iid }}
shop (required)	Permanent shop's domain {{ shop.permanent_domain }}
domain (required)	Primary shop's domain {{ shop.domain }}
namespace (required)	Shopify API meta field option Metafield Documentation
key (required)	Shopify API meta field option Metafield Documentation

JSON response

                    {
                        "status":200,
                        "message":"Meta field deleted successfully"
                    }
        

massdelete

Delete all customer meta field(s) for namespace

Request

Option	Value
Request URL	https://{{ shop.metafields.ollistsapp.appurl }}/api/massdelete
Method	POST

Request parameter

Parameter	Description
_method (required)	DELETE
customerid (required)	Current customer id {{ customer.id }}
iid (required)	App's token {{ shop.metafields.ollistsapp.iid }}
shop (required)	Permanent shop's domain {{ shop.permanent_domain }}
domain (required)	Primary shop's domain {{ shop.domain }}
namespace (required)	Shopify API meta field option Metafield Documentation

JSON response

                    {
                        "status":200,
                        "message":"3 meta field(s) deleted successfully"
                    }
        

getlist

Get all customer meta field(s) for namespace

Request

Option	Value
Request URL	https://{{ shop.metafields.ollistsapp.appurl }}/api/getlist
Method	POST

Request parameter

Parameter	Description
customerid (required)	Current customer id {{ customer.id }}
iid (required)	App's token {{ shop.metafields.ollistsapp.iid }}
shop (required)	Permanent shop's domain {{ shop.permanent_domain }}
domain (required)	Primary shop's domain {{ shop.domain }}
namespace (required)	Shopify API meta field option Metafield Documentation

JSON response

                    {
                        "status":200,
                        "message":"3 meta field(s) found in namespace - compare",
                        "items":[
                                    {"12214143615043":"s14-onl-li-4184l-navy"},
                                    {"12214188507203":"zoulou-coat-black"},
                                    {"12214237331523":"wrapped-up-hat-in-natural-white"}
                                ],
                        "count":3
                    }
        

Support

If you have any questions fill free to email me at mpthemes@gmail.com