TransactionCustomerDetailsRequest

  • customer
    Type: object · EmbeddedCustomerRequest nullable

    Embedded customer object for inline upsert

    • customer_type
      Type: string · CustomerTypeenum
      required

      Customer classification that affects tax treatment. One of: retail, marketplace, reseller

      values
      • retail
      • marketplace
      • reseller
    • external_created_at
      Type: string · External Created AtFormat: date-time
      required

      Created timestamp from your system, used for audit and reconciliation

    • external_id
      Type: string · External Id
      min length:  
      1
      max length:  
      256
      required

      Unique identifier from your system

    • external_updated_at
      Type: string · External Updated AtFormat: date-time
      required

      Last-updated timestamp from your system, used for audit and reconciliation

    • source
      Type: string · DataSourceenum
      required

      Namespace that scopes external_id to prevent collisions across integrations. All records sharing the same source must have unique external_ids.

      values
      • netsuite
      • priority
      • zoho_books
      • quickbooks
      • salesforce
    • addresses
      Type: object · CustomerAddresses nullable

      Customer billing and shipping addresses

    • comment
      Type: string · Comment
      max length:  
      200       nullable

      Internal notes about this customer

    • customer_status
      Type: stringenum nullable

      Account lifecycle status. active: can be used in new transactions, inactive: soft-deleted and excluded from lookups, suspended: temporarily blocked from new transactions

      values
      • active
      • inactive
      • suspended
    • email
      Type: string · Email
      max length:  
      256       nullable

      Contact email address

    • id
      Type: string · IdFormat: uuid nullable

      Internal identifier (UUID)

    • name
      Type: string · Name
      max length:  
      256       nullable

      Customer display name

    • sub_source
      Type: string · Sub Source
      max length:  
      256       nullable

      Optional sub-source tag (e.g., store name, branch code). Part of the composite identity together with external_id and source.

    • tax_number
      Type: string · Tax Number
      max length:  
      100       nullable

      Tax identification number (e.g., EIN, VAT)

  • customer_external_id
    Type: string · Customer External Id nullable

    External customer ID for lookup (requires customer_source)

  • customer_id
    Type: string · Customer IdFormat: uuid nullable

    Internal customer UUID for lookup

  • customer_source
    Type: stringenum nullable

    Source namespace of the customer to look up. Must match the source value used when the customer was originally created.

    values
    • netsuite
    • priority
    • zoho_books
    • quickbooks
    • salesforce
  • customer_sub_source
    Type: string · Customer Sub Source
    max length:  
    256     nullable

    Sub-source tag of the customer to look up. Must match the value used when the customer was created.

  • customer_type_override
    Type: stringenum nullable

    Override customer type for this transaction only (retail, marketplace, wholesale, retail_exempt)

    values
    • retail
    • marketplace
    • reseller