Delivery methods file

The delivery options a rep can choose at checkout: what each charges, and when an order will arrive. They can also be set up by hand in Business Rules; an import updates the ones it names.

File name: DeliveryMethods.csv, DeliveryMethods_2026-11-01.json or DeliveryMethods-export.xml (also delivery_methods, delivery-methods). The name starts with the record type, in any case, and anything after a _ or - is yours.

Required: Code. Everything else may be left out or left blank.

Example

One complete record, in each format. All three import as the same record. The CSV is the sample file for delivery methods.

Code,Name,RateRule,Rate,FreeOverValue,Bands,LeadTimeDays,CutOffTime,TaxCode,SortOrder,IsActive
PALLET,Pallet delivery,weight_band,25.00,,0:25.00|500:45.00,5,12:00,T1,1,Yes

[
  {
    "code": "PALLET",
    "name": "Pallet delivery",
    "rateRule": "weight_band",
    "rate": 25.0,
    "bands": "0:25.00|500:45.00",
    "leadTimeDays": 5,
    "cutOffTime": "12:00",
    "taxCode": "T1",
    "sortOrder": 1,
    "isActive": true
  }
]

<?xml version="1.0" encoding="UTF-8"?>
<Feed>
  <DeliveryMethod>
    <code>PALLET</code>
    <name>Pallet delivery</name>
    <rateRule>weight_band</rateRule>
    <rate>25.00</rate>
    <bands>0:25.00|500:45.00</bands>
    <leadTimeDays>5</leadTimeDays>
    <cutOffTime>12:00</cutOffTime>
    <taxCode>T1</taxCode>
    <sortOrder>1</sortOrder>
    <isActive>Yes</isActive>
  </DeliveryMethod>
</Feed>

In XML each record is a <DeliveryMethod> element; the element around them can be called anything.

Fields

Code

Your code for the method. It goes out on every order that uses it.

• Format: Text, matched exactly, capitals included.
• Required: Yes.
• Example: PALLET
• Tip: Read in capitals: std and STD are one method.

Name

What reps and customers see at checkout.

• Format: Text.
• Required: No.
• Example: Pallet delivery
• Tip: A new method with no name is shown by its Code.

RateRule

How it charges: flat, free_over, weight_band or destination_band.

• Format: Text.
• Required: No.
• Example: weight_band
• Tip: A rule the app does not know charges Rate, so a typing mistake never makes delivery free.

Rate

The charge. For a banded method, what is charged when no band matches.

• Format: A number such as 9.99. A currency symbol, thousands separators and a decimal comma are read too.
• Required: No.
• Example: 25.00

FreeOverValue

For free_over: orders at or above this are delivered free.

• Format: A number such as 9.99. A currency symbol, thousands separators and a decimal comma are read too.
• Required: No.
• Tip: Judged on what the customer pays for the goods, after any promotion.

Bands

For weight_band, from-weight:charge in kilograms, such as 0:25.00|500:45.00. For destination_band, country:charge, such as GB:9.95|IE:19.95.

• Format: Text.
• Required: No.
• Example: 0:25.00|500:45.00
• Tip: Bands that cannot be read leave the method on its Rate rather than refusing the row.

LeadTimeDays

Working days to deliver. Blank shows no delivery date.

• Format: A whole number.
• Required: No.
• Example: 5

CutOffTime

Orders placed after this time count from the next working day. Blank for no cut-off.

• Format: A time of day, 24-hour, such as 15:00.
• Required: No.
• Example: 12:00

TaxCode

Blank taxes delivery as the goods on the order are taxed. A code fixes its rate.

• Format: Text, matched exactly, capitals included.
• Required: No.
• Example: T1

SortOrder

Lower numbers show first.

• Format: A whole number.
• Required: No.
• Example: 1

IsActive

Yes to offer it, No to withdraw it.

• Format: Yes or no: see Yes and no below.
• Required: No.
• Example: Yes

Rules for every field

• A blank cell keeps what the tablet has, with Ignore blank cells on, as it ships. Switched off, a blank clears the field.
• A column the file does not have always keeps what the tablet has, whatever that setting says.
• A value that cannot be read, such as a date, number or yes/no in a shape the app does not know, stops that record importing. The sync log names the field and the value, and the record keeps what it had. A field whose tip says otherwise is the exception.
• Column names are matched without case and ignoring surrounding spaces.

Yes and no

In any case:

• Yes: true, t, yes, y, 1, -1, x, on, active, enabled
• No: false, f, no, n, 0, off, inactive, disabled