Skip to main content

Interface: BasketSubmissionData

Customer and submission information provided during checkout.

This interface defines the structure of the complete customer information collected during the checkout process. It includes both standard contact fields and any custom fields defined for the submission form.

This comprehensive data set ensures that all necessary information is collected for order processing, fulfillment, and customer communication.

Properties​

address?​

optional address: string

Customer's shipping or billing address (optional).

The physical address for shipping or billing purposes. May be structured as a single string or broken into components depending on the implementation.

companyName?​

optional companyName: string

Customer's company or organization name (optional).

The business or organization name if the order is being placed on behalf of a company rather than an individual. This may affect pricing, billing, and shipping options.

customFields?​

optional customFields: Record<string, undefined | string | number | boolean>

Values for custom fields defined in the submission form.

A record mapping custom field keys to their values, which may be strings, booleans, numbers, or undefined depending on the field type. These fields extend the standard submission data with business-specific information.

email​

email: string

Customer's email address.

The primary email address for order confirmations and communications. This is a required field for all submissions and must be a valid email format.

fullName​

fullName: string

Customer's complete name.

The full name of the person placing the order or the primary contact for the order. This is a required field for all submissions.

language​

language: string

Language preference for communications.

The ISO language code indicating which language should be used for order confirmations, receipts, and other communications. This affects both the language of automated emails and which language version of custom field values is used.

lastModifiedAt?​

optional lastModifiedAt: number

Timestamp of the last modification to the submission data.

Records when the submission data was last updated, which may differ from the final submission time if partial data was saved previously.

notes?​

optional notes: string

Additional comments or special instructions (optional).

Free-form text field for the customer to provide any special requests, delivery instructions, or other notes relevant to the order.

parameters​

parameters: SubmissionDataParameters[]

Processed custom field values with metadata.

A more comprehensive representation of custom field values that includes not just the values but also metadata about the fields themselves. This format is used for processing and validation purposes.

phone?​

optional phone: string

Customer's phone number (optional).

An optional contact number for the customer, which can be used for delivery coordination or order clarification if needed.

submittedAt​

submittedAt: number

Timestamp when the submission was completed.

Records when the cart was submitted, stored as milliseconds since epoch. This is used for order tracking, reporting, and SLA calculations.