Overview

The CommerceInterface (CI) FTP method allows Merchants / Vendors to interact with the CI platform via FTP file transfers for orders and shipping tracking.


FTP Address, Settings & Credentials
Access the FTP by using an FTP client and the SFTP domain sftp.commerceinterface.com. Your Merchant Service agent (or Account Manager if you dropship with Groupon) will set you up with an FTP and the username and password will be emailed to you directly. Or you can set it up on your own in the CI UI under Account Settings -> Account Information -> If so how would you like to receive order files -> FTP. The credentials will be emailed afterwards as well.


Frequency of Drops

You can configure your order drop frequency to every 1, 2, 3, or 4 hours. Once the orders have been exported, they will be flagged as exported in CI UI and these orders will not be included in future exports so it’s important to pick up all the available files – rather than just the most recent one.

Note that each manual export via the CI portal of not yet exported orders will flag orders as “exported” and will be excluded from the FTP export


Frequency of Imports

CI picks up any posted shipping confirmation file or inventory file 30 minutes after every hour.


Directory Structure

Files intended to be imported into your system and to be processed such as orders will be placed in the /in/ directory on the FTP server. We recommend deleting the order files on the FTP server once downloaded.

Files intended for CI to be imported and processed such as ship confirmations (Tracking) should be placed in the /out/shipments/ directory. Once processed, CI will delete posted files.

CI automatically creates a copy of all the order files in the Archive directory (/in/archive/Year/Month). You can pull any old order files from this directory, but note that you are not able to delete any files from this directory.


Order File Structure

Non-exported orders are placed into the /in/ directory in a .CSV file.


Web User Interface Access

You may also access the data via web UI at scm.commerceinterface.com. When an account is created for your company, a username and password for the UI is also created and emailed to you.


Orders CSV

The Orders CSV is a comma-separated file containing order information for previously non-exported orders. Each line represents an order and so care should be taken when shipping to consider the quantity as an order can contain more than one item.


Field Name

Description

Present

Example

fulfillment_line_item_id

Unique item reference

Always

1040291031

groupon_number

Groupon order number

Always

GG-3X4G-ZL3L-2J7Z-ABCD

order_date

Day order added to CI

Always

4/1/19 10:34

merchant_sku_item

The item SKU / EAN / UPC code

Always

9780394800769

quantity_requested

Default 1

Always

3

shipment_method_requested

Default ‘BEST’

Always

BEST

shipment_address_name

Full name of the order recipient

Always

JOHN SMITH

shipment_address_street

Address Line 1 for the order recipient

Always

1 Swan Lane

shipment_address_street_2

Address Line 2 for the order recipient e.g., Company, Flat #, House #

Always

Suite 100

shipment_address_city

City for the order recipient

Always

Chicago

shipment_address_stat

State for the order recipient

Always

 IL

shipment_address_postal_code

Postal code for the order recipient

Always 

60654

shipment_address_country

Country for the order recipient

Not always present

US

gift

false or true, indicating whether order needs to be gift wrapped

Always

 False

gift_message

330 character max message input by customer for gift recipient

Blank initially

 

quantity_shipped

N/A

Blank

 

shipment_carrier

N/A

Blank

 

shipment_method

N/A

Blank

 

shipment_tracking_number

N/A

Blank

 

ship_date

According to the contractual agreed SLA the calculated 'due on' date

Blank

 4/2/19 23:59


Field Name

Description

Present

Example

groupon_sku

Groupon unique buy option if item is CI deal

Sometimes

a0YC000000m02Jr

custom_field_value

Groupon customer purchase code

Blank initially

001008081P

permalink

Groupon's deal ID

Always

gg-cm-book-of-childrens-coloring-book

item_name

The name of the product being sold

Always

Children’s animal coloring book

vendor_id

Groupon's unique CI ID for the vendor if item is CI deal

Sometimes

251810

salesforce_deal_option_id

Identifies deal option if CI deal

Sometimes

a0YC000000m02Jr

groupon_cost

Groupon cost price

Always

15.00

billing_address_name

Full name of the  billing address for the customer who placed the order

Always

JOHN SMITH

billing_address_street

Address Line 1 for the billing contact

Always

1 SWAN LANE

billing_address_city

City for the billing contact

Always

Chicago

billing_address_stat

State for the billing contact

Always

 IL

billing_address_postal_code

Postal code for the billing contact

Always

60654

billing_address_country

Country for the billing contact

Always

 US

purchase_order_number

Grupon's purchase order number

Blank initially

 

product_weight

Product weight

Sometimes

 

product_weight_unit

Unit of measure (e.g. lbs, oz, etc.)

Sometimes

 

product_length

Product length

Sometimes

 

product_width

Product width

Sometimes

 

product_height

Product height

Sometimes


product_dimension_unit

Units of measure (e.g. in, ft, etc.)

Sometimes

pounds 

customer_phone

Delivery telephone number

Sometimes

5551234567

incoterms

N/A

Blank initially

 

hts_code

internationally standardized system of names and numbers to classify traded products

Blank initially


3pl_name

3PL name if order is fulfilled by Groupon

Sometimes

 

3pl_warehouse_location

3PL location if order is fulfilled by Groupon

Sometimes

 

kitting_details

On non-Gateway deals, a free selectable value on deal option level

Sometimes

 

sell_price

The price for which the product was sold for on Groupon Goods

Always

20

deal_opportunity_id

Groupon’s deal reference. Only on CI deals.

Sometimes

006C000001AeLXR

shipment_strategy

"Standard" is default. "Expedited" indicates need to use expedited service.

Always

Standard 

fulfillment_method

Order fulfilment method

Always

Drop Ship (Supplier small parcel)

country_of_origin

Country of origin for order

Sometimes

 US

merchant_permalink

Groupon’s unique vendor string

Sometimes

Vendor X 

feature_start_date

Date featured deal went online

Sometimes

 1/1/18 5:00

feature_end_date

Date featured deal goes offline

Sometimes

 1/26/20 7:59

bom_sku

On non-Gateway deals, a free selectable value on deal option level

Sometimes

 

parent_order_id

Parent order ID 

Always

205556789


Shipping Confirmation CSV

The ship confirmations (Tracking) CSV file should be returned with the data shown in the field definition table below. Please ensure the field headings match exactly. Please use consignment number by default for “tracking” if the item was sent untracked.


Field Name

Description

Sample

Required

fulfillment_line_item_id

Groupon's  fulfillment_line_item_id you get in the order file

0010146VD3

Mandatory

carrier

Populate this field with the carrier used to ship the package. 

The approved carrier codes can be pulled from the CI UI -> Reports tab -> Approved Carrier Report.

DPD

Mandatory

tracking

The tracking number for the shipment

15505432107023S

Mandatory

shipped_qty

If the shipment required multiple boxes, additional tracking numbers can be listed by using the quantity accordingly

1

Mandatory

inventory_decrement_date

Date product was shipped by the carrier  date format DD/MM/YYYY

01/10/2013

Mandatory



Shipping Confirmation Alerts

If CommerceInterface encounters any errors when processing your shipping confirmation data, the system will send you an email from noreply@commerceinterfce.com letting you know what file had the errors. We will process all successful line items and notify you of any that contained errors. We will also drop a file with the error line items into the error folder within the shipments directory (out/shipments/error).




Auto Archiving

CommerceInterface auto archives all the FTP order files we drop. Drop Shippers can use these archives to re-pull any file they may need. When we drop an order file we also drop a copy of that order file into the Archive folder within the /in directory. We have an organized folder structure with Archive, where we will separate the files by year and month. Please see the screenshot below for an example of where these files archive files can be found. Note that this Archive directory in ONLY read access, which means we allow you to view the files and you can export the file. However, you will not be able to remove or add any files to this directory.




Approved Carrier Codes

When using the Ship Confirmation file, you will need to populate the carrier column with the correct Carrier Code. To obtain the list of carrier codes, login to the UI, go to the Reports section and export the list of carrier codes for your country.