Order Reference Feed
Purpose
If the merchant is using TradeGlobal's shipping portal or ShipOrder API to generate shipping labels, it may be necessary to make use of the Order Reference Feed/OrderReference API. If the merchant's OMS/WMS generates an identifier that is placed on the package, this identifier will not exist in TradeGlobal. The order reference feed enables the merchant to pass these identifiers/references into TradeGlobal, so when the order is manifested, the merchant's warehouse can generate shipping labels in the TradeGlobal shipping portal using the merchant's order references/identifiers.
These order references may be passed at the order or SKU levels. If the order is a split shipment/multi-package order, it will be necessary to pass SKU level references so that the shipping portal will know how to split up the SKUs in the order. To do this simply populate the SKU field with each reference. If the order is a single package order, simply leave the SKU field blank to pass the reference as an order level reference.
How it Works
Data Flow
This feed should be sent from the merchant to the TG Commerce FTP site. TradeGlobal will archive all files passed to the FTP.
Timing of Updates
The Order Reference Feed batch process runs every 30 minutes 24 hours a day.
General Feed Requirements
File Formats
TradeGlobal Commerce's standard order reference feed is in CSV format. Click Here for a standard template.
Data Requirements
Field | Data Format | Purpose | Required | Description | Max Character Limit | Default Value |
---|---|---|---|---|---|---|
MerchantCode | String | Uniquely identifies the merchant at the time of execution | Y | Unique identifier | 20 | None |
OrderNum | String | Identifies the order number that was passed to TradeGlobal | Y | Order Number in TradeGlobal | 50 | None |
RefNumber | String | Merchant's unique identifier/order reference value in their OMS/WMS | Y | Order Reference Value | 50 | None |
SKU | String | Merchant's unique identifier for the product | C | Necessary if the order has multiple packages, or is a split shipment | 100 | None |