Data Models and Parameter Constraints
Configuration
| Field | Type | Required | Min Length | Max Length |
|---|---|---|---|---|
| basketType | string | ✓ | 1 | 255 |
| eCommerceUrl | string | - | 1 | 255 |
| basketUrl | string | - | 1 | 255 |
| customerGetUrl | string | - | 1 | 255 |
| customerPostUrl | string | - | 1 | 255 |
| paymentSucceededUrl | string | - | 1 | 255 |
| payoutSucceededUrl | string | - | 1 | 255 |
| paymentCancelledUrl | string | - | 1 | 255 |
| paymentFailedUrl | string | - | 1 | 255 |
| eInvoiceCreatedUrl | string | - | 1 | 255 |
| eInvoiceCancelledUrl | string | - | 1 | 255 |
| intentUrl | string | - | 1 | 255 |
| odealRequestKey | string | - | 1 | 255 |
Add Employees
| Field | Type | Required | Min Length | Max Length |
|---|---|---|---|---|
| employeeReferenceCode | string | ✓ | 1 | 255 |
| name | string | ✓ | 1 | 255 |
| surname | string | ✓ | 1 | 255 |
| gsmNumber | string | - | 10 | 10 |
| identityNumber | string | - | 11 | 11 |
| mailAddress | string | - | 1 | 50 |
Save Product
| Field | Type | Required | Min Length | Max Length |
|---|---|---|---|---|
| unitId | bigInt | ✓ | 1 | - |
| name | string | ✓ | 1 | 255 |
| description | string | ✓ | 1 | 255 |
| referenceCode | string | ✓ | 1 | 10 |
| grossPrice | decimal | ✓ | 1 | 9999999999 |
| vatRatio | int | ✓ | 1 | Max Int |
| vatDescription | string | ✓ | 1 | 255 |
| sctRatio | double | ✓ | 1 | 1 |
| sctDescription | string | ✓ | 1 | 255 |
| barcodes | Array of strings | - | 1 | 2147483647 |
Save Customer
| Field | Type | Required | Min Length | Max Length |
|---|---|---|---|---|
| referenceCode | string | ✓ | 1 | 255 |
| type | string | ✓ | 1 | 255 |
| title | string | ✓ | 1 | 255 |
| name | string | - | 1 | 255 |
| surname | string | - | 1 | 255 |
| taxOffice | string | - | 1 | 255 |
| taxNumber | string | - | 10 | 255 |
| identityNumber | string | - | 1 | 150 |
| gsmNumber | string | - | 10 | 255 |
| string | ✓ | 1 | 255 | |
| city | string | ✓ | 1 | 255 |
| town | string | ✓ | 1 | 255 |
| address | string | ✓ | 1 | 500 |
Basket Transfer
Main Fields
| Field | Type | Required | Min | Max |
|---|---|---|---|---|
| referenceCode | string | ✓ | 1 | 255 |
| externalDeviceKey | string | - | 1 | 100 |
| receiptInfo | string | - | 1 | 255 |
| customInfo | string | - | 1 | 255 |
customer (object)
| Field | Type | Required | Min | Max |
|---|---|---|---|---|
| referenceCode | string | ✓ | 1 | 255 |
| type | string | ✓ | 1 | 255 |
| title | string | ✓ | 1 | 255 |
| name | string | ✓ | 1 | 255 |
| surname | string | ✓ | 1 | 255 |
| taxOffice | string | - | 1 | 255 |
| taxNumber | string | - | 10 | 255 |
| identityNumber | string | - | 1 | 150 |
| gsmNumber | string | ✓ | 10 | 255 |
| string | ✓ | 1 | 255 | |
| city | string | ✓ | 1 | 255 |
| town | string | ✓ | 1 | 255 |
| address | string | ✓ | 1 | 500 |
price (object)
| Field | Type | Required | Min | Max |
|---|---|---|---|---|
| grossPrice | decimal | ✓ | 1 | 99999999 |
items (Array of objects)
| Field | Type | Required | Min | Max |
|---|---|---|---|---|
| quantity | decimal | ✓ | 1 | 99999999 |
items.product (object)
| Field | Type | Required | Min | Max |
|---|---|---|---|---|
| unitCode | string | ✓ | 1 | 25 |
| name | string | - | 1 | 255 |
| referenceCode | string | - | 1 | 50 |
items.product.price (object)
| Field | Type | Required | Min | Max |
|---|---|---|---|---|
| grossPrice | double | ✓ | 1 | 99999999 |
| vatRatio | int | - | 1 | Max Int |
| sctRatio | int | - | 1 | Max Int |
Notes
- The ✓ symbol indicates required fields
- The "-" symbol indicates fields that are not required
- Max Int value: 2147483647

