Insert/Update Entities
Deprecated
POST
/api
Last modified:2024-08-14 19:13:38
insertEntities_v3 web service.{
entitiesRecords: [
{
entities: {
entityCode: "",
entityType: "",
entitySubtype: "",
country: "",
description: "",
channel: "",
catalog: "",
region: "",
province: "",
ecommerceManagement: "",
mobileShopActive: "",
onlyDigital: ""
},
entityPeripheralsFtf: [
{
peripheralCode: "",
remoteIpAddress": "",
port": "",
description": ""
}],
entityPeripheralsPos: [{
peripheralCode: "",
remoteIpAddress: "",
description: "",
inStore: "",
digital: ""
}],
entityPeripheralsPrinters: [
{
peripheralCode: "",
remoteIpAddress: "",
description: "",
printerBrand: "",
printerModel: "",
printerFilling: "",
printerTaxation: "",
printerLoginType: "",
printerRoundingType: "",
paperWidth: "",
cashDrawer: ""
}
],
"registers":[
{
registerType: "",
registerCode: "",
ipAddress: ""
}
]
}
]
}
| Field | Type | Description | Mandatory |
|---|---|---|---|
| entityCode | Varchar(250) | Shop/store | ✓ |
| parentEntityCode | Int(20) | Trade entity | ✓ (if shops section valued) |
| entityType | Varchar(250) | Entity type (SHOP = Negozi, WRH = Magazzini) | ✓ |
| entitySubtype | Varchar(250) | Entity subtype | ✓ |
| country | Varchar(3) | ISO2 Initial of the country | ✓ |
| description | Varchar(250) | Description of the entity | ✓ (in insert) |
| channel | Varchar(250) | Channel code | |
| catalog | Varchar(250) | Catalog code | |
| region | Varchar(250) | Region code. (referenced on the relative master table) | |
| province | Varchar(3) | Province code. (referenced on the relative master table) | |
| ecommerceManagement | Char(1) | It indicates If the entity is managed in the ecommerce (default 'F') | |
| mobileShopActive | Char(1) | It indicates if the entity is active for mobile shop app. Values: ’T’ - store active for mobile shop ‘F’ - store not active for mobile shop, default 'F' | |
| onlyDigital | Char(1) | It indicates if the store can sell only by catalog and not by App. Values:’T’ - the store can sell only by catalog ‘F’ - the store can sell also by Mobile Shop app, default 'F' |
Note that the section is not mandatory, and can be an empty array. In case it is valued, it must be an array of objects composed as follows.
| Field | Type | Description | Mandatory |
|---|---|---|---|
| peripheralCode | Varchar(250) | Code of the peripheral | ✓ |
| remoteIpAddress | Varchar(100) | Remote IP address of the peripheral | ✓ |
| port | Decimal(5) | It indicates the port of the peripheral | ✓ |
| description | Varchar(250) | Description of the peripheral | ✓ (in insert) |
Note that the section is not mandatory, and can be an empty array. In case it is valued, it must be an array of objects composed as follows.
| Field | Type | Description | Mandatory |
|---|---|---|---|
| peripheralCode | Varchar(250) | Code of the peripheral | ✓ |
| remoteIpAddress | Varchar(100) | Remote IP address of the peripheral | ✓ |
| port | Decimal(5) | It indicates the port of the peripheral | ✓ |
| description | Varchar(250) | Description of the peripheral | ✓ (in insert) |
| keepSocketOpen | Char(1) | It indicates whether to keep the socket open (default 'F') | |
| printOnPos | Char(1) | It indicates if the receipt for the pos payment is printer on pos or in the cash software (default 'F') | |
| posManualValidation | Char(1) | It indicates if the POS is validated manually by the vendor or it is automatic. Values:’T’ - manual validation ‘F’ - automatic validation (default 'F') | |
| inStore | Char(1) | It indicates if active for channel inStore. Values:’T’ - active 'F' - disabled (default 'F') | |
| digital | Char(1) | It indicates if active for channel digital. Values:’T’ - active 'F' - disabled (default 'F') |
Note that the section is not mandatory, and can be an empty array. In case it is valued, it must be an array of objects composed as follows.
| Field | Type | Description | Mandatory |
|---|---|---|---|
| peripheralCode | Varchar(250) | Code of the peripheral | ✓ |
| remoteIpAddress | Varchar(100) | Remote IP address of the peripheral | ✓ |
| description | Varchar(250) | Description of the peripheral | ✓ (in insert) |
| printerBrand | Varchar(30) | It indicates the brand of the printer. Values:'DITRON','EPSON' | ✓ |
| printerModel | Varchar(50) | It indicates the model for the printer. | ✓ |
| printerFilling | Varchar(50) | It indicates where the round value for the total is applicated. Values:'FIRST': in the first item 'LAST': in the last item | ✓ |
| printerTaxation | Varchar(10) | It indicates the type of the taxation for the printer: Values: 'NONE' - 'RT' - 'RT2.0' | ✓ |
| printerLoginType | Varchar(10) | It indicates the type of login for the printer. Values:'NONE' - 'DIGEST' - 'BASE64' | ✓ |
| printerRoundingType | Varchar(10) | It indicates the type of rounding. Values:'FULL' - 'UP' - 'DOWN' | ✓ |
| paperWidth | Varchar(10) | It indicates the width of the paper in the printer. Values:'58MM' - '80MM' | ✓ |
| cashDrawer | Char(1) | It indicates if the printer has the cash drawer or not. Value 'T' - with cash drawer 'F' - no cash drawer | ✓ |
| printerUsername | Varchar(250) | It is the user for the access to the printer | ✓ (if password is set) |
| printerPassword | Varchar(250) | It is the password for the access to the printer | ✓ (if username is set) |
Note that the section is not mandatory, and can be an empty array. In case it is valued, it must be an array of objects composed as follows.
| Field | Type | Description | Mandatory |
|---|---|---|---|
| registerType | Varchar(250) | Type of register (SHOP,MOBILE_SHOP) | ✓ |
| registerCode | Int | Code of the register | ✓ |
| ipAddress | Varchar(250) | Remote IP address of the register | ✓ |
| description | Varchar(250) | Description of the register (default 'Shop'+registerCode) | |
| firebaseToken | Varchar(250) | Token of firebase for send notify to register |
Request
Query Params
Header Params
Body Params application/json
Request Code Samples
Responses
Modified at 2024-08-14 19:13:38