Insert/Update articles

To insert one or more articles, 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

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

insertedObjects: 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
itemsRecords	Array of items objects	An array of objects (see below for the complete structure). To update an article also specify the progId, which is the identifier for the article	✓

ItemRecords structure

[
    {
        items: {
            itemCode: article item code
            description: article description
            shopDescription: shop description
            season: numeric season which the article belongs to (1, 2, 3)
            seasonCode: code of the season which the article belongs to
            saleSeasonCode: code of the sale season which the article belongs to
            year: 4-digit year
        },
        hierarchies: [
            {
                hierarchyType: type of the article hieararcy
                hierarchyLevel: level of the article hieararcy
            }
        ],
        attributes: [
            {
                attributeType: type of the article attribute
                attributeLevel: level of the article attribute
            }
        ],
        dimensionGroups: [
            {
                dimensionType: type of the article dimension
                dimensionGroup: code of the article dimension group
            }
        ],
        /* itemBarcodes is used to insert dimensions WITH their relative barcodes */
        itemBarcodes: [
            {
                barcode: article barcode
                barcodeType: type of barcode
                dimensions: [
                    {
                        dimension: article dimension
                        dimensionGroup: article dimension group
                        dimensionType: article dimension type
                    }
                ]
            }
        ],
        /* dimensionLevels is used to insert dimensions WITHOUT barcodes */
        "dimensionLevels": [
            {
                "dimension": "",
                "dimensionGroup": "",
                "dimensionType": ""
            }
        ],
        itemSuppliers: [
            {
                cap: ZIP code
                province: ISO string for Italian provinces (TV, BL, VE, MI, etc...)
                country: ISO string for the country (IT, EN, FR, etc...)
                city: city
                phone: phone number
                address1: address
                customerCode: "",
                main: 'T' (true) or 'F' (false), indicates wether this is the main supplier or not
                subjectCompanyName: company name for the supplier
                email: email address
            }
        ]
    }
]

Response example

{
    "success": true,
    "code": 200,
    "message": "Insert/update successful",
    "errorObjects": [],
    "insertedObjects": [
        {
            "progId": "2604"
        }
    ]
}

Notes

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

Request

Query Params

Header Params

Body Params text/plain

Example

Example:{ "itemsRecords": [ { "items": { "itemCode": "", "description": "", "shopDescription": "", "season": "", "seasonCode": "", "year": "" }, "hierarchies": [ { "hierarchyType": "", "hierarchyLevel": "" } ], "attributes": [ { "attributeType": "", "attributeLevel": "" } ], "dimensionGroups": [ { "dimensionType": "", "dimensionGroup": "" } ], /* itemBarcodes is used to insert dimensions WITH their relative barcodes */ "itemBarcodes": [ { "barcode": "", "barcodeType": "", "dimensions": [ { "dimension": "", "dimensionGroup": "", "dimensionType": "" } ] } ], /* dimensionLevels is used to insert dimensions WITHOUT barcodes */ "dimensionLevels": [ { "dimension": "", "dimensionGroup": "", "dimensionType": "" } ], "itemSuppliers": [ { "cap": "74015", "province": "TV", "country": "IT", "city": "Oderzo", "phone": "+390000000000", "address1": "Via Mottola Km 2,200", "customerCode": "SARTORIA_DELL_AICA", "main": "T", "subjectCompanyName": "Maglieria dell'Aica S.r.l", "email": "maglieriadellaica@aica.it" } ] } ] }

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert/Update articles

Request

Request Code Samples

Responses