PartnerCreateCompleteOrderModel

Creates a vehicle service contract order with complete customer and payment information. Before calling this endpoint, you must perform a plan search to obtain searchResultPlanId values.

  • payment
    Type: object · CreatePaymentModel
    required

    Payment details including card information and payment option. Required.

    Payment information for creating an order. Contains credit/debit card details and payment terms. For Finco-shaped orders, card fields (Chaiz.API.Models.CreatePaymentModel.AccountNumber, Chaiz.API.Models.CreatePaymentModel.CreditCardExpirationDateString, Chaiz.API.Models.CreatePaymentModel.CVC, Chaiz.API.Models.CreatePaymentModel.MethodType) may be omitted — the embedded Shift widget collects them on the frontend and the backend never sees them. Chaiz.API.Models.CreatePaymentModel.PaymentOption stays required because it drives plan-side pricing on both paths. Whole-model validation is enforced by !:CreateNewOrderModel.Validate.

    • paymentOption
      Type: string · PaymentOptionenum
      required

      Payment option (installment plan). Required for both USAePay and Finco-shaped orders. Values: 0 = Monthly Payments, 2 = Pay in Full (one-time payment).

      Possible values: Default (0) - Default, Half (1) - Half, Full (2) - Full

      values
      • Default
      • Half
      • Full
    • accountNumber
      Type: string | null
      min length:  
      13
      max length:  
      16      Format: credit-card

      Credit or debit card number (13-16 digits). Required for USAePay-shaped orders; omitted for Finco-shaped orders where the Shift widget collects card data on the FE. For testing, use 4111111111111111 (Visa test card).

    • creditCardExpirationDateString
      Type: string | null

      Card expiration date in MM/YYYY format. Required for USAePay-shaped orders; omitted for Finco-shaped orders. Must be a valid future date when supplied.

    • cvc
      Type: string | null
      min length:  
      3
      max length:  
      5       Pattern: ^\d+$

      Card security code (CVV/CVC). 3-5 digits. Required for most USAePay transactions; omitted for Finco-shaped orders.

    • methodType
      Type: string · PaymentMethodTypeenum

      Possible values: None (0) - None, VISA (1) - Visa, MASTERCARD (2) - Master Card, AmericanExpress (3) - American Express, Discover (4) - Discover, ACHSavings (5) - ACH Savings, ACHChecking (6) - ACH Checking

      values
      • None
      • VISA
      • MASTERCARD
      • AmericanExpress
      • Discover
      • ACHSavings
      • ACHChecking
  • searchResultPlanIds
    Type: array integer[]
    required

    Array of searchResultPlanId values from a previous plan search. Required. These IDs identify which specific plans the customer wants to purchase. Typically contains a single plan ID, but can include multiple for bundled purchases.

  • userDetails
    Type: object · PartnersUserDetailsMainModel
    required

    Customer billing and contact information. Required. Includes name, email, phone, and address details.

    Partner-specific customer information for order creation. Extends UserDetailsMainModel with an optional external ID for partner tracking.

    • address
      Type: string Pattern: ^(?=.*[a-zA-Z])(?!.*@).*$
      required

      Customer's street address. Required. 5-60 characters, must include street name.

    • city
      Type: string Pattern: ^[A-Za-z\u00C0-\u024F''.\-]+(?:[\s\-][A-Za-z\u00C0-\u024F''.\-]+)*$
      required

      Customer's city. Required. 3-32 characters.

    • email
      Type: string Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$Format: email
      required

      Customer's email address. Required. Must be a valid email format.

    • firstName
      Type: string Pattern: ^[a-zA-Z' .-]+$
      required

      Customer's first name. Required. 2-32 characters, letters only (including dot, whitespace, dash, apostrophe).

    • lastName
      Type: string Pattern: ^[a-zA-Z' .-]+$
      required

      Customer's last name. Required. 2-32 characters, letters only (including dot, whitespace, dash, apostrophe).

    • state
      Type: string Pattern: ^[a-zA-Z]+$
      required

      Two-letter US state code. Required. Must match the state derived from the ZIP code.

    • zip
      Type: stringFormat: postal-code
      required

      5-digit US ZIP code. Required. Must be a valid ZIP code that matches the state.

    • addressApartment
      Type: string | null

      Optional. Apartment, suite, or unit number. Maximum 4 characters.

    • externalId
      Type: string | null

      Optional. Your internal customer/user ID for tracking purposes. This ID will be stored with the order and included in webhook notifications.

    • phoneNumber
      Type: string | null

      Customer's phone number. Optional but recommended. 10-digit US phone number.

  • device
    Type: string | null

    Optional. Device type for analytics tracking. Common values: "Desktop", "Mobile", "Tablet"

  • partner
    Type: string | null

    Your unique partner identifier provided during onboarding. Optional — if omitted, resolved automatically from your authentication token.

  • selectedAddonIds
    Type: array integer[] | null

    Optional. Array of add-on IDs to include with the order. Add-on IDs are returned in the plan search results under each plan's addons array.