API: customers and orders

type Customer = {
  customerId: number
  email: string | null
  firstName: string | null
  lastName: string | null
  phoneNumber: string | null
  organisationName: string | null
  language: string
  notificationPreference: 'EMAIL' | 'SMS' | 'WHATSAPP'
  customerType: 'PRO_FORMA' | 'ACCOUNT' | 'INTERNAL'
  discountPercentage: number | null
}

type Address = {
  addressId: number             // omit when you create an address
  name: string                  // name of the contact person
  company: string
  street1: string
  street2: string
  city: string
  state: string
  zip: string
  country: string               // the "country" value from GET /countries
  jurisdictionIsoCode: string   // the "iso" value from GET /countries/{country}/jurisdictions
  phone: string
  email: string
  residential: boolean
  taxId: string | null
  isBillingAddress: boolean
  isShippingAddress: boolean
  countryAlpha2Code: string     // response only
  countryAlpha3Code: string     // response only
}

// Request
{
  currency: string
  toAddressId: number
  parts: { partRevisionId: string; units: MeasurementUnit; quantity: number; processPricesId: string; materialId: number }[]
}

// Response
type ShippingRates = {
  shippingMethodId: number | null
  tooLargeForBoxes: boolean     // the parts do not fit the boxes of the manufacturer
  errorWithCarrier: boolean     // the carrier gave no rate
  rates: { id: string; rate: number; currency: string; serviceType: string; serviceName: string; shippingMethodId: number }[]
}[]

{ order: Order; requisitionMapping: Record<string, Requisition> }   // key: your line key

type Order = {
  id: number
  state: 'QUOTE' | 'ORDER'
  quoteNumber: string | null
  orderNumber: string | null    // set when the quote becomes an order
  price: number | null
  currency: string
  paymentStatus: 'UNPAID' | 'PROCESSING' | 'PAID' | 'REFUNDED' | 'EXTERNALLY_TRACKED'
  isReviewRequired: boolean
  isVoided: boolean
  isArchived: boolean
  operatorNote: string | null
  purchaseOrderNumber: string | null
  requisitionIds: number[]
  threadId: number              // for messages and files
  shipping: Shipping | null
  shipments: Shipment[]
  billingAddress: Address | null
  discount: { discountId: number; code: string | null; percentage: number } | null
  tax: object | null
  kanbanColumn: { id: string; name: string; color: string | null } | null   // production stage
  createdAt: string
  lastUpdated: string
}

type Requisition = {
  id: number
  orderId: number
  sequence: number
  name: string
  partRevisionId: string
  units: MeasurementUnit
  quantity: number
  processPricesId: string
  materialId: number
  colorId: number | null
  infillId: number | null
  precisionId: number | null
  leadTimeId: string | null
  postProcessingIds: number[]
  pricePaid: number | null
  watertight: boolean
}

type Shipment = {
  id: string
  type: 'COURIER' | 'COLLECTION'
  fulfilledAt: string
  destination: object
  parcels: object[]
  tracking?: { provider: string; providerService: string; trackingNumber: string; trackingUrl: string | null } | null
}

type Payment = {
  id: string
  provider: string              // the paymentProvider of the store
  finalPrice: number
  tax: number
  currency: string
  clientSecret?: string | null
  paymentPrincipal?: string | null
  merchantAccount?: string | null
  flywireGatewayUrl?: string | null
  stripePaymentIntentStatus?: string | null
}

{ "activityType": "CONVERSATION", "conversationType": "GENERIC", "threadId": 880, "message": "When will you ship?" }

type Page<T> = { content: T[]; totalElements: number; totalPages: number; pageNumber: number; pageSize: number; isEmpty: boolean; isFirst: boolean; isLast: boolean }