| Table of Contents |
|---|
...
Field | Description | Example Value |
ProductCode | The code of the product | B100 |
ProductName | The name of the product | Corona 24 Pack Carton |
ProductDescription | A description of the product, keep all descriptions on one line (65000 character limit) | This is a bottle of Beer.<br>It’s very refreshing. |
CategoryLevel1 | The first level category (Beer -> Lager -> Cartons) | Beer |
CategoryLevel2 | The second level category (Beer -> Lager -> Cartons) | Lager |
CategoryLevel3 | The third level category (Beer -> Lager -> Cartons) | Cartons |
UNSPSC | United Nations Standard Products and Services Code | - |
ManufacturerName | The name of the manufacturer | Generic Beer Co. |
ManufacturerProductCode | The manufacturer’s product code | BEER01 |
SpecialInstructions | Can be used in addition to the description (400 character limit) | This is a second description |
UnitOfMeasure | The unit for measuring an item (2 character limit e.g. EA for each) | EA |
Weight | Shows an items weight on the website (unrelated to freight) | 7.92kg |
Size | Shows an items size on the website (unrelated to freight) | - |
FreightChargeApplies | The item weight value used for freight rules based on weight e.g. 1 for 1kg or 100 for 100g | 0.6 or 600 |
LeadTime | Time (in days) that it will take for item to be processed. | 2 |
MinimumOrder | The minimum number of a products that must be ordered | 1 |
StandardPrice | The standard (regular) price of a product | 3.20 |
GSTRate | The Tax rate for an item | 10 |
Priority | The higher (1 being the highest) the priority value the sooner it is shown in a category list. | 10 |
IsHidden | Shows (0) or hides (1) a product on the website. | 0 |
AllowStockLevels | Shows (1) or hides (0) an item’s stock balance set in StockBalance | 1 |
StockBalance | Shows (1) or hides (0) the amount of stock on hand for the item | 235 |
AllowNegative | Enables (1) or disables (0) backordering of items for customers | 0 |
An example Catalogue Item File with the above information can be downloaded here.
Upload a Catalogue Item File
...
Field | Description | Example Value |
FreightName | Freight text value viewable to the customer during the checkout process | Standard or Express |
FreightMethod | Internal Freight rule name viewable in the Control Panel | Freight-Melbourne (V1) |
EffectiveType | How the freight will be restricted e.g. POSTCODE or COUNTRY | POSTCODE |
EffectiveCode | Value for the EffectiveType e.g. 5000-5100;5400-5999; (POSTCODE) or ;NZ; (COUNTRY) | 3000-3210; |
UseFlatRate | 1 (Use a flat rate) or 0 (Use a calculation) for Freight | 0 |
UnitType | 1 or 0. | 1 |
UnitCost | Cost for each unit on top of BaseAmount e.g. $2.50 Cost for each item in cart | 2.50 |
BaseAmount | Base cost for Freight before adding Unit Cost e.g. $15 | 15.00 |
BreakType | the type of freight rule e.g. COST, FUNIT, PUNIT or X | COST (Price) FUNIT (Weight/Cubic) or CUNIT (Count) |
BreakLowerLimit | The starting or lowest value for the rule e.g. 0 kgs or grams | 0 (0 kgs or grams) |
BreakUpperLimit | The ending or highest value for the rule e.g. 3 kgs or 300 grams | 3 (kgs) or 300 (grams) |
Active | 1 (sets the rule active) or 0 (if BuyerSpecific is being used) | 1 |
TaxPercent | The tax rate for the Freight rule (should be 10 for GST) | 10 |
BuyerSpecific | If the Freight rule will be manually assigned to buyers in Manage Buyers | 0 |
An example Freight File with the above information can be downloaded here.
Upload a Freight File
The Freight File upload process allows you to either refresh all freight records in Control Panel or append to existing freight records.
...
See the table below for a description of what each field is for and also the file (attached) for an example of the data we will require.
Project Customers: Please extract the customers from your accounting system and add the data to the buyer file format. Once complete please return the buyer file to us for review.
| Info |
|---|
|
...
| Field | Summary | Example |
|---|---|---|
| BuyerName | The customer's company name. | Building Co |
| Address1 | The first part of the customer's address | 123 Main Street |
| Address2 | An optional second line for a customer's address | Corner 1 and 2 Streets |
| City | The city or suburb | Melbourne |
| State | The state | VIC |
| PostCode | The post code | 3000 |
| Country | The country | AU |
| Fax | If a customer has a fax number | 12348888 |
| AdminName | The full name of the customer. | John Smith |
| AdminEmail | Customer email, Should match BuyerUserName if using email addresses as usernames | |
| AdminPhone | The phone number of the customer | 0499123999 |
| ABN | Australian Business Number | 123456789 |
| BuyerUserName | Customer username, Should match AdminEmail if using email addresses as usernames | |
| BuyerPassword | A generic password can be entered here as customers will be sent a link to set their own | Password99 |
| BuyerType | 2 for an Administrator (full access) or 1 for a Standard User (restricted access) | 2 |
| ApprovalStatus | 1 should be set here, 0 will mean Buyers aren't approved and will not be able to login. | 1 |
| DefaultTerm | The default payment term for a Buyer. Only one can be set here. | Credit Card |
| RestrictView | N/A | |
| RestrictViewBy | N/A | |
| DefaultStore | N/A | |
| SellerReference | Must match the customer's reference in the accounting system. | BUILDINGCO |
| StartPage | N/A |
An example Buyer File with the above information can be downloaded here.
Upload a Buyer File
The Buyer File upload process allows you to either upload your initial buyer file records in Control Panel or append to existing buyer records.
...
Field | Summary | Example |
ParentProductCode | The code of the product that will contain the child product(s) | 12345 |
ChildProductCode | The code of the product(s) that will appear against the parent product | 12345_child |
Type | option: for product option menus addon: for related products against a parent | option addon |
ChildPriority | option: the order in which options appear (highest number appears first) addon: the order in which related products appear (highest number appears first) | 1 1 |
An example Catalogue Association File with the above information can be downloaded here.
Upload a Catalogue Association File
The Catalogue Association File upload process allows you to upload the associations between products you made in the file.
...