Custom Attributes

Custom Attributes are flexible, tailored attributes that allow you to extend the entities in the Piggy system.

Currently, Custom Attributes can be created for the following entities:

business_profilesFor entity: Business Profile (or Shop)

contactFor entity: Contact

rewardFor entity: Reward

promotionFor entity: Promotion (note: use this one when working with Vouchers)

voucherFor entity: Voucher (note: this is for individual vouchers, you'll likely need Promotion instead

giftcardFor entity: Giftcard

giftcard_transactionFor entity: Giftcard Transaction

prepaidFor entity: Prepaid Transaction

bookingFor entity: Booking

visitFor entity: Visit

shiftFor entity: Shift

If you're missing any entity here, please reach out so we can see if we can make it happen on short notice.

List Custom Attributes

Get a list of Custom Attributes for a specified entity.

GET

https://api.piggy.eu/api//custom-attributes

Headers

Authorization

Bearer {{ access_token | api_key }}

application/json

Params

entitystring

REQUIRED

The entity of the Custom Attributes you want to retrieve.

Response Example

{
    "data": [
        {
            "entity": "voucher",
            "name": "acme_promotion_id",
            "label": "Acme Promotion ID",
            "type": "text",
            "group_name": null,
            "group": {
                "name": "General",
                "created_by_user": null,
                "position": 1
            },
            "is_piggy_defined": false,
            "is_soft_read_only": false,
            "is_hard_read_only": false,
            "has_unique_value": false,
            "description": "Promotion for Acme discount logic",
            "options": null,
            "position": 1,
            "created_at": "2023-11-13T16:04:14+00:00",
            "meta": [],
        }
    ]
}

Create Custom Attribute

Creates a new Custom Attribute for a specified entity. You need to provide essential details like the entity type, name, label, and data type of the attribute. There's also the option to add a description and, for select attributes, an array of options.

POST

https://api.piggy.eu/api//custom-attributes

Headers

Authorization

Bearer {{ access_token | api_key }}

application/json

Body

entitystring

REQUIRED

The entity that you want to create the Custom Attributes for.

namestring

REQUIRED

The unique value for the Custom Attribute, used for internal purposes.

labelstring

REQUIRED

The label for the attribute, which is outputted.

typestring

REQUIRED

The data type of the attribute, possible options: url, text, date, phone, float, color, email, number, select, boolean, rich_text, date_time, long_text, date_range, time_range, identifier, birth_date, file_upload, media_upload, multi_select or license_plate.

optionsarray

OPTIONAL

Applicable for (multi)selects only. Array consisting of name and value arrays.

descriptionstring

OPTIONAL

A description for the attribute.

group_namestring

OPTIONAL

Name of the Group to which the attribute belongs.

Response Example

{
    "data": {
        "entity": "promotion",
        "name": "discount_type",
        "label": "Discount Type",
        "type": "select",
        "group": {
            "name": "General",
        },
        "is_piggy_defined": false,
        "is_soft_read_only": false,
        "is_hard_read_only": false,
        "has_unique_value": false,
        "description": "Type of discount for this Voucher",
        "options": [
            {
                "value": "percentage",
                "label": "Percentage",
            },
            {
                "value": "fixed",
                "label": "Fixed",
            },
        ],
        "created_at": "2023-11-13T16:04:14+00:00",
    },
    "meta": []
}

Update Custom Attribute

Updates the properties of a Custom Attribute. Note that only the label, description, options for selects and multiselects, group can be updated. Attributes defined by the system cannot be updated.

PUT

https://api.piggy.eu/api//custom-attributes/{{custom_attribute_name}}

Headers

Authorization

Bearer {{ access_token | api_key }}

application/json

Body

entitystring

REQUIRED

The entity that you want to create the Custom Attributes for.

labelstring

OPTIONAL

The label for the attribute, which is outputted.

optionsarray

OPTIONAL

Applicable for (multi)selects only. Array consisting of name and value arrays.

descriptionstring

OPTIONAL

A description for the attribute.

group_namestring

OPTIONAL

Name of the Group to which the attribute belongs.

Response Example

{
    "data": {
        "entity": "promotion",
        "name": "discount_type",
        "label": "Discount Type",
        "type": "select",
        "group": {
            "name": "General",
        },
        "is_piggy_defined": false,
        "is_soft_read_only": false,
        "is_hard_read_only": false,
        "has_unique_value": false,
        "description": "Type of discount for this Voucher",
        "options": [
            {
                "value": "percentage",
                "label": "Percentage",
            },
            {
                "value": "fixed",
                "label": "Fixed",
            },
        ],
        "created_at": "2023-11-13T16:04:14+00:00",
    },
    "meta": []
}

Contacts

Contacts are the basis of the loyalty system, for whom any action is created

Credit Receptions

The issuing of credits is done using so-called Credit Receptions

Custom Attributes

List Custom Attributes

Create Custom Attribute

Update Custom Attribute

Related

Contacts

Credit Receptions