Export/API Orders

overview & purpose at every screen of the admin panel, we have given the option to export the data into an excel file here we have an option using which you can export the orders to any third party app exporting orders can be a quick way to transfer all the order details into third party analytics software or accounting software we have various order export settings, api web services settings, and hot folder settings, so that you do not miss any information export api orders export orders either manually or all at once using this interface using this section, you can easily export all your orders into your offline system at first you will have to understand and configure the export/api settings to enable order transfer (which we will discuss later in the document) after successful configuration simply selects the order range from various options, decide upon a date range and choose the order status(es) then, click on export to move order records to your offline system click manual transfer, if you wish to move only selective orders to your offline system export api settings you manage the export api settings from the admin >> orders >> export/api orders >> export/api settings (top right link) this displays a summary of current export order settings, such as export style, export file format, export file name format, hot folder setting, and folder location and structure to change the settings, click on ‘ export/api settings ’ button export order settings to manage the export order settings, go to admin >> orders >> export/api orders >> export/api settings >> export/api settings tab this section decides how your export file will look export style – this will create either a single file for all orders or create single files per order export file name format – with the variables provided decide the file name of the export order file export format – depending on your business usage you can choose the file format i e xml or excel we also have a separate section for api web services where you will have to generate a token, this token will be used as authentication while using this service set a format, and provide an ip address capture order information – get the list of variables that will be included in various information captured such as order details, customer details, billing details, order product info, shipping address, and order shipment info hot folder settings the hot folder is a folder set in the server that holds the exported files you can access this section from the admin >> orders >> export / api orders >> export / api settings >> hot folder settings tab in this section, you get to decide the hot folder's location, name, and structure folder location – select the required option and save the updated settings server folder a folder will be created on the server remote ftp folder configure your own ftp, and the system will create folders in your configured ftp connection type printer wise folder the folder will be created based on the printer management system select the preferred transfer protocol ( ftps or sftp ) configure the required connection details cloud storage the cloud storage integrated into your system will be displayed here (the 'google drive' option is listed in the above example) selecting the option will enable you to transfer the order details to a cloud storage option automated transfer automated functionality will export your orders automatically after a specific duration that will automatically transfer the print job ticket of orders this automated service will be on a paid basis this configuration helps protect sensitive data while maintaining seamless order processing secure file transfer enhancement the system provides enhanced connection testing options when the hot folder transfer is configured printer wise edit printer the edit printer screen allows the admin to configure and manage printer account details and ftp settings for automated file transfers admins can now view and use the following options under the transfer settings test sftp connection test ftps connection printer details this section includes the basic information and settings for the selected printer printer name enter or edit the printer’s name as it should appear in the system email specify the email address associated with the printer this may be used for notifications or communication password choose whether to leave the existing password unchanged or set a new one email notification enable or disable email notifications for this printer notify toggle on if you wish to send order or job alerts to this printer use printer as shipper enable this option if the printer address is the shipper address for shipping rate calculations and when the printer admin creates the shipment for shipping rate calculations, this applies only when the split call is set to "order product wise" note add printer information, such as details of the printer machine and other relevant specifications tags select or create tags to categorize printers for easier management ftp details this section defines how print files are transferred automatically to the printer’s system connection type choose the connection method from the dropdown, namely ftp , ftps , and sftp remote host enter the address of the remote server remote ftp port specify the port used to communicate with the remote server remote username enter the username used for authenticating to the ftp/sftp server remote password enter the password of the account on the remote server click the eye icon to view or hide the password remote directory path define the folder path where the print files should be copied on the remote server once all details are entered, click save or save & back at the top of the screen to apply your changes these options allow admins to verify the connection and ensure the secure transfer setup is functioning correctly before initiating file transfers api service settings the api web service allows you to efficiently retrieve order details, customer information, and update order statuses based on the parameters you pass it offers a streamlined way to integrate your store data with external systems while ensuring accuracy and real time synchronization this api provides data in xml or json format for a complete list of supported queries, mutations, and integration steps, please refer to the https //documenter getpostman com/view/17600430/2sa2xjzbau