4WS Suite
Home
API Reference
  • Data mangement API
  • Documents API
Home
API Reference
  • Data mangement API
  • Documents API
Fourwayshop
  1. Export (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
      • Insert/Update dimensional groups
      • Insert/Update price groupings
      • Insert/Update dimensions
      • Insert/Update attributes
      • Insert/Update hieararchies
      • Insert/Update seasons
      • Insert/Update articles
      • Insert/Update Articles Master data
      • Insert/Update Lists
      • Insert/Update Dimensions Groups
      • Create EAN13 barcode
      • Insert/Update Barcode
      • Assign dimensions to groupings
    • 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
        POST
      • Get Barcodes Export
        POST
      • Get Prices Export
        POST
      • Get Customers Export
        POST
      • Get Suppliers Export
        POST
      • Get Sales Export
        POST
      • Get Movements Export
        POST
      • Get Vouchers Export
        POST
    • Configuration Mobile Shop (deprecated)
      • Insert/Update Entities
      • Insert Seller
    • Mappings
      • Insert Mappings
      • Get Mappings
  1. Export (deprecated)

Get Prices Export

Deprecated
POST
/api
Last modified:2024-08-21 09:23:34
To retrieve one or more prices, 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 prices information. Read below for the response structure
This is the list of fields that can be passed in the request body:
FieldDescriptionTypeMandatory
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 pricecs (even the ones before the last request)
Char(1)
Notes
In case completeExtraction is not T the web service will retrieve all the modified prices 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 20 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:
FieldDescriptionTypeMandatory
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 prices from the 23rd to the 43rd will be returned.
Number
The response is composed as follows
FieldDescriptionTypeMandatory
priceListType
Type of the price list
Varchar(250)
āœ“
priceList
Code of the price list (there will be a price list for each shop)
Varchar(250)
āœ“
priceListDescription
Description of the price list
Varchar(250)
āœ“
priceListStartDate
Date of validity start of the price list
Date
āœ“
priceListEndDate
Date of validity end of the price list
Date
āœ“
entityCode (entities section)
Code of the shop for which the price list is active (this information is in an array)
Varchar(250)
āœ“
entityDescription (entities section)
Description of the shop for which the price list is active (this information is in an array)
Varchar(250)
āœ“
itemCode (prices section)
Code of product(this information is in an array)
Date
āœ“
startDate (prices section)
Date of start validity of the price (this information is in an array)
Date
āœ“
price (prices section)
Price (this information is in an array)
Decimal(20,6)
āœ“
Response example
{
    "success": true,
    "valueObjectList": [
        {
        "priceListType": "A",
        "priceList": "LISTINO1",
        "priceListDescription": "Listino 1",
        "priceListStartDate": "2020-04-24 00:00:00",
        "priceListEndDate": null,
        "prices": [
            {
                "itemCode": "00070003",
                "startDate": "2020-06-05 00:00:00",
                "price": 25
            },
            {
                "itemCode": "0648",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "10402",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "10500",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "13973",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "15312",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "15317",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "15327 HO",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "15327 L",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "15327 M",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "15927 I",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "16416",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "16511",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "16802",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "17209",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "17219",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "201671",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "206-02 M",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "30976",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            },
            {
                "itemCode": "31067",
                "startDate": "2020-06-05 00:00:00",
                "price": null
            }
        ],
        "entityCodes": [
            {
                "entityCode": "10",
                "entityDescription": "Negozio 10"
            },
            {
                "entityCode": "999",
                "entityDescription": "Eredi Ciarlariello"
            },
            {
                "entityCode": "2",
                "entityDescription": "Negozio 2"
            },
            {
                "entityCode": "3",
                "entityDescription": "Negozio 3"
            },
            {
                "entityCode": "4",
                "entityDescription": "Negozio 4"
            },
            {
                "entityCode": "5",
                "entityDescription": "Negozio 5"
            },
            {
                "entityCode": "6",
                "entityDescription": "Negozio 6"
            },
            {
                "entityCode": "7",
                "entityDescription": "Negozio 7"
            },
            {
                "entityCode": "9",
                "entityDescription": "Negozio 9"
            },
            {
                "entityCode": "11",
                "entityDescription": "Lunerti srl"
            },
            {
                "entityCode": "12",
                "entityDescription": "Huaman lopez"
            },
            {
                "entityCode": "15",
                "entityDescription": "Curcio srl"
            },
            {
                "entityCode": "30",
                "entityDescription": "Fraticelli srl"
            },
            {
                "entityCode": "33",
                "entityDescription": "Fratelli Ferri spa"
            },
            {
                "entityCode": "99",
                "entityDescription": "Salvemini"
            },
            {
                "entityCode": "110",
                "entityDescription": "Negozio 110"
            },
            {
                "entityCode": "1",
                "entityDescription": "Negozio 1"
            }
        ]
    }]
}

Request

Query Params

Header Params

Body Params application/json

Example
{
    "completeExtraction": "T",
    "languageId": "IT",
    "system": "GESTIONALE_ESTERNO"
}

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=getPricesExport_v3&appId=KEEPIT&applicationId=KEEPIT&start=9' \
--header 'username: {{USERNAME}}' \
--header 'password: {{PASSWORD}}' \
--header 'companyId: {{COMPANY_ID}}' \
--header 'siteId: {{SITE_ID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "completeExtraction": "T",
    "languageId": "IT",
    "system": "GESTIONALE_ESTERNO"
}'

Responses

🟢200Get Prices Export
application/json
Body

Example
{
    "success": true,
    "valueObjectList": [
        {
            "priceListType": "A",
            "priceList": "LISTINO1",
            "priceListDescription": "Listino 1",
            "priceListStartDate": "2020-04-24 00:00:00",
            "priceListEndDate": null,
            "prices": [
                {
                    "itemCode": "00070003",
                    "startDate": "2020-06-05 00:00:00",
                    "price": 25
                },
                {
                    "itemCode": "0648",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "10402",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "10500",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "13973",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "15312",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "15317",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "15327 HO",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "15327 L",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "15327 M",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "15927 I",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "16416",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "16511",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "16802",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "17209",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "17219",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "201671",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "206-02 M",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "30976",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                },
                {
                    "itemCode": "31067",
                    "startDate": "2020-06-05 00:00:00",
                    "price": null
                }
            ],
            "entityCodes": [
                {
                    "entityCode": "10",
                    "entityDescription": "Negozio 10"
                },
                {
                    "entityCode": "999",
                    "entityDescription": "Eredi Ciarlariello"
                },
                {
                    "entityCode": "2",
                    "entityDescription": "Negozio 2"
                },
                {
                    "entityCode": "3",
                    "entityDescription": "Negozio 3"
                },
                {
                    "entityCode": "4",
                    "entityDescription": "Negozio 4"
                },
                {
                    "entityCode": "5",
                    "entityDescription": "Negozio 5"
                },
                {
                    "entityCode": "6",
                    "entityDescription": "Negozio 6"
                },
                {
                    "entityCode": "7",
                    "entityDescription": "Negozio 7"
                },
                {
                    "entityCode": "9",
                    "entityDescription": "Negozio 9"
                },
                {
                    "entityCode": "11",
                    "entityDescription": "Lunerti srl"
                },
                {
                    "entityCode": "12",
                    "entityDescription": "Huaman lopez"
                },
                {
                    "entityCode": "15",
                    "entityDescription": "Curcio srl"
                },
                {
                    "entityCode": "30",
                    "entityDescription": "Fraticelli srl"
                },
                {
                    "entityCode": "33",
                    "entityDescription": "Fratelli Ferri spa"
                },
                {
                    "entityCode": "99",
                    "entityDescription": "Salvemini"
                },
                {
                    "entityCode": "110",
                    "entityDescription": "Negozio 110"
                },
                {
                    "entityCode": "1",
                    "entityDescription": "Negozio 1"
                }
            ]
        }
    ],
    "moreRows": true,
    "resultSetLength": 78862
}
🟠422Unique constraint error
Modified atĀ 2024-08-21 09:23:34
Previous
Get Barcodes Export
Next
Get Customers Export
Built with