Get bulk CSV Export

Bulk CSV Retrieval

This API allows users to retrieve a CSV file based on the provided export name (EXPORT_NAME) and an optional generation date (date). If the file is available, the API returns a URL for downloading it.

Four Way Shop does not enable CSV exports by default; a specific request must be made via our ticketing system.

Actors

API Client: The system or user initiating the request.

4ws.suite Platform: The backend system that processes the request.

Preconditions

The external system must have the necessary permissions and access to the document creation service, please refer to Authentication.

The export name (EXPORT_NAME) must be a valid and existing identifier.

Optionally, a date parameter (date) can be provided to specify the generation date of the file. If omitted, the API checks for the most recent file.

Main Success Scenario

The API client sends a GET request with a valid EXPORT_NAME and an optional date parameter.

If the file exists:

The API responds with a success flag set to true.

The response contains a fileUrl for downloading the CSV file.

Response Export found

Sample use of file_url

EXPORT_NAME	Export
DISCOUNT_CAUSALS_EXPORT	Export forzature prezzo
RETURN_CAUSALS_EXPORT	Export causali di reso
CLIENTS_CARD_EXPORT	Export delle card dei clienti
CLIENTS_DESTINATION_EXPORT	Export delle destinazioni dei clienti
CLIENTS_PRIVACY_EXPORT	Export dei consensi privacy dei clienti
CLIENTS_REFERENCES_EXPORT	Export dei riferimenti dei clienti
BRANDS_EXPORT	Export dei brands
SUBJECTS_EXPORT	Export dei soggetti
EMPLOYEES_EXPORT	Export Dipendenti
PAYMENT_METHODS_EXPORT	Export metodi di pagamento
SUBJECTS_RELATIONS_EXPORT	Export relazioni soggetti
SALE_PROFILE_SHOPS_EXPORT	Export saldi negozi
PRICELIST_SHOPS_EXPORT	Export dei listini negozio
TOTAL_CLIENTS_EXPORT	Export dei clienti
PRODUCTS_VARIANTS_EXPORT	Export delle varianti prodotto
PRODUCTS_VARIANTS_GROUP_EXPORT	Export dei gruppi variante prodotto
PURCHASE_EXPORT	Export degli acquisti
SALES_ORDERS_EXPORT	Export degli ordini di vendita
SALES_ORDERS_PAYMENTS_EXPORT	Export dei pagamenti degli ordini di vendita
SALES_PAYMENTS_EXPORT	Export dei pagamenti delle vendite
SALE_PROFILE_EXPORT	Export dei profili di vendita
SALE_PROFILE_SHOPS	Export dei profili di vendita negozi
STOCK_ECOMMERCE_EXPORT	Export delle giacenze ecommerce
STOCK_EXPORT	Export delle giacenze
PRODUCTS_ATTRIBUTES_EXPORT	Export degli attribuiti
PRODUCTS_BARCODES_EXPORT	Export dei barcode
PRODUCTS_CLASSIFICATIONS_EXPORT	Export delle gerarchie
PRODUCTS_EXPORT	Export dei prodotti
PRICELIST_SHOPS	Export Listini - Sedi
PRICELIST_EXPORT	Export dei listini
SALES_EXPORT	Export delle vendite
MOVEMENTS_EXPORT	Export dei movimenti
CLIENTS_EXTERNAL_MAPPINGS	Export delle mappature
SUPPLIERS_EXPORT	Export dei fornitori
PRODUCTS_SUPPLIERS_EXPORT	Export dei prodotti fornitori
LOCATIONS_EXPORT	Export delle locazioni

Alternate Flows

If the requested file does not exist:

The API responds with a success flag set to false.

The response includes a message indicating the error.

Response Export found

In this case, you need to check the Bulk Export application configurations.

{
  "success": false,
  "message": "Error retrieving export file"
}

Sequence Diagram

Best Practices

Please refer to Best Practices for Error Handling in External System for best practices on implementation.

Code Examples in Node.js

Example: Retrieving a CSV File

application/json

Body

Example

{
    "success": true,
    "export_name": "CATALOG_ITEMS_EXPORT",
    "file_url": "https://fake_url.com/CATALOG_ITEMS_EXPORT/CATALOG_ITEMS_EXPORT.csv?GoogleAccessId=xxxx"
}

Get bulk CSV Export

Bulk CSV Retrieval

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Example: Retrieving a CSV File

Request

Request Code Samples

Responses

Get bulk CSV Export

Bulk CSV Retrieval#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Example: Retrieving a CSV File#

Request

Request Code Samples

Responses

Bulk CSV Retrieval

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Example: Retrieving a CSV File