4WS Suite
Home
API Reference
Data mangement API
Documents API
Home
API Reference
Data mangement API
Documents API
Fourwayshop
Home
Copy Page
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
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
Home
Copy Page
Concepts
Date Handling
Date Handling All Date information within the API is expressed in the GMT time zone.This decision is based on the fact that the API can be invoked by ...
Managing Languages
The suite provides 10 languages for its master data: Italian English German French Spanish Portuguese Japanese Arabic Chinese Russian For example, t...
Handling Field Updates and Null Values in Service Requests
Updating information occurs even when the field is set to null. If no modifications are desired, omit the field in the request body. For example, to r...
ISO Code
4ws.suite uses the ISO standard to encode certain information such as countries, languages, currency, provinces, etc. Countries All countries are enco...
Vat rates
The suite provides standard VAT rate codes applicable to various transactions. Here are some examples: VAT Code Description 4 Standard rate 1 ...
Product structure
This document provides an overview of the core concepts related to product characteristics in our API. The concepts are crucial for understanding how ...
Product Images
Within the suite, it is possible to associate one or more images with a product. These images will then be displayed within the applications or can be...
Product dimensions
In our system, product dimensions are a crucial aspect for categorizing and managing product variants. The dimension types are established during the ...
Product pricing
Pricing API Documentation Overview Each product can have the following types of prices: Supplier Purchase Price Supplier Billing Price Retail Price ...
Dimension group vs Dimension grouping
When discussing Dimension Group: Dimensional groups categorize related dimensions under a common umbrella. These groups can be defined either through ...
Subjects overview
Subject Each subject has a unique code Each subject registered in 4ws.suite has a unique code that identifies their personal data, such as first name,...
Documents structure
Concepts Document Type and Cause Each document type (documentType) has associated typical causes (cause). When requesting to retrieve a document type,...
Previous
Technical Prerequisites
Next
Date Handling