Get Movements Export

To retrieve one or more movements, 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

valueObjectList : is an array containing all the movements information. Read below for the response structure

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

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 movements (even the ones before the last request)	Char(1)

Notes

In case completeExtraction is not T the web service will retrieve all the modified movements 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).

The web service is paginated, and will return a chunk of 10 elements at most.

There's a limit of 100 calls for this API

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

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 movements from the 23rd to the 43rd will be returned.	Number

The response is composed as follows

Document Header section

Field	Description	Type
docType	Document type	Char(20)
docTypeDescription	Description for the docType	Varchar(250)
currency	Currency used in the document values	Varchar(250)
currencyDescription	Description for the currency	Varchar(250)
causal	Document causal	Varchar(250)
causalDescription	Description for the causal	Varchar(250)
year	Document year	Decimal(4, 0)
documentDate	Document date	Datetime
movementDate	Movement date	Datetime
refDocument	Reference code for the document	Varchar(250)
entityCode	Code of the shop	Varchar(250)
entityCodeDescription	Description for the entityCode	Varchar(250)
transportDocument	Code of the transport document	Varchar(250)
supplierDocument	Code of the supplier document	Varchar(250)
supplierCode	Supplier code	Varchar(250)
supplierDenomination	Denomination of the supplier	Varchar(250)
customerCode	Customer code	Varchar(250)
customerDenomination	Denomination of the customer	Varchar(500)
consolidated	Indicates wether the document is consolidated ('T') or not ('F')	Char(1)
entityCodeDest	Code of the destination shop	Varchar(250)
entityCodeDestDescription	Description for the entityCodeDest	Varchar(250)
deliveryDate	Delivery date	Datetime
note	Document notes	Varchar(1024)
totalQuantity	Total packages quantity	Decimal(7, 2)

Document Details section

Field	Description	Type
rowNumber	The number row	Int(11)
barcode	Barcode for the SKU	Varchar(50)
quantity	Article quantity	Decimal(10, 2)
orderRow	Order row number	Decimal(15, 0)
cessionPrice	Article cession price	Decimal(7, 2)
note	Notes for the row	Varchar(1024)

Document Packages section

Field	Description	Type
packageNumber	Package number	Varchar(250)
packageBarcode	Barcode for the package	Varchar(250)
externalPackage	Barcode for the external package	Varchar(250)
consolidated	Indicates wether the package is consolidated ('T') or not ('F')	Char(1)
movementDate	Package movement date	Datetime

Package Details section

Field	Description	Type
packageNumber	Package number	Varchar(250)
rowNumber	Row number	Int(11)
quantity	Package quantity	Decimal(7, 2)

Response example

{
  "success": true,
  "valueObjectList": [
      {
        "documentHeader": {
            "docType": "1",
            "docTypeDescription": "Entrata merci",
            "currency": "EUR",
            "currencyDescription": "Euro",
            "causal": "1",
            "causalDescription": "Entrata merci",
            "year": 2020,
            "documentDate": "2019-10-01 16:00:00",
            "movementDate": "2019-10-01 16:00:00",
            "refDocument": "ENTRATAMERCI-1170",
            "entityCode": "1",
            "entityCodeDescription": "Negozio 1",
            "consolidated": "T",
            "totalQuantity": 4,
            "packagesNumber": 0
        },
        "documentDetails": [
            {
                "rowNumber": 1,
                "barcode": "1000012495404",
                "quantity": 2
            },
            {
                "rowNumber": 2,
                "barcode": "1000012495381",
                "quantity": 2
            }
        ],
        "documentPackages": [],
        "packageDetails": []
    }]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Get Movements Export

application/json

Body

Example

{
    "success": true,
    "valueObjectList": [
        {
            "documentHeader": {
                "docType": "1",
                "docTypeDescription": "Entrata merci",
                "currency": "EUR",
                "currencyDescription": "Euro",
                "causal": "1",
                "causalDescription": "Entrata merci",
                "year": 2020,
                "documentDate": "2019-10-01 16:00:00",
                "movementDate": "2019-10-01 16:00:00",
                "refDocument": "ENTRATAMERCI-1170",
                "entityCode": "1",
                "entityCodeDescription": "Negozio 1",
                "consolidated": "T",
                "totalQuantity": 4,
                "packagesNumber": 0
            },
            "documentDetails": [
                {
                    "rowNumber": 1,
                    "barcode": "1000012495404",
                    "quantity": 2
                },
                {
                    "rowNumber": 2,
                    "barcode": "1000012495381",
                    "quantity": 2
                }
            ],
            "documentPackages": [],
            "packageDetails": []
        }
    ],
    "moreRows": false,
    "resultSetLength": 1
}

🟠422Unique constraint error