Hip eCommerce

            LocationGroup

            LocationGroup

            Overview

            A Location Group is a resource which is attached to the Postage resource of a Listing. A Location Group represents a group of one or more countries. By default, all Sellers have two Location Groups set: "Domestic" which represents the Seller's home country, and "Everywhere Else" which represents all other countries (ie: International Shipping). However, please note that Sellers can customize their Location Groups, as well as remove the default Location Groups.

            Note: Sellers can customize their Location Groups from the Members Area > Selling > Seller Tools > Postage Setup page.

            Fields

            Field
            Visibility
            Type
            Description
            name
            public
            string
            The name of the Location Group.
            countries
            public
            array(int)
            An array of valid Country IDs (see HipStamp IDs, HipPostcard IDs or HipComic IDs).

            Associations

            This resource has no associations.

            Methods

            findAllLocationGroups

            Method Name: findAllLocationGroups
            Synopsis: Finds active Location Groups for the current user.
            HTTP Method: GET
            URI: /postage/settings/location_groups
            Parameters: n/a

            Examples

            findAllLocationGroups

            Request:
            GET https://www.hipstamp.com/api/postage/location_groups?api_key={YOUR_API_KEY}

            Response:
            {
                  "count": 2,
                  "type": "location_group",
                  "results": [
                        {
                              "name": "Domestic",
                              "countries": ["2083", "2084" ]
                        },
                        {
                              "name": "Everywhere Else",
                              "countries": ["2316" ]
                        },
                  ],
                  "params": { }
            }


            Updated: 18 Nov 2017 02:29 AM
            Helpful?  
            Help us to make this article better
            0 0