How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Origin Energy Orders API

APIs for placing and managing orders.

Origin Energy Orders API is one of 23 APIs that Origin Energy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 91 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.origin-kraken.energy/v1.

2 operations 2 paths 91 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.mydata.cdr.originenergy.com.au
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Origin Energy Orders API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (DRFKrakenTokenAuthentication). An API key is passed in the header as Authorization (DataImportViewerAPIKeyAuthentication).

  • DRFKrakenTokenAuthentication — JWT-based authentication
  • DataImportViewerAPIKeyAuthentication — Token-based authentication with required prefix "Token "

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

orders 2

APIs for placing and managing orders.

POST
/v2/orders/
Schedule the placement of an order in Kraken
V2 Schedule Order body → 201400
GET
/v2/orders/{external_order_id}/
Return the status of an order process
V2 Order Status 1 param → 200404500

Schemas 91

The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are BusinessUser (21 properties), AusStructuredStreetAddress (18 properties), AusEmbeddedElectricityAgreement (13 properties), AusSolarPpaAgreement (13 properties). Each schema is shown below with its type and property counts.

AusGasAgreement
object
13 properties 5 required
ContractSalesRecord
object
2 properties
PartnerCommissionConfig
object
4 properties 1 required
StandardizedValidationErrorResponse
object
3 properties 3 required
PromotionAssignmentSchedule
object
3 properties 2 required
LatestError
object
3 properties
Terms
PortfolioSettings
object
4 properties
NoteDocument
object
1 property 1 required
AusStructuredStreetAddress
object
18 properties
BillingDocumentIssuanceFrequencyTerm
object
6 properties 5 required
TaxAdjustmentConfiguration
object
3 properties 2 required
CharacteristicOverrideConfiguration
object
3 properties 2 required
TerminationFee
object
5 properties 3 required
PromotionAssignmentTarget
object
4 properties 2 required
CollateralRequired
object
5 properties 3 required
TaskParameters
object
3 properties
ProductRateOverrideSchedule
object
3 properties 1 required
TrancheTargetResidualFeeMarket
object
3 properties 3 required
OrderAccount
PartnerCommission
object
3 properties 2 required
TimeSeriesSpecificationEligibilitySchedule
object
5 properties 4 required
AusAgreementAddOn
object
1 property 1 required
ContractRenewalAgreementByMarketName
OrderBusiness
PaysByDirectDebitTerm
object
3 properties 2 required
ExistingBusiness
object
10 properties 2 required
BusinessDetail
object
2 properties 2 required
ImportEvent
object
3 properties 2 required
ScheduleOrder
object
2 properties 2 required
ProductRateOverrideItemByVariantProfile
object
5 properties 3 required
Order
object
5 properties 4 required
IndexationOption
object
2 properties 2 required
PortfolioReference
object
2 properties 2 required
CorrectivePeriodMarketConfig
object
4 properties 3 required
TrancheTargetResidualFee
object
4 properties 3 required
ContractMetaData
object
3 properties 2 required
NewBusiness
object
10 properties 2 required
Metadata
object
2 properties 2 required
AusEEPAExportContractedVolumePeriod
object
5 properties 5 required
ContractSubject
object
4 properties 2 required
Address
object
11 properties 1 required
AusEmbeddedElectricityAgreement
object
13 properties 5 required
PromotionAssignmentTerm
object
3 properties 2 required
AccountReference
object
2 properties 2 required
GuaranteeOfOriginConfiguration
object
3 properties 2 required
SalesInfo
object
9 properties 2 required
BespokeRateConfiguration
object
3 properties 2 required
AgreementIntermediaryDetails
object
2 properties 1 required
SupplyPointTaxAdjustment
object
7 properties 5 required
CustomerAlternativeNumber
object
1 property
OrderManagementContractWithSubjects
object
7 properties 4 required
StandardizedError
object
3 properties 3 required
BusinessPortfolio
object
4 properties 1 required
BillDueDate
object
4 properties 3 required
ContractedVolumeConfiguration
object
3 properties 2 required
ProductRateOverrideConfiguration
object
4 properties 2 required
EffectivePeriod
object
2 properties 1 required
CharacteristicOverride
object
3 properties 2 required
BespokeRateItem
object
5 properties 3 required
SalesChannelCharacteristic
object
2 properties 2 required
ProductRateOverrideItemByRateBand
object
3 properties 3 required
BespokeRateSchedule
object
6 properties 3 required
ExistingAccount
object
4 properties 3 required
AusPropertyRichAddress
object
11 properties 5 required
VariantProfile
object
2 properties
ImportStatusResponse
object
6 properties 4 required
NewAccount
object
8 properties 5 required
ContractRenewal
object
5 properties 4 required
OrderLine
AusEmbeddedUnmeteredElectricityAgreement
object
13 properties 5 required
AusEEPAExportContractedVolumeConfiguration
object
3 properties 2 required
ProductCharacteristic
CustomerUserDetail
object
2 properties 2 required
AusEmbeddedUnmeteredGasAgreement
object
13 properties 5 required
AusEmbeddedWaterAgreement
object
13 properties 5 required
BusinessUser
object
21 properties 1 required
RateGroupEligibilitySchedule
object
5 properties 4 required
AusElectricityAgreement
object
13 properties 5 required
AusEmbeddedGasAgreement
object
13 properties 5 required
AusSolarPpaAgreement
object
13 properties 5 required
LatePaymentFees
object
6 properties 4 required
Note
object
7 properties
ErrorResponse
object
2 properties 2 required
ContractedVolumePeriod
object
5 properties 5 required
CorrectivePeriod
object
3 properties 2 required
RateGroupEligibilityConfiguration
object
4 properties 3 required
MinimumContractLength
object
5 properties 4 required
ContractVersion
object
2 properties 2 required
DelayerDays
object
4 properties 3 required
BillingInformation
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

origin-energy-orders-api-openapi.yml Raw ↑

Other APIs Origin Energy publishes across the network.

Origin Energy Kraken GraphQL API
Origin Energy Kraken External Events
Origin Energy Kraken Authorization Server
Origin Energy Account Import API
Origin Energy Business Import API
Origin Energy Data Holder Customers API
Origin Energy Data Holder Operations API
Origin Energy Data Import API
Origin Energy Distributed Energy Resources API
Origin Energy Electricity Service Points API
Origin Energy Electricity Usage API
Origin Energy Energy Account Balances API
Where this information came from

This is an independent, third-party profile of Origin Energy Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.