4WS Suite
Home
API Reference
  • Data mangement API
  • Documents API
Home
API Reference
  • Data mangement API
  • Documents API
Fourwayshop
  1. Articles (deprecated)
  • Four Way Shop API
  • Before start develop
  • Why we use Resource-oriented design
  • Technical Prerequisites
  • Concepts
    • Date Handling
    • Managing Languages
    • Handling Field Updates and Null Values in Service Requests
    • ISO Code
    • Vat rates
    • Product structure
    • Product Images
    • Product dimensions
    • Product pricing
    • Dimension group vs Dimension grouping
    • Subjects overview
    • Documents structure
  • Best Practices
    • Best Practices for Error Handling in External System
    • How Testing callback response
    • Best Practices for delopers
  • Data management
    • Authentication
    • Rate Limits
    • Paginated Responses
    • Getting Started
    • API Changelog
    • Use cases
      • Cataloging a Dimension
      • Creating a New Product
      • Retriving a product details
      • Defining Product Pricing
      • Updating External System Product Catalog
      • Activate product variants and add barcodes to SKUs
      • Move a Barcode from One Product to Another
    • API
      • Login
        • login
      • Product
        • Brand
          • Get All Brands
          • Get A Brand
          • Insert brand
          • Update brand
        • Season
          • Get All Seasons
          • Get A Season
          • Insert season
          • Update season
        • Attribute
          • Get All Attribute Types
          • Get Attribute Type
          • Get Attribute
          • Insert attribute
          • Update attribute
        • Hierarchy
          • Insert hierarchy
          • Update hierarchy
        • Dimension groups
          • Insert dimension group
          • Update dimension group
        • Dimension
          • Insert dimension
          • Update dimension
          • Delete dimension
        • Product
          • Get products
          • Get product
          • Get product grouping
          • Get SKU's barcodes
          • Get product stock
          • Insert product
          • Update product
        • Activate dimensions on products
          • Insert active dimensions
          • Delete active dimensions
        • Barcode
          • Get SKU from barcode
          • Generate missing barcodes
          • Generate missing barcode for SKU
          • Insert barcode
          • Delete barcode
        • Prices
          • Get product prices
        • Price dimension groupings
          • Get Dimension Price Grouping
          • Get All Dimension Price Grouping
          • Insert dimension grouping
          • Update dimension grouping
          • Delete dimension grouping
        • Assortment
          • insert product assortment
          • delete product assortment
        • Image
          • Get images
          • Add image
          • Replace image
          • Delete image
        • Supplier
          • Get Item suppliers
          • Insert item supplier
          • Delete item supplier
          • Update item supplier
        • Custom category
          • Get Custom code
          • Insert Custom code
          • Update Custom code
        • Vat
          • Vat types
            • Get VAT type
            • Get VAT types
          • VATs
            • Get VATs
            • Get VATs by type
            • Get VAT
          • Vat rates
            • Get VAT rates
            • Get single VAT rates
        • Stock
          • Insert stock
          • Get stock
      • Price lists
        • Get price lists
        • Get price lists by type
        • Get price list
        • Get prices from price list
        • Get entities from price lists
        • Insert Price List
        • Insert Product Price
        • Insert Entity On Price Lists
        • Update price list
        • Delete all product prices
        • Delete single product price
        • Delete entity from a price lists
      • Supplier
        • Supplier contacts
        • Supplier addresses
        • Get Suppliers
        • Get A Specific Supplier
        • Insert supplier
        • Update supplier
      • Entities
        • Get entities
        • Get entity
        • Insert entity
        • Update entity
      • Miscellaneous
        • Get requests rate limits
      • Catalog
        • Get Catalogs details
        • Get Catalog details by Code
        • Get products by Catalog Code
      • Export
        • Get bulk CSV Export
  • 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
      • Document Manager
        • Orders
          • Save Sale Order
          • Save Return Order
        • Orchestrated Orders
          • Orchestrated Order
          • Orchestrated Return order
          • Orchestrated Update order
        • Cart
          • Cart Validation
          • Cart Full Validation
        • Sales
          • Save receipt
          • Salve only Order
          • Replace or update sale
          • Get last digital order
        • Warehouse
          • Save Entry from supplier
          • Save Transfer document
          • Save Free Entry
        • Purchase
          • Save Purchase
        • Get Document
        • Update Document external references
      • Customer
        • Get Customer
        • Set Customer Opt-in
      • Loyalty vouchers
        • Get customer loyalty vouchers
        • Get loyalty vouchers at a time interval
        • Get last loyalty vouchers
      • Giftcard
        • Get Giftcard
        • Update Giftcard
        • Generate Gift Card Barcode
        • Gift Card PDF Generation
      • Stock
        • Get Stock
        • Get last stock
        • Insert Stock
  • šŸš« KeepIT
    • Authentication
    • Use cases
    • Articles (deprecated)
      • Get Articles
        POST
      • Insert/Update dimensional groups
        POST
      • Insert/Update price groupings
        POST
      • Insert/Update dimensions
        POST
      • Insert/Update attributes
        POST
      • Insert/Update hieararchies
        POST
      • Insert/Update seasons
        POST
      • Insert/Update articles
        POST
      • Insert/Update Articles Master data
        POST
      • Insert/Update Lists
        POST
      • Insert/Update Dimensions Groups
        POST
      • Create EAN13 barcode
        POST
      • Insert/Update Barcode
        POST
      • Assign dimensions to groupings
        POST
    • Price Lists (deprecated)
      • Insert price list
      • Add entity to price list
      • Add item price to price list
      • Insert sale profile
      • Insert sale period
      • Add item price to sale period
    • Stock (deprecated)
      • Get Stock
      • Get Stock Date
      • Get Stock CSV
      • Insert/Update Stock
    • Sales (deprecated)
      • Insert/Update sales
      • Delete sales
      • Upload printer sales archive
    • Deposit (deprecated)
      • Insert/Update deposits
    • Services
      • Insert/Update services
      • Delete services
    • Points
      • Insert/Update points
      • Calculate and Insert/Update Points
      • Delete points
    • Subjects
      • Check customers
      • Anonymize customers
      • Get subject data
      • Get customer discount
      • Insert/Update customer
      • Insert/Update billing customers
      • Insert/Update CRM customer
      • Insert/Update children
      • Change/Replacement card
      • Insert CRM user
    • Giftcards & Vouchers
      • Get giftcard
      • Insert/Update giftcards
      • Insert/Update Vouchers
    • Missed Opportunity
      • Get Lost Opportunities
      • Insert/Update missed opportunities
      • Delete missed opportunity
    • Documents (deprecated)
      • Insert documents
      • Get document
    • Catalogs
      • Get Catalog
      • Insert/update catalog
      • Insert/Update hierarchies item catalog
      • Insert/Update entity clusters
    • Suppliers (deprecated)
      • Insert/Update tailor
      • Insert/Update supplier
    • Export (deprecated)
      • Get Items Export
      • Get Barcodes Export
      • Get Prices Export
      • Get Customers Export
      • Get Suppliers Export
      • Get Sales Export
      • Get Movements Export
      • Get Vouchers Export
    • Configuration Mobile Shop (deprecated)
      • Insert/Update Entities
      • Insert Seller
    • Mappings
      • Insert Mappings
      • Get Mappings
  1. Articles (deprecated)

Insert/Update Articles Master data

Deprecated
POST
/api
Last modified:2024-08-14 15:18:58
It's possible to insert or update an article specifying its dimensions with a single call.
In addition to the article, it also inserts seasons, attributes, hierarchies.
To do so, the following JSON body must be passed to the insertUpdateMasterData web service.
{
    itemsRecords: [
        {
            items: {
                itemCode: "",
                description: "",
                shopDescription: "",
                year: "",
                season: "",
                itemVat: "",
                itemType: ""
            },
            dimensionGroups: [
                {
                    dimensionType: "",
                    dimensionGroup: ""
                },
                {
                    dimensionType: "",
                    dimensionGroup: ""
                }
            ],
            attributeLevels: [
                {
                    attributeType: "",
                    attributeLevel: "",
                    description: ""
                },
                {
                    attributeType: "",
                    attributeLevel: "",
                    description: ""
                },
                {
                    attributeType: "",
                    attributeLevel: "",
                    description: ""
                }
            ],
            hierarchyLevels: [
                {
                    hierarchyType: "",
                    hierarchyLevel: "",
                    levelNumber: "",
                    description: "",
                    system: ""
                },
                {
                    hierarchyType: "",
                    hierarchyLevel: "",
                    description: "",
                    levelNumber: "",
                    fatherHierarchyLevel: "",
                    fatherHierarchyType: "",
                    system: ""
                },
                {
                    hierarchyType: "",
                    hierarchyLevel: "",
                    system: "",
                    fatherHierarchyType: "",
                    levelNumber: "",
                    fatherHierarchyLevel: "",
                    description: ""
                }
            ],
            itemSuppliers: [
                {
                    customerCode: "",
                    itemSupplier: "",
                    main: ""
                }
            ],
            seasons: [
                {
                    seasonCode: "",
                    description: "",
                    year: "",
                    season: ""
                }
            ],
            itemBarcodes: [
                {
                    barcodeType: "1",
                    barcode: "666666"
                }
            ],
            dimensionLevels: [
                {
                    dimension: "1",
                    dimensionGroup: "200",
                    barcode: "666666",
                    barcodeType: "1",
                    dimensionType: "TAGLIA"
                }
            ]
        }
    ]
}
items section
FieldTypeDescriptionMandatory
itemCode
string
Item code
āœ“
description
string
Description for the item
āœ“
shopDescription
string
Short description for the item (at most 20 characters)
āœ“
year
string
Item year
āœ“
season
string
Item season code
āœ“
itemVat
string
VAT Code for the item
āœ“
itemType
string
Item type (e.g. PRODUCT)
āœ“
dimensionGroups section
Note that the section is not mandatory, and can be an empty array. In case it is valued, it must be an array of objects composed as follows.
FieldTypeDescriptionMandatory
dimensionType
string
Item code
āœ“
dimensionGroup
string
Description for the item
āœ“
attributeLevels section
Note that the section is not mandatory, and can be an empty array. In case it is valued, it must be an array of objects composed as follows.
FieldTypeDescriptionMandatory
attributeType
string
Attribute type
āœ“
attributeLevel
string
Attribute level code
āœ“
description
string
Attribute level description
āœ“
hierarchyLevels section
Note that the section is not mandatory, and can be an empty array. In case it is valued, it must be an array of objects composed as follows.
FieldTypeDescriptionMandatory
hierarchyType
string
Hierarchy type
āœ“
hierarchyLevel
string
Hierarchy level code
āœ“
levelNumber
string
Hierarchy number
āœ“
description
string
Hierarchy level description
āœ“
system
string
System code
āœ“
itemSuppliers section
Note that the section is not mandatory, and can be an empty array. In case it is valued, it must be an array of objects composed as follows.
FieldTypeDescriptionMandatory
customerCode
string
Supplier code
āœ“
itemSupplier
string
Supplier
āœ“
main
string
'T' if it's the main supplier for the item, 'F' otherwise
āœ“
seasons section - an array composed as follows
FieldTypeDescriptionMandatory
seasonCode
string
Season code
āœ“
description
string
Season description
āœ“
year
string
Season year
āœ“
season
string
Season number
āœ“
itemBarcodes section
Note that the section is not mandatory, and can be an empty array. In case it is valued, it must be an array of objects composed as follows.
FieldTypeDescriptionMandatory
barcodeType
string
Barcode type
āœ“
barcode
string
Item barcode
āœ“
dimensionLevels section - an array composed as follows
FieldTypeDescriptionMandatory
dimension
string
Dimension code
āœ“
dimensionGroup
string
Dimension group code
āœ“
barcode
string
Item barcode
āœ“
barcodeType
string
Barcode type
āœ“
dimensionType
string
Dimension type
āœ“
Notes
There's a limit of 100 calls for this API.

Request

Query Params

Header Params

Body Params application/json

Example
{
    "itemsRecords": [
        {
            "items": {
                "itemCode": "123456",
                "description": "Item complete description",
                "shopDescription": "Item description",
                "year": "2021",
                "season": "1",
                "itemVat": "20",
                "itemType": "PRODUCT"
            },
            "dimensionGroups": [
                {
                    "dimensionType": "TAGLIA",
                    "dimensionGroup": "200"
                },
                {
                    "dimensionType": "COLORE",
                    "dimensionGroup": "100"
                }
            ],
            "attributeLevels": [
                {
                    "attributeType": "MARCHIO",
                    "attributeLevel": "MSB",
                    "description": "MySpecialBrand"
                },
                {
                    "attributeType": "MATERIALE",
                    "attributeLevel": "ORO",
                    "description": "Oro 18 carati"
                },
                {
                    "attributeType": "TACCO",
                    "attributeLevel": "10",
                    "description": "Tacco 10"
                }
            ],
            "hierarchyLevels": [
                {
                    "hierarchyType": "SESSO",
                    "hierarchyLevel": "U",
                    "levelNumber": "1",
                    "description": "Unisex",
                    "system": "TRADE"
                },
                {
                    "hierarchyType": "REPARTO",
                    "hierarchyLevel": "10",
                    "description": "Bijoux",
                    "levelNumber": "2",
                    "fatherHierarchyLevel": "U",
                    "fatherHierarchyType": "SESSO",
                    "system": "TRADE"
                },
                {
                    "hierarchyType": "CATEGORIA",
                    "hierarchyLevel": "50",
                    "system": "TRADE",
                    "fatherHierarchyType": "REPARTO",
                    "levelNumber": "3",
                    "fatherHierarchyLevel": "10",
                    "description": "Anelli"
                }
            ],
            "itemSuppliers": [
                {
                    "customerCode": "101010",
                    "itemSupplier": "ANE002",
                    "main": "T"
                }
            ],
            "seasons": [
                {
                    "seasonCode": "12021",
                    "description": "P/E 2021",
                    "year": "2021",
                    "season": "1"
                }
            ],
            "itemBarcodes": [
				{
					"barcodeType": "1",
					"barcode": "666666"
				}
			],
			"dimensionLevels": [
				{
					"dimension": "1",
					"dimensionGroup": "200",
					"barcode": "666666",
					"barcodeType": "1",
					"dimensionType": "TAGLIA"
				}
			]
        }
    ]
}

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=insertUpdateMasterData_v3&appId=KEEPIT&applicationId=KEEPIT' \
--header 'username: {{USERNAME}}' \
--header 'password: {{PASSWORD}}' \
--header 'companyId: {{COMPANY_ID}}' \
--header 'siteId: {{SITE_ID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "itemsRecords": [
        {
            "items": {
                "itemCode": "123456",
                "description": "Item complete description",
                "shopDescription": "Item description",
                "year": "2021",
                "season": "1",
                "itemVat": "20",
                "itemType": "PRODUCT"
            },
            "dimensionGroups": [
                {
                    "dimensionType": "TAGLIA",
                    "dimensionGroup": "200"
                },
                {
                    "dimensionType": "COLORE",
                    "dimensionGroup": "100"
                }
            ],
            "attributeLevels": [
                {
                    "attributeType": "MARCHIO",
                    "attributeLevel": "MSB",
                    "description": "MySpecialBrand"
                },
                {
                    "attributeType": "MATERIALE",
                    "attributeLevel": "ORO",
                    "description": "Oro 18 carati"
                },
                {
                    "attributeType": "TACCO",
                    "attributeLevel": "10",
                    "description": "Tacco 10"
                }
            ],
            "hierarchyLevels": [
                {
                    "hierarchyType": "SESSO",
                    "hierarchyLevel": "U",
                    "levelNumber": "1",
                    "description": "Unisex",
                    "system": "TRADE"
                },
                {
                    "hierarchyType": "REPARTO",
                    "hierarchyLevel": "10",
                    "description": "Bijoux",
                    "levelNumber": "2",
                    "fatherHierarchyLevel": "U",
                    "fatherHierarchyType": "SESSO",
                    "system": "TRADE"
                },
                {
                    "hierarchyType": "CATEGORIA",
                    "hierarchyLevel": "50",
                    "system": "TRADE",
                    "fatherHierarchyType": "REPARTO",
                    "levelNumber": "3",
                    "fatherHierarchyLevel": "10",
                    "description": "Anelli"
                }
            ],
            "itemSuppliers": [
                {
                    "customerCode": "101010",
                    "itemSupplier": "ANE002",
                    "main": "T"
                }
            ],
            "seasons": [
                {
                    "seasonCode": "12021",
                    "description": "P/E 2021",
                    "year": "2021",
                    "season": "1"
                }
            ],
            "itemBarcodes": [
				{
					"barcodeType": "1",
					"barcode": "666666"
				}
			],
			"dimensionLevels": [
				{
					"dimension": "1",
					"dimensionGroup": "200",
					"barcode": "666666",
					"barcodeType": "1",
					"dimensionType": "TAGLIA"
				}
			]
        }
    ]
}'

Responses

šŸŸ¢200Success
application/json
Body

Example
{}
šŸŸ 422Unique constraint error
Modified atĀ 2024-08-14 15:18:58
Previous
Insert/Update articles
Next
Insert/Update Lists
Built with