Spot Metrics logo
Documentation Powered by ReDoc

Spot Metrics mOS API (v1.0.0)

Download OpenAPI specification:Download

E-mail: [email protected] URL: https://www.spotmetrics.com/

Introduction

This is the Spot Metrics mOS API.

Authentication

x-access-token

The header x-access-token must be sent in every API call, it is used to authorize the API calls.

Security Scheme Type API Key
Header parameter name: x-access-token

bankAccountTokenAuth

The endpoint Generate Token requires this authencation method.

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Alert

Upsert alert

Registers a new alert or update an existing record.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
alertTypeId
required
number

Alert type ID.

description
number

Problem description.

Responses

Request samples

Content type
application/json
Example
create
create
update
{
  • "alertTypeId": 34,
  • "description": "description alert"
}

Response samples

Content type
application/json
{
  • "id": 67
}

Get Alerts

Lists many alert records by mall.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
string
Example: limit=300

Length of list without pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "alertId"
Enum: "alertId" "alertTypeId" "dateAlert" "dateResolved"

Property to order response list.

startDateTimeAlert
string <date-tme>
Example: startDateTimeAlert=2022-01-04T17:05:25.000Z

start date and time alert filter.

endDateTimeAlert
string <date-tme>
Example: endDateTimeAlert=2022-01-04T17:05:25.000Z

end date and time alert filter.

startDateTimeResolved
string <date-tme>
Example: startDateTimeResolved=2022-01-04T17:05:25.000Z

end date and time alert resolved filter.

endDateTimeResolved
string <date-tme>
Example: endDateTimeResolved=2022-01-04T17:05:25.000Z

end date and time alert resolved filter.

alertTypeId
string
Example: alertTypeId=3

alert type Id filter.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Alert Types

Get Alert Types

Lists all alert types records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
string
Example: limit=300

Length of list without pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "alertTypeName"
Enum: "alertTypeId" "alertOrignId" "alertLevelId" "alertTypeName"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Loan

Get Loans

Retrieves the summary of all loans from the specified mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

search
string
Example: search=Carrinho

Search parameter

page
string
Example: page=2
limit
string
Example: limit=25
column
string
Example: column=3
order
string
Enum: "asc" "desc"
sortBy
string
Enum: "id" "fullname" "type" "loaned" "datetime"
startDate
string <date>
Example: startDate=2020-05-01

Loan start date

endDate
string <date>
Example: endDate=2020-06-01

Loan end date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Loan

Registers a new loan

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
required
object

Loan Data

required
object

Customer Data

Responses

Request samples

Content type
application/json
{
  • "loan": {
    },
  • "customer": {
    }
}

Response samples

Content type
application/json
{
  • "id": 10
}

Send Acceptance Term

Send the acceptance term through the specified channel

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
email
string <email>

Email address

mobileNumber
string

Mobile number

channel
required
string
Enum: "email" "sms" "print"

Channel to send the data acceptance term message. When channel = 'email' the property 'email' must be sent. When channel = 'sms' the property 'mobileNumber' must be sent

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "e3258e47-227e-496d-8dec-e3789611cdab"
}

Check Acceptance Term

Checks if the acceptance term was already accepted

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 121

Acceptance Term ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{
  • "accepted": true
}

Get Loan

Retrieves a specific loan by ID

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

Loan ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{
  • "customer": {
    },
  • "loan": {
    }
}

Update Loan

Updates a loan

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

Loan ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
required
object
object

Customer Data

Responses

Request samples

Content type
application/json
{
  • "loan": {
    },
  • "customer": {
    }
}

Export Loan

Exports the loan in PDF format

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

Loan ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Loan Item

Get Loan Items

Retrieves the summary of all loan items from the specified mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

typeId
string
Example: typeId=2

The type of the loan item

status
string
Enum: "excellent" "good" "damaged"

Status of the loan item

enabled
boolean

show enabled or disabled items

limit
string
Example: limit=20

Length of list without pagination.

page
string

Page number when searching with pagination.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Loan Item

Creates a new loan item

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
tag
required
integer

Loan item tag

typeId
required
integer

Type ID of the loan item

inventoryNumber
string

Loan item inventory number

model
string

Model of the loan item

status
required
string
Enum: "excellent" "good" "damaged"

Status of the loan item

Responses

Request samples

Content type
application/json
{
  • "tag": 1,
  • "typeId": 18,
  • "inventoryNumber": "W269NWFGWX",
  • "model": "Carrinho de Bebê Sweet Baby Style Rosa",
  • "status": "excellent"
}

Get Loan Item Stock

Retrieves data about the stock of loan items from the specified mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

typeId
required
integer
Example: typeId=4

The type of the loan item

Loan item type IDs can be retrieved on the endpoint: Get Loan Item Types

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Loan Item Available Ids

Retrieves the available ids to associated a loan item

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

typeId
required
string
Example: typeId=4

The type of the loan item

Loan item type IDs can be retrieved on the endpoint: Get Loan Item Types

amount
required
string
Example: amount=10

The amount of this loan item type to be upserted

Responses

Response samples

Content type
application/json
[
  • 5,
  • 8,
  • 11,
  • 12,
  • 13,
  • 14,
  • 15,
  • 16,
  • 17,
  • 18
]

Patch Loan Item

Patches a loan item with specified id

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

Loan Item ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
inventoryNumber
string

Loan item inventory number

model
string

Model of the loan item

status
string
Enum: "excellent" "good" "damaged"

Status of the loan item

Responses

Request samples

Content type
application/json
{
  • "inventoryNumber": "W269NWFGWX",
  • "model": "Carrinho de Bebê Sweet Baby Style Rosa",
  • "status": "excellent"
}

Delete Loan Item

Deletes a loan item

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

Loan Item ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Get Loan Item

Retrieves information about a loan item

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

Loan Item ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{
  • "id": 3,
  • "tag": 1,
  • "inventoryNumber": "W269NWFGWX",
  • "typeId": 18,
  • "typeName": "Carrinho de Bebê",
  • "model": "Carrinho de Bebê Sweet Baby Style Rosa",
  • "status": "excellent"
}

Get Loan Item Types

Retrieves the registered loan item types

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Loan Item Type

Registers a new loan item type

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
name
required
string

The name of the loan item type

forChild
boolean
Default: false

Indicator of whether the loan item has child information

Responses

Request samples

Content type
application/json
{
  • "name": "Carrinho de Bebê",
  • "forChild": true
}

Response samples

Content type
application/json
{
  • "id": 3
}

Get Loan Item Type

Retrieves a loan item type

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

Loan Item ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{
  • "id": 4,
  • "name": "Carrinho de Bebê",
  • "forChild": true
}

Delete Loan Item Types

Delete a Loan item type

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 16

Type ID

query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Responses

Update Loan Item Types

Update a Loan item type

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 16

Type ID

query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
name
string

type name

forChild
boolean

says if the item is for children

Responses

Request samples

Content type
application/json
{
  • "name": "CARRINHO DE BEBÊ",
  • "forChild": true
}

Loan Graphs

Get Total Loans by Day

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

typeId
integer
Example: typeId=4

The type of the loan item

Loan item type IDs can be retrieved on the endpoint: Get Loan Item Types

mode
string
Enum: "stacked" "grouped-sorted"
Example: mode=stacked

mode

period
required
string
Enum: "year" "month" "week" "day"

period

Responses

Response samples

Content type
application/json
{
  • "stacked/month": [
    ],
  • "stacked/year": [
    ],
  • "grouped-sorted/month": [
    ],
  • "grouped-sorted/year": [
    ]
}

Get Usage Per Period

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

typeId
integer

typeId

period
required
string
Enum: "year" "month" "week" "day"

period

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Average Loan Time

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

typeId
integer

typeId

period
required
string
Enum: "year" "month" "week" "day"

period

Responses

Response samples

Content type
application/json
{
  • "month": [
    ],
  • "year": [
    ]
}

Get Loan Statistics

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

typeId
integer

typeId

period
required
string
Enum: "year" "month" "week" "day"

period

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Lost Found

Get Lost Founds

Retrieves the summary of all lost and founds from the specified mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

search
string
Example: search=Carteira

Search parameter

page
string
Example: page=2
limit
string
Example: limit=25
column
string
Example: column=3
sortBy
string
Enum: "id" "description" "location" "item" "returned"
order
string
Enum: "asc" "desc"
startDate
string <date>
Example: startDate=2020-05-01

Lost found start date

endDate
string <date>
Example: endDate=2020-06-01

Lost found end date

oldItems
boolean
Example: oldItems=true

filter by items older than ninety days with no return

status
string
Enum: "lost" "found" "givenAway" "destroyed"
Example: status=destroyed

Filter for item status

clientIdInput
string
Example: clientIdInput=4177

client input ID

clientIdOutput
string
Example: clientIdOutput=1777

client output ID

itemTypeId
string
Example: itemTypeId=10

item type ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 144
}

Create Lost Found

Register a new Lost and Found

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
required
object

Lost and Found Data. At least one of the properties itemId and itemName must be sent. If both are sent, itemId has priority.

object

Customer Data

object

Employee Data

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": 11231
}

Get Lost Ocurrence

Returns the summary of all lost for the specified mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

page
string
Example: page=2
limit
string
Example: limit=25
order
string
Enum: "asc" "desc"
startDate
string <date>
Example: startDate=2020-05-01

Lost ocurrence start date

endDate
string <date>
Example: endDate=2020-06-01

Lost ocurrence end date

status
string
Enum: "foundItems" "lostItems"
Example: status=foundItems

filter by occurrence status. Lost Items or Found Items.

clientId
string
Example: clientId=1097

Filter by client id

itemTypeId
string
Example: itemTypeId=1097

Filter by item Type Id

sortBy
string
Default: "id"
Enum: "id" "clientId" "receivetTyeId" "lostFoundItemId" "ocurrenceDate" "description" "lostOcorrunceNumber" "userRegisterId" "registerDate" "lostfoundId" "registerLostFoundDate" "userUpdatedId" "updatedDate"
Example: sortBy=1097

Possible sorting types

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 144
}

Create Lost Ocurrence

Register a new Lost ocurrence

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
description
string <date>

description of the lost item

ocurrenceDate
string <date>

date the customer lost the item

lostFoundItemId
integer

lost item type id

required
object

Responses

Request samples

Content type
application/json
{
  • "description": "o cliente perdeu uma carteira amarela com chaveiro do bob esponja no banheiro masculino do 3° andar ",
  • "ocurrenceDate": "2021-10-15",
  • "lostFoundItemId": 78,
  • "customer": {
    }
}

Disable Lost Ocurrence

disable a lost ocurrence

Authorizations:
x-access-token
path Parameters
lostOcurrenceId
required
string
Example: 6

lostOcurrenceId

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Get Lost Found Location

Retrieves the registered Lost Found location

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Lost Found Item

Retrieves the registered Lost Found item

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Lost Found

Retrieves a specific lost and found by ID

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

Lost Found ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{
  • "input": {
    },
  • "output": {},
  • "lostFound": {
    }
}

Update Lost Found

Updates a Lost and Found

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 11231

Lost and Found ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
lostOcurrenceId
integer

lost Ocurrence ID

required
object
object

Input Data about Customer or Employee

object

Output Data about Customer, required when lostFound.return = true

Responses

Request samples

Content type
application/json
{
  • "lostOcurrenceId": 0,
  • "lostFound": {},
  • "input": {
    },
  • "output": {
    }
}

Export Lost Found

Exports the lost found in PDF format

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

Lost Found ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Item donation

Donation of lost find items

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
dateDonation
required
string <date>

Date of donation

idItems
required
Array of numbers[ items ]

Lost found id array

donationDestinationName
required
string

Donation destination name

observation
required
string

observation for donated item

Responses

Request samples

Content type
application/json
{
  • "dateDonation": "2021-09-27",
  • "idItems": [
    ],
  • "donationDestinationName": "instituto de doação do RJ",
  • "observation": "example description"
}

Item Destruction

Destruction of lost find items

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
dateDestruction
required
string <date>

Date of destruction

idItems
required
Array of numbers[ items ]

Lost found id array

Responses

Request samples

Content type
application/json
{
  • "dateDestruction": "2021-09-27",
  • "idItems": [
    ]
}

Lost Found Item

Upsert Lost found item

lost and found object type.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
id
integer

lost found item ID for update

name
required
string

lost found item

Responses

Request samples

Content type
application/json
{
  • "id": 3,
  • "name": "MEDICAMENTOS"
}

Get lost found items

Get lost found items

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
string
Example: limit=300

Length of list without pagination.

search
string
Example: search=MEDICAMENTOS

Search parameter: 'lost found item name' OU 'lost found item ID'

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Enum: "name" "id"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Disable lost found item

Disable a lost found item

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 4

lost found item ID

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Get lost found item

Get lost found item

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 4

lost found item ID

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 90,
  • "name": "CARTEIRA"
}

Lost Found Graphs

Get Lost Found Basic Statistics

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

itemId
integer
Example: itemId=4

The type of the lost found item

startDate
required
string <date>
Example: startDate=2020-01-01
endDate
required
string <date>
Example: endDate=2021-01-01

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Lost Found Average Weekly Usage

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

itemId
integer
Example: itemId=4

The type of the lost found item

startDate
required
string <date>
Example: startDate=2020-01-01
endDate
required
string <date>
Example: endDate=2021-01-01

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Lost Found Most Lost Items

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

itemId
integer
Example: itemId=4

The type of the lost found item

startDate
required
string <date>
Example: startDate=2020-01-01
endDate
required
string <date>
Example: endDate=2021-01-01

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get Lost Found Not Withdrawn Items

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

itemId
integer
Example: itemId=4

The type of the lost found item

startDate
required
string <date>
Example: startDate=2020-01-01
endDate
required
string <date>
Example: endDate=2021-01-01

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Utilities

Upload Attachments

Uploads attachment files and returns the URLs

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: multipart/form-data
attachments
required
string <binary>

The attachment files to be uploaded

Responses

Response samples

Content type
application/json
[]

Forward Group

List forward groups

List forward groups by mall

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
integer
Example: limit=300

Length of list without pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "forwardGroupId"
Enum: "forwardGroupId" "name"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Create forward group

Register a forward group by mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
name
required
string

forward group name

Responses

Request samples

Content type
application/json
{
  • "name": "Jurídico"
}

List forward group

List forward group

Authorizations:
x-access-token
path Parameters
forwardGroupId
required
string
Example: 2341

ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{
  • "id": 11,
  • "name": "Tecnologia"
}

Delete a forward group

logical deletation of a forward group

Authorizations:
x-access-token
path Parameters
forwardGroupId
required
string
Example: 2341

ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Ticket

Get Tickets

Retrieves the summary of all customer service tickets from the specified mall with an optional search parameter

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

search
string
Example: search=João

Search parameter

clientId
string
Example: clientId=1

Client Id

statusId
string
Example: statusId=1

Status Id

employeeName
string
Example: employeeName=Tarcísio

Employee Name

reasonId
string
Example: reasonId=2

Reason Id

channelId
string
Example: channelId=3

Channel Id

page
string
Example: page=2
limit
string
Example: limit=25
column
string
Example: column=3
sortBy
string
Enum: "id" "fullname" "score" "reason" "status" "channel" "cpf"
order
string
Enum: "asc" "desc"
startDate
string <date>
Example: startDate=2020-05-01

Start date

endDate
string <date>
Example: endDate=2020-06-01

End date

_fields
string
Example: _fields=fieldName

Custom fields to search a keyword. To search in more than one field, the names of field must be separated by commas(,).

_keyword
string
Example: _keyword=@search

Keyword to search in the custom fields.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 144
}

Create Ticket

Registers a new customer service ticket

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
required
object

Ticket Data

complainantingStoreId
integer

Complainant store ID

required
object or object or object or object

Customer Data

object
object

Vehicle Data

object

Form to request an external service for the mall.

Responses

Request samples

Content type
application/json
{
  • "ticket": {},
  • "complainantingStoreId": 98,
  • "customer": { },
  • "store": {
    },
  • "vehicle": {
    },
  • "serviceOrderOpening": {
    }
}

Response samples

Content type
application/json
{
  • "id": 2341
}

Get Ticket

Retrieves a customer service ticket

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 2341

Ticket ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
Example
mallLoyalty
mallLoyalty
mallNoLoyalty
{
  • "complainantingStore": {
    },
  • "customer": {},
  • "ticket": {
    },
  • "vehicle": {
    },
  • "serviceOrderOpening": {
    }
}

Update Ticket

Updates a customer service ticket

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 2341

Ticket ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
required
object

Ticket Data

required
object
object
object

Vehicle Data

object

Form to request an external service for the mall.

Responses

Request samples

Content type
application/json
{
  • "ticket": {},
  • "customer": {
    },
  • "store": {
    },
  • "vehicle": {
    },
  • "serviceOrderOpening": {
    }
}

Export Ticket

Exports the ticket in PDF format

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 2341

Ticket ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Get Services Order Opening

Returns work order opening ticket records

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

mall ID

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "startDateTime" "endDateTime"

Property to order response list.

statusId
string
Example: statusId=6

status ID

startDateTime
string <date-time>
endDateTime
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Ticket Property

Upsert Reason

Create a new reason record or update an existing record.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
One of
active
boolean

Enable or disable a reason.

parentId
integer

Reason id father.

name
required
string

Reason name.

formsId
Array of integers[ items ]

Responses

Request samples

Content type
application/json
Example
createReason
createReason
updateReason
{
  • "active": true,
  • "parentId": 2,
  • "name": "ESTACIONAMENTO",
  • "formsIds": [
    ]
}

Get Reasons

Retrieves the customer service reasons of a parent reason (or the root reasons if no parent ID is provided)

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

parentId
string
Example: parentId=2

Parent Reason ID

formId
string
Example: formId=2

form Reason ID

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Reason

Retrieves one customer service reasons in particular

Authorizations:
x-access-token
path Parameters
reasonId
required
string
Example: 10000

Reason ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Status

Retrieves all the customer service status for the specified mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Types

Retrieves all the customer service types for the specified mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Forward Groups

Retrieves all the forward groups for the specified mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Channels

Retrieves all the communication channels for the specified mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Short Ticket

Get Short Tickets

Retrieves the summary of all customer service short tickets from the specified mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

page
string
Example: page=1

Page number when searching with pagination.

limitByPage
string
Example: limitByPage=50

Length of list per page with pagination.

limit
string
Example: limit=300

Length of list without pagination.

sortBy
string
Default: "id"
Enum: "id" "dateTime"

Customer Property to order response list. (ENUM: 'id', 'dateTime').

order
string
Default: "desc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Short Ticket

Registers a new customer service short ticket

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
channelId
required
integer

The ID of the channel that originated the short ticket.

Channel ids can be retrieved on the endpoint: Get Channels

comment
required
string <= 100 characters

Short ticket comment

Responses

Request samples

Content type
application/json
{
  • "channelId": 3,
  • "comment": "Um clinte perguntou se o shopping possuia a loja C&A"
}

Response samples

Content type
application/json
{
  • "id": 5432
}

Get Short Ticket

Retrieves a customer service short ticket

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 5432

Short ticket ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{
  • "id": 5432,
  • "channel": {
    },
  • "dateTime": "2019-08-24T14:15:22Z",
  • "comment": {
    }
}

Origins

Get Origins

Returns all Origins available to the mall

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Ticket Relationship Settings

list ticket relationship settings

list many ticket relationship settings.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
integer
Example: limit=300

Length of list without pagination.

page
string

identifies the current page

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "reasonId"
Value: "reasonId"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 144
}

Create ticket relationship settings

Creates relationship between the reason for the occurrence with forwarding groups.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
reasonId
required
integer

customer service reason ID

idForwardGroups
required
Array of integers[ items ]

Responses

Request samples

Content type
application/json
{
  • "reasonId": 7,
  • "idForwardGroups": [
    ]
}

List a ticket relationship setup

List a ticket relationship setup

Authorizations:
x-access-token
path Parameters
reasonId
required
string
Example: 7

ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{
  • "forwardGroups": [
    ],
  • "reasonTree": [
    ]
}

mOS-store: Tickets

Get Tickets

Retrieves the summary of all customer service tickets from the specified mall with an optional search parameter

Authorizations:
x-access-token
query Parameters
storeId
required
string
Example: storeId=6

store ID

search
string
Example: search=João

Search parameter

clientId
string
Example: clientId=1

Client Id

statusId
string
Example: statusId=1

Status Id

sectorId
string
Example: sectorId=1

sector Id

employeeName
string
Example: employeeName=Tarcísio

Employee Name

reasonId
string
Example: reasonId=2

Reason Id

channelId
string
Example: channelId=3

Channel Id

page
string
Example: page=2
limit
string
Example: limit=25
column
string
Example: column=3
sortBy
string
Enum: "id" "fullname" "score" "reason" "status" "channel" "cpf"
order
string
Enum: "asc" "desc"
startDate
string <date>
Example: startDate=2020-05-01

Start date

endDate
string <date>
Example: endDate=2020-06-01

End date

_fields
string
Example: _fields=fieldName

Custom fields to search a keyword. To search in more than one field, the names of field must be separated by commas(,).

_keyword
string
Example: _keyword=@search

Keyword to search in the custom fields.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 144
}

Create Ticket

Registers a new customer service ticket

Authorizations:
x-access-token
query Parameters
storeId
required
string
Example: storeId=665

storeId ID

Request Body schema: application/json
required
object

Ticket Data

required
object or object or object or object

Customer Data

object
object

Vehicle Data

object

Form to request an external service for the mall.

Responses

Request samples

Content type
application/json
{
  • "ticket": {},
  • "customer": { },
  • "store": {
    },
  • "vehicle": {
    },
  • "serviceOrderOpening": {
    }
}

Response samples

Content type
application/json
{
  • "id": 2341
}

Get Ticket

Retrieves a customer service ticket

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 2341

Ticket ID

query Parameters
storeId
required
string
Example: storeId=6

store ID

Responses

Response samples

Content type
application/json
Example
mallLoyalty
mallLoyalty
mallNoLoyalty
{
  • "complainantingStore": {
    },
  • "customer": {},
  • "ticket": {
    },
  • "vehicle": {
    },
  • "serviceOrderOpening": {
    }
}

Update Ticket

Updates a customer service ticket

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 2341

Ticket ID

query Parameters
storeId
required
string
Example: storeId=62

store ID

Request Body schema: application/json
required
object

Ticket Data

object
required
object
object

Form to request an external service for the mall.

Responses

Request samples

Content type
application/json
{}

mOS-store: Ticket Property

Get Reasons

Retrieves the customer service reasons of a parent reason (or the root reasons if no parent ID is provided)

Authorizations:
x-access-token
query Parameters
storeId
required
string
Example: storeId=6

store ID

parentId
string
Example: parentId=2

Parent Reason ID

formId
string
Example: formId=2

form Reason ID

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Channels

Retrieves all the communication channels for the specified mall

Authorizations:
x-access-token
query Parameters
storeId
required
string
Example: storeId=6

store ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

mOS-store: Sectors

List Sectors

Lists many active sectors records.

Authorizations:
x-access-token
query Parameters
storeId
required
integer
Example: storeId=6

Associated store ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Default: "order"
Enum: "id" "name"

Property to order response list.

search
string

Search by name.

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "data": [
    ]
}

Signatures

Upsert Signatures

Register or Update a signature.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
id
integer

A signature indentifier.

name
required
string

A Signature name.

active
required
boolean

Signature status.

entranceId
required
integer

A entrance indentifier.

mallAdministrationId
integer

A mall administration indentifier.

urlSignature
required
string

A signature URL.

required
Array of objects[ items ]

A signature types array.

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "name": "CommunicationSignature",
  • "active": true,
  • "entranceId": 1,
  • "mallAdministrationId": 1,
  • "urlSignature": "www.spot-signature.com.br",
  • "signatureTypes": [
    ]
}

Delete Signatures

Register or Update a signature.

Authorizations:
x-access-token
path Parameters
signatureId
required
string
Example: 6

Signature ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Update Signatures Content

Update signatures content.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
One of
smsText
required
string

A text message to be sent to the customer.

emailContent
string

A email's content to be sent to the customer.

Responses

Request samples

Content type
application/json
{
  • "smsText": "text message",
  • "emailContent": "<hmtl></html>"
}

Mall Signatures

Get Signatures by mall

Get Signatures by mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

entranceId
string
Example: entranceId=6

Entrance ID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Communication",
  • "entranceId": 1,
  • "active": true,
  • "urlSignature": "www.url.com",
  • "mallId": 1,
  • "administrationId": 1,
  • "signatureTypes": {
    }
}

Get Signatures by administration

Get Signatures by administration

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

entranceId
string
Example: entranceId=6

Entrance ID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Communication",
  • "entranceId": 1,
  • "active": true,
  • "urlSignature": "www.url.com",
  • "mallId": 1,
  • "administrationId": 1,
  • "signatureTypes": {
    }
}

Progress Acceptance

ProgressAcceptance

Progress Acceptance

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
One of
channel
required
string

channel type

originId
required
integer

Acceptance Origin ID

clientId
required
integer

Client who is accepting.

programId
required
integer

Loyalty program ID

itemId
integer

Loan item ID

lostId
integer

Lost found item ID

Responses

Request samples

Content type
application/json
{
  • "channel": "email",
  • "originId": 5,
  • "clientId": 9,
  • "programId": 98,
  • "itemId": 2044,
  • "lostId": 653
}

Response samples

Content type
application/json
{
  • "hash": "5572abda6ca2dd996d26dd02ac109c5f"
}

Get progress acceptance status

Get progress acceptance status

Authorizations:
x-access-token
path Parameters
hash
required
string
Example: 5572abda6ca2dd996d26dd02ac109c5f

Progress Hash

Responses

Response samples

Content type
application/json
{
  • "status": "PENDENTE",
  • "message": "Enviando solicitação para o cliente."
}

Get progress acceptance infos

Get progress acceptance infos

Authorizations:
x-access-token
path Parameters
hash
required
string
Example: 5572abda6ca2dd996d26dd02ac109c5f

Progress Hash

Responses

Response samples

Content type
application/json
{
  • "customerName": "John",
  • "htmlContent": "<html></html>",
  • "mallName": "Mall",
  • "signedOptIn": true
}

Accept Progress

Accept Progress

Authorizations:
x-access-token
path Parameters
hash
required
string
Example: 5572abda6ca2dd996d26dd02ac109c5f

Progress Hash

Request Body schema: application/json
optIn
boolean

Reject or Accept All Terms

Responses

Request samples

Content type
application/json
{
  • "optIn": true
}

Response samples

Content type
application/json
{
  • "hash": "5572abda6ca2dd996d26dd02ac109c5f"
}

Mall Terms

Get Mall Loan Terms

Get mall loan terms

Authorizations:
x-access-token
path Parameters
itemId
required
string
Example: 6

Item ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
id
integer

A client indentifier.

cpf
string

A brazilian's unique citizen identifier.

fullName
string

A full name.

birthday
string <date>

A date following the format (YYYY-MM-DD).

sex
string
Enum: "F" "M" "O"

A character representing the sex.

mobileNumber
string

A mobile number.

homePhone
string

A home phone

email
string

An email address.

zipCode
string

Postal address code.

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "cpf": "54084425788",
  • "fullName": "Fulano Teste",
  • "birthday": "2015-07-28",
  • "sex": "F",
  • "mobileNumber": "21987659999",
  • "homePhone": "2140028922",
  • "email": "[email protected]",
  • "zipCode": "51562673"
}

Response samples

Content type
application/json
{
  • "term": "<html></html>"
}

Get Mall Lost Found Terms

Get mall lost found terms

Authorizations:
x-access-token
path Parameters
itemId
required
string
Example: 6

Item ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
id
integer

A client indentifier.

cpf
string

A brazilian's unique citizen identifier.

fullName
string

A full name.

birthday
string <date>

A date following the format (YYYY-MM-DD).

sex
string
Enum: "F" "M" "O"

A character representing the sex.

mobileNumber
string

A mobile number.

homePhone
string

A home phone

email
string

An email address.

zipCode
string

Postal address code.

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "cpf": "54084425788",
  • "fullName": "Fulano Teste",
  • "birthday": "2015-07-28",
  • "sex": "F",
  • "mobileNumber": "21987659999",
  • "homePhone": "2140028922",
  • "email": "[email protected]",
  • "zipCode": "51562673"
}

Response samples

Content type
application/json
{
  • "term": "<html></html>"
}

mOS-store: Bank Account

Get Bank Accounts

Retrieves the store bank accounts

Authorizations:
x-access-token
query Parameters
storeId
required
string
Example: storeId=820

Store ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Bank Account

Creates a bank account

Authorizations:
x-access-token
query Parameters
storeId
required
string
Example: storeId=6

store ID

Request Body schema: application/json
bankAccountToken
required
string

Bank account token. It can be generated using the endpoint: Generate Token

Responses

Request samples

Content type
application/json
{
  • "bankAccountToken": "d9184d7ad5ef48a2a7bf8cb634d5ffeb"
}

Response samples

Content type
application/json
{
  • "message": "Conta bancária cadastrada com sucesso."
}

Disable Bank Account

Disables a bank account

Authorizations:
x-access-token
path Parameters
bankAccountId
required
string
Example: 4

Bank account ID

query Parameters
storeId
required
string
Example: storeId=6

store ID

Responses

Response samples

Content type
application/json
{
  • "message": "Conta bancária desabilitada com sucesso."
}

Generate Token

Generates a Bank Account Token

Authorizations:
bankAccountTokenAuth
path Parameters
marketplace_id
required
string
Request Body schema: application/json
holder_name
required
string

Account holder's name

bank_code
required
string

Bank institution number

routing_number
required
string

Bank branch number without verification digit

account_number
required
string

Bank account number with verification digit

ein
required
string

CNPJ

type
required
string
Enum: "checking" "savings"

Responses

Request samples

Content type
application/json
{
  • "holder_name": "João Silva",
  • "bank_code": "237",
  • "routing_number": "0215",
  • "account_number": "09747087",
  • "ein": "75136476000153",
  • "type": "checking"
}

Response samples

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

mOS-store: Bank Transfer

Get Bank Transfers

Retrieves the store bank tranfers

Authorizations:
x-access-token
query Parameters
storeId
required
string
Example: storeId=820

Store ID

search
string
Example: search=Banco Bradesco S.A.

Search parameter: (bank name, account number)

page
string
Example: page=1

Page number when searching with pagination.

limit
string
Example: limit=300

Length of list without pagination.

sortBy
string
Enum: "id" "bankName" "accountNumber" "createdAt" "value"

Property to order response list.

order
string
Enum: "asc" "desc"
startDateTime
string <date-time>
Example: startDateTime=2021-10-25T23:00:00Z

start date time

endDateTime
string <date-time>
Example: endDateTime=2021-11-20T23:00:00Z

end date time

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Bank Transfer

Creates a bank transfer

Authorizations:
x-access-token
query Parameters
storeId
required
string
Example: storeId=6

store ID

Request Body schema: application/json
bankAccountId
required
integer
value
required
number

Responses

Request samples

Content type
application/json
{
  • "bankAccountId": 2,
  • "value": 2050.35
}

Response samples

Content type
application/json
{
  • "message": "Transferência bancária realizada com sucesso."
}

mOS-store: Store

Get marketplace ID

Returns marketplace ID

Authorizations:
x-access-token
query Parameters
storeId
required
string
Example: storeId=820

Store ID

Responses

Response samples

Content type
application/json
{
  • "id": "3456789e8a0847138df7380f0b"
}

Get Balance

Returns the store balance

Authorizations:
x-access-token
query Parameters
storeId
required
string
Example: storeId=820

Store ID

Responses

Response samples

Content type
application/json
{
  • "balance": 2050
}

Generate QRCode

Generate a QRCode by storeId

Authorizations:
x-access-token
query Parameters
storeId
required
string
Example: storeId=820

Store ID

Responses

Get Sales Plans

Returns store sale plan

Authorizations:
x-access-token
query Parameters
storeId
string
Example: storeId=820

Store ID

storeCode
string
Example: storeCode=e077

Store code

Responses

Response samples

Content type
application/json
{
  • "id": 4,
  • "name": "americanas",
  • "fee_details": [
    ]
}

mOS-mall: Payment

Get Payments

Retrieves the store payments

Authorizations:
x-access-token
query Parameters
clientId
required
string
Example: clientId=820

Client ID, it must be sent when storeId is not sent

storeId
required
string
Example: storeId=820

Store ID, it must be sent when clientId is not sent

search
string
Example: search=João

Search parameter: (customer name, invoice number, store name)

page
string
Example: page=1

Page number when searching with pagination.

limit
string
Example: limit=300

Length of list without pagination.

sortBy
string
Enum: "id" "invoiceNumber" "createdAt" "storeName" "clientName" "installments" "value" "status"

Property to order response list.

order
string
Enum: "asc" "desc"
startDateTime
string <date-time>
Example: startDateTime=2021-10-25T23:00:00Z

start date time

endDateTime
string <date-time>
Example: endDateTime=2021-11-20T23:00:00Z

end date time

status
string
Enum: "pending" "succeeded" "refunded"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 18
}

Accept Payment

Accepts a payment

Authorizations:
x-access-token
path Parameters
paymentId
required
string
Example: 4

Payment ID

query Parameters
storeId
required
string
Example: storeId=820

Store ID

Request Body schema: application/json
invoiceNumber
required
string

Invoice number

Responses

Request samples

Content type
application/json
{
  • "invoiceNumber": "100301098"
}

Response samples

Content type
application/json
{
  • "message": "Pagamento foi aceito com sucesso."
}

Reject Payment

Rejects a payment

Authorizations:
x-access-token
path Parameters
paymentId
required
string
Example: 4

Payment ID

query Parameters
storeId
required
string
Example: storeId=820

Store ID

Responses

Response samples

Content type
application/json
{
  • "message": "Pagamento rejeitado com sucesso."
}

Get Payments items

Retrieve store payment reconciliation

Authorizations:
x-access-token
query Parameters
clientId
required
string
Example: clientId=820

Client ID, it must be sent when storeId is not sent

storeId
required
string
Example: storeId=820

Store ID, it must be sent when clientId is not sent

search
string
Example: search=João

Search parameter: (customer name, invoice number, store name)

page
string
Example: page=1

Page number when searching with pagination.

limit
string
Example: limit=300

Length of list without pagination.

sortBy
string
Enum: "id" "invoiceNumber" "createdAt" "clientName" "value" "origin" "storeName"

Property to order response list.

column
string
Example: column=3
order
string
Enum: "asc" "desc"
startDateTime
string <date-time>
Example: startDateTime=2021-10-25T23:00:00Z

start date time

endDateTime
string <date-time>
Example: endDateTime=2021-11-20T23:00:00Z

end date time

status
string
Enum: "pending" "succeeded" "refunded"
origin
string
Enum: "creditcard" "cashback"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 18
}

Banner

Create Banner

Registers a new Banner.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
image
required
string

image url

title
required
string

banner title

subtitle
required
string

banner subtitle

details
required
string

banner details

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": 10
}

Read Banner

Read specific shopping mall banners

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

Banner ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{}

Update Banner

Update a banner

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 6

Banner Id

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
image
string

image url

title
string

banner title

subtitle
string

banner subtitle

details
string

banner details

Responses

Request samples

Content type
application/json
{}

Delete banner

delete a banner

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

Banner Id

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Campaign

Create campaign

Create a new campain

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
name
required
string

campaign name

required
object
required
object
type
required
string
Enum: "flash" "campaign"

campaign type

clubExclusive
required
boolean

campaign exclusivity

contextTags
Array of integers[ items ]

Contextos da campanha

personaTags
Array of integers[ items ]

Personas da campanha

stores
required
Array of integers[ items ]

stores

object

Responses

Request samples

Content type
application/json
{
  • "name": "campanha teste 1",
  • "startDate": {
    },
  • "endDate": {
    },
  • "type": "campaign",
  • "clubExclusive": false,
  • "contextTags": [
    ],
  • "personaTags": [
    ],
  • "stores": [
    ],
  • "channels": {
    }
}

Response samples

Content type
application/json
{
  • "id": 10
}

Read campaigns

Read campaigns

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=3

mall id

endDate
string <date>
Example: endDate=2021-04-20

End date

startDate
string <date>
Example: startDate=2021-03-20

Start date

search
string
Example: search=xxx

Search parameter

limit
string
Example: limit=25
page
string
Example: page=2
column
string
Example: column=3
order
string
Enum: "asc" "desc"
type
required
string
Enum: "campaign" "flash"
published
string
Enum: "true" "false"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 237
}

Read a campaign

Read a specific campaign

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

campaign ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "campanha teste 1",
  • "startDate": {
    },
  • "endDate": {
    },
  • "clubExclusive": false,
  • "contextTags": [
    ],
  • "personaTags": [
    ],
  • "stores": [
    ],
  • "channels": {
    },
  • "reinforcementId": 43,
  • "type": "campaign"
}

Update campaign

Update a specific campaign

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

campaign ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Request Body schema: application/json
name
string

campaign name

object
object
type
required
string

campaign type

clubExclusive
boolean

campaign exclusivity

contextTags
Array of integers[ items ]

Contextos da campanha

personaTags
Array of integers[ items ]

Personas da campanha

stores
Array of integers[ items ]

stores

object

Responses

Request samples

Content type
application/json
{
  • "name": "campanha teste 1",
  • "startDate": {
    },
  • "endDate": {
    },
  • "type": "campaign",
  • "clubExclusive": false,
  • "contextTags": [
    ],
  • "personaTags": [
    ],
  • "stores": [
    ],
  • "channels": {
    }
}

Delete campaign

Delete a specific banner

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

campaign ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Publish campaign

Publish specific campaign

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

campaign ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Responses

Reinforce campaign

Campaign successfully enhanced

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

campaign ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Responses

Response samples

Content type
application/json
{
  • "id": 6
}

Get campaign preview

Get campaign preview

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
stores
Array of integers[ items ]

Store IDs

contextTags
Array of integers[ items ]
personaTags
Array of integers[ items ]
channels
required
Array of strings[ items non-empty ]
Items Enum: "email" "sms"

Responses

Request samples

Content type
application/json
{
  • "stores": [
    ],
  • "contextTags": [
    ],
  • "personaTags": [
    ],
  • "channels": [
    ]
}

Response samples

Content type
application/json
{
  • "total": 10,
  • "email": 5,
  • "sms": 5
}

Campaign Tag

Get Campaign Tags

Retrieves campaign tags

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{
  • "contextTags": [
    ],
  • "personaTags": [
    ]
}

Email

Create email

Create a new email

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
subject
required
string

email subject

content
required
string

email content

metadata
string

email metadata

Responses

Request samples

Content type
application/json
{
  • "subject": "teste",
  • "content": "<!DOCTYPE html> <html> <head> <title>Page Title</title> </head> <body>\n<h1>This is a Email</h1> <p>This is a Email.</p>\n</body> </html>",
  • "metadata": "dados"
}

Response samples

Content type
application/json
{
  • "id": 12
}

Read email

read a specific email

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

email ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Responses

Response samples

Content type
application/json
{
  • "id": 6,
  • "subject": "subject-teste",
  • "content": "<!DOCTYPE html> <html> <head> <title>Page Title</title> </head> <body>\n<h1>This is a Email</h1> <p>This is a Email.</p>\n</body> </html>",
  • "metadata": "dados"
}

Update email

updates a specific email

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

email ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Request Body schema: application/json
subject
string

subject

content
string

email content

metadata
string

email metadata

Responses

Request samples

Content type
application/json
{
  • "subject": "subject-test2",
  • "content": "<!DOCTYPE html> <html> <head> <title>Page Title</title> </head> <body>\n<h1>This is an Email</h1> <p>This is an Email.</p> <p>This is an Email.</p>\n</body> </html>",
  • "metadata": "dados"
}

Delete email

delete a specific email

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

email ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Responses

Get email quotas

read email quotas from a specific mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

mall ID

Responses

Response samples

Content type
application/json
{
  • "numLimitEmail": 1000,
  • "used": 900
}

Push

Create push

Create a new push

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
heading
required
string

heading

content
required
string

content

Responses

Request samples

Content type
application/json
{
  • "heading": "teste-heading",
  • "content": "test-content"
}

Response samples

Content type
application/json
{
  • "id": 13
}

Read push

Read a specific push

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

push ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Responses

Response samples

Content type
application/json
{
  • "id": 6,
  • "heading": "test-heading",
  • "content": "content-test"
}

Update a specific push

update a specific push

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

sms ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Request Body schema: application/json
content
string

content

Responses

Request samples

Content type
application/json
{
  • "content": "test-content2"
}

Delete a specific push

delete a specific push

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

push ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Responses

Sms

Create sms

Create a new sms

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
One of
subject
required
string

subject

content
required
string

content

marketing
required
boolean

marketing

Responses

Request samples

Content type
application/json
Example
entryMarketingTrue
entryMarketingTrue
entryMarketingFalse
{
  • "subject": "teste",
  • "content": "content teste",
  • "marketing": true
}

Response samples

Content type
application/json
{
  • "id": 13
}

Get sms

Read a specific sms

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

email ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Responses

Response samples

Content type
application/json
{
  • "id": 6,
  • "subject": "test",
  • "content": "test content",
  • "marketing": false
}

Update sms

update a specific sms

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

sms ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Request Body schema: application/json
content
string

content

marketing
boolean

marketing

Responses

Request samples

Content type
application/json
{
  • "content": "updated SMS content",
  • "marketing": false
}

Delete sms

delete a specific sms

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

sms ID

query Parameters
mallId
required
string
Example: mallId=6

mall ID

Responses

Get sms quotas

read SMS quotas from a specific mall

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

mall ID

Responses

Response samples

Content type
application/json
{
  • "numLimitSms": 1000,
  • "used": 900
}

Email Template

Upsert email template

Register a new email template.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
subject
required
string
metadata
required
string
content
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "subject": "string",
  • "metadata": "string",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": 34
}

List Email templates

Lists many active email template records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

subject
string

Filter by subject.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "subject"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Email template

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Email template ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "message": "O template de email informado não foi encontrado."
}

Get email template

Lists one active email template record by mall.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Email template id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "subject": "string",
  • "metadata": "string",
  • "content": "string"
}

E-mail

Send Email

Send e-mail.

Authorizations:
x-access-token
Request Body schema: application/json
Any of
Any of
mallId
required
number

Mall Identifier.

emails
Array of strings
emailId
number

Email Identifier.

content
required
string
subject
required
string
sourceType
required
string
Enum: "OPERACIONAL" "PLATAFORMA" "REGUA"

Responses

Request samples

Content type
application/json
{ }

Store

Create Store

Registers a new Store .

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
mallId
required
integer

MallId where the store is located

name
required
string

Store's legal name

legalName
required
string

Store's name

logo
string

Store's Logo

location
string

Store stand number

receberCurriculo
boolean

If the store wants to receive a resume

emBreve
boolean

If the store is going to open soon

complement
string

Store complement information

contactName
required
string

Name to contact

contactPhone
required
string

Number to contact

email
required
string <email>

Email address

type
required
string
Enum: "loja" "quiosque"

Store's type

active
required
boolean

If store are active

cnpj
string

Store's CNPJ

phones
required
Array of strings
lucs
Array of integers[ items ]
segmentId
required
number
activityIds
required
Array of numbers[ items ]
Array of objects[ items ]
object
metadata
string

The store's answer to de custom property.

Responses

Request samples

Content type
application/json
{
  • "mallId": 2,
  • "name": "Lojas Americanas",
  • "legalName": "Lojas Americanas SA",
  • "logo": "string",
  • "location": "L13",
  • "receberCurriculo": true,
  • "emBreve": true,
  • "complement": "Loja",
  • "contactName": "João da Silva",
  • "contactPhone": "11111111111",
  • "email": "[email protected]",
  • "type": "loja",
  • "active": true,
  • "cnpj": "30621140000148",
  • "phones": [
    ],
  • "lucs": [
    ],
  • "segmentId": 1,
  • "activityIds": [
    ],
  • "additionalLegalEntities": [
    ],
  • "customFields": {
    },
  • "metadata": "String"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "mallId": 1,
  • "cnpj": "30621140000148",
  • "name": "Lojas Americanas",
  • "email": "[email protected]",
  • "customFields": {
    },
  • "metadata": "String"
}

Get Stores

Returns a list of stores.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get All Stores

Get All Stores

Authorizations:
x-access-token
path Parameters
mallId
required
string
Example: 820

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Best Store

Get best Stores

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{
  • "store_id": 1,
  • "name": "Lojas Americanas"
}

Find Store

Find a Store .

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
mallId
integer

MallId where the store is located

name
string

Store's name

Responses

Request samples

Content type
application/json
{
  • "mallId": 2,
  • "name": "Lojas Americanas"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "mall_id": 2,
  • "name": "Lojas Americanas",
  • "legal_name": "Lojas Americanas SA",
  • "stand_number": "1234",
  • "logo": "string",
  • "location": "L13",
  • "receber_curriculo": true,
  • "em_breve": true,
  • "complement": "loja",
  • "contactName": "Lucas",
  • "contactPhone": "11111111111",
  • "email": "[email protected]",
  • "type": "loja",
  • "active": true,
  • "cnpj": "30621140000148",
  • "phones": [
    ],
  • "activities": [
    ],
  • "mcc_activity_id": 5,
  • "employee_register_id": 5,
  • "employee_update_id": 5,
  • "register_date": "2021-05-17T15:05:22.691Z",
  • "last_update": "2021-05-17T15:05:22.691Z",
  • "average_ticket": 1,
  • "external_id": 1,
  • "coalition_pin": 1,
  • "coalition_id": 1,
  • "customFields": {
    },
  • "additionalLegalEntities": [
    ],
  • "metadata": "String"
}

Search Stores

Returns a list of stores filtered by a search string.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

name
string
Example: name=mc

Store's name

email
string

Store's e-mail.

legalName
string
Example: legalName=SERVIÇOS LTDA

Store's legal name.

cnpj
string

Store's CNPJ.

standNumber
string
Example: standNumber=L12

Store's stand number.

location
string
Example: location=2F

Store's location.

category
string
Example: category=1

Store's category.

subcategories
string
Example: subcategories=6,7

Store's subcategories IDs. To search in more than one field, the names of field must be separated by commas(,).

active
string
Enum: "true" "false"
Example: active=true

Store's status

page
string
Example: page=1

Page number when searching with pagination.

limitByPage
string
Example: limitByPage=50

Length of list per page with pagination.

limit
string
Example: limit=300

Length of list without pagination.

sortBy
string
Default: "id"
Enum: "name" "legalName" "type" "cpf" "email" "mobileNumber" "id"

Customer Property to order response list. (ENUM: 'name', 'cpf', 'email', 'mobileNumber').

order
string
Default: "desc"
Enum: "asc" "desc"
_fields
string
Example: _fields=Instagram,Twitter

Custom fields to search a keyword. To search in more than one field, the names of field must be separated by commas(,).

_keyword
string
Example: _keyword=@search

Keyword to search in the custom fields.

_display
string
Example: _display=cpf,fullName,address.zipCode,customFields.rg

List of properties to be displayed on response. To search in more than one field, the names of field must be separated by commas(,). PS: To select subproperties must be sended 'property.subproperty'. Ex: address.zipCode

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 1
}

AutoComplete

AutoComplete

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

search
required
string
Example: search=6

Mall ID

page
string
Example: page=1

Page number when searching with pagination.

limitByPage
string
Example: limitByPage=50

Length of list per page with pagination.

limit
string
Example: limit=300

Length of list without pagination.

sortBy
string
Enum: "name" "legalName" "cnpj" "email"

Store Property to order response list. (ENUM: 'name', 'legalName', 'cnpj', 'email').

active
string
Enum: "true" "false"

Store's status. (ENUM: 'true', 'false').

order
string
Default: "desc"
Enum: "asc" "desc"
_display
string
Example: _display=fullName,cnpj,name

Responses

Response samples

Content type
application/json
{
  • "id": 423,
  • "name": "MC DONALD'S",
  • "legalName": "MC DONALD'S LTDA",
  • "slug": "MC",
  • "receberCurriculo": true,
  • "emBreve": true,
  • "type": "loja",
  • "cnpj": 93457203000192,
  • "logo": "https://exemple.blob.core.windows.net/exemple/lojas/mc.png",
  • "email": "[email protected]",
  • "active": true,
  • "phones": [
    ],
  • "url": "example.com",
  • "facebook": "@store",
  • "instagram": "@store",
  • "products": "",
  • "presentation": {
    },
  • "storeluc": [
    ],
  • "additionallegalentities": [
    ],
  • "activities": [
    ]
}

AutoCompleteReduced

AutoCompleteReduced

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

search
required
string
Example: search=6

Mall ID

page
string
Example: page=1

Page number when searching with pagination.

limitByPage
string
Example: limitByPage=50

Length of list per page with pagination.

limit
string
Example: limit=300

Length of list without pagination.

sortBy
string
Enum: "name" "legalName" "cnpj" "email"

Store Property to order response list. (ENUM: 'name', 'legalName', 'cnpj', 'email').

active
string
Enum: "true" "false"

Store's status. (ENUM: 'true', 'false').

order
string
Default: "desc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
{
  • "id": 423,
  • "name": "MC DONALD'S",
  • "legalName": "MC DONALD'S LTDA",
  • "cnpj": 93457203000192
}

Update Store

Update a Store.

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 820

Store ID

query Parameters
mallId
required
string
Example: mallId=1

Mall ID

Request Body schema: application/json
id
integer

Store ID

mallId
required
integer

MallId where the store is located

name
required
string

Store's legal name

legalName
required
string

Store's name

logo
string

Store's Logo

location
string

Store stand number

receberCurriculo
boolean

If the store wants to receive a resume

emBreve
boolean

If the store is going to open soon

complement
string

Store complement information

contactName
required
string

Name to contact

contactPhone
required
string

Number to contact

email
required
string <email>

Email address

type
required
string
Enum: "loja" "quiosque"

Store's type

active
required
boolean

If store are active

cnpj
string

Store's CNPJ

phones
required
Array of strings
segmentId
required
number
lucs
Array of integers[ items ]
activityIds
required
Array of numbers[ items ]
Array of objects[ items ]
object
metadata
string

The store's answer to de custom property.

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "mallId": 2,
  • "name": "Lojas Americanas",
  • "legalName": "Lojas Americanas SA",
  • "logo": "string",
  • "location": "L13",
  • "receberCurriculo": true,
  • "emBreve": true,
  • "complement": "Loja",
  • "contactName": "João da Silva",
  • "contactPhone": "11111111111",
  • "email": "[email protected]",
  • "type": "loja",
  • "active": true,
  • "cnpj": "30621140000148",
  • "phones": [
    ],
  • "segmentId": 1,
  • "lucs": [
    ],
  • "activityIds": [
    ],
  • "additionalLegalEntities": [
    ],
  • "customFields": {
    },
  • "metadata": "String"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "mallId": 1,
  • "cnpj": "30621140000148",
  • "name": "Lojas Americanas",
  • "email": "[email protected]"
}

Get Store

Get Stores

Authorizations:
x-access-token
path Parameters
storeId
required
string
Example: 6

Store ID

query Parameters
mallId
required
string
Example: mallId=1

Mall ID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "mall_id": 2,
  • "name": "Lojas Americanas",
  • "legal_name": "Lojas Americanas SA",
  • "stand_number": "1234",
  • "logo": "string",
  • "location": "L13",
  • "receber_curriculo": true,
  • "em_breve": true,
  • "complement": "loja",
  • "contactName": "Lucas",
  • "contactPhone": "11111111111",
  • "email": "[email protected]",
  • "type": "loja",
  • "active": true,
  • "cnpj": "30621140000148",
  • "phones": [
    ],
  • "segmentId": 5,
  • "activityIds": [
    ],
  • "lucs": [
    ],
  • "additionalLegalEntities": [
    ],
  • "employee_register_id": 5,
  • "employee_update_id": 5,
  • "register_date": "2021-05-17T15:05:22.691Z",
  • "last_update": "2021-05-17T15:05:22.691Z",
  • "average_ticket": 1,
  • "external_id": 1,
  • "coalition_pin": 1,
  • "coalition_id": 1,
  • "customFields": {
    },
  • "metadata": "String"
}

Update store active

Update store active

Authorizations:
x-access-token
path Parameters
storeId
required
string
Example: 6

Store ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
active
required
boolean

field to update store operating status

Responses

Request samples

Content type
application/json
{
  • "active": true
}

Upseart Shopkeeper

Create or Update Shopkeeper.

Authorizations:
x-access-token
path Parameters
storeId
required
string
Example: 20

Store ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
One of
One of
clientId
required
integer

Existing customer id

name
string

Shopkeeper name

cpf
string
phone
string

Shopkeeper phone

email
string <email>

Shopkeeper email

relationshipType
required
string
Value: "PROPRIETÁRIO(A)"
idStorePosition
integer
dtaAdmission
string <date>

Shopkeeper admission date

dtaEnd
string <date>

shopkeeper disabling date

statusShopkeeper
string
Default: "active"
Enum: "active" "inactive"

shopkeeper status

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": 52
}

Get Shopkeepers

Get shopkeepers by storeId.

Authorizations:
x-access-token
path Parameters
storeId
required
string
Example: 20

Store ID

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
string
Example: limit=300

Length of list without pagination.

search
string
Example: search=FUNCIONÁRIO

Search parameter: 'cpf' OU 'name' OU 'nme relationshiptype' OU 'nme storeposition'

validity
string
Value: "valid"
Example: validity=valid

search for valid benefit records

limitByPage
string
Example: limitByPage=5

Limit of itens per page.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Enum: "id" "idStore" "IdClient" "idRelationshiptype" "idStoreposition" "dtaRegister" "dtaAdmission" "dtaEnd" "flgContact"

Property to order response list.

statusShopkeeper
string
Enum: "active" "inactive"

Search by shopkeeper status

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Disable Shopkeeper

Disable Shopkeeper.

Authorizations:
x-access-token
path Parameters
storeId
required
string
Example: 20

Store ID

shopkeeperId
required
string
Example: 20

Shopkeeper id

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
dtaEnd
string <date>

shopkeeper's dismissal date

Responses

Request samples

Content type
application/json
{
  • "dtaEnd": "2019-08-24"
}

Get Shopkeeper

Get shopkeeper

Authorizations:
x-access-token
path Parameters
storeId
required
string
Example: 20

Store ID

shopkeeperId
required
integer
Example: 5

shopkeeper ID

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "John Doe",
  • "cpf": "string",
  • "clientId": 0,
  • "phone": "999999999",
  • "email": "[email protected]",
  • "relationshipType": "PROPRIETÁRIO(A)",
  • "idStorePosition": 12,
  • "dtaAdmission": "2019-08-24",
  • "dtaEnd": "2019-08-24",
  • "statusShopkeeper": "inactive"
}

Store Positions

Find all store positions.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Store relationship types

Find all store relationship types.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Available Lucs

Get Available Lucs

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=820

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Luc

Upsert Luc

Register or update a new Luc .

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
object
floorId
required
integer

id of the ground where the luc will be raised

Responses

Request samples

Content type
application/json
{
  • "luc": {
    },
  • "floorId": 7
}

Get Lucs

Get lucs

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
string
Example: limit=300

Length of list without pagination.

search
string
Example: search=Piso 3

Search parameter: 'luc name' OU 'floor name'

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Enum: "floorId" "lucId" "lucName"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Disable Luc

Disable luc

Authorizations:
x-access-token
path Parameters
lucId
required
string
Example: 4

luc ID

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Get Luc

Get luc

Authorizations:
x-access-token
path Parameters
lucId
required
string
Example: 4

luc ID

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "A88",
  • "floor": {
    }
}

Get Floors

Get floors by mall ID

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Report Menu

Upsert Report Menu

Register a new report menu or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
name
required
string

Name report menu.

order
required
integer

Report menu order.

Responses

Request samples

Content type
application/json
{
  • "id": 56,
  • "name": 17,
  • "order": 3
}

Response samples

Content type
application/json
{
  • "id": 34
}

Get Reports Menu

Lists many active report menu records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Default: "numOrder"
Enum: "id" "numOrder" "name"

Property to order response list.

search
string

Search by name.

fallback
string
Enum: "true" "false"

Prioritizes the return of custom report menus if the mall does not return a standard report menu.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Report Menu

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Report menu ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "message": "O menu de relatório informado não foi encontrado."
}

Get Report Menu

Lists one active report menu record by mall.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Report menu id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 56,
  • "name": 17,
  • "order": 3
}

Report

Upsert Report

Register a new report or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
Any of
tooltip
integer

Additional explanation about the report.

order
integer

Report order.

queryString
required
string

Report query string.

reportMenuId
integer

report menu ID.

numberColumns
required
integer
Enum: 6 8 12 24

Occupancy of the report on the grid.

name
required
string

Report name.

chartType
required
string
Enum: "area" "bar" "horizontalBar" "line" "number" "pie" "radar" "table"

chart type

Responses

Request samples

Content type
application/json
{
  • "id": 56,
  • "tooltip": "relatorio que busca a quantidade de clientes que entraram no programa de fidelidade nmos ultimos 7 dias",
  • "order": 3,
  • "queryString": "SELECT COUNT(DISTINCT column) FROM table;",
  • "reportMenuId": 5,
  • "numberColumns": 6,
  • "name": "string",
  • "chartType": "area"
}

Response samples

Content type
application/json
{
  • "id": 34
}

Get Reports

Lists many active report records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Default: "numOrder"
Enum: "id" "numOrder" "name"

Property to order response list.

search
string

Search by name.

fallback
string
Enum: "true" "false"

Prioritizes the return of customized reports, if the mall has not returned standard reports.

reportMenuId
string

Filter records by report menu ID

chartType
string
Enum: "area" "bar" "horizontalBar" "line" "number" "pie" "radar" "table"

Filter records by chart type.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Report

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Report ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "message": "O relatório informado não foi encontrado."
}

Get Report

Lists one active report record by mall.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Report id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "tooltip": "relatorio que busca a quantidade de clientes que entraram no programa de fidelidade nmos ultimos 7 dias",
  • "order": 3,
  • "queryString": "SELECT COUNT(DISTINCT column) FROM table;",
  • "reportMenu": {
    },
  • "numberColumns": 6,
  • "name": "string",
  • "chartType": "area"
}

Report Entity

Get Report Entity

Lists many report entity records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Default: "name"
Enum: "id" "name"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Report Administrator

Load Administratot Report

Load a administrator report.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
query
string

Responses

Request samples

Content type
application/json
{
  • "query": "{\"limit\":500}"
}

Response samples

Content type
application/json
{
  • "query": { },
  • "data": { },
  • "lastRefreshTime": "2022-08-11T12:55:12.988Z",
  • "annotation": { },
  • "dataSource": "default",
  • "dbType": "snowflake",
  • "external": false,
  • "slowQuery": false
}

Script Navegation

Upsert Script Navegation

Register a new script navegation or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

scriptId
required
integer
Example: scriptId=90

Script campaign ID.

Request Body schema: application/json
One of
nextStageId
integer

Next stage ID.

order
required
integer

Order number

navigationText
required
string

Navegation Text

stageId
required
integer

Stage ID.

Responses

Request samples

Content type
application/json
{
  • "id": 345,
  • "nextStageId": 780,
  • "order": 1,
  • "navigationText": "Horário de Atendimento:",
  • "stageId": 45
}

Response samples

Content type
application/json
{
  • "id": 34
}

Get Script Navegation

Lists many script navegation records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

scriptId
required
integer
Example: scriptId=90

Script campaign ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Default: "numOrder"
Enum: "id" "numOrder"

Property to order response list.

nextStageId
string

Filter to return the next navigation script

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Script Navegation

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Script Navegation ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

scriptId
required
integer
Example: scriptId=90

Script campaign ID.

Responses

Response samples

Content type
application/json
{
  • "message": "A navegação informada não foi encontrada."
}

Get Script Navegation

Lists one active script navegation record by mall and script campaign.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Script navegation id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

scriptId
required
integer
Example: scriptId=90

Script campaign ID.

Responses

Response samples

Content type
application/json
{
  • "id": 345,
  • "nextStageId": 780,
  • "order": 1,
  • "stageId": 45,
  • "scriptId": 67,
  • "navigationText": "Horário de Atendimento:"
}

Script Stage

Upsert Script Stage

Register a new script stage or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

scriptId
required
integer
Example: scriptId=90

Script campaign ID.

Request Body schema: application/json
One of
stageText
required
string

Stage Text

Responses

Request samples

Content type
application/json
{
  • "id": 345,
  • "stageText": "Em frete a loja Aquamar"
}

Response samples

Content type
application/json
{
  • "id": 34
}

Get Script Stage

Lists many script stage records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

scriptId
required
integer
Example: scriptId=90

Script campaign ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Default: "numOrder"
Enum: "id" "numOrder"

Property to order response list.

nextStageId
string

Filter to return the next navigation script

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Script Stage

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Script Stage ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

scriptId
required
integer
Example: scriptId=90

Script campaign ID.

Responses

Response samples

Content type
application/json
{
  • "message": "A etapa do roteiro de atendimento informada não foi encontrada."
}

Get Script Stage

Lists one active script stage record by mall and script campaign.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Report id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

scriptId
required
integer
Example: scriptId=90

Script campaign ID.

Responses

Response samples

Content type
application/json
{
  • "id": 345,
  • "scriptId": 780,
  • "stageText": "Em frete a loja Aquamar"
}

Script

Upsert Script

Register a new script or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
name
required
string

Script Name

stageStartId
required
integer

stage start ID.

Responses

Request samples

Content type
application/json
{
  • "id": 345,
  • "name": "ATENDIMENTO VIA PARQUE",
  • "stageStartId": 0
}

Response samples

Content type
application/json
{
  • "id": 34
}

Get Scripts

Lists many script records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "numOrder"
Enum: "id" "numOrder"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Script

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Script Stage ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "A etapa do roteiro de atendimento informada não foi encontrada."
}

Get Script

Lists one active script record by mall and script campaign.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Script id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 345,
  • "name": "ATENDIMENTO VIA PARQUE",
  • "stageStartId": 170
}

Script Campaign

Get Script Campaigns

Lists many script campaign records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "numOrder"
Enum: "id" "numOrder"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Get Script Campaign

Lists one active script record by mall and script campaign.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Script campaign ID to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 345,
  • "name": "ATENDIMENTO VIA PARQUE",
  • "description": "string",
  • "dateBegin": "2019-08-24T14:15:22Z",
  • "dateEnd": "2019-08-24T14:15:22Z",
  • "script": {
    }
}

Persona

Upsert Persona

Register a new persona or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
Any of
name
required
string

Persona name.

description
string

Persona description/tooltip.

query
required
string

Persona query string cubejs.

Responses

Request samples

Content type
application/json
Example
create
create
update
{
  • "name": "Lojista",
  • "description": "description persona",
  • "query": "SELECT COUNT(DISTINCT column) FROM table;"
}

Response samples

Content type
application/json
{
  • "id": 34
}

Get Personas

Lists many active persona records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "name"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Persona

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Persona ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "message": "A persona informada não foi encontrada."
}

Get Persona

Lists one active persona record by mall.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Persona id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "query": "SELECT COUNT(DISTINCT column) FROM table;",
  • "name": "string",
  • "default": true,
  • "readonly": true,
  • "description": "string"
}

Promotion

Upsert Promotion

Register a new promotion or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
name
string

Promotion name.

imageURL
string

Promotion image URL.

disclaimer
string

Promotion disclaimer.

startDate
string

Promotion start date.

endDate
string

Promotion end date.

exchangeValue
integer

Amount that should be spent in order to exchange for a ticket

extendedFields
string

extended fields in JSON Object string format

regulationURL
string

Regulation details.

indicatesSeller
boolean

Flag to indicate seller

issueCoupon
string

Flag to indicate coupon issuance.

issueGifts
boolean

Flag to indicate gifts issuance.

luckyNumber
boolean

Flag to indicate lucky number.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": 34
}

Get Promotions

Lists many active promotion records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
active
string
Default: "true"
Enum: "true" "false"

Property to response list active or inactive promotions.

Responses

Response samples

Content type
application/json
{}

Delete Promotion

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Promotion ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "message": "A promoção informada não foi encontrada."
}

Get Promotion

Lists one active promotion record by mall.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Promotion id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{}

Quiz

Upsert quiz

Register a new quiz or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
name
required
string

Quiz name.

startDateTime
required
string <date-time>

Date on which the quiz will be made available to customers.

endDateTime
string <date-time>

Date the survey will be closed to customers.

order
integer

Order in which the questionnaire will appear in the list in relation to the others.

Responses

Request samples

Content type
application/json
{
  • "id": 102,
  • "name": "Questionario natalino 2022.",
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z",
  • "order": 5
}

Response samples

Content type
application/json
{
  • "id": 34
}

List Quizzes

Lists many active quizzes records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Default: "order"
Enum: "id" "name" "order" "startDateTime" "endDateTime"

Property to order response list.

search
string

Search by name.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Quiz

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Quiz ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "message": "O questionario informado não foi encontrado."
}

Get Quiz

Lists one active quiz record by mall.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Quiz id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 5,
  • "name": "Questionario natalino 2022.",
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z",
  • "order": 2
}

Questions

Upsert questions

Register a new question in a quiz or update a record.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

quizId
required
string
Example: quizId=34

quiz ID

Request Body schema: application/json
One of
question
required
string

New question for the quiz.

visible
required
boolean

Used to show or not show a question in the form used by the user

mandatory
required
boolean

Says if the question is mandatory

order
required
integer

Says the order of the question in a quiz

typeId
required
integer

The type of answer button

Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "id": 469,
  • "question": "Você pretende vir ao shopping no natal ?.",
  • "questionOptions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 34
}

List Questions

List many active quiz questions

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

quizId
required
integer
Example: quizId=6

Quiz ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Default: "order"
Enum: "id" "order"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Question

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Question ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
Example
QUESTION_OPTION_NOT_FOUND
QUESTION_OPTION_NOT_FOUND
QUIZ_NOT_FOUND
QUESTION_NOT_FOUND
{
  • "message": "A opção de pergunta informada não foi encontrada."
}

Get Question

Lists one active quiz record by mall.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Quiz id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 2,
  • "question": "Você pretende vir ao shopping no natal ?.",
  • "visible": true,
  • "mandatory": true,
  • "order": 4,
  • "type": {
    },
  • "questionOptions": [
    ]
}

Question Options

Delete Question Option

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Question ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
Example
QUESTION_OPTION_NOT_FOUND
QUESTION_OPTION_NOT_FOUND
QUIZ_NOT_FOUND
QUESTION_NOT_FOUND
{
  • "message": "A opção de pergunta informada não foi encontrada."
}

Question Types

List of button types answer a question

List many active types answer question

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Default: "order"
Enum: "id" "type"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Quiz answers

Create Quiz Answer

Register a new quiz Answer.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

quizId
required
string
Example: quizId=34

quiz ID

clientId
required
string
Example: clientId=34

client ID

Request Body schema: application/json
One of
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "answerQuestions": [
    ]
}

Response samples

Content type
application/json
Example
QUESTION_NOT_FOUND
QUESTION_NOT_FOUND
QUIZ_NOT_FOUND
{
  • "message": "A pergunta informada não foi encontrada."
}

List of quiz answers by customer

List of quiz answers by customer

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

quizId
integer

Quiz ID.

clientId
integer
Example: clientId=67

client ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

mOS-store: Sales Declaration

Create sales declaration

Registers a sales declaration.

Authorizations:
x-access-token
query Parameters
storeId
required
string
Example: storeId=5

Store ID

Request Body schema: application/json
salesDeclarationDate
required
string <date>

sales declaration date

salesValue
required
number

sales value

auditedValue
number

audited value

Responses

Request samples

Content type
application/json
{
  • "salesDeclarationDate": "2021-05-04",
  • "salesValue": 123888.85,
  • "auditedValue": 123888.85
}

List many sales declarations

list many sales declarations

Authorizations:
x-access-token
query Parameters
limit
integer
Example: limit=300

Length of list without pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
month
integer
Example: month=5

filter month number.

year
integer
Example: year=2020

filters by year.

storeId
required
integer
Example: storeId=101

filters by storeId.

sortBy
string
Default: "id"
Enum: "id" "storeId" "salesDeclarationDate" "salesValue" "auditedValue"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

List a sales declaration

list a sales declaration

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

sales declaration ID to be filtered

query Parameters
storeId
required
integer
Example: storeId=6

The ID of the associated store.

Responses

Response samples

Content type
application/json
{
  • "id": 11,
  • "storeId": 101,
  • "salesValue": 150582.89,
  • "auditedValue": 150582.89,
  • "salesDeclarationDate": "2021-08-10"
}

Update sales declation

Update a sales declaration.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

sales declaratin ID to be filtered

query Parameters
storeId
required
string
Example: storeId=5

Store ID

Request Body schema: application/json
storeId
number

store ID

salesValue
number

sales value

auditedValue
number

audited value

salesDeclarationDate
string <date>

sales declaration date

Responses

Request samples

Content type
application/json
{
  • "storeId": 101,
  • "salesValue": 150582.89,
  • "auditedValue": 150582.89,
  • "salesDeclarationDate": "2021-08-10"
}

mOS-mall: Sales Declaration

List many sales declarations

list many sales declarations

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
integer
Example: limit=300

Length of list without pagination.

page
string
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
startDate
string
Example: startDate=2021-05-19

Start date to be searched.

endDate
string <date>
Example: endDate=2021-07-18

End date to be searched.

storeId
integer
Example: storeId=101

filters by storeId.

sortBy
string
Default: "id"
Enum: "id" "storeId" "salesDeclarationDate" "salesValue" "auditedValue"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

List a sales declaration

list a sales declaration

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

sales declaration ID to be filtered

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 11,
  • "storeId": 101,
  • "salesValue": 150582.89,
  • "auditedValue": 150582.89,
  • "salesDeclarationDate": "2021-08-10"
}

Audits the value of the sales declaration.

audit a sales declaration.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

sales declaratin ID to be filtered

query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
auditedValue
required
number

audited value

Responses

Request samples

Content type
application/json
{
  • "auditedValue": 150582.89
}

Babycare

Get Babycare Visits

Get All babycare

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

search
string
Example: search=Joãozinho Silva

Search by customer name or baby name

startDate
string
Example: startDate=2021-05-19

Start date to be searched.

endDate
string <date>
Example: endDate=2021-07-18

End date to be searched.

limit
string
Example: limit=300

Length of list without pagination.

limitByPage
string
Example: limitByPage=5

Limit of itens per page.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Enum: "id" "dateTime" "customerName" "childName" "score"

Property to order response list. (ENUM: 'dateTime', 'customerName', 'childName', 'score').

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 1
}

Create babycare visit (upsert)

Create a babycare visit

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

Request Body schema: application/json
object

Babycare object request

object or object or object or object
object

Custom fields object request

Responses

Request samples

Content type
application/json
{
  • "babycare": {
    },
  • "customer": { },
  • "customFields": {
    }
}

Response samples

Content type
application/json
{
  • "babyCare": {
    }
}

Get babycare visit by ID

Return a babycare visit

Authorizations:
x-access-token
path Parameters
babycareId
required
string
Example: 552

babycare ID

query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "babycare": {
    },
  • "customer": {
    },
  • "customFields": {
    }
}

Get activity types

Return all activity types

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Babycare Graphics

Get visits heatmap

Return a babycare heatmap

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

selectedMallIds
required
string
Example: selectedMallIds=1,2,3

The IDs of the associateds malls.

offset
string
Default: "week"
Enum: "today" "week" "month" "year"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get categories pizza

Return babycare categories pizza

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

selectedMallIds
required
string
Example: selectedMallIds=1,2,3

The IDs of the associateds malls.

offset
string
Default: "today"
Enum: "today" "week" "month" "year"

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Get visits bars

Return babycar visits bars data

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

selectedMallIds
required
string
Example: selectedMallIds=1,2,3

The IDs of the associateds malls.

offset
string
Default: "today"
Enum: "today" "week" "month" "year"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get recurrence

Return the recurrence data

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

selectedMallIds
required
string
Example: selectedMallIds=1,2,3

The IDs of the associateds malls.

offset
string
Default: "week"
Enum: "today" "week" "month" "year"

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get average consumption

Return the average consumption

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

selectedMallIds
required
string
Example: selectedMallIds=1,2,3

The IDs of the associateds malls.

offset
string
Default: "today"
Enum: "today" "week" "month" "year"

Responses

Response samples

Content type
application/json
{
  • "reais": 1
}

Get conversions

Return the conversions

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

selectedMallIds
required
string
Example: selectedMallIds=1,2,3

The IDs of the associateds malls.

offset
string
Default: "today"
Enum: "today" "week" "month" "year"

Responses

Response samples

Content type
application/json
{
  • "conversions": 1
}

Babycare Usage Types

List Many babycare usage types.

List Many registers of babycare usage types.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Enum: "id" "name"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 1000
}

Insert a babycare usage type.

Insert a new babycare usage type.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

Request Body schema: application/json
name
string

babycare usage type name.

Responses

Request samples

Content type
application/json
{
  • "name": "banho"
}

List a babycare usage type.

List a register of babycare usage type.

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 6

babycare usage type ID.

query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 12,
  • "name": "troca de fralda"
}

Delete a babycare usage type.

Delete a register of babycare usage type (logical exclusion).

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 6

babycare usage type ID

query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

Responses

Transaction

Get Transactions

Returns a list of transactions.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
string
Example: limit=300

Length of list without pagination.

limitByPage
string
Example: limitByPage=5

Limit of itens per page.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "cnpj" "cpf" "invoiceDate" "invoiceNumber" "value" "qrcodeUrl" "imageUrl" "invoiceSerialNumber"

Property to order response list.

clientId
string
Example: clientId=3

Search parameter: 'clientId'

recordReturnType
string
Value: "all"

Attention! when passing the value 'all', the response may take a while as it will return all records from all possible sources.

startDateTime
string <date-time>
Example: startDateTime=2021-10-25T23:00:00Z

Filter by invoice start date

endDateTime
string <date-time>
Example: endDateTime=2021-11-20T23:00:00Z

Filter by invoice end date

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 20
}

Create Transaction Reversal

Reverse an approved transaction.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
clientId
required
integer

client ID

transactionId
required
integer

Transaction ID

Responses

Request samples

Content type
application/json
{
  • "clientId": 409,
  • "transactionId": 34
}

Get Transaction by code

Returns a transaction record.

Authorizations:
x-access-token
path Parameters
codeTransaction
required
string
Example: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d

uuid record to filter transaction.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Register Transaction

Registers a new transaction.

The 'originId' must be retrieved from Get Origins

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Request Body schema: application/json
Any of
id
integer
originId
required
integer
storeId
integer
cnpj
required
string
clientId
integer
cpf
string
invoiceNumber
required
string
invoiceSerialNumber
string
value
number
invoiceDate
string <date-time>
customFields
object
metadata
string
qrcodeUrl
string <uri>
imageUrl
string <uri>

Responses

Request samples

Content type
application/json
{
  • "id": 22,
  • "originId": 10,
  • "storeId": 45,
  • "cnpj": "95858430000155",
  • "clientId": 678,
  • "cpf": "33847651099",
  • "invoiceNumber": "string",
  • "invoiceSerialNumber": "5632",
  • "value": 1050,
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "customFields": { },
  • "metadata": "string",
  • "qrcodeUrl": "http://example.com",
  • "imageUrl": "http://example.com"
}

Response samples

Content type
application/json
{
  • "codeTransaction": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"
}

Get QRCode Infos

Returns a QRCode infos.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

qrCodeUrl
required
string
Example: qrCodeUrl=6700703807216330880636;76001;2022-08-18T12:18:13.978-03:00;812e31e0091d44eaadfc8dd19bc70e63;76301:179162;33220802952485001897650070001791621321004551

QRCode string value.

Responses

Response samples

Content type
application/json
{
  • "invoiceDate": "2018-11-07T02:00:00.000Z",
  • "invoiceNumber": "010432",
  • "invoiceSerialNumber": "14406358000123",
  • "cnpj": "11111111111111",
  • "value": 29.8,
  • "imageUrl": "6700703807216330880636;76001;2022-08-18T12:18:13.978-03:00;812e31e0091d44eaadfc8dd19bc70e63;76301:179162;33220802952485001897650070001791621321004551"
}

Transaction Backoffice

Get transaction

Returns transaction list.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

statusId
string
Example: statusId=2

Status ID

clientId
string
Example: clientId=62837

Client ID

employeeId
string
Example: employeeId=1000

Employee ID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "statusId": 2,
  • "reason": {
    },
  • "status": {
    },
  • "employee": {
    },
  • "client": {
    },
  • "store": {
    },
  • "registerDate": "2021-09-17 10:47:07.372155",
  • "imageUrl": "https://lambda-bucket-image-test-resized.s3.amazonaws.com/123.jpg"
}

Get Next Transaction

Returns next backoffice transaction.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{}

Count transactions by Status

Returns transaction count.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Release backoffice transaction

Release backoffice transaction.

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 1

Transaction ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Suspend backoffice transaction

Suspend backoffice transaction.

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 1

Transaction ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Denie backoffice transaction

Denie backoffice transaction

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
id
integer
reasonId
integer

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "reasonId": 2
}

Approve backoffice transaction

Approve backoffice transaction

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
id
integer
storeId
integer
invoiceNumber
string
invoiceSerialNumber
string
purchaseDate
string
purchaseValue
integer
paymentTypeId
integer

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "storeId": 2,
  • "invoiceNumber": "2JS492NVJ23DV",
  • "invoiceSerialNumber": "5678",
  • "purchaseDate": "2021-09-17 10:47:07.372155",
  • "purchaseValue": 230.3,
  • "paymentTypeId": 2
}

Get denied reasons

Returns denied reasons.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get payment types

Returns payment types.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Benefits

Upsert Benefit

Register a new benefit or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
name
required
string

Name of the new benefit.

valRecharge
number

Unit to recharge benefits for rechargeable benefits.

programId
required
integer

Loyalty program ID.

storeId
integer

Store id associated with the benefit.

description
string

Benefit description.

voucherText
string or null

Returns the html of the voucher if the benefit is printed, otherwise it will be returned null.

voucherDescription
string or null

voucher description.

amountStock
number

It is necessary to fill in the value of the benefit in stock if the stockable flag is true.

usageRule
string

Description of the benefit use rule.

categoryId
integer

Benefit category id.

Array of objects[ items ]

Array of properties of the association between benefit and modality.

Responses

Request samples

Content type
application/json
Example
createBenefit
createBenefit
updateBenefit
{
  • "name": "prato eliana kertész",
  • "programId": 3,
  • "storeId": 2,
  • "description": "string",
  • "usageRule": "string",
  • "amountStock": 2000,
  • "valRecharge": 10.8,
  • "voucherText": "<section>n <strong>BENEFÍCIO:</strong>&nbsp;{{redeemName}}<br/>n <strong>NOME DO CLIENTE:</strong>&nbsp;{{customer.fullName}}<br/>n <strong>CPF:</strong>&nbsp;{{customer.cpf}}<br/>n <strong>CÓDIGO DA TROCA:</strong>&nbsp;{{voucherId}}<br/>n <strong>DATA RESGATE:</strong>&nbsp;{{redeemDate}}<br/>n</section>n<section>n <strong>ATENDENTE:</strong>&nbsp;{{employee.name}}<br/>n <strong>INFORMAÇÕES GERAIS:</strong>&nbsp;{{redeemDescription}}<br/>n <strong>Autorizo que sejam descontados {{redeemPoints}} pontos do Programa Solar em<br/>n troca do benefício {{redeemName}} e estou de <br/>acordo com as regras de utilização do mesmo.n </strong><br/>n <strong>NOME DO CLIENTE:</strong>&nbsp;{{customer.fullName}}<br/>n <strong>CPF:</strong>&nbsp;{{customer.cpf}}<br/>n <strong>CÓDIGO DA TROCA:</strong>&nbsp;{{voucherId}}<br/>n <strong>DATA RESGATE:</strong>&nbsp;{{redeemDate}}<br/>n <strong>Saldo de Pontos {{balance}} em {{date}}</strong><br/>n <strong>ASSINATURA DO CLIENTE:</strong>&nbsp;__________________________________n </section>",
  • "voucherDescription": "voucher description",
  • "categoryId": 5,
  • "modalities": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 67
}

Get Benefits

Lists many active benefit records by mall.

Authorizations:
x-access-token
query Parameters
programId
required
integer
Example: programId=6

Program ID.

mallId
required
integer
Example: mallId=6

Associated mall ID.

clientId
string
Example: clientId=20022
modalityId
string
Example: modalityId=2
categoryId
string
Example: categoryId=2
stock
string
Enum: "true" "false"
Example: stock=true
limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

search
string
Example: search=Americanas S.A

Search parameter: 'categorieName OU storeName OU benefitName'

rechargable
string
Value: "rechargable"
Example: rechargable=rechargable

search by benefit rechargable

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "name"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 2265,
  • "pagination": {
    }
}

Delete Benefit

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Benefit ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Get Benefit

Lists one active benefit record by mall.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Benefit id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 56,
  • "name": "prato eliana kertész",
  • "description": "string",
  • "amountStock": 3000,
  • "valRecharge": 10.8,
  • "store": {
    },
  • "category": {
    },
  • "modalities": [
    ]
}

Get Categories

Lists Many benefit category records per mall.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Default: "benefitCategoryName"
Enum: "benefitCategoryName" "benefitCategoryId"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Get Available Benefits

Lists many Available benefit records by mall.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

clientId
required
string
Example: clientId=20022
programId
integer
Example: programId=6

Program ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "name"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 2265,
  • "pagination": {
    }
}

Redeem Benefit

Redeem Benefit

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6
Request Body schema: application/json
clientId
required
integer
benefitId
required
integer
quantity
required
integer

Responses

Request samples

Content type
application/json
{
  • "clientId": 20022,
  • "benefitId": 25,
  • "quantity": 2
}

Response samples

Content type
application/json
{
  • "id": [
    ],
  • "redeemDate": "2019-08-24T14:15:22Z",
  • "withdrawn": true,
  • "benefit": {
    },
  • "quantity": 0
}

List Redeemed Benefit Operations

List Redeemed Benefit Operations.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

clientId
required
integer

Client ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Enum: "redeemDate" "quantity"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Get Redeemed Benefit Operation

Get Redeemed Benefit Operation.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Redeemed benefit operation id.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "redeemDate": "2019-08-24T14:15:22Z",
  • "withdrawn": true,
  • "benefit": {
    },
  • "quantity": 0
}

Get Benefits Inventory Statement

Lists benefit inventory statement records by mall.

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 1
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

type
string
Enum: "SAIDA" "ENTRADA" "RESGATE"
redeem
boolean
Enum: true false
order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Enum: "registerDate" "amount"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 14,
  • "balance": 20
}

Create Benefit Inventory Registry

Register a new benefit inventory registry.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
benefitId
required
integer

Benefit identifier

amount
required
integer

Registry amount

description
required
string

Registry description

type
required
string
Enum: "ENTRADA" "SAIDA"

Registry type

Responses

Request samples

Content type
application/json
{
  • "benefitId": 1,
  • "amount": 130,
  • "description": "Aumento de estoque.",
  • "type": "ENTRADA"
}

Get Benefit Redeem Voucher Content

Get Benefit Redeem Voucher Content.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
benefitId
required
integer

Benefit identifier

voucherId
required
integer

Voucher identifier

required
object or object
redeemDate
string <date-time>

start date and time alert filter.

shelflifeDate
string <date>

start date and time alert filter.

balance
string

Responses

Request samples

Content type
application/json
{
  • "benefitId": 1,
  • "voucherId": 1,
  • "customer": { },
  • "redeemDate": "2022-01-04T17:05:25.000Z",
  • "shelflifeDate": "2022-01-04",
  • "balance": "2000"
}

Response samples

Content type
application/json
{
  • "voucher": "<html></html>"
}

Create Benefit Return

Return of benefits

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
clientId
required
integer

Cliente ID.

benefitRescueId
required
integer

Benefit rescue ID.

amount
required
integer

Quantity to be returned.

Responses

Request samples

Content type
application/json
{
  • "clientId": 1787,
  • "benefitRescueId": 56,
  • "amount": 4
}

Withdraw a redeemed benefit

Withdraw a redeemed benefit

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6
Request Body schema: application/json
clientId
required
integer
redeemId
required
integer

redeem ID.

Responses

Request samples

Content type
application/json
{
  • "clientId": 20022,
  • "redeemId": 25
}

Modalities

Upsert Modality

Register a new modality or update a register. Modalities are the levels of participation of a customer in a loyalty program

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
name
required
string

Name of the new modality.

priorityNumber
integer

ascending/descending order of modalities.

programId
required
integer

Loyalty program ID.

minimumPoints
number

Minimum points to reach the level.

expirationDays
integer

Days for Points Expiration. (required for "Point Expiration" mode only)

expirationMonths
integer

Months for Points Expiration. (required for "Point Expiration" mode only)

expirationEndMonth
required
boolean

To expire at the end of the month.

pointsRescue
number

Enabled, the customer drops out of mode when he loses points.

resettablePoints
required
integer

Enables zero points when being demoted.

daysAvalition
integer

Days window for points evaluation. (Required only for “Score date” mode)

initialModality
boolean

If the modality will be initial.

returnable
boolean

If the modality will be returnable.

previusModalityId
integer

Previous modality ID.

nextModalityId
integer

Next modality ID.

minimunPointsToNextModality
integer

Minimum score to move up the modality

loyaltyPoints
required
boolean

When it is possible to score on loyalty

walletPoints
required
boolean

When it is possible to score on wallet

Responses

Request samples

Content type
application/json
Example
createModality
createModality
updateModality
{
  • "name": "Ouro",
  • "programId": 3,
  • "minimumPoints": 20000,
  • "expirationDays": 30,
  • "expirationMonths": 2,
  • "expirationEndMonth": true,
  • "pointsRescue": 40000,
  • "resettablePoints": false,
  • "daysAvalition": 20,
  • "initialModality": true,
  • "returnable": true,
  • "previusModalityId": null,
  • "nextModalityId": 1,
  • "minimunPointsToNextModality": 30000,
  • "loyaltyPoints": true,
  • "walletPoints": false
}

Response samples

Content type
application/json
{
  • "id": 67
}

Get Modalities

Lists many active Modalities records by mall.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

programId
required
integer
Example: programId=6

Program ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

search
string
Example: search=Ouro

Search parameter: 'modality name'

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "name"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Modality

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Modality ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Get Modality

Lists one active modality record by mall and modality ID.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Modality ID to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 56,
  • "name": "PRATA",
  • "priorityNumber": 1,
  • "programId": 3,
  • "minimumPoints": 2000,
  • "expirationDays": 20,
  • "expirationMonths": 4,
  • "expirationEndMonth": false,
  • "pointsRescue": 4000,
  • "resettablePoints": true,
  • "daysAvalition": 10,
  • "initialModality": false,
  • "returnable": true,
  • "minimunPointsToNextModality": 3000,
  • "loyaltyPoints": true,
  • "walletPoints": false,
  • "nextModality": {
    },
  • "previousModality": {
    }
}

Check Modalities Health

Return health of program modalities.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

programId
required
integer
Example: programId=6

Program ID to be filtered.

Responses

Response samples

Content type
application/json
{
  • "health": false,
  • "errors": [
    ]
}

Programs

Upsert Program

Register a new loyalty Program or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
name
required
string

Name of the new program.

loyaltyTypeId
required
integer

Loyalty type ID.

startDate
required
string <date>

Loyalty program start date.

endDate
string <date>

Loyalty program end date.

extraPoint
required
boolean

Extra point limit number.

maxExtraPoint
number

maximum number of extra points.

maxAmountExtraPoint
number
cpfMandatory
required
boolean

Flag to say that CPF is mandatory to participate in the loyalty program.

invoiceNumberMandatory
required
boolean

Flag to say that the invoice number is required to participate in the loyalty program.

acceptanceTermMandatory
boolean

Flag to say that the acceptance term is required to participate in the loyalty program.

qrCodeReader
boolean

Flag to say that the acceptance QRCode reader in the loyalty program.

Responses

Request samples

Content type
application/json
Example
createProgram
createProgram
updateProgram
{
  • "name": "Programa de fidelidade 2022 do shopping Spot",
  • "loyaltyTypeId": 5,
  • "startDate": "2022-01-24",
  • "endDate": "2022-12-24",
  • "extraPoint": true,
  • "maxExtraPoint": 20000,
  • "cpfMandatory": 5,
  • "maxAmountExtraPoint": 67,
  • "invoiceNumberMandatory": false,
  • "acceptanceTermMandatory": true
}

Response samples

Content type
application/json
{
  • "id": 67
}

Get Programs

Lists many active Loyalty programs records by mall.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
startDate
string <date>

Search by start date.

endDate
string <date>

search by end date.

sortBy
string
Default: "id"
Enum: "id" "name" "extraPoint" "invoiceNumberMandatory" "cpfMandatory"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Get Program Term

Return the loyalty program terms.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

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

Get Program

Lists one active loyalty program record by mall.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Loyalty program ID to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 56,
  • "name": "Programa de fidelidade 2022 do shopping Spot",
  • "loyaltyType": {
    },
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "extraPoint": true,
  • "maxExtraPoint": 5000,
  • "maxAmountExtraPoint": 67,
  • "cpfMandatory": true,
  • "invoiceNumberMandatory": true,
  • "acceptanceTermMandatory": true,
  • "qrCodeReader": true
}

Get Programs Types

Lists Many progrma types records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Default: "programTypeName"
Enum: "programTypeId" "programTypeName"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Statement

Get Client Loyalty Statement

Get Client Loyalty Statement

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6
clientId
required
string
Example: clientId=20522
limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
startDateTime
string <date>
endDateTime
string <date>
isExpirationDate
string
Enum: "true" "false"
type
string
Enum: "COMPRA" "PONTOS-EXTRAS" "DEBITO" "RESGATE-BENEFICIO"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "total": 2265
}

Status

Get Client Loyalty Status

Get Client Loyalty Status

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6
clientId
required
string
Example: clientId=20522

Responses

Response samples

Content type
application/json
{
  • "balance": {
    },
  • "points": {
    },
  • "modalities": [
    ],
  • "isRegistered": true
}

Rechargeable Benefits

Upsert Rechargeable Benefit

Register a new rechargeable Benefit or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
clientId
required
integer

Client ID.

rechargeableBenefitTypeId
required
integer

Rechargeable benefit type ID.

codRechargeableBenefit
required
integer

Customer rechargeable benefit identification code.

dscRechargeableBenefit
required
integer

Description of the customer's rechargeable benefit.

dteExpiration
string <date>

Expiry date of the customer's rechargeable benefit.

Responses

Request samples

Content type
application/json
Example
createBenefit
createBenefit
updateBenefit
{
  • "clientId": 1777,
  • "rechargeableBenefitTypeId": 1,
  • "codRechargeableBenefit": "2199567985",
  • "dscRechargeableBenefit": "string",
  • "dteExpiration": "2022-05-08"
}

Response samples

Content type
application/json
{
  • "id": 67
}

Get Rechargeable Benefits

Lists many active rechargeable benefit records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "dteExpiration"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 2265,
  • "pagination": {
    }
}

Delete Rechargeable Benefit

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Rechargeable Benefit ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Get Rechargeable Benefit

Lists one active rechargeable benefit record by mall.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Rechargeable Benefit id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "clientId": 1777,
  • "rechargeableBenefitTypeId": 2,
  • "type": {
    },
  • "codRechargeableBenefit": "CESRS-00104",
  • "dscRechargeableBenefit": "string",
  • "dteExpiration": "2019-08-24",
  • "active": true
}

Get Rechargeable Benefit Types

Lists Many rechargeable Benefit type records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "asc"
Enum: "asc" "desc"
sortBy
string
Default: "name"
Enum: "name" "id"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Get Rechargeable Benefits By Client Id

Lists many active rechargeable benefit records by client id.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

clientId
required
integer
Example: clientId=1777

Client ID.

rechargeableBenefitTypeId
integer
Example: rechargeableBenefitTypeId=90

Rechargeable benefit type ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "dteExpiration"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 2265,
  • "pagination": {
    }
}

Points

Create Credit

Grant credit in the wallet or loyalty points program.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
clientId
required
integer

client ID

amountPoints
required
number

amount of points to be credited

description
required
string

field to describe the reason

type
string or null
Enum: "balancePoints" "loyaltyPoints"

Responsible for saying the type of credit (wallet or loyalty). If not sent, none of the types will be credited to the wallet and loyalty points program.

Responses

Request samples

Content type
application/json
{
  • "clientId": 409,
  • "amountPoints": 300,
  • "description": "string",
  • "type": "balancePoints"
}

Create Debit

Debit points from a customer's wallet.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
clientId
required
integer

client ID

description
required
string

field to describe the reason

amountPoints
required
number

amount of points to be credited.

Responses

Request samples

Content type
application/json
{
  • "clientId": 409,
  • "description": "string",
  • "amountPoints": 300
}

Customer

Upsert Client

Register or Update a client.

Authorizations:
x-access-token
Request Body schema: application/json
Any of
id
required
integer

A client indentifier.

cpf
string

A brazilian's unique citizen identifier.

fullName
string

A full name.

birthday
string <date>

A date following the format (YYYY-MM-DD).

sex
string
Enum: "F" "M" "O"

A character representing the sex.

mobileNumber
string

A mobile number.

homePhone
string

A home phone

email
string

An email address.

mallId
integer

The ID of the associated mall.

originRegistryId
integer

Origin's ID of the client's registration.

object
object
metadata
string

The customer's answer to de custom property.

object

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "cpf": "54084425788",
  • "fullName": "João Alfredo",
  • "birthday": "2015-07-28",
  • "sex": "M",
  • "mobileNumber": "21987659999",
  • "homePhone": "2140028922",
  • "email": "[email protected]",
  • "mallId": 6,
  • "originRegistryId": 2,
  • "address": {
    },
  • "customFields": {
    },
  • "metadata": "String",
  • "signatures": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "cpf": "54084425788",
  • "fullName": "João Alfredo",
  • "birthday": "2015-07-28",
  • "sex": "F",
  • "mobileNumber": "21987659999",
  • "homePhone": "2140028922",
  • "email": "[email protected]",
  • "mallId": 6,
  • "originRegistryId": 2,
  • "address": {
    },
  • "customFields": {
    },
  • "metadata": "String",
  • "signatures": {
    }
}

Search Customer

Search customer using search parameter

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID.

cpf
string
Example: cpf=19217190012

CPF parameter.

name
string
Example: name=Joao

Customer name parameter.

email
string

Customer email parameter.

mobileNumber
string
Example: mobileNumber=21987673647

Customer mobile number parameter.

modality
string
Enum: "true" "false" "force"
Example: modality=true

When to return the object of the loyalty modality. The 'force' mode has the same behavior as 'true' but won't return the client data if it is not associated with a loyalty modality. The 'force' mode only works if the cpf parameter is sent.

page
string
Example: page=1

Page number when searching with pagination.

limitByPage
string
Example: limitByPage=50

Length of list per page with pagination.

limit
string
Example: limit=300

Length of list without pagination.

sortBy
string
Default: "id"
Enum: "name" "cpf" "email" "mobileNumber" "id"

Customer Property to order response list. (ENUM: 'name', 'cpf', 'email', 'mobileNumber').

order
string
Default: "desc"
Enum: "asc" "desc"
_fields
string
Example: _fields=Instagram,Twitter

Custom fields to search a keyword. To search in more than one field, the names of field must be separated by commas(,).

_keyword
string
Example: _keyword=@search

Keyword to search in the custom fields.

_display
string
Example: _display=cpf,fullName,address.zipCode,customFields.rg

List of properties to be displayed on response. To search in more than one field, the names of field must be separated by commas(,). PS: To select subproperties must be sended 'property.subproperty'. Ex: address.zipCode

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 1
}

Get Client

Returns an object representing a client.

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 12324

Client's ID.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

modality
string
Enum: "true" "false" "force"
Example: modality=true

When to return the object of the loyalty modality. The 'force' mode has the same behavior as 'true' but won't return the client data if it is not associated with a loyalty modality.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "cpf": "54084425788",
  • "fullName": "João Alfredo",
  • "birthday": "2015-07-28",
  • "address": {
    },
  • "sex": "F",
  • "mobileNumber": "21987659999",
  • "homePhone": "2140028922",
  • "email": "[email protected]",
  • "customFields": {
    },
  • "metadata": "String",
  • "signatures": {
    }
}

Auto Complete Customer

Search customer using search parameter

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

search
required
string
Example: search=João Silva

Search parameter (name or CPF)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Dependent

Create Dependents

Register a new dependent.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
responsibleId
required
integer

responsible customer id.

required
Array of objects or objects[ items ]

depentent customer data.

Responses

Request samples

Content type
application/json
{
  • "responsibleId": 3678,
  • "dependents": [
    ]
}

Response samples

Content type
application/json
Example
RESPONSIBLE_NOT_FOUND
RESPONSIBLE_NOT_FOUND
MANDATORY_DATA_RESPONSIBLE_ABSENT
DEPENDENT_NOT_FOUND
DEPENDENCE_DEGREE_ALREADY_EXISTS
DEGREEKINSHIP_NOT_FOUND
GENDER_INCOMPATIBLE
{
  • "message": "O responsável informado não foi encontrado."
}

update dependency relationship

update dependency relationship.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
responsibleId
required
integer

responsible customer id.

required
Array of objects[ items ]

depentent customer data.

Responses

Request samples

Content type
application/json
{
  • "responsibleId": 3678,
  • "dependents": [
    ]
}

Response samples

Content type
application/json
Example
RESPONSIBLE_NOT_FOUND
RESPONSIBLE_NOT_FOUND
MANDATORY_DATA_RESPONSIBLE_ABSENT
DEPENDENT_NOT_FOUND
DEPENDENCE_DEGREE_NOT_EXISTS
DEGREEKINSHIP_NOT_FOUND
GENDER_INCOMPATIBLE
{
  • "message": "O responsável informado não foi encontrado."
}

List Dependents

Lists many dependents records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

responsibleId
required
integer
Example: responsibleId=6

Responsible customer ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Value: "id"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Get Dependent

Get dependent

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

resposibleId
required
integer
Example: resposibleId=8

Responsible customer ID.

Responses

Response samples

Content type
application/json
{
  • "id": 4580,
  • "name": "Enzo",
  • "birthDate": "2010-04-01",
  • "genre": "M",
  • "degreekinship": {
    }
}

Degree kinship types

List Degree kinship types

Lists many Degreekinship types records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "name"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Get Degree kinship

Get Degree kinship

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

Responses

Response samples

Content type
application/json
{
  • "id": 4580,
  • "name": "mãe"
}

Customer Credit Cards

Create Credit Card

Register a client credit card.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
cardNumber
string

The card number

flagName
string

The card flag name

clientId
integer

The client identifier

Responses

Request samples

Content type
application/json
{
  • "cardNumber": "5555.XXXX.XXXX.4444",
  • "flagName": "MASTERCARD",
  • "clientId": 20450
}

List Credit Cards

List client credit cards.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID.

page
string
Example: page=1

Page number when searching with pagination.

limit
string
Example: limit=300

Length of list without pagination.

sortBy
string
Default: "id"
Enum: "cardNumber" "flagName"

Customer Property to order response list. (ENUM: 'name', 'cpf', 'email', 'mobileNumber').

order
string
Default: "desc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 1
}

Delete Credit Card

Delete a client credit card.

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 10

Credit card ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

clientId
required
string
Example: clientId=2384

Client ID

Responses

Journey Studio

Upsert Journey Studio

Upsert Journey Entity.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

mallAdministratorId
integer
Example: mallAdministratorId=6

Associated mall administrator ID.

Request Body schema: application/json
name
required
string
active
required
boolean
startDateTime
string
personaId
number
clusterId
number
object or object or object

Responses

Request samples

Content type
application/json
{
  • "name": "First Journey",
  • "active": true,
  • "startDateTime": "2021-12-26T17:38:23.056Z",
  • "personaId": 3,
  • "clusterId": 1,
  • "node": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Jornada está sendo criada."
}

Get All Journeys

Get All Journeys.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

mallAdministratorId
integer
Example: mallAdministratorId=6

Associated mall administrator ID.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 1
}

Get Full Journey

Get Full Journey.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 15

Journey ID.

query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

Responses

Response samples

Content type
application/json
{
  • "name": "First Journey",
  • "active": true,
  • "startDateTime": "2021-12-26T17:38:23.056Z",
  • "personaId": 3,
  • "published": true,
  • "clusterId": 1,
  • "node": {
    }
}

Journey Types

Get Action Conector Types

Get Action Conector Types.

Authorizations:
x-access-token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Interval Conector Types

Get Interval Conector Types.

Authorizations:
x-access-token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Condition Conector Types

Get Condition Conector Types.

Authorizations:
x-access-token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Conditional Operator Conector Types

Get Conditional Operator Conector Types.

Authorizations:
x-access-token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Journey Cluster

Upsert Journey Cluster

Upsert Journey Cluster.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

Request Body schema: application/json
id
required
number
name
required
string
expirationDate
required
string <date-tme>

start date and time alert filter.

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "name": "First Journey",
  • "expirationDate": "2022-01-04T17:05:25.000Z"
}

Response samples

Content type
application/json
{
  • "message": "Jornada está sendo criada."
}

Get All Journey CLusters

Get All Journey CLusters.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

name
string
Example: name=clusterName

Cluster name.

startDateTime
string
Example: startDateTime=2022-01-04T17:05:25.000Z

Start date to be searched.

endDateTime
string
Example: endDateTime=2022-01-04T17:05:25.000Z

End date to be searched.

limit
string
Example: limit=300

Length of list without pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Enum: "id" "name" "expirationDate"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 1
}

Get All Journey CLusters

Get All Journey CLusters.

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 2

Cluster ID.

query Parameters
mallId
required
string
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "clusterName",
  • "expirationDate": "2022-05-23T15:17:40.338Z",
  • "mallId": 5
}

Custom Fields

Get Custom Form by Entity

Get customized form of shopping by Entity.

Authorizations:
x-access-token
query Parameters
entityId
required
string
Example: entityId=1

Entity ID

mallId
required
string
Example: mallId=6

Mall ID

limit
string
Example: limit=20

Limit by page

page
string
Example: page=6

Page

order
string
Enum: "asc" "desc"
Example: order=asc

Order 'asc' or 'desc'

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 2
}

Upsert Custom Form Field

Creates a Field to Custom Form

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
id
number

Custom field identifier

visibleToPlatform
required
boolean

If field is visible to mOS Platform

entityId
required
number

Entity ID

name
required
string

Name of field

label
required
string

Label to be present on the form

tooltip
string

Field's tooltip

numOrder
number

Order number field

required
boolean

If field is required the fill

required
object or object

Responses

Request samples

Content type
application/json
Example
customFieldWithGroupType
customFieldWithGroupType
customFieldWithSingleType
{
  • "visibleToPlatform": true,
  • "entityId": 1,
  • "name": "Field Name",
  • "label": "Field Label",
  • "tooltip": "Tooltip",
  • "required": true,
  • "fieldType": {
    },
  • "grouperId": 4
}

Response samples

Content type
application/json
{
  • "id": 1
}

Delete Custom Form Field by ID

Delete a Field to Custom Form by ID

Authorizations:
x-access-token
path Parameters
fieldId
required
string
Example: 820

Field ID

query Parameters
entityId
string
Example: entityId=1

Entity ID

mallId
string
Example: mallId=5

Mall ID

fieldName
string
Example: fieldName=whatsapp

Field Name

Responses

Custom Fields Types

Get All Field Types

Get All Field Types.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Custom Fields Grouper

Get All Field Groupers

Get All Field Types.

Authorizations:
x-access-token
query Parameters
entityId
string
Example: entityId=1

Entity ID

mallId
string
Example: mallId=6

Mall ID

limit
string
Example: limit=20

Limit by page

page
string
Example: page=6

Page

order
string
Enum: "asc" "desc"
Example: order=asc

Order 'asc' or 'desc'

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Create Field Groupers

Create Field Types.

Authorizations:
x-access-token
query Parameters
mallId
string
Example: mallId=6

Mall ID

Request Body schema: application/json
name
string

Grouper's name

label
string

Grouper's label

numOrder
integer

Grouper's order

entityId
string

entity's Id. Ex: 1 = Client Entity, 2 = Store Entity

Responses

Request samples

Content type
application/json
{
  • "name": "socialMedia",
  • "label": "Redes Sociais",
  • "numOrder": 1,
  • "entityId": 1
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete Field Grouper by ID

Delete a Field Grouper by ID

Authorizations:
x-access-token
path Parameters
grouperId
required
string
Example: 820

Grouper ID

query Parameters
mallId
string
Example: mallId=6

Mall ID

entityId
string
Example: entityId=1

Entity ID

Responses

Custom Fields Positions

Create Field Position

Create Field Types.

Authorizations:
x-access-token
query Parameters
mallId
string
Example: mallId=6

Mall ID

entityId
string
Example: entityId=1

Entity ID

Request Body schema: application/json
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "fieldsPositions": [
    ]
}

Custom Fields Answer

Register Client Answer With Hash

Register Client Answer With Hash

Authorizations:
x-access-token
path Parameters
hash
required
string
Example: 551e34a8-dc3f-4a5e-81db-fb5ba243ab39

Client Hash

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "customFields": {
    }
}

Login

Login

Sign to receive a access token

Request Body schema: application/json
email
required
string

Customer e-mail

password
required
string

Customer password

token
string

Token two factor authentication

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "name": "Jorge",
  • "area": "Spot",
  • "isMosMallRegistered": true,
  • "isMosStoreRegistered": false,
  • "tfa": true
}

Refresh Token

Sign to receive a new access token

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Change Password

Request Password Change

Request change password E-mail

Request Body schema: application/json
email
required
string

Customer e-mail

Responses

Request samples

Content type
application/json
{}

Verify Hash

Verify HASH

path Parameters
hash
required
string
Example: IT8EPO2J4LDHS84J

Responses

Change Password

Verify HASH

path Parameters
hash
required
string
Example: IT8EPO2J4LDHS84J
Request Body schema: application/json
email
required
string

Customer e-mail

password
required
string

Customer password

confirmPassword
required
string

Customer password

Responses

Request samples

Content type
application/json
{}

Permissions

Get Permissions

Get all permissions of Customer.

Authorizations:
x-access-token

Responses

Response samples

Content type
application/json
{
  • "malls": [
    ]
}

Update Permissions

Update de User Permissions

Authorizations:
x-access-token
Request Body schema: application/json
employeeMallId
required
number

Employee ID that must be updated

Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "employeeMallId": 1,
  • "mallRoles": [
    ]
}

Response samples

Content type
application/json
{
  • "employee": {
    }
}

Update Role Permissions

Update de Role Permissions

Authorizations:
x-access-token
Request Body schema: application/json
id
required
number

Role ID

mallId
required
number

Mall's ID where that role must be updated

required
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "mallId": 1,
  • "mallRolePermissions": [
    ]
}

MOS-Store Permissions

Get Permissions

Get all permissions of Customer.

Authorizations:
x-access-token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Users

Create user

Creates a new user.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
cpf
string
name
required
string
area
string
email
required
string
phone
string
password
required
string
roleId
required
integer

Responses

Request samples

Content type
application/json
{
  • "cpf": "54084425788",
  • "name": "João Silva",
  • "area": "Marketing",
  • "email": "[email protected]",
  • "phone": "21987654321",
  • "password": "s3nh4#@!",
  • "roleId": 22
}

Response samples

Content type
application/json
{
  • "id": 552,
  • "cpf": "54084425788",
  • "name": "João Silva",
  • "area": "Marketing",
  • "email": "[email protected]",
  • "phone": "21987654321",
  • "active": true
}

Read users

Read users

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

mall id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update user

Updates a user.

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 552

User ID

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
cpf
string
name
string
area
string
email
string
phone
string
password
string
roleId
integer
active
boolean

Responses

Request samples

Content type
application/json
{
  • "cpf": "54084425788",
  • "name": "João Silva",
  • "area": "Marketing",
  • "email": "[email protected]",
  • "phone": "21987654321",
  • "password": "s3nh4#@!",
  • "roleId": 22,
  • "active": false
}

Read user

Read user

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 552

User ID

query Parameters
mallId
required
string
Example: mallId=6

mall id

Responses

Response samples

Content type
application/json
{
  • "id": 552,
  • "cpf": "54084425788",
  • "name": "João Silva",
  • "area": "Marketing",
  • "email": "[email protected]",
  • "phone": "21987654321",
  • "active": true
}

Delete user

Delete user

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 552

User ID

query Parameters
mallId
required
string
Example: mallId=6

mall id

Responses

Update user own data

Updates a user own data.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
email
string
phone
string
password
string

Responses

Request samples

Content type
application/json
{}

Read user own data

Read user own data

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

mall id

Responses

Response samples

Content type
application/json
{
  • "id": 552,
  • "cpf": "54084425788",
  • "name": "João Silva",
  • "email": "[email protected]",
  • "phone": "21987654321"
}

profile-roles

Upsert Role

Register a new role or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
name
required
string

Role Name

permissionIds
Array of integers[ items ]

permissions IDs.

Responses

Request samples

Content type
application/json
{
  • "id": 345,
  • "name": "supervisor",
  • "permissionIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 34
}

Get Roles

Lists many role records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "name"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Role

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Role ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
Example
ROLE_NOT_FOUND
ROLE_NOT_FOUND
PROFILE_WITHOUT_PERMISSION
PRFILE_WITH_ACTIVE_EMPLOYEES
{
  • "status": 400,
  • "message": "O perfil informado não foi encontrado."
}

Get Role

Lists one active role record by mall

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Role id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 34,
  • "name": "Administrador",
  • "permissions": [
    ]
}

profile-permissions

Get Permissions

Lists many permission records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "name" "code"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Two Factor Authentication

Register two factor authentication

Register a two factor authentication for employee

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

The ID of the associated mall.

Request Body schema: application/json
employeeId
required
number

Employee ID

Responses

Request samples

Content type
application/json
{
  • "employeeId": 1000
}

Response samples

Content type
application/json
Example
notValidate
notValidate
validate
{
  • "verified": false,
  • "qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMQAAADECAYAAADApo5rAAAAAklEQVR4AewaftIAAAjkSURBVO3BQY4kyZEAQdVA/f/Lug0eHHZyIJBZPRyuidgfrLX+42GtdTystY6HtdbxsNY6HtZax8Na63hYax0Pa63jYa11PKy1joe11vGw1joe1lrHw1rreFhrHT98SOVvqviEyjdVvKEyVUwqv6niRmWq+ITK31TxiYe11vGw1joe1lrHD19W8U0qb6j8TSpTxaQyVUwqU8WkMlXcqHyiYlKZKj5R8U0q3/Sw1joe1lrHw1rr+OGXqbxR8YbKVHGjMlW8oTJVTCpTxU3FTcWk8kbFpPJGxW9SeaPiNz2stY6HtdbxsNY6fvgfozJVfELlEyo3FW9U3Ki8UTGpTCo3Ff9LHtZax8Na63hYax0/rFcqJpWbikllUvmmikllqnijYlKZVKaKf7OHtdbxsNY6HtZaxw+/rOKfpDJV3KhMFZPKTcWkMlXcqNxUvFExqUwVb1R8U8V/k4e11vGw1joe1lrHD1+m8k+qmFRuVKaKSWWqmFQ+oTJVTCo3KlPFpDJVTCpTxaQyVUwqU8WNyn+zh7XW8bDWOh7WWscPH6r4N1F5o+ITFW+oTBWTylRxUzGpvFExqUwVNxX/Jg9rreNhrXU8rLUO+4MPqEwVk8o3VdyoTBU3Km9U3KhMFZ9QuamYVKaKSeUTFW+ofFPFb3pYax0Pa63jYa11/PBlKlPFpDJVfFPFJyo+UTGpfKJiUvlExaQyVUwqk8pU8UbFjco/6WGtdTystY6Htdbxw5dVfELlpmJSeaNiqrhRuamYVG4qblRuKm4qJpWbipuKN1SmikllqnhD5abiEw9rreNhrXU8rLUO+4NfpDJV3KhMFW+oTBWTylTxm1RuKt5QmSpuVN6ouFGZKiaVqWJSeaNiUrmp+MTDWut4WGsdD2ut44cvU5kqJpWbikllqvhExaRyU3GjMlXcVEwqU8Wk8obKJ1SmihuVG5WbikllUpkqftPDWut4WGsdD2ut44cPqUwVb1TcVEwqU8U3VdyovFExqUwVk8obKp+o+ETFGyqTyidUpopPPKy1joe11vGw1jp++FDFjcpUMal8U8WkclMxqbxR8ZsqblRuKiaVSeWfVDGpTBWTylTxTQ9rreNhrXU8rLWOHz6kclPxRsWNyqTyRsUbFW+o3FRMKlPFjcpNxRsVn1CZKv7NHtZax8Na63hYax0/fKhiUvmEyk3FpDJVTCqTyk3Fv0nFpDJVTBWTyhsVv6niDZWp4hMPa63jYa11PKy1DvuDX6RyU/GGylTxTSo3FTcqU8WkMlVMKjcVk8obFTcqU8UnVN6ouFG5qfjEw1rreFhrHQ9rreOHD6ncVNyoTBWTyidUfpPKVDGp3KhMFW9UfEJlqphUPlExqbyhMlX8poe11vGw1joe1lrHD19WMalMFVPFTcWNylRxU3GjMlVMKjcqU8Wk8gmVT1RMFZPKVPEJlaliUnlD5abiEw9rreNhrXU8rLWOHz5UMam8ofKbKt6omFRuKm5UpopvqphUpopJZaq4UXmjYqq4qZhU/kkPa63jYa11PKy1jh++rOJGZar4JpVPVLyhMlW8oTJVTCpTxaRyo/KJiknlRuWmYlL5b/Kw1joe1lrHw1rr+OHLVG4qJpWpYlJ5o+JG5Y2KSeVG5Y2KSeWNiknlpuITFZPKTcUbFZPKVPGbHtZax8Na63hYax32B79I5aZiUpkqJpWpYlK5qfgmlaniRmWqmFQ+UTGp3FS8oTJVTCqfqJhU3qj4xMNa63hYax0Pa63D/uAXqdxUTCp/U8WNylQxqdxUTCo3FZPKP6niRuWmYlKZKm5Uporf9LDWOh7WWsfDWuv44ZdVTCo3FW+oTBWTyicq/iaVqWJSmSpuVKaKSWWquFGZKt6ouFGZKm5UpopPPKy1joe11vGw1jp++DKVqeITKlPFVDGpTBWTyidUpopJZVKZKm5UJpWpYlKZKm5UPlFxo3JTMalMFTcqU8U3Pay1joe11vGw1jp++LKKSWWquFGZKiaVqWKq+ITKVPGbVG4q3lCZKm5UblSmijcqJpUblanib3pYax0Pa63jYa112B98QOVvqnhD5W+qmFSmikllqphUpooblaniRuWfVDGp3FT8poe11vGw1joe1lrHD7+sYlKZKiaVqeKbKiaVqWJSeUNlqphUpopJ5UblmyreUJkqPqHyCZWp4hMPa63jYa11PKy1jh++rGJSuVGZKiaVNyp+U8WNyqQyVUwqU8WkclPxTSo3FZPKVHGjMlVMKjcqU8U3Pay1joe11vGw1jp++GUVk8pUMalMFZPKVPGbKiaVm4pJ5aZiUpkqJpUblZuKm4pJZVKZKiaVqWKqmFRuKm5UpopPPKy1joe11vGw1jrsDz6gMlXcqNxUTCpTxY3KGxWTylRxo/JNFb9J5RMVk8o/qeKbHtZax8Na63hYax32B/9iKlPFpHJT8YbKVPGGylRxozJVTCpvVNyoTBWTyk3FGypTxaQyVUwqU8UnHtZax8Na63hYax32Bx9Q+ZsqblQ+UfFNKm9U3KjcVHxC5aZiUpkqJpWpYlK5qZhUpopvelhrHQ9rreNhrXX88GUV36Ryo3JTMalMFZPKVDGpTBWfqJhUpoqbijdU/qaKNypuKiaVqeITD2ut42GtdTystY4ffpnKGxW/qWJSuVGZKj5RMalMFZ9QmSpuKiaVG5UblU+ovFHxTQ9rreNhrXU8rLWOH/6fq7hR+SaVG5WbipuKSWWquKl4Q2Wq+CaVG5Wp4hMPa63jYa11PKy1jh/+x1RMKjcVk8o3VUwqU8Wk8gmVqWJSuam4UblR+aaKSWWq+KaHtdbxsNY6HtZaxw+/rOI3VbxRMancVNyoTBW/SeWmYlL5hMpUMalMFW+oTBWTyt/0sNY6HtZax8Na6/jhy1T+JpWp4kZlqvhExaTyhspUMancVEwqNxU3KlPFpDJV/E0Vv+lhrXU8rLWOh7XWYX+w1vqPh7XW8bDWOh7WWsfDWut4WGsdD2ut42GtdTystY6HtdbxsNY6HtZax8Na63hYax0Pa63jYa11/B94M9SVeTaJgwAAAABJRU5ErkJggg=="
}

Disable two factor authentication

disable two-factor authentication for an employee

Authorizations:
x-access-token
path Parameters
employeeId
required
string
Example: 1000

Employee ID.

query Parameters
mallId
required
string
Example: mallId=5

The ID of the associated mall.

Responses

Users

Read users

Read users

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=6

mall id

sortBy
string
Example: sortBy=name

Sort by

order
string
Example: order=desc

Order by

search
string
Example: search=Joao

Name or Email

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Read user

Read user

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 552

User ID

query Parameters
mallId
required
string
Example: mallId=6

mall id

Responses

Response samples

Content type
application/json
{
  • "id": 552,
  • "cpf": "54084425788",
  • "name": "João Silva",
  • "area": "Marketing",
  • "email": "[email protected]",
  • "phone": "21987654321",
  • "active": true
}

Delete user

Delete user

Authorizations:
x-access-token
path Parameters
id
required
string
Example: 552

User ID

query Parameters
mallId
required
string
Example: mallId=6

mall id

Responses

Interaction

Register interaction

Register a new interaction

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "trackData": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Get interactions

Return all the interactions.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
string
Example: limit=300

Length of list without pagination.

page
string

identifies the current page

order
string
Default: "desc"
Enum: "asc" "desc"
startDateTime
string <dateTime>
endDateTime
string <dateTime>
name
string

filter by interaction name

sortBy
string
Default: "id"
Enum: "id" "startDate" "endDate"

Property to order response list. ('id', 'startDate', 'endDate').

clientId
string
Example:

Filter records by customer ID. Whenever you want to filter by customers, give preference to this filter instead of the 'search' filter.

trackType
string
Enum: "ATTENDANCE" "ONLINE" "PARKING" "WIFI" "CUSTOMER SERVICE" "LOAN" "BABYCARE" "LOST AND FOUND" "TELEMARKETING" "RELATIONSHIP ACTION" "APPLICATION" "MARKETPLACE" "LOYALTY" "PROMOTION" "QUIZ" "EMAIL TRACKING" "TRANSACTION" "PESQUISA"
Example: trackType=ATTENDANCE

Filter records by interaction type

search
string

Search by interaction description.

_display
string
Example: _display=trackData.track.trackType

property search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 3509
}

Get interaction types

Return all the interaction types.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

limit
string
Example: limit=300

Length of list without pagination.

page
string

identifies the current page

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "startDate" "endDate"

Property to order response list. (ENUM: 'id', 'name').

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 3509
}

Events Controller

Upsert Events

Register a new event or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

Request Body schema: application/json
One of
name
required
string

Name assigned to the Event

sessionController
required
boolean

If this field is checked, we will have control of the session day, start time and end time of the session, in addition to controlling how many people can participate in each session.

description
string

Description of the event.

minimumAge
integer

Field used to validate the participation of the responsible/dependent in the event.

maximumParticipationByDay
integer

If configured, the customer will only be able to participate the number of times configured in this field within the same day.

maximumParticipation
integer

If configured, the customer will only be able to participate the number of times configured in this field during the event period.

startDateTime
required
string <date-time>

Date that will be used to make the Event available for use, if the date is less than the informed date, the event will not be available.

endDateTime
string <date-time>

Date that will be used to remove the Event from the “air”, that is, it will no longer be available to be answered.

Responses

Request samples

Content type
application/json
{
  • "id": 102,
  • "name": "Mall innovation week",
  • "sessionController": true,
  • "description": "primeira Innovation Week 2022",
  • "minimumAge": 16,
  • "maximumParticipationByDay": 4,
  • "maximumParticipation": 7,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 34
}

List Events

Lists many active events records.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "name" "startDateTime" "endDateTime"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Event

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Event ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "message": "O evento informado não foi encontrado."
}

Get Event

Lists one active event record by mall.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Event id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

Responses

Response samples

Content type
application/json
{
  • "id": 102,
  • "name": "Mall innovation week",
  • "sessionController": true,
  • "description": "primeira Innovation Week 2022",
  • "minimumAge": 16,
  • "maximumParticipationByDay": 4,
  • "maximumParticipation": 7,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z"
}

Sessions Controller

Upsert Session

Register a new session or update a register.

Authorizations:
x-access-token
query Parameters
mallId
required
string
Example: mallId=5

Mall ID

eventId
required
string
Example: eventId=5

session-related event id

Request Body schema: application/json
One of
name
required
string

Name assigned to the session

visible
required
boolean

Field that will be used to show or not a session to be selected.

quantity
integer

Field that identifies the number of seats available for the registered session.

startDateTime
required
string <date-time>

Date and time that will be used to make the session date available to be used in an event, if the date and time is less than the current date, the session will not be available to be selected.

endDateTime
string <date-time>

Field to indicate the end date and time of a session.

Responses

Request samples

Content type
application/json
{
  • "id": 102,
  • "name": "Sessão de natal",
  • "visible": true,
  • "quantity": 30,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 98
}

List Sessions

List session records of an active event.

Authorizations:
x-access-token
query Parameters
mallId
required
integer
Example: mallId=6

Associated mall ID.

eventId
required
string
Example: eventId=5

session-related event id

limit
string
Example: limit=300

Length of list without pagination.

page
string
Default: "1"
Example: page=1

Page number when searching with pagination.

order
string
Default: "desc"
Enum: "asc" "desc"
sortBy
string
Default: "id"
Enum: "id" "name" "startDateTime" "endDateTime"

Property to order response list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 100
}

Delete Session

Logically delete an active record.

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 6

Session ID to be deleted.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

eventId
required
string
Example: eventId=5

session-related event id

Responses

Response samples

Content type
application/json
{
  • "message": "A sessão informada não foi encontrada."
}

Get Session

Returns a session record of an active event

Authorizations:
x-access-token
path Parameters
id
required
integer
Example: 90

Session id to be filtered.

query Parameters
mallId
required
integer
Example: mallId=6

The ID of the associated mall.

eventId
required
string
Example: eventId=5

session-related event id

Responses

Response samples

Content type
application/json
{
  • "id": 102,
  • "name": "Sessão de natal",
  • "visible": true,
  • "quantity": 30,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z"
}

Legado

Get Permissions

Get all permissions of Customer.

Authorizations:
x-access-token

Responses

Response samples

Content type
application/json
{
  • "malls": [
    ]
}

Login

Sign to receive a access token

Request Body schema: application/json
email
required
string

Customer e-mail

password
required
string

Customer password

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": 1,
  • "registerDate": "2020-02-02 00:00:00",
  • "name": "Emplyoee name",
  • "cpf": "999.999.999-99",
  • "email": "[email protected]",
  • "area": "Spot",
  • "phone": "21999999999",
  • "malls": [
    ]
}

MOS-Store Invite

MOS-Store-invite

Send MOS-Store's invite

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
email
required
string

Employee e-mail

profileId
required
integer

Profile which employee will have

storeId
required
integer

Store which employee will have access to

name
required
string

Employee's name

Responses

Request samples

Content type
application/json
{}

MOS-Store-verify-hash

Send MOS-Store's invite

path Parameters
hash
required
string
Example: e4c93fcd53c1b2da0b3382f13c830528

Hash

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Responses

Response samples

Content type
application/json
{
  • "isRegistered": true
}

MOS-Store-accept-invite-registered

Send MOS-Store's invite

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
hash
required
string

Confirmation Hash

email
required
string

Employee's e-mail

password
required
string

Employee's password

Responses

Request samples

Content type
application/json
{
  • "hash": "e4c93fcd53c1b2da0b3382f13c830528",
  • "email": "[email protected]",
  • "password": "***********"
}

Response samples

Content type
application/json
{
  • "message": "Usuário cadastrado com sucesso."
}

MOS-Store-accept-invite-registered

Send MOS-Store's invite

query Parameters
mallId
required
string
Example: mallId=6

Mall ID

Request Body schema: application/json
hash
required
string

Confirmation Hash

name
string

Employee's name

cpf
string

Employee's CPF

area
string

Employee's Area

phone
string

Employee's Phone

email
required
string

Employee's e-mail

password
required
string

Employee's password

Responses

Request samples

Content type
application/json
{
  • "hash": "e4c93fcd53c1b2da0b3382f13c830528",
  • "name": "Jake",
  • "cpf": "111.111.111-11",
  • "area": "TI",
  • "phone": "+5521999999999",
  • "email": "[email protected]",
  • "password": "***********"
}

Response samples

Content type
application/json
{
  • "message": "Usuário cadastrado com sucesso."
}

API's Audit

Get API's Logs

Get apis event logs

Authorizations:
x-access-token
query Parameters
mallId
string
Example: mallId=6

Mall ID

apiName
string
Enum: "AuthAPI" "CommunicationAPI" "DataAgreementAPI"
Example: apiName=AuthAPI

Mall ID

event
string
Enum: "Request" "Error"
Example: event=Request
method
string
Enum: "POST" "GET" "PUT" "DELETE" "PATCH"
Example: method=POST
employeeId
string
Example: employeeId=1000
fromInternalRequest
string
Example: fromInternalRequest=true
fromThirdParty
string
Example: fromThirdParty=true
url
string
Example: url=/mos/v1/communication-management/send-email
xPartnerkey
string
Example: xPartnerkey=2lnhP^Y$j%bF&o4EgQl18*xk!vMvSWGEnBfiB!VlbZxmPjYRA*

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 1
}