Folders - Outbound from SPS to Customer
General Information
We suggest checking for files at daily to hourly intervals, while avoiding the top of the hour. Logins at intervals more frequent than 30 minutes are usually not advantageous.
You are responsible for deleting files from these directories after you have retrieved them.
Folders
out – Used to send Automated Fulfillment live/production data to you, from your trading partners
testout – Used to send Automated Fulfillment test data to you, from your trading partners
File Names
File naming conventions are flexible, but we recommend the following:
Document Type Code | + | Unique Parcel ID (SPS Generated) | = | Unique File Name |
PO (Order) | + | (Any Value) | = | PO123456789 |
In this example, you must be able to process any file beginning with PO for import data and ED for EDI Pass Through data. The rest of the name is a unique ID generated at SPS, but is not indicative of any data in the file.
Folders - Inbound from Customer to SPS
General Information
This is where you will place files you would like SPS to process and send to your trading partners.
SPS will delete files from these directories during processing.
Folders
in – Used to receive Automated Fulfillment live/production data from you, for your trading partners
testin – Used to receive Automated Fulfillment test data from you, for your trading partners
File Names
File naming conventions are flexible, but we recommend the following:
Document Type Code | + | Unique Parcel ID (SPS Generated) | = | Unique File Name |
IN (Invoice) | + | (Any Value) | = | IN123456789 |
SH (Shipment) | + | (Any Value) | = | SH456123789 |
You must:
Generate a file name that begins with an agreed-upon Document Type Code that is unique for that document.
Use a unique value after that code in order to ensure files don't over-write one another before processing.
File Batching
If you are going to combine files together to be placed in the in or testin directory, they all must be of the same document type (such as an invoice) and same trading partner. Please do not combine multiple trading partners in one file.
Make sure you test a batched file scenario with your team at SPS, because the map may need to be modified to accommodate processing batched files. Batch scripting may be considered custom development and not in the standard scope of the project. Please be sure to use a batched file scenario during your testing phase with SPS Commerce to confirm your solution can accommodate this process if necessary.
General SFTP Script Process
SPS Commerce does not provide pre-built scripts. This document provides the commands and file syntax required for successful data flow. A typical SFTP/FTP command flow would be similar to that below:
cd /in | Files are uploaded to "in" directories such as /in or /testin |
mput PO* | Repeat for each file type sent to SPS |
cd /out | Files are downloaded from "out" directories such as /out or /testout |
ls PR* | Repeat for each file type received from SPS |
FOR # of files returned by ls above | Repeat the following two lines for each file that was listed by ls above |
get PRnnnnnnn | Use real file name |
delete PRnnnnnnn | Use real file name |
END FOR LOOP |
|
quit | Exit FTP session |
*Do not use mget with mdel, as it is possible to delete a file that has not yet been received.
More Information
📚 To see all articles regarding Fulfillment, check out our Fulfillment Collection.
👩💻 Need to contact Customer Support? Try Chat!