- Four Way Shop API
- Before start develop
- Why we use Resource-oriented design
- Technical Prerequisites
- Concepts
- Best Practices
- Data management
- Authentication
- Rate Limits
- Paginated Responses
- Getting Started
- API Changelog
- Use cases
- API
- Documents
- Authentication
- Paginated responses
- Managing API Callbacks
- Document notifications
- Customer promo data notifications
- Use cases
- Updating External System Stock
- E-commerce Recipt Processing
- E-commerce Return Receipt Processing
- E-commerce Order sale Processing
- E-commerce Return Order Processing
- E-commerce Order Handling and Internal Stock Transfer
- E-commerce & Gift Card
- Creating a free entry
- Retrieving a Document by Identifier
- Cart Validation Service
- Sale and Shipping costs
- Handling Line Item Discounts
- Managing Price Forcing in Cart Items
- Purchase Order Registration
- Supplier Goods Entry From Purchase Order
- Update an Orchestrated Order
- New Orchestrated Return Orders
- API
- 🚫 KeepIT
- Authentication
- Use cases
- Articles (deprecated)
- Get Articles
- Insert/Update dimensional groups
- Insert/Update price groupings
- Insert/Update dimensions
- Insert/Update attributes
- Insert/Update hieararchies
- Insert/Update seasons
- Insert/Update articles
- Insert/Update Articles Master data
- Insert/Update Lists
- Insert/Update Dimensions Groups
- Create EAN13 barcode
- Insert/Update Barcode
- Assign dimensions to groupings
- Price Lists (deprecated)
- Stock (deprecated)
- Sales (deprecated)
- Deposit (deprecated)
- Services
- Points
- Subjects
- Giftcards & Vouchers
- Missed Opportunity
- Documents (deprecated)
- Catalogs
- Suppliers (deprecated)
- Export (deprecated)
- Configuration Mobile Shop (deprecated)
- Mappings
Get Suppliers Export
Deprecated
POST
/api
Last modified:2024-08-21 09:23:42
POST call, passing a JSON body as specified below.| Field | Description | Type | Mandatory |
|---|---|---|---|
| languageId | Language for the article localized strings ( IT or EN, defaults to user languare or IT if omitted) | String | |
| completeExtraction | If set to T, extracts ALL the suppliers (even the ones before the last request) | Char(1) |
completeExtraction is not T the web service will retrieve all the modified suppliers since the last request (in this case, the parameter system must be set in the body request, representing the system the recalls will be retrieved from).| Field | Description | Type | Mandatory |
|---|---|---|---|
| start | Pagination offset parameter. (only if completeExtraction is T)The WS will retrieve the elements starting from the one with the index specified here. For example, if 'start' is set to 23, the suppliers from the 23rd to the 43rd will be returned. | Number |
| Field | Description | Type | Mandatory |
|---|---|---|---|
| subjectCode | Code of the customer | Varchar(250) | |
| subjectName | Name of the customer | Varchar(250) | |
| subjectSurname | Surname of the customer | Varchar(250) | |
| subjectCompanyName | Company name related to the customer | Varchar(250) | |
| address1 | Address of the customer | Varchar(100) | |
| address2 | Address of the customer | Varchar(100) | |
| zipCode | Zip code of the address | Varchar(20) | |
| municipality | Municipality | Varchar(250) | |
| city | City of the customer | Varchar(250) | |
| state | State of the address (used for USA states) | Varchar(250) | |
| country | Code of country of the address | Varchar(3) | |
| language | Language of the customer | Varchar(250) | |
| currency | Currency of the customer | Char(3) | |
| sex | Sex of the customer | Char(1) | |
| birthday | Date of birth | Date | |
| fiscalCode | Fiscal code | Varchar(50) | |
| companyVatCode | Vat code of the company | Varchar(50) | |
| idCard | Number of the identity card | Varchar(100) | |
| passport | Number of the passport | Varchar(100) | |
| cardBarcode | Code of the card | Varchar(250) | |
| earnedPoints | Points earned related to the card | Decimal(10,0) | |
| entityCode | Code of store that issued the fidelity | Varchar(250) | |
Email address of the supplier | Varchar(250) | ||
| phone | Phone Number of the supplier | Varchar(250) | |
| createDate | Create date supplier | Datetime | |
| lastUpdate | Update date supplier | Datetime |
{
"success": true,
"valueObjectList": [
{
"subject": {
"subjectCode": "021955 S",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Nurul srl",
"address1": null,
"address2": null,
"zipCode": "20010",
"municipality": null,
"city": null,
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"createDate": "2022-06-23 14:32:54",
"lastUpdate": null,
"cardBarcode": null,
"earnedPoints": null,
"entityCode": null,
"email": "_Nurul@nomail.com",
"phone": "0868246223"
}
}]
}
Request
Query Params
Header Params
Body Params application/json
Example
{
"completeExtraction": "T",
"languageId": "IT",
"system": "GESTIONALE_ESTERNO"
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api?cmd=getSuppliersExport_v3&appId=KEEPIT&applicationId=KEEPIT&start=9' \
--header 'username: {{USERNAME}}' \
--header 'password: {{PASSWORD}}' \
--header 'companyId: {{COMPANY_ID}}' \
--header 'siteId: {{SITE_ID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"completeExtraction": "T",
"languageId": "IT",
"system": "GESTIONALE_ESTERNO"
}'Responses
🟢200Get Suppliers Export
application/json
Body
Example
{
"success": true,
"valueObjectList": [
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"createDate": "2022-06-23 14:32:54",
"lastUpdate": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
},
{
"subject": {
"subjectCode": "02DELLA",
"subjectName": null,
"subjectSurname": null,
"subjectCompanyName": "Fratelli Orlando srl",
"address1": null,
"address2": null,
"zipCode": "80010",
"municipality": null,
"city": "ARZANO",
"state": null,
"country": null,
"language": null,
"currency": null,
"sex": null,
"birthday": null,
"fiscalCode": null,
"companyVatCode": null,
"idCard": null,
"passport": null,
"subjectSubtype": "SUPPLIER",
"subjectSubtypeDescription": "Fornitore",
"cardBarcode": null,
"issueDate": null,
"activationDate": null,
"expirationDate": null,
"earnedPoints": null,
"cardSubtype": null,
"cardSubtypeDescription": null,
"entityCode": null,
"entityDescription": null,
"email": "_Orlando@nomail.com",
"phone": "0186695161"
}
}
],
"moreRows": true,
"resultSetLength": 379
}🟠422Unique constraint error
Modified at 2024-08-21 09:23:42