QuoteListItem

A quote or sheet your organization exported, as listed.

Includes your buy price and margin: this is your own record, never the customer's view.

id
Type: integer
required

The quote's id, for GET /quotes/{quote_id}.
issued_at
Type: stringFormat: date-time
required

When it was exported (UTC).
reference
Type: string
required

Your quote number: "Q-" for a quote, "S-" for a sheet, e.g. "Q-000126". Numbered within your organization.
accept_url
Type: stringnullable

The page the customer opens to see and accept the quote. It shows the quote's current state, so it works even once expired or archived. Null only on some older quotes.
accepted_at
Type: stringFormat: date-timenullable

When the customer accepted it. Null if not.
accepted_by_name
Type: stringnullable

The name the customer gave when accepting, if any.
archived_at
Type: stringFormat: date-timenullable

When it was archived (withdrawn or replaced). Null if it was not.
buy
Type:

What the carrier charges you, per container: freight plus surcharges.

Properties: 2
commodity
Type: stringnullable

The commodity, or "Multiple".
currency
Type: string

The currency of every amount (ISO 4217).
customer_id
Type: integernullable

The customer it was quoted to. Null for a sheet.
customer_name
Type: stringnullable

That customer's name.
equipment_sizes
Type: array of string

The container sizes quoted, smallest first.
kind
Type: enum

quote: sent to a customer. sheet: exported for no customer.

values
quotesheet
lanes
Type: array of QuoteLane

Every lane the quote covers.

Properties: 6
margin
Type:

Sell minus buy.

Properties: 2
place_of_delivery
Type: stringnullable

Where the cargo is delivered, or "Multiple" if the quote covers several destinations.
place_of_receipt
Type: stringnullable

Where the cargo is picked up, or "Multiple" if the quote covers several origins.
quoted_by_id
Type: integernullable

The user who exported it.
quoted_by_name
Type: stringnullable

That user's name, or their email if they have no name.
rate_count
Type: integer

How many priced lines (rate × container size) it holds.
requote_requested_at
Type: stringFormat: date-timenullable

When the customer asked for updated rates. Null if they have not.
requoted_from_id
Type: integernullable

The quote this one replaced, if it is a requote.
sell
Type:

What the customer was quoted, per container: buy plus your margin.

Properties: 2
service
Type: stringnullable

The service, e.g. CY/CY (port to port), or "Multiple".
ship_type
Type: stringnullable

Mode · container size · container type, each "Multiple" when the quote covers several.
size_bands
Type: array of QuoteSizeBand

The prices by container size and type.

Properties: 7
status
Type: enumnullable

Where the quote stands. Null for a sheet, unless it was archived.

values
pendingacceptedexpiredarchivedrequote_requested
valid_until
Type: stringFormat: date-timenullable

When the quote can no longer be accepted (UTC). After this it is expired. Null if it has no time limit.

QuoteListApiResponse

QuoteListResponse