List orders

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

offset

integer<int32>

default:0

Offset of the page.

limit

integer<int32>

default:10

Size of the page.

filter.customerNumber

string

Optional filtering by customer number

filter.fromUpdatedAt

string<date>

Optional filtering by date from the last update

filter.partnershipType

enum<string>

default:All

Optional filtering by partnership type Partnership types enumeration

Available options:

Affiliate,

Whitelabel,

All

Response

200 - application/json

Response DTO for listing orders by partner ID. Contains the list of orders, count, and pagination information.

isSuccess

boolean

read-only

Success status of the operation based on status code (2xx range).

Example:

true

message

string | null

Optional message to provide additional information about the operation result.

Example:

null

error

object[] | null

Optional error details in case of an error(s).

Hide child attributes

error.severity

enum<string>

Severity of the error.

Available options:

Error,

Warning,

Notice

Example:

"Error"

error.code

string

Internal error code for client processing.

Example:

"validation-failed"

error.message

string

Error message.

Example:

"First name is required for non-business customers."

error.details

string | null

Additional details about the error.

Example:

null

refUri

string<uri> | null

read-only

Optional reference URI to point to the resulting resource.

data

object

Returned data instance.

Hide child attributes

data.orders

object[]

List of orders.

Hide child attributes

data.orders.customerNumber

string

required

Read-only customer number provided by the API

Example:

"123456789"

data.orders.emailAddress

string

required

Email Address of the customer

Example:

"max_mustermann@rabot-charge.de"

data.orders.tariffName

string

required

Name of the selected tariff for this order

Example:

"rabot.smart"

data.orders.contractNumber

string

required

Order / Contract number

Example:

"987654321"

data.orders.firstName

string | null

First name of the customer or NULL if business customer.

Example:

"Max"

data.orders.lastName

string | null

Last name of the customer or NULL if business customer.

Example:

"Mustermann"

data.orders.businessName

string | null

Business name or NULL if private customer

Example:

null

data.orders.meterNumber

string | null

Meter number as provided as part of the order, can be null

Example:

"12LN6786454"

data.orders.meLoIdentifier

string | null

Metering Location identifier or NULL if not provided

Example:

"DE12345678901234567890"

data.orders.maLoIdentifier

string | null

Market Location identifier or NULL if not provided

Example:

"99987999749"

data.orders.deliveryAddress

object

Delivery address of the customer

Hide child attributes

data.orders.deliveryAddress.title

string | null

Academic title or NULL if none

Example:

"Dr."

data.orders.deliveryAddress.firstName

string | null

First name or NULL if business address

Example:

"Thomas"

data.orders.deliveryAddress.lastName

string | null

Last name or NULL if business address

Example:

"Mustermann"

data.orders.deliveryAddress.businessName

string | null

Business name in case of business address or NULL if person

Example:

null

data.orders.deliveryAddress.gender

enum<string>

Gender of the address holder

Available options:

Male,

Female,

Other

data.orders.deliveryAddress.extension

string | null

Address extension

Example:

null

data.orders.deliveryAddress.streetName

string

Street name

Example:

"Grüner Weg"

data.orders.deliveryAddress.houseNumber

string

House number or NULL if none

Example:

"42"

data.orders.deliveryAddress.city

string

Name of the city

Example:

"Berlin"

data.orders.deliveryAddress.postCode

string

Postcode in valid format

Example:

"14109"

data.orders.deliveryAddress.countryCode

string

ISO 3166 A2 code of the country

Example:

"DE"

data.orders.state

enum<string>

State of the order processing

Available options:

Open,

Delivery,

Unspecified,

PendingDelivery,

Cancelled,

Rejected,

Revoked,

Processing

Example:

"Delivery"

data.orders.processingInfo

string | null

Human-readable information about the processing of Order.

Example:

"Exported to MaKo provider"

data.orders.denialReason

enum<string>

Reason for the order denial, if applicable

Available options:

Dunning,

InsufficientSolvency,

ContractCommitment,

Duplicate,

UnsuccessfulSupplierChange,

Other

Example:

"Other"

data.orders.deliveryState

object

Last delivery state update information for this order.

Hide child attributes

data.orders.deliveryState.startDate

string<date> | null

Delivery start date.

Example:

"2024-02-01"

data.orders.deliveryState.endDate

string<date> | null

Delivery end date or NULL if not specified.

Example:

null

data.orders.deliveryState.state

enum<string>

Current delivery state

Available options:

None,

Delivery,

DeliveryPending,

CancelledDelivery,

CancelledPendingDelivery,

Cancelled,

Denied,

Revoked,

InChangeProcess,

Unknown

Example:

"InChangeProcess"

data.orders.deliveryState.message

string | null

Message received with the delivery state change from MaKo operator.

Example:

null

data.orders.deliveryState.denialReason

enum<string>

Reason for denial if state is "Denied" or NULL otherwise.

Available options:

Dunning,

InsufficientSolvency,

ContractCommitment,

Duplicate,

UnsuccessfulSupplierChange,

Other

Example:

null

data.orders.deliveryState.cancellationReason

enum<string>

Cancellation reason if state is "Canceled" or NULL otherwise.

Available options:

None,

Dunning,

OtherSupplier,

CustomerSupplierChange,

CustomerRelocation,

Decommissioning,

Unknown,

CustomerProduct,

CustomerPrice,

CustomerService,

CustomerMisc,

CustomerPriceChange

Example:

null

data.orders.actualDateOfDelivery

string<date> | null

Start of delivery date, as confirmed by DSO and previous supplier, null if not known (yet)

Example:

"2025-04-01"

data.orders.endDateOfDelivery

string<date> | null

End of delivery date, if contract is canceled

Example:

null

data.orders.contractSignatureDate

string<date-time> | null

deprecated

Contract signature date, as provided in order creation request

Example:

"2025-02-23 14:24:15"

data.orders.contractSignedAt

string<date-time> | null

Contract signature date, as provided in order creation request

Example:

"2025-02-23 14:24:15"

data.orders.estimatedYearlyConsumption

integer<int32> | null

Estimated yearly consumption, in kWh

Example:

3500

data.orders.previousYearConsumption

integer<int32> | null

Previous year consumption, in kWh

Example:

4200

data.orders.salesPersonIdentifier

string | null

Identifier of the sales person associated with the contract.

count

integer<int32>

read-only

Number of items returned in the list.

Example:

10

hasMoreItems

boolean

Indicates whether there are more items to be returned in the list, that are not included in the limit of this request.

Example:

true

Introduction

Get Started

Quickstart

Guides

Updates

API reference

Authorizations

Query Parameters

Response

Introduction

Get Started

Quickstart

Guides

Updates

API reference

Documentation Index

Authorizations

Query Parameters

Response