API docs by Redocly

Wallify (1.0.0)

Download OpenAPI specification:Download

Settings List

Authorizations:
BearerToken
Request Body schema: application/json

Settings data

wallet_notification_email
string

Default wallet notification for updated mail.

wallet_notification_first_name
string

Default wallet notification for updated first name.

wallet_notification_last_name
string

Default wallet notification for updated last name.

wallet_notification_phone
string

Default wallet notification for updated phone number.

wallet_notification_wallet_points
string

Default wallet notification for updated points.

wallet_notification_wallet_redeemable_points
string

Default wallet notification for updated redeemable points.

wallet_notification_favorite_store
string

Default wallet notification for updated store.

wallet_notification_creation
string

Default wallet notification for customer creation.

wallet_notification_deletion
string

Default wallet notification for customer deletion.

Responses

Request samples

Content type
application/json
{
  • "wallet_notification_email": "string",
  • "wallet_notification_first_name": "string",
  • "wallet_notification_last_name": "string",
  • "wallet_notification_phone": "string",
  • "wallet_notification_wallet_points": "string",
  • "wallet_notification_wallet_redeemable_points": "string",
  • "wallet_notification_favorite_store": "string",
  • "wallet_notification_creation": "string",
  • "wallet_notification_deletion": "string"
}

Settings Update

Authorizations:
BearerToken
Request Body schema: application/json

Settings data

wallet_notification_email
string

Default wallet notification for updated mail.

wallet_notification_first_name
string

Default wallet notification for updated first name.

wallet_notification_last_name
string

Default wallet notification for updated last name.

wallet_notification_phone
string

Default wallet notification for updated phone number.

wallet_notification_wallet_points
string

Default wallet notification for updated points.

wallet_notification_wallet_redeemable_points
string

Default wallet notification for updated redeemable points.

wallet_notification_favorite_store
string

Default wallet notification for updated store.

wallet_notification_creation
string

Default wallet notification for customer creation.

wallet_notification_deletion
string

Default wallet notification for customer deletion.

Responses

Request samples

Content type
application/json
{
  • "wallet_notification_email": "string",
  • "wallet_notification_first_name": "string",
  • "wallet_notification_last_name": "string",
  • "wallet_notification_phone": "string",
  • "wallet_notification_wallet_points": "string",
  • "wallet_notification_wallet_redeemable_points": "string",
  • "wallet_notification_favorite_store": "string",
  • "wallet_notification_creation": "string",
  • "wallet_notification_deletion": "string"
}

Response samples

Content type
application/json
{
  • "message": "The given data was invalid.",
  • "errors": {
    }
}

List all customers

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "external_id": "string",
  • "reference": "string",
  • "salutation": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "phone": "string",
  • "favorite_store_id": "string",
  • "additional_stores": [
    ],
  • "has_generated_card": false,
  • "wallet_points": 0,
  • "wallet_redeemable_points": 0,
  • "wallet_marketing_notification": "string",
  • "wallet_marketing_notification_end_date": "2019-08-24T14:15:22Z",
  • "is_deactivated": true,
  • "has_shop_account": true,
  • "has_card": true
}

Create customer

Authorizations:
BearerToken
Request Body schema: application/json

Customer data

title
string or null

Formal title of the updated customer.

external_id
string or null

External Id of the created customer.

reference
string or null

Reference of the created customer.

salutation
string or null

Salutation of the created customer.

first_name
string

First name of the created customer.

last_name
string

Last name of the created customer.

email
string or null

E-Mail of the created customer.

phone
string or null

Phone number of the created customer.

favorite_store_id
string or null

UUID/Reference of favorite store of the created customer.

additional_stores
Array of strings or null

Array of UUID/Reference of additional stores of the created customer.

has_generated_card
boolean or null
Default: false

Customer triggered initial pass generation.

wallet_points
integer

Wallet points of the created customer.

wallet_redeemable_points
integer

Wallet redeemable points of the created customer.

wallet_marketing_notification
string

Wallet marketing notification of the created customer.

wallet_marketing_notification_end_date
string <date-time>

Wallet marketing notification end date of the created customer.

is_deactivated
boolean

If true, created customer is deactivated.

has_shop_account
boolean

If true, created customer has shop account.

has_card
boolean

If true, created customer has shop card.

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "external_id": "string",
  • "reference": "string",
  • "salutation": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "phone": "string",
  • "favorite_store_id": "string",
  • "additional_stores": [
    ],
  • "has_generated_card": false,
  • "wallet_points": 0,
  • "wallet_redeemable_points": 0,
  • "wallet_marketing_notification": "string",
  • "wallet_marketing_notification_end_date": "2019-08-24T14:15:22Z",
  • "is_deactivated": true,
  • "has_shop_account": true,
  • "has_card": true
}

Response samples

Content type
application/json
{
  • "message": "The given data was invalid.",
  • "errors": {
    }
}

Get specific customer

Authorizations:
BearerToken
path Parameters
customer
required
string

Customer UUID or External ID

Responses

Update specific customer

Authorizations:
BearerToken
path Parameters
customer
required
string

Customer UUID or External ID

Request Body schema: application/json

Customer data

title
string or null

Formal title of the updated customer.

external_id
string or null

External Id of the updated customer.

reference
string or null

Reference of the updated customer.

first_name
string or null

First name of the updated customer.

salutation
string or null

Salutation of the updated customer.

last_name
string or null

Last name of the updated customer.

email
string or null

E-Mail of the updated customer.

phone
string or null

Phone number of the updated customer.

wallet_points
integer

Wallet points of the updated customer.

wallet_redeemable_points
integer

Wallet redeemable points of the updated customer.

wallet_marketing_notification
string

Wallet marketing notification of the updated customer.

wallet_marketing_notification_end_date
string <date-time>

Wallet marketing notification end date of the updated customer.

is_deactivated
boolean

If true, updated customer is deactivated.

has_shop_account
boolean

If true, updated customer has shop account.

has_card
boolean

If true, updated customer has shop card.

email_notification
string

Notification message for the email-Property. When DEFAULT the default message is sent, when SILENT, no notification is sent. Other text will be sent as notification to wallet pass. Notification message need to include %@ inside the message otherwise Apple Devices dont receive the Notification.

phone_notification
string

Notification message for the phone-Property. When DEFAULT the default message is sent, when SILENT, no notification is sent. Other text will be sent as notification to wallet pass. Notification message need to include %@ inside the message otherwise Apple Devices dont receive the Notification.

first_name_notification
string

Notification message for the first_name-Property. When DEFAULT the default message is sent, when SILENT, no notification is sent. Other text will be sent as notification to wallet pass. Notification message need to include %@ inside the message otherwise Apple Devices dont receive the Notification.

last_name_notification
string

Notification message for the last_name-Property. When DEFAULT the default message is sent, when SILENT, no notification is sent. Other text will be sent as notification to wallet pass. Notification message need to include %@ inside the message otherwise Apple Devices dont receive the Notification.

wallet_points_notification
string

Notification message for the wallet_points-Property. When DEFAULT the default message is sent, when SILENT, no notification is sent. Other text will be sent as notification to wallet pass. Notification message need to include %@ inside the message otherwise Apple Devices dont receive the Notification.

wallet_redeemable_points_notification
string

Notification message for the wallet_redeemable_points-Property. When DEFAULT the default message is sent, when SILENT, no notification is sent. Other text will be sent as notification to wallet pass. Notification message need to include %@ inside the message otherwise Apple Devices dont receive the Notification.

favorite_store_notification
string

Notification message for the favorite_store-Property. When DEFAULT the default message is sent, when SILENT, no notification is sent. Other text will be sent as notification to wallet pass. Notification message need to include %@ inside the message otherwise Apple Devices dont receive the Notification.

additional_stores_notification
string

Notification message for the additional_stores-Property. When DEFAULT the default message is sent, when SILENT, no notification is sent. Other text will be sent as notification to wallet pass. Notification message need to include %@ inside the message otherwise Apple Devices dont receive the Notification.

wallet_marketing_notification_notification
string

Notification message for the wallet_marketing_notification-Property. When DEFAULT the default message is sent, when SILENT, no notification is sent. Other text will be sent as notification to wallet pass. Notification message need to include %@ inside the message otherwise Apple Devices dont receive the Notification.

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "external_id": "string",
  • "reference": "string",
  • "first_name": "string",
  • "salutation": "string",
  • "last_name": "string",
  • "email": "string",
  • "phone": "string",
  • "wallet_points": 0,
  • "wallet_redeemable_points": 0,
  • "wallet_marketing_notification": "string",
  • "wallet_marketing_notification_end_date": "2019-08-24T14:15:22Z",
  • "is_deactivated": true,
  • "has_shop_account": true,
  • "has_card": true,
  • "email_notification": "string",
  • "phone_notification": "string",
  • "first_name_notification": "string",
  • "last_name_notification": "string",
  • "wallet_points_notification": "string",
  • "wallet_redeemable_points_notification": "string",
  • "favorite_store_notification": "string",
  • "additional_stores_notification": "string",
  • "wallet_marketing_notification_notification": "string"
}

Response samples

Content type
application/json
{
  • "message": "The given data was invalid.",
  • "errors": {
    }
}

Delete specific customer

Authorizations:
BearerToken
path Parameters
customer
required
string

Customer UUID or External ID

Responses

Deactivate specific customer

Authorizations:
BearerToken
path Parameters
customer
required
string

Customer UUID or External ID

Responses

Response samples

Content type
application/json
{
  • "message": "The given data was invalid.",
  • "errors": {
    }
}

Activate specific customer

Authorizations:
BearerToken
path Parameters
customer
required
string

Customer UUID or External ID

Responses

Response samples

Content type
application/json
{
  • "message": "The given data was invalid.",
  • "errors": {
    }
}

List all stores

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "caption": "string",
  • "external_id": "string",
  • "reference": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "wallet_relevant_text": "string"
}

Create store

Authorizations:
BearerToken
Request Body schema: application/json

Store data

caption
string

Caption of the created store.

external_id
string or null

External Id of the created store.

reference
string or null

Reference of the created store.

latitude
string

Latitude of the created store.

longitude
string or null

Longitude of the created store.

wallet_relevant_text
string

Relevant text for geo location related wallet pass notification.

Responses

Request samples

Content type
application/json
{
  • "caption": "string",
  • "external_id": "string",
  • "reference": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "wallet_relevant_text": "string"
}

Response samples

Content type
application/json
{
  • "message": "The given data was invalid.",
  • "errors": {
    }
}

Get specific store

Authorizations:
BearerToken
path Parameters
store
required
string

Store UUID or External ID

Responses

Update specific store

Authorizations:
BearerToken
path Parameters
store
required
string

Store UUID or External ID

Request Body schema: application/json

Store data

caption
string

Caption of the update store.

external_id
string or null

External Id of the update store.

reference
string or null

Reference of the update store.

latitude
string

Latitude of the update store.

longitude
string or null

Longitude of the update store.

wallet_relevant_text
string

Relevant text for geo location related wallet pass notification.

Responses

Request samples

Content type
application/json
{
  • "caption": "string",
  • "external_id": "string",
  • "reference": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "wallet_relevant_text": "string"
}

Response samples

Content type
application/json
{
  • "message": "The given data was invalid.",
  • "errors": {
    }
}

Delete specific store

Authorizations:
BearerToken
path Parameters
store
required
string

Store UUID or External ID

Responses

Import stores

Authorizations:
BearerToken
Request Body schema: application/json

Store CSV Import

file
required
string

CSV File with stores.

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Response samples

Content type
application/json
{
  • "message": "The given data was invalid.",
  • "errors": {
    }
}

Send specific customer a marketing notification

Authorizations:
BearerToken
path Parameters
customer
required
string

Customer UUID or External ID

Request Body schema: application/json

Customer marketing notification

notification
required
string

Marketing notification text.

end_date
required
string

Marketing notification end date.

Responses

Request samples

Content type
application/json
{
  • "notification": "string",
  • "end_date": "string"
}

Response samples

Content type
application/json
{
  • "message": "The given data was invalid.",
  • "errors": {
    }
}