RateSearchExportRequest

What to put in the exported rate sheet (an Excel workbook), and how to price it.

Export either every result of a search (isSelectedAll true, with the search's routes, sizes and filters) or chosen rows (isSelectedAll false, with selectedRows). Naming a customer makes the sheet a quote to that customer: their saved column layout and contact details are used, the quote is numbered and recorded, and it opens with a page carrying an ACCEPT link.

isSelectedAll
Type: boolean
required

True: export every result of the search described by routes, containerSizes and advanceFilter. False: export only selectedRows.
advanceFilter
Type:

The search's other filters.

Properties: 10
containerSizes
Type: array of string

Container sizes to price, as the search took them: 20, 40, 40HC, 45, 48, 53. Empty for every size.
customer_export_id
Type: integer
greater than:
0nullable

One of the customer's saved export layouts (columns and their order). Requires customer_id.
customer_id
Type: integer
greater than:
0nullable

Your customer the sheet is for. Makes the export a quote to them. Without one, a generic rate sheet is produced.
is_margin_apply
Type: boolean

Add your margin to the rates. The margin_* fields apply only when this is true.
margin_apply_to
Type: enum

What margin_percentage is a percentage of: BASE_RATE (ocean freight alone) or TOTAL_RATE (freight plus surcharges). Either way the margin is added to the base rate, so base rate plus surcharges still equals the total.

values
BASE_RATETOTAL_RATE
margin_flat_rate
Type: number
min:
0

A flat amount added per container, in USD.
margin_percentage
Type: number
min:
0
max:
100

A percentage added, of the amount margin_apply_to names.
margin_round_up_to
Type: enum

Round the marked-up base rate up to a multiple of 1, 5 or 10 USD. "0" leaves it unrounded.

values
01510
routes
Type: array of RouteItem

The lanes the search ran on. Required when isSelectedAll is true.

Properties: 6
routeVia
Type: nullable

The search's via-point filter, if it had one.

Properties: 2
selectedRows
Type: array of SelectedRateSearchRow

The rows to export, as returned by the rate search. Required when isSelectedAll is false.

Properties: 4

RateSearchDrayageLegSchema

RateSearchInlandLegSchema