Delete sales

To delete one or more sales, 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

deletedObjects: Array that contains the correctly processed objects

progId: The identifier for the inserted object

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

Field	Description	Type	Mandatory
goodsRecords	Array of sales objecs	Check below for the goodsRecords structure detail To update a hierarcy also specify the progId, which is the identifier for the hierarcy	✓

goodsRecords structure

{
    goodsRecords: [{
        goods: {
            customerCode: 123456,
            documentDate: "yyyy-mm-dd hh:mm:ss",
            refDocument: "xxx",
            actionType: "PURCHASE",
            entityCode: 0,
            system: "ECOMMERCE",
                            "cancellationDocumentDate": "2021-09-06 17:40:00",
                            "cancellationRefDocument": "1-16"
        }
    }]
}

Response example (failed deletion)

{
    success: false,
    code: 400,
    message: "Error: no update has been performed, check the errorObjects array for more info.",
    errorObjects: [
        {
            entityCode: 80,
            documentDate: "2019-01-28 16:44:50",
            refDocument: 2,
            customerCode: "26410",
            errorMessage: "Error: the sale is already deleted."
        }
    ],
    deletedObjects: []
}

Notes

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

Request

Query Params

Header Params

Body Params application/json

Example

{
    "goodsRecords": [
        {
            "goods": {
                "customerCode": 123456,
                "documentDate": "yyyy-mm-dd hh:mm:ss",
                "refDocument": "xxx",
                "actionType": "PURCHASE",
                "entityCode": 0,
                "system": "ECOMMERCE",
                "cancellationDocumentDate": "2021-09-06 17:40:00",
                "cancellationRefDocument": "1-16"
            }
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request

Request Code Samples

Responses