4WS Suite
Home
API Reference
  • Data mangement API
  • Documents API
Home
API Reference
  • Data mangement API
  • Documents API
Fourwayshop
  1. Use cases
  • 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
  1. Use cases

E-commerce Recipt Processing

E-commerce send a sale receipt#

Use Case Description#

An E-commerce site selling fashion products such as T-shirts, pants, jackets, and dresses needs to integrate with the 4ws.suite to handle the registration of sales through fiscal and non-fiscal receipts.
The 4ws.suite provides three APIs that the e-commerce system must invoke to complete the sales process.
WARNING
By using the API as specified in this documentation, the document will be recorded as unfiscalized (not printed).
The salesperson will still have the option to print the document later using the MobileShop application.
This functionality allows for efficient handling of document processing and printing.
Actors#
E-commerce System: The external system initiating the order processing and stock transfer.
4ws.trade Service: The service Save sale handling the creation of sales and stock transfer documents.
Store Clerks: The clerks or warehouse workers are responsible for preparing the items and the package, printing the sales receipt and preparing the documentation for shipment.
Preconditions#
The sale receipt request is correctly formatted and sent to 4ws.trade.
The external system must have the necessary permissions and access to the document creation service, please refer to Authentication.
APIs Used#
1.
Cart Validation
Purpose: Validates the shopping cart and applies any automatic discounts.
Input: JSON containing the cart with header information and product line items (items) being sold.
Output: JSON of the updated cart with applied discounts.
2.
Save sale
Purpose: Registers the sale and generates a receipt.
Input: JSON of the cart returned from the Cart Validation API.
Output: JSON with receipt references, including a unique barcode and documentNumber.
Date fields
All date fields in the JSON body for this sales document creation service must be provided in GMT (Greenwich Mean Time) format.

Document prices#

The external system must ensure that prices in the documents are valued according to the following rules:
priceSale: the product's selling price is a gross VAT amount;
priceInvoice: the product's invoice price (purchase invoice) is a net VAT amount;
pricePurchase: the product's purchase price (typically purchase order) is a net VAT amount.
If the fields priceSale is mandotary instead priceInvoice, and pricePurchase are not provided, the system will attempt to retrieve prices based on the branchCode and the sale, invoice, and purchase price lists. If no matching price is found, the API will return an error, and the document will not be created.

Process Flow#

1.
The e-commerce site prepares a shopping cart in JSON format containing the product information the customer intends to purchase.
2.
The e-commerce site invokes the Cart Validation API, passing the cart in JSON format.
3.
The Cart Validation API returns an updated cart with any applied discounts.
4.
The e-commerce site invokes the Save sale API, passing the updated cart.
5.
The Save sale API returns a JSON containing a unique receipt ID.
6.
The e-commerce site records the receipt ID to uniquely link it to the sales order.
INFO
This use case is intended for saving unprinted receipts for orders that have already been placed through an external system.
The validation step is important to ensure that the order is valid and that there are no errors.
The additional fields that are added to the JSON object are required for the sales insertion service to process the receipt.

Usage Examples#

Example Cart validation
Validation result
Save a reciept sale
Save sale callback result
e-commerce and transactionId
It is strongly recommended that the e-commerce site stores the unique receipt ID 02931b8a-a6c8-4e47-b3f1-041ffb1e432q and links it uniquely to the collected order.

Sequence Diagram#

This description clarifies how the e-commerce site integrates with the 4ws.suite APIs to manage the sales process and receipt registration.
INFO
Please refer to Best Practices for Error Handling in External System for best practices on implementation.

Clecks operation#

Here is the procedure that the clerk must follow when receiving an e-commerce sale via the Save sale service in the 4ws Mobile Shop register:
1.
Order Reception:
The clerk receives a notification of a new e-commerce sale in the 4ws Mobile Shop register.
2.
Package Preparation:
The clerk begins preparing the package with the products ordered by the customer.
3.
Sale Fiscalization:
Before closing the package, the clerk must fiscalize the sale.
Access the 4ws Mobile Shop register and print the receipt for the received e-commerce sale.
4.
Receipt Insertion:
Once the receipt is printed, the clerk inserts it into the package along with the ordered products.
5.
Package Closure:
The package is then closed and sealed, ready for shipment.
6.
Contact Shipping Service:
With the package ready, the clerk contacts the shipping service to arrange for the package to be sent to the customer.
By following this procedure, the clerk ensures that each e-commerce order is correctly processed, fiscalized, and shipped to the customer, complying with all fiscal regulations and the store's operational practices.

Return sale#

If the goods sold are returned by the customer, the e-commerce must send the return movement through a return receipt that will return the goods to the warehouse.
Refer to the use case E-commerce Return Receipt Processing with 4ws.trade

Discounts#

Modified at 2025-07-01 15:10:46
Previous
Updating External System Stock
Next
E-commerce Return Receipt Processing
Built with