4WS Suite
Home
API Reference
API Reference
  • Data mangement API
  • Documents API
Home
API Reference
API Reference
  • Data mangement API
  • Documents API
Fourwayshop
  1. Documenti
  • 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
  • Schemas
    • Documenti
      • List document
      • TAX DOCUMENT RECEIPT
    • Data management
      • Subjects
        • Crm01Subjects
        • Crm04Cards
        • Crm02SubjectTypes
        • Crm03SubjectSubtypes
        • Crm05CardTypes
        • Crm06CardSubtypes
        • Paginazione sample
        • Crm41Privacy
        • Crm11Contacts
        • Ini23PrivacyTypes
        • Crm10ContactTypes
        • Crm18Circuits
        • Crm33SubjectDestinations
        • Ini05DestinationTypes
      • Products
        • Season
        • Season response POST
        • Product
        • Dimension Group
        • Dimension
        • Barcode
        • Price dimension groupping
        • Supplier
        • Hierarchy
        • Custom Category
      • Catalog
        • Art41ItemCatalogHierarchies
        • Art42ItemCatalogHieLevels
        • Catalog
        • Products catalog
      • Entities
        • Entity
      • Pricelist
        • Pricelist
      • VAT
        • vatTypes
        • VAT
        • vatRates
      • Stock
        • Product Stock
      • Deposits
Home
API Reference
API Reference
  • Data mangement API
  • Documents API
Home
API Reference
API Reference
  • Data mangement API
  • Documents API
Fourwayshop
  1. Documenti

List document

{
    "success": true,
    "documentHeader": {
        "id": "71d3bf0e-c7c2-4dee-8b30-41a50806926f",
        "additionalInfo": "{\"EFSTA\":{\"needFiscalityData\":true}}",
        "addressee": "string",
        "addresseeAddress": "30, 20121 MILANO (LU) - IT",
        "addresseeDescription": "string",
        "addresseeType": "FATT",
        "appearance": "BOXES",
        "barcode": "99991710413892325000001",
        "billingAddress": "string",
        "billingCity": "string",
        "billingClientCode": "string",
        "billingClientIdKeepit": "string",
        "billingCompanyName": "string",
        "billingCountry": "IT",
        "billingCountryDescription": "Italia",
        "billingDenomination": "string",
        "billingEmail": "email@mail.com",
        "billingFiscalCode": "string",
        "billingIsCompany": "Y",
        "billingLawNature": "1",
        "billingName": "string",
        "billingPec": "email@mailpec.com",
        "billingProvince": "TV",
        "billingSdiCode": "SUBM70N",
        "billingSurname": "string",
        "billingVatCode": "11359591002",
        "billingZipCode": "string",
        "branchCode": 0,
        "branchCodeAddressee": "string",
        "branchCodePickup": 0,
        "branchCodeTransfer": "string",
        "branchDescription": "string",
        "branchSubtype": "CORNER",
        "branchType": "SHOP",
        "brandCode": "string",
        "brandDescription": "string",
        "buyerCode": "string",
        "cancelDate": "2019-08-24 14:15:22",
        "cardBarcode": "99991710413892325000001",
        "carrierAddress": "string",
        "carrierCode": "string",
        "cashbackTotalAmount": 0,
        "cause": "OUT",
        "causeDescription": "string",
        "causeSign": 0,
        "channel": "B2B_SALE",
        "channelDescription": "string",
        "clientCode": "string",
        "clientIdKeepit": 0,
        "clientPhoneNumber": "string",
        "companyId": "string",
        "confirmationDateOrder": "2019-08-24 14:15:22",
        "costs": "string",
        "createDate": "2019-08-24 14:15:22",
        "currency": "EUR",
        "currencyCompany": "EUR",
        "currencySite": "EUR",
        "currencySymbol": "€",
        "customerDeliveryDate": "2019-08-24 14:15:22",
        "ddtNumber": "string",
        "deliveryConditions": "string",
        "deliveryDate": "2019-08-24 14:15:22",
        "deliveryLimitDate": "2019-08-24 14:15:22",
        "deposit": 0,
        "discount1": 0,
        "discount2": 0,
        "discount3": 0,
        "discount4": 0,
        "discount5": 0,
        "discountAmount": 0,
        "discountPerc": 0,
        "discountReason": "string",
        "discountReasonDescription": "string",
        "discountType": "P",
        "discountWithVat": 0,
        "docNumberDigital": "string",
        "documentDate": "2019-08-24 14:15:22",
        "documentDeliveryExternal": "string",
        "documentExternal": "string",
        "documentNumber": "SDN/0000001449",
        "documentStatus": "OPEN",
        "documentType": "DELIVERY_NOTE",
        "documentTypeDescription": "Documento scarico merci da vendita",
        "endValidity": "string",
        "entityCode": 0,
        "exchangeRate": 0,
        "freight": "string",
        "isB2B": "Y",
        "isClickAndCollect": "Y",
        "isDeposit": "Y",
        "isDigital": "Y",
        "isEvadable": "Y",
        "isFiscal": "Y",
        "isInStore": "Y",
        "isParcelEnable": "Y",
        "isReservation": "Y",
        "jsonParcels": "{\"9100000000428\":true,\"9100000000411\":true}",
        "lastUpdate": "2019-08-24 14:15:22",
        "lstConnectedNumberDigital": "string",
        "movementDate": "2019-08-24 14:15:22",
        "note": "string",
        "orderBranch": "string",
        "orderDate": "2019-08-24 14:15:22",
        "orderYear": 0,
        "payeeAddress": "string",
        "payeeCity": "string",
        "payeeCompanyName": "Riccardo SRL",
        "payeeCountry": "IT",
        "payeeEmail": "email@mail.com",
        "payeeIsCompany": "Y",
        "payeeName": "string",
        "payeeProvince": "TV",
        "payeeSdiCode": "string",
        "payeeSurname": "string",
        "payeeTaxRegime": "string",
        "payeeVatCode": "string",
        "payeeZipCode": "string",
        "paymentExpirationDate": "2019-08-24 14:15:22",
        "payments": "string",
        "pointsBalance": 0,
        "pointsEarned": 0,
        "pointsMessage": "string",
        "pointsPrevious": 0,
        "printerReceiptNumber": "string",
        "printerSerial": "string",
        "printerTaxation": "string",
        "printerZReport": "string",
        "promoDiscount": 0,
        "rebates": 0,
        "reconciliationStatus": "Y",
        "refDigitalDocumentHeader": "string",
        "refDocumentHeader": "string",
        "refFiscalDocumentHeader": "string",
        "refundDate": "2019-08-24 14:15:22",
        "registerCode": 0,
        "reservedTo": "string",
        "rowVersion": 0,
        "seasonCode": "string",
        "sectional": "string",
        "sellerCode": "string",
        "sellerDescription": "string",
        "sender": "string",
        "senderAddress": "string",
        "senderDescription": "string",
        "senderType": "string",
        "shippingAddress1": "string",
        "shippingAddress2": "string",
        "shippingCity": "string",
        "shippingCountry": "IT",
        "shippingCountryDescription": "Italia",
        "shippingEmail": "email@mail.com",
        "shippingFirstName": "string",
        "shippingLastName": "string",
        "shippingMultiple": "string",
        "shippingMunicipality": "string",
        "shippingNote": "string",
        "shippingPhone": "string",
        "shippingProvince": "TV",
        "shippingRegion": "string",
        "shippingState": "string",
        "shippingSubjectCompanyName": "string",
        "shippingZipCode": "string",
        "siteId": 0,
        "status": "E",
        "statusMachineLog": 0,
        "stepB2B": 0,
        "subjectDenomination": "string",
        "supplierBranch": "string",
        "supplierCode": "string",
        "supplierReference": "string",
        "tailorCode": "string",
        "tailorCost": "string",
        "tailorDeliveryDate": "2019-08-24 14:15:22",
        "tailorDescription": "string",
        "taxFreeData": "string",
        "taxFreeNumber": "string",
        "taxRateExemption": 0,
        "taxableIncome": 0,
        "totalAmount": 0,
        "totalCostTaxableIn": 0,
        "totalCostTaxableOut": 0,
        "totalDiscount": 0,
        "totalInvoiceTaxableIn": 0,
        "totalInvoiceTaxableOut": 0,
        "totalPackages": 0,
        "totalQuantity": 0,
        "totalQuantityIn": 0,
        "totalQuantityOut": 0,
        "transferBranch": "string",
        "transportType": "string",
        "userCreate": "string",
        "userUpdate": "string",
        "userVisibility": "string",
        "vatCodeExemption": "string",
        "visibleMobile": "string",
        "weightKg": "string",
        "withdrawalDate": "2019-08-24 14:15:22",
        "year": 0
    },
    "documentRows": [
        {
            "id": "string",
            "attributeDescriptionLevel1": "string",
            "attributeDescriptionLevel10": "string",
            "attributeDescriptionLevel2": "string",
            "attributeDescriptionLevel3": "string",
            "attributeDescriptionLevel4": "string",
            "attributeDescriptionLevel5": "string",
            "attributeDescriptionLevel6": "string",
            "attributeDescriptionLevel7": "string",
            "attributeDescriptionLevel8": "string",
            "attributeDescriptionLevel9": "string",
            "attributeLevel1": "string",
            "attributeLevel10": "string",
            "attributeLevel2": "string",
            "attributeLevel3": "string",
            "attributeLevel4": "string",
            "attributeLevel5": "string",
            "attributeLevel6": "string",
            "attributeLevel7": "string",
            "attributeLevel8": "string",
            "attributeLevel9": "string",
            "barcode": "9780201379624",
            "brandCode": "string",
            "brandDescription": "string",
            "cancelDate": "2019-08-24 14:15:22",
            "companyId": "string",
            "composition": "55% Cotone, 45% Seta",
            "createDate": "2019-08-24 14:15:22",
            "currencySymbol": "€",
            "currencySymbolCompany": "€",
            "currencySymbolSite": "€",
            "customerDeliveryDate": "2019-08-24 14:15:22",
            "deliveryDate": "2019-08-24 14:15:22",
            "deliveryDateReservation": "2019-08-24 14:15:22",
            "deposit": 0,
            "description": "string",
            "descriptionGrouping": "string",
            "dimension1": "string",
            "dimension2": "string",
            "dimension3": "string",
            "dimension4": "string",
            "dimension5": "string",
            "dimensionDescription1": "string",
            "dimensionDescription2": "string",
            "dimensionDescription3": "string",
            "dimensionDescription4": "string",
            "dimensionDescription5": "string",
            "dimensionGroup1": "string",
            "dimensionGroup2": "string",
            "dimensionGroup3": "string",
            "dimensionGroup4": "string",
            "dimensionGroup5": "string",
            "dimensionGrouping": "string",
            "dimensionPosition1": "1",
            "dimensionPosition2": "25",
            "dimensionPosition3": "24",
            "dimensionPosition4": "3",
            "dimensionPosition5": "7",
            "dimensionType1": "TAGLIA",
            "dimensionType2": "TAGLIA",
            "dimensionType3": "TAGLIA",
            "dimensionType4": "TAGLIA",
            "dimensionType5": "TAGLIA",
            "discount1": 0,
            "discount2": 0,
            "discount3": 0,
            "discount4": 0,
            "discount5": 0,
            "discountAmount": 0,
            "discountPerc": 0,
            "discountReason": "string",
            "discountRowTotalAmount": 0,
            "discountTotalAmount": 0,
            "discountType": "P",
            "discountWithVat": 0,
            "documentDate": "2019-08-24 14:15:22",
            "endDateReservation": "2019-08-24 14:15:22",
            "endValidity": "2019-08-24 14:15:22",
            "entityCode": "string",
            "hierarchyDescriptionLevel1": "string",
            "hierarchyDescriptionLevel10": "string",
            "hierarchyDescriptionLevel2": "string",
            "hierarchyDescriptionLevel3": "string",
            "hierarchyDescriptionLevel4": "string",
            "hierarchyDescriptionLevel5": "string",
            "hierarchyDescriptionLevel6": "string",
            "hierarchyDescriptionLevel7": "string",
            "hierarchyDescriptionLevel8": "string",
            "hierarchyDescriptionLevel9": "string",
            "hierarchyLevel1": "string",
            "hierarchyLevel10": "string",
            "hierarchyLevel2": "string",
            "hierarchyLevel3": "string",
            "hierarchyLevel4": "string",
            "hierarchyLevel5": "string",
            "hierarchyLevel6": "string",
            "hierarchyLevel7": "string",
            "hierarchyLevel8": "string",
            "hierarchyLevel9": "string",
            "internalDocumentRow": "string",
            "itemCode": "string",
            "itemSubType": "ITEM",
            "itemType": "PRODUCT",
            "lastUpdate": "2019-08-24 14:15:22",
            "madeIn": "IT",
            "note": "string",
            "originalBarcode": "string",
            "originalPrice": 0,
            "priceCmp": 0,
            "priceForcingReason": "string",
            "priceInvoiceTaxable": 0,
            "priceInvoiceTaxableCompany": 0,
            "priceInvoiceTaxableSite": 0,
            "priceList": "string",
            "pricePurchaseTaxable": 0,
            "pricePurchaseTaxableCompany": 0,
            "pricePurchaseTaxableSite": 0,
            "priceSale": 0,
            "priceSaleCompany": 0,
            "priceSaleSite": 0,
            "quantity": 0,
            "quantity1": 0,
            "quantity10": 0,
            "quantity2": 0,
            "quantity3": 0,
            "quantity4": 0,
            "quantity5": 0,
            "quantity6": 0,
            "quantity7": 0,
            "quantity8": 0,
            "quantity9": 0,
            "quantityArrived": 0,
            "quantityCanceled": 0,
            "quantityCommitted": 0,
            "quantityDispatched": 0,
            "quantityExit": 0,
            "quantityInvoiced": 0,
            "quantityOnDelivery": 0,
            "quantityOrder": 0,
            "quantityOrderPurchase": 0,
            "quantityOrderTransfer": 0,
            "quantityReceipted": 0,
            "quantityReceiptedReturned": 0,
            "quantityReservated": 0,
            "quantityReturned": 0,
            "quantityReturnedInvoice": 0,
            "quantityTransferred": 0,
            "refDocumentDescription": "{\"docNumber\":\"95\",\"documentDate\":\"2024-04-19 08:34:57\",\"documentType\":\"STORAGE_DOCUMENT\",\"documentTypeDescription\":\"Richiesta di Consegna\",\"barcode\":\"99991713515700019000095\",\"documentId\":\"acea5529-af22-4422-b154-980d4e7fc637\",\"year\":\"2024\"}",
            "refDocumentRow": "f476cf2c-66b6-46aa-985a-89650f85e412",
            "refOrder": "876d79c8-43f6-4bdb-a72e-eea49ec80352",
            "refOrderRow": "a718f1ee-2601-4599-a836-115bd2247c48",
            "refParcel": "9100000000411",
            "refParcelDescription": "{\"parcelId\":\"000041\",\"parcelBarcode\":\"9100000000411\",\"parcelType\":\"SCATOLA\"}",
            "returnReasonDescription": "Cambio merce",
            "returnReasonId": "CAMBIO",
            "returnReasonNote": "Taglia troppo grande",
            "rowNumber": 0,
            "rowStatus": "OPEN",
            "rowTaxableIncome": 0,
            "rowTotal": 0,
            "rowVat": 0,
            "rowVersion": 0,
            "seasonCode": "1",
            "seasonDescription": "string",
            "sellerCode": "string",
            "sellerDescription": "string",
            "siteId": 0,
            "startDateReservation": "2019-08-24 14:15:22",
            "startValidity": "2019-08-24 14:15:22",
            "status": "E",
            "supplierCode": "string",
            "supplierItemCode": "string",
            "tailorCode": "string",
            "tailorCost": 0,
            "tailorDeliveryDate": "2019-08-24 14:15:22",
            "tailorDescription": "string",
            "tailorNote": "string",
            "tailorProductBarcode": "string",
            "tailorProductCode": "string",
            "tailorProductDescription": "string",
            "taxRate": 22,
            "taxRateExemption": "string",
            "unitPrice": 0,
            "userCreate": "string",
            "userUpdate": "string",
            "vatCode": "4",
            "vatCodeExemption": "55"
        }
    ],
    "moreRows": true
}
Built with