Insert/Update missed opportunities

To insert one or more missed opportunities, it's necessary to make a POST call, passing a JSON body as specified below.

The web service response will be composed of:

success: Boolean that indicated wether the request was successful or not

code : HTTP Code for the response

200 means the request was correctly processed

204 means a duplicate record was found in KeepIT, and that no insertion was performed

206 means that not all records were inserted or processed

400 means that the request body is invalid or contains syntax errors

500 means a server error has happened

message: response message for the request (e.g. "Insertion successful" or "Missing required parameter")

errorObjects: Array that contains the objects that caused errors when processed

entityCode : store code specified in the JSON request

documentDate : document date specified in the JSON request

refDocument: reference document specified in the JSON request

insertedObjects: Array that contains the correctly processed objects

progId: identifier for the inserted object

This is the list of fields that can be passed in the request body:

Field	Description	Type	Mandatory
missedOpportunity	Array of missed opportunities objecs	See below for the the object structure To update an attribute also specify the progId, which is the identifier for the attribute. If not specified, a new missed opportunity will be created	✓

To specify the loyal customer who marked the missed opportunity, the field `subjectCard` must be set or, alternatively, the customer email in the field `subjectEmail`.

To specift the employee who caught the missed opportunity set the field vendorCode.

The field itemCode refer to the article code of some articles that must be already set in KeepIT when the report occurs.

missedOpportunity structure

Field	Description	Type	Mandatory
missedOpportunityType	Type of the missed opportunity. (referenced on the master table)	Varchar(250)	✓
opportunityDate	Date of the missed opportunity	Date	✓
itemCode	Code of the product	Varchar(250)
itemDescription	Description of the product	Varchar(250)
barcode	Barcode of the SKU	Varchar(250)
origHierarchyLevel1 to origHierarchyLevel10	Description of the hierarchy level of the product if specified	Varchar(250)
origAttributeLevel1 to origAttributeLevel10	Description of the attributes of the product if specified	Varchar(250)
origDimension1 to origDimension5	Description of the dimensions of the product if specified (color, size etc.)	Varchar(250)
hierarchyLevel1 to hierarchyLevel10	Description of the hierarchy of the product requested by the customer	Varchar(250)
attributeLevel1 to attributeLevel10	Description of the attributes of the product requested by the customer	Varchar(250)
dimension1 to dimension5	Description of the dimensions of the product requested by the customer (color, size etc.)	Varchar(250)
note	Note for the missed opportunity	Varchar(2048)
subjectCard	Card barcode of the customer	Varchar(250)
vendorCode	Code of the vendor	Varchar(250)
itemCode1	Code of the product if specified	Varchar(250)

Response example

{
    "success": true,
    "code": 200,
    "message": "Inserimento/Update riuscito con successo.",
    "errorObjects": [
    ],
    "insertedObjects": [
        {
            "progId": "15"
        }
    ]
}

Notes

There's a limit of 100 calls for this API.

Request

Query Params

Header Params

Body Params text/plain

Example

Example:{ "missedOpportunity": [ { "progId":"15", "missedOpportunityType":"NO_SIZE", "opportunityDate" : "2018-01-01 12:30:00", "itemCode": "MISSED_OPPORTUNITY_123", "itemDescription": "Opportunità mancata 123", "barcode": "999999999999", "origHierarchyLevel1": "Gerarchia orgine 1", "origHierarchyLevel2": "Gerarchia orgine 2", "origHierarchyLevel3": "Gerarchia orgine 3", "origHierarchyLevel4": "Gerarchia orgine 4", "origHierarchyLevel5": "Gerarchia orgine 5", "origHierarchyLevel6": "Gerarchia orgine 6", "origHierarchyLevel7": "Gerarchia orgine 7", "origHierarchyLevel8": "Gerarchia orgine 8", "origHierarchyLevel9": "Gerarchia orgine 9", "origHierarchyLevel10": "Gerarchia orgine 10", "origAttributeLevel1": "Livello attributo 11", "origAttributeLevel2": "Livello attributo 22", "origAttributeLevel3": "Livello attributo 33", "origAttributeLevel4": "Livello attributo 44", "origAttributeLevel5": "Livello attributo 55", "origAttributeLevel6": "Livello attributo 66", "origAttributeLevel7": "Livello attributo 77", "origAttributeLevel8": "Livello attributo 88", "origAttributeLevel9": "Livello attributo 99", "origAttributeLevel10": "Livello attributo 10", "origDimension1": "Dimesnione d1", "origDimension2": "Dimesnione d2", "origDimension3": "Dimesnione d3", "origDimension4": "Dimesnione d4", "origDimension5": "Dimesnione d5", "hierarchyLevel1": "Livello dimesnione l1", "hierarchyLevel2": "Livello dimesnione l2", "hierarchyLevel3": "Livello dimesnione l3", "hierarchyLevel4": "Livello dimesnione l4", "hierarchyLevel5": "Livello dimesnione l5", "hierarchyLevel6": "Livello dimesnione l6", "hierarchyLevel7": "Livello dimesnione l7", "hierarchyLevel8": "Livello dimesnione l8", "hierarchyLevel9": "Livello dimesnione l9", "hierarchyLevel10": "Livello dimesnione l10", "attributeLevel1": "Livello attributo 1", "attributeLevel2": "Livello attributo 2", "attributeLevel3": "Livello attributo 3", "attributeLevel4": "Livello attributo 4", "attributeLevel5": "Livello attributo 5", "attributeLevel6": "Livello attributo 6", "attributeLevel7": "Livello attributo 7", "attributeLevel8": "Livello attributo 8", "attributeLevel9": "Livello attributo 9", "attributeLevel10": "Livello attributo 10", "dimension1": "Dimesnione dd1", "dimension2": "Dimesnione dd2", "dimension3": "Dimesnione dd3", "dimension4": "Dimesnione dd4", "dimension5": "Dimesnione dd5", "note": "Delle note", "subjectEmail": "luca.biasotto@sinesy.it", "vendorCode": "60330", "itemCode1": "U01_TMB755WD022", "itemCode2": "U38_MNFM13WU183" } ] }

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Insert Missed opportunity - Fail

text/html

Body

Example

{"success":false,"code":400,"message":"Errore: non è stato eseguito l'inserimento/update, verificare il messaggio di errore dei record ritornati.","errorObjects":[{"itemCode":"MISSED_OPPORTUNITY_123","barcode":"999999999999","errorMessage":"Error: opportunityDate is not set."}],"insertedObjects":[]}

🟢200Update Missed opportunity - Success

🟢200Insert Missed opportunity - Success

🟠422Unique constraint error