Origin Energy Orders API

openapi: 3.2.0
info:
  title: Kraken Orders API
  version: v1
  description: APIs for placing and managing orders.
servers:
- url: https://api.origin-kraken.energy/v1
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: orders
  x-title: Orders
  description: APIs for placing and managing orders.
  x-documentation-order: 8
paths:
  /v2/orders/:
    post:
      operationId: V2 Schedule Order
      description: Use this endpoint to schedule the placement of an order in Kraken. It accepts a request containing the necessary information for order placement, validates the data, and creates an order management task to be executed asynchronously.
      summary: Schedule the placement of an order in Kraken
      tags:
      - orders
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleOrder'
            examples:
              ExamplePayload:
                value:
                  external_order_id: ORD-12345678
                  accounts:
                  - type: EXISTING
                    account_identifier: acc-ref-001
                    account_number: A-12345678
                  businesses:
                  - type: EXISTING
                    business_identifier: biz-ref-001
                    company_name: Tentacle Corp
                    company_number: '12345678'
                    business_type: LTD
                  order_lines:
                  - type: CONTRACT_RENEWAL
                    target_type: BUSINESS
                    target_reference: biz-ref-001
                    contract:
                      identifier: contract-001
                      valid_from_date: '2026-01-01'
                      signed_at_date: '2025-12-15'
                      valid_to_date: '2027-01-01'
                      versions: []
                      subjects:
                      - type: ACCOUNT
                        identifier: acc-ref-001
                summary: Example payload
        required: true
      security:
      - DataImportViewerAPIKeyAuthentication: []
      - DRFKrakenTokenAuthentication: []
      responses:
        '201':
          description: The payload has been successfully scheduled.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardizedValidationErrorResponse'
              examples:
                ScheduleOrderValidationErrorResponse:
                  value:
                    code: order_process_failed_validation
                    detail: Order payload validation failed.
                    domain: order_process
                  summary: Schedule order validation error response
                  description: If there are validation errors, a 400 Bad Request response will be returned detailing the errors. To resolve these errors, refer to the field definitions and validation rules.
                ScheduleOrderErrorResponse:
                  value:
                    non_field_errors:
                      detail: The order with external order ID ORD-12345678 has already been processed.
                      code: order_process_already_processed
                  summary: Schedule order error response
                  description: If an order has already been processed, a 400 Bad Request response will be returned.
          description: Validation errors occurred while processing the request.
      x-doc-alerts: []
  /v2/orders/{external_order_id}/:
    get:
      operationId: V2 Order Status
      description: Use this endpoint to retrieve the current status of an order. The order is identified by its external_order_id.
      summary: Return the status of an order process
      parameters:
      - in: path
        name: external_order_id
        schema:
          type: string
        required: true
      tags:
      - orders
      security:
      - DataImportViewerAPIKeyAuthentication: []
      - DRFKrakenTokenAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportStatusResponse'
              examples:
                OrderStatusSuccessResponse(processed):
                  value:
                    status: PROCESSED
                    created_at: '2025-04-17T00:00:00Z'
                    modified_at: '2025-04-17T01:00:00Z'
                    latest_error: null
                    latest_event:
                      event: ORDER_PROCESS_SUCCEEDED
                      occurred_at: '2025-04-17T01:00:00Z'
                      data: null
                  summary: Order status success response (processed)
                  description: A successful response for an order that has been processed.
                OrderStatusSuccessResponse(errored):
                  value:
                    status: ERRORED
                    created_at: '2025-04-17T00:00:00Z'
                    modified_at: '2025-04-17T01:30:00Z'
                    latest_error:
                      code: validation_error
                      detail: Account number is invalid
                      domain: accounts
                    latest_event:
                      event: ORDER_PROCESS_ERRORED
                      occurred_at: '2025-04-17T01:30:00Z'
                      data:
                        code: validation_error
                        detail: Account number is invalid
                        domain: accounts
                  summary: Order status success response (errored)
                  description: A successful response for an order that has errored during processing.
          description: The status of the order.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OrderNotFoundResponse:
                  value:
                    detail: The requested resource was not found.
                    code: not_found
                  summary: Order not found response
                  description: Returned when no order process exists for the given external_order_id.
          description: Order not found for the given external_order_id.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidOrderProcessStatusResponse:
                  value:
                    detail: 'Order process has no status set for external_order_id: example-order-id'
                    code: invalid_status_for_order_process
                  summary: Invalid order process status response
                  description: Returned when the order process has an invalid or missing status.
          description: The order process has an invalid or missing status.
      x-doc-alerts: []
components:
  schemas:
    AusGasAgreement:
      type: object
      properties:
        market_name:
          enum:
          - AUS_GAS
          type: string
          x-spec-enum-id: 0c099a1ab65e563b
          description: <p>The market name of the supply point.</p>
          x-enum-descriptions:
            AUS_GAS: AUS_GAS
        account_reference:
          type: string
          description: <p>The identifier of the account that owns this supply point. Must match one of the contract's subject accounts.</p>
        agreed_at:
          type:
          - string
          - 'null'
          format: date-time
          description: <p>The datetime the agreement was agreed at.</p>
        business_contract_identifier:
          type:
          - string
          - 'null'
          description: <p>The identifier of the business contract this agreement should be linked to.</p>
        characteristics:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ProductCharacteristic'
          description: <p>Characteristics of the agreed product that the customer has chosen.</p>
          x-validators:
          - name: Validate that each child has unique values for the <code>⁨code⁩</code> field
            description: Validate that each child has unique values for the <code>⁨code⁩</code> field.
            possible_errors:
            - children_with_duplicate_values
        effective_from:
          type: string
          format: date
          description: <p>The date from which the agreement is effective (inclusive), i.e. the agreement starts on the midnight of this date, such that this date becomes the first day covered by this agreement.</p>
        effective_to:
          type:
          - string
          - 'null'
          format: date
          description: <p>The date to which the agreement is effective (exclusive), i.e. the agreement will end on the midnight of this date, such that the previous day is the last day covered by this agreement.</p>
        intermediary:
          allOf:
          - $ref: '#/components/schemas/AgreementIntermediaryDetails'
          description: <p>Details about the intermediary relationship for this agreement. When provided, an intermediary link will be created between the agreement and the portfolio, establishing a business intermediary relationship.</p>
        product_addons:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AusAgreementAddOn'
          description: <p>A list of product addons that apply to the specific agreement.</p>
        rate_overrides:
          type: object
          additionalProperties:
            type: string
            format: decimal
            pattern: ^-?\d{0,10}(?:\.\d{0,5})?$
          description: <p>Agreement rate overrides.</p>
        rates_agreed_at:
          type:
          - string
          - 'null'
          format: date-time
          description: <p>The datetime the rates were agreed at.</p>
        supply_point_identifier:
          type: string
          description: <p>The identifier of the supply point to add the agreement to.</p>
        tariff_code:
          type: string
          description: <p>The code for the agreement tariff. Must match an existing tariff code of an active product.</p>
          x-validators:
          - name: Validate product code exists
            description: Validate that the product code exists in Kraken.
            possible_errors:
            - product_code_does_not_exist
      required:
      - account_reference
      - effective_from
      - market_name
      - supply_point_identifier
      - tariff_code
      x-validators:
      - name: Validate <code>⁨effective_to⁩</code> not before <code>⁨effective_from⁩</code>
        description: Validates that <code>⁨effective_to⁩</code>, if given, is on or later than <code>⁨effective_from⁩</code>.
        possible_errors:
        - start_date_later_than_end_date
    ContractSalesRecord:
      type: object
      properties:
        affiliate_organisation_name:
          type: string
          description: <p>The affiliate organisation name associated with the contract.</p>
          maxLength: 128
          x-validators:
          - name: Validate affiliate organisation exists
            description: Validate that an affiliate organisation exists in Kraken for the given name.
            possible_errors:
            - affiliate_organisation_does_not_exist
        sales_channel:
          enum:
          - DIRECT
          - PRICE_COMPARISON
          - TELESALES
          - DIGI_TELESALES
          - EVENTS
          - FIELD_SALES
          - AGGREGATOR
          - PARTNERSHIPS
          - NEW_TENANT
          - MOVE_IN
          - WORKPLACE_POP_UP
          - BROKER
          - PARENT_POWER
          - PEOPLE_POWER
          - GIFT_OF_KIT
          - HIGH_REFERRER
          - SUPPLIER_OF_LAST_RESORT
          - ACQUISITION
          - WORKS_WITH_OCTOPUS
          - LANDLORD
          - DEBT_COLLECTION_AGENCY
          type: string
          x-spec-enum-id: f4ccf4dcda60c174
          description: <p>The sales channel associated with the contract</p>
          x-enum-descriptions:
            DIRECT: Direct
            PRICE_COMPARISON: Price comparison
            TELESALES: Telesales
            DIGI_TELESALES: Digital telesales
            EVENTS: Events
            FIELD_SALES: Field sales
            AGGREGATOR: Aggregator
            PARTNERSHIPS: Partnerships
            NEW_TENANT: New tenant
            MOVE_IN: Move in
            WORKPLACE_POP_UP: Workplace pop-up
            BROKER: Broker
            PARENT_POWER: Parent power
            PEOPLE_POWER: People power
            GIFT_OF_KIT: Gift of kit
            HIGH_REFERRER: High referrer
            SUPPLIER_OF_LAST_RESORT: Supplier of last resort
            ACQUISITION: Acquisition
            WORKS_WITH_OCTOPUS: Works with octopus
            LANDLORD: Landlord
            DEBT_COLLECTION_AGENCY: Debt collection agency
      x-validators:
      - name: Sales channel matches affiliate organisation
        description: Validates that when an affiliate_organisation_name is provided, the sales_channel is in the set of channels configured for that organisation.
        possible_errors:
        - sales_channel_does_not_match_affiliate_organisation
    PartnerCommissionConfig:
      type: object
      properties:
        apply_uplift:
          type: boolean
          default: false
          description: <p>Whether to apply a product uplift for this partner commission. Defaults to <code>false</code>.</p>
        override_trailing_percentage:
          type:
          - string
          - 'null'
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
          description: <p>Optional override for the trailing commission percentage. Overrides the default percentage on the partner commission.</p>
        override_unit_amount:
          type:
          - string
          - 'null'
          format: decimal
          pattern: ^-?\d{0,8}(?:\.\d{0,8})?$
          description: <p>Optional override for the unit-based commission rate. Overrides the default unit amount on the partner commission.</p>
        partner_commission_number:
          type: string
          description: <p>The unique identifier of the partner commission (e.g. <code>OPC-XXXXXXXX</code> or <code>TPC-XXXXXXXX</code>).</p>
          maxLength: 20
      required:
      - partner_commission_number
    StandardizedValidationErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: <p>The code for the error.</p>
        detail:
          type: string
          description: <p>A description of the error.</p>
        errors:
          type: array
          items:
            $ref: '#/components/schemas/StandardizedError'
          description: <p>A list of field-specific errors.</p>
      required:
      - code
      - detail
      - errors
    PromotionAssignmentSchedule:
      type: object
      properties:
        discount_targets:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/PromotionAssignmentTarget'
          description: <p>Mapping of discount code to a list of targets the discount applies to.</p>
        params:
          type: object
          description: '<p>Optional parameters for the promotion assignment schedule. Supports the following keys: <code>promotion_start_date</code> — an ISO 8601 datetime string (e.g. <code>2024-01-15T00:00:00+00:00</code>) that overrides the date used when calculating promotion eligibility (e.g. months since sign-up). If omitted, the date is derived from the customer''s agreement.</p>'
        promotion_code:
          type: string
          description: <p>The promotion code to apply.</p>
      required:
      - discount_targets
      - promotion_code
      x-validators:
      - name: Promotion assignment discount targets are valid
        description: Validates that the promotion exists, discounts are defined in the promotion, target types match the discount target type, and target identifiers are valid.
        possible_errors:
        - discount_not_in_promotion
        - invalid_input_data
        - promotion_not_registered
        - rate_source_provider_not_registered
        - source_data_not_supported_for_fixed_rate
        - source_data_reference_mismatch
        - target_identifier_invalid
        - target_type_mismatch
        - target_type_not_registered
      - name: Promotion assignment params are valid
        description: Validates that the params field contains only valid values. If promotion_start_date is provided, it must be a valid ISO 8601 datetime string.
        possible_errors:
        - invalid_promotion_start_date
    LatestError:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
          description: <p>The error code identifying the type of error that occurred.</p>
        detail:
          type:
          - string
          - 'null'
          description: <p>A detailed description of the error that occurred.</p>
        domain:
          type:
          - string
          - 'null'
          description: <p>The domain or context in which the error occurred.</p>
    Terms:
      oneOf:
      - $ref: '#/components/schemas/BespokeRateConfiguration'
      - $ref: '#/components/schemas/BillDueDate'
      - $ref: '#/components/schemas/BillingDocumentIssuanceFrequencyTerm'
      - $ref: '#/components/schemas/CharacteristicOverrideConfiguration'
      - $ref: '#/components/schemas/CollateralRequired'
      - $ref: '#/components/schemas/ContractMetaData'
      - $ref: '#/components/schemas/ContractedVolumeConfiguration'
      - $ref: '#/components/schemas/CorrectivePeriod'
      - $ref: '#/components/schemas/DelayerDays'
      - $ref: '#/components/schemas/GuaranteeOfOriginConfiguration'
      - $ref: '#/components/schemas/LatePaymentFees'
      - $ref: '#/components/schemas/MinimumContractLength'
      - $ref: '#/components/schemas/PartnerCommission'
      - $ref: '#/components/schemas/PaysByDirectDebitTerm'
      - $ref: '#/components/schemas/ProductRateOverrideConfiguration'
      - $ref: '#/components/schemas/PromotionAssignmentTerm'
      - $ref: '#/components/schemas/RateGroupEligibilityConfiguration'
      - $ref: '#/components/schemas/TrancheTargetResidualFee'
      - $ref: '#/components/schemas/TaxAdjustmentConfiguration'
      - $ref: '#/components/schemas/TerminationFee'
      - $ref: '#/components/schemas/AusEEPAExportContractedVolumeConfiguration'
      discriminator:
        propertyName: term_type
        mapping:
          BESPOKE_RATE_CONFIGURATION: '#/components/schemas/BespokeRateConfiguration'
          BILL_DUE_DATE: '#/components/schemas/BillDueDate'
          ISSUANCE_FREQUENCY: '#/components/schemas/BillingDocumentIssuanceFrequencyTerm'
          CHARACTERISTIC_OVERRIDE: '#/components/schemas/CharacteristicOverrideConfiguration'
          COLLATERAL_REQUIRED: '#/components/schemas/CollateralRequired'
          CONTRACT_METADATA: '#/components/schemas/ContractMetaData'
          CONTRACTED_VOLUME_CONFIGURATION: '#/components/schemas/ContractedVolumeConfiguration'
          CORRECTIVE_PERIOD: '#/components/schemas/CorrectivePeriod'
          DELAYER_DAYS: '#/components/schemas/DelayerDays'
          GUARANTEE_OF_ORIGIN_CONFIGURATION: '#/components/schemas/GuaranteeOfOriginConfiguration'
          LATE_PAYMENT_FEES: '#/components/schemas/LatePaymentFees'
          MINIMUM_CONTRACT_LENGTH: '#/components/schemas/MinimumContractLength'
          PARTNER_COMMISSION: '#/components/schemas/PartnerCommission'
          PAYS_BY_DIRECT_DEBIT: '#/components/schemas/PaysByDirectDebitTerm'
          PRODUCT_RATE_OVERRIDE_SCHEDULE: '#/components/schemas/ProductRateOverrideConfiguration'
          PROMOTION_ASSIGNMENT: '#/components/schemas/PromotionAssignmentTerm'
          RATE_GROUP_ELIGIBILITY: '#/components/schemas/RateGroupEligibilityConfiguration'
          TRANCHE_TARGET_RESIDUAL_FEE: '#/components/schemas/TrancheTargetResidualFee'
          TAX_ADJUSTMENT_CONFIGURATION: '#/components/schemas/TaxAdjustmentConfiguration'
          TERMINATION_FEE: '#/components/schemas/TerminationFee'
          EEPA_EXPORT_CONTRACTED_VOLUME: '#/components/schemas/AusEEPAExportContractedVolumeConfiguration'
    PortfolioSettings:
      type: object
      properties:
        collective_billing:
          type: boolean
          default: false
          description: <p>Set all accounts on the portfolio to be billed collectively. This value can only be provided if the account is the portfolio lead account.</p>
        collective_payments:
          type: boolean
          default: false
          description: <p>Set all accounts on the portfolio to pay collectively. This value can only be provided if the account is the portfolio lead account.</p>
        delegate_billing_schedule_to_children:
          type: boolean
          default: false
          description: <p>When using collective billing, use the child account's billing options to determine when we charge and prepare billing documents (as opposed to using the lead account's options). This value can only be provided if the account is the portfolio lead account.</p>
        send_collective_bill_constituent_messages:
          type: boolean
          default: false
          description: <p>When using collective billing, send collective bill constituent messages to each member of the collective bill. This value can only be provided if the account is the portfolio lead account.</p>
    NoteDocument:
      type: object
      properties:
        document_path:
          type: string
          description: <p>The S3 relative path to the document to be attached to the note.</p>
          x-validators:
          - name: Validate path exists in file store
            description: Validate that the given path corresponds to a file that has previously been uploaded to the migration file store. Note that this validation is disabled by default and can be enabled using the relevant feature flag.
            possible_errors:
            - path_does_not_exist_in_file_store
      required:
      - document_path
    AusStructuredStreetAddress:
      type: object
      properties:
        building_or_property_name:
          type: string
          description: <p>Building or property name. No longer than 60 chars as two lines of 30 chars each. If more than 30 chars, there must be a <code>\n</code> after 30 chars.</p>
          maxLength: 60
          x-validators:
          - name: Validate multiline max length
            description: Validates that the value has at most 2 lines and max 30 characters per line.
            possible_errors:
            - multiline_max_length_exceeded
        flat_or_unit_number:
          type: string
          description: <p>if supplied, <code>flat_or_unit_type</code> must be as well. limit of 7 characters, numbers and <code>.</code> with optional alphabetical prefix and suffix.</p>
        flat_or_unit_type:
          enum:
          - ANT
          - APT
          - ATM
          - BBQ
          - BLCK
          - BTSD
          - BLDG
          - BNGW
          - CAGE
          - CARP
          - CARS
          - CLUB
          - COOL
          - CTGE
          - DUP
          - FY
          - F
          - GRGE
          - HALL
          - HSE
          - KSK
          - LSE
          - LBBY
          - LOFT
          - LOT
          - MSNT
          - MB
          - 'OFF'
          - PTHS
          - REAR
          - RESV
          - RM
          - SEC
          - SHED
          - SHOP
          - SHRM
          - SIGN
          - SITE
          - SL
          - STOR
          - STR
          - STU
          - SUBS
          - SE
          - TNCY
          - TWR
          - TNHS
          - U
          - VLT
          - VLLA
          - WARD
          - WE
          - WKSH
          type: string
          x-spec-enum-id: 9306e5734ae7a103
          description: <p>Flat or unit type.</p>
          x-enum-descriptions:
            ANT: Antenna
            APT: Apartment
            ATM: ATM
            BBQ: Barbeque
            BLCK: Block
            BTSD: Boatshed
            BLDG: Building
            BNGW: Bungalow
            CAGE: Cage
            CARP: Carpark
            CARS: Carspace
            CLUB: Club
            COOL: Coolroom
            CTGE: Cottage
            DUP: Duplex
            FY: Factory
            F: Flat
            GRGE: Garage
            HALL: Hall
            HSE: House
            KSK: Kiosk
            LSE: Lease
            LBBY: Lobby
            LOFT: Loft
            LOT: Lot
            MSNT: Maisonette
            MB: Marine Berth
            'OFF': Office
            PTHS: Penthouse
            REAR: Rear
            RESV: Reserve
            RM: Room
            SEC: Section
            SHED: Shed
            SHOP: Shop
            SHRM: Showroom
            SIGN: Sign
            SITE: Site
            SL: Stall
            STOR: Store
            STR: Strata Unit
            STU: Studio
            SUBS: Substation
            SE: Suite
            TNCY: Tenancy
            TWR: Tower
            TNHS: Townhouse
            U: Unit
            VLT: Vault
            VLLA: Villa
            WARD: Ward
            WE: Warehouse
            WKSH: Workshop
        floor_or_level_number:
          type: string
          description: <p>if supplied, <code>floor_or_level_type</code> must be as well. limit of 5 characters, numbers and <code>.</code> with optional alphabetical prefix and suffix</p>
          maxLength: 7
        floor_or_level_type:
          enum:
          - B
          - FL
          - G
          - L
          - LG
          - M
          - LL
          - OD
          - P
          - PTHS
          - PLF
          - PDM
          - RT
          - SB
          - UG
          - LB
          type: string
          x-spec-enum-id: 9810b2a79eb3d5cf
          description: <p>Floor or level type.</p>
          x-enum-descriptions:
            B: Basement
            FL: Floor
            G: Ground
            L: Level
            LG: Lower Ground
            M: Mezzanine
            LL: Lower Level
            OD: Observation Deck
            P: Parking
            PTHS: Penthouse
            PLF: Platform
            PDM: Podium
            RT: Rooftop
            SB: Sub-Basement
            UG: Upper Ground
            LB: Lobby
        house_number_1:
          type: integer
          description: <p>House number 1. If provided, <code>street_name</code> must be as well.</p>
        house_number_2:
          type: integer
          description: <p>House number 2. If provided, <code>house_number_1</code> must be as well.</p>
        house_number_suffix_1:
          type: string
          description: <p>House number suffix 1. If provided, <code>house_number_1</code> must be as well.</p>
          maxLength: 1
        house_number_suffix_2:
          type: string
          description: <p>House number suffix 2. If provided, <code>house_number_2</code> must be as well.</p>
          maxLength: 1
        location_descriptor:
          type: string
          description: <p>A description of the location.</p>
        lot_number:
          type: string
          description: <p>Letters, numbers and <code>.</code>.</p>
          maxLength: 6
        postal_delivery_number_prefix:
          type: string
          description: <p>Postal delivery number prefix. Alphabetical (Uppercase). If provided, <code>postal_delivery_number_value</code> must be as well.</p>
          maxLength: 3
          x-validators:
          - name: Validate value contains only alphabetic capitals
            description: Validate the value contains only capital letters A-Z.
            possible_errors:
            - value_must_be_alphabetic_caps
        postal_delivery_number_suffix:
          type: string
          description: <p>Postal delivery number suffix. Alphabetical (Uppercase). If provided, <code>postal_delivery_number_value</code> must be as well.</p>
          maxLength: 3
          x-validators:
          - name: Validate value contains only alphabetic capitals
            description: Validate the value contains only capital letters A-Z.
            possible_errors:
            - value_must_be_alphabetic_caps
        postal_delivery_number_value:
          type: integer
          description: <p>Postal delivery number value. If provided, <code>postal_delivery_typ</code> must be as well.</p>
        postal_delivery_type:
          enum:
          - CARE PO
          - CMA
          - CMB
          - CPA
          - GPO BOX
          - LOCKED BAG
          - MS
          - PO BOX
          - PRIVATE BAG
          - RSD
          - RMB
          - RMS
          type: string
          x-spec-enum-id: 4faa648b6a55c770
          description: <p>Postal delivery type.</p>
          x-enum-descriptions:
            CARE PO: CARE PO
            CMA: CMA
            CMB: CMB
            CPA: CPA
            GPO BOX: GPO BOX
            LOCKED BAG: LOCKED BAG
            MS: MS
            PO BOX: PO BOX
            PRIVATE BAG: PRIVATE BAG
            RSD: RSD
            RMB: RMB
            RMS: RMS
        street_name:
          type: string
          description: <p>Street name.</p>
          maxLength: 45
        street_suffix:
          enum:
          - CN
          - DE
          - E
          - EX
          - IN
          - LR
          - ML
          - N
          - NE
          - NW
          - OF
          - 'ON'
          - OT
          - OP
          - S
          - SE
          - SW
          - UP
          - W
          type: string
          x-spec-enum-id: f105f3c67a4f2af4
          description: <p>Street suffix. If provided, <code>street_name</code> must be as well.</p>
          x-enum-descriptions:
            CN: Central
            DE: Deviation
            E: East
            EX: Extension
            IN: Inner
            LR: Lower
            ML: Mall
            N: North
            NE: North East
            NW: North West
            OF: 'Off'
            'ON': 'On'
            OT: Outer
            OP: Overpass
            S: South
            SE: South East
            SW: South West
            UP: Upper
            W: West
        street_type:
          enum:
          - ACCS
          - ACRE
          - ALLY
          - ALWY
          - AMBL
          - ANCG
          - ANX
          - APP
          - ARC
          - ARTL
          - ART
          - AVE
          - BA
          - BANK
          - BASN
          - BAY
          - BCH
          - BEND
          - BLK
          - BWLK
          - BVD
          - BVDE
          - BOWL
          - BRCE
          - BRAE
          - BRAN
          - BRK
          - BRET
          - BDGE
          - BDWY
          - BROW
          - BYPA
          - BYWY
          - CAUS
          - CTR
          - CNWY
          - CH
          - CIR
          - CLT
          - CCT
          - CRCS
          - CL
          - CLR
          - CLDE
          - CMMN
          - CNCD
          - CON
          - CNN
          - CPS
          - CNR
          - CSO
          - CRSE
          - CT
          - CTYD
          - COVE
          - CRES
          - CRST
          - CRF
          - CRK
          - CRSS
          - CRSG
          - CRD
          - COWY
          - CUWY
          - CDS
          - CUT
          - CTTG
          - DALE
          - DASH
          - DELL
          - DENE
          - DEVN
          - DIP
          - DSTR
          - DIV
          - DOCK
          - DOM
          - DOWN
          - DWNS
          - DR
          - DRWY
          - ESMT
          - EDGE
          - ELB
          - END
          - ENT
          - ESP
          - EST
          - EXP
          - EXTN
          - FAWY
          - FTRK
          - FBRK
          - FLNE
          - FITR
          - FLAT
          - FLTS
          - FOLW
          - FTWY
          - FORD
          - FSHR
          - FK
          - FORM
          - FWY
          - FRNT
          - FRTG
          - GAP
          - GDN
          - GDNS
          - GTE
          - GTES
          - GTWY
          - GLD
          - GLEN
          - GRA
          - GRN
          - GRND
          - GR
          - GLY
          - HRBR
          - HVN
          - HETH
          - HTS
          - HRD
          - HWY
          - HILL
          - HLLW
          - HUB
      

# --- truncated at 32 KB (176 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/origin-energy/refs/heads/main/openapi/origin-energy-orders-api-openapi.yml