shop.settings.getProductCodes

Returns information about the setup product codes.

Parameters

• format GET Optional

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

Return value

Array with the following keys:

• codes array Product code list. Each list item is an array with the following keys:
• codes[]['id'] int Code ID.
• codes[]['code'] string Code identifier.
• codes[]['name'] string Code name.
• codes[]['icon'] string Relative icon URL.
• codes[]['logo'] string Relative URL of a plugin using the code.
• codes[]['protected'] int Protected code flag meaning that a code cannot be deleted or have its identifier modified as long as its supporting plugin is installed and enabled.
• codes[]['plugin_id'] string ID of the plugin supporting the code.
• codes[]['type_ids'] array IDs or product types for which the code is marked as available.

Example