shop.settings.getRegions

Returns array of country regions set up in store backend.

Parameters

  • country GET Optional

    3-letter code of the country whose regions must be returned. If it is not specified then the method returns regions of all set up countries.

  • format GET Optional

    Sets response format. Available options: json (default), xml.

Return value

List of country regions as an array. Array keys are 3-letter country codes, array values are region arrays. The sub-array of each region contains values with the following keys:

  • [country][]['code'] string Region code.
  • [country][]['name'] string Region name.

Example

https://demo1.webasyst.com/api.php/shop.settings.getRegions?