API ENUMs

This page details the predefined values (ENUMs) used across the Koncili API.

This documentation describes all enumerated types (ENUMs) used in the Marketplace API, including their possible values, descriptions, and related endpoints.

ENUM Overview

ENUMs are used to standardize:

Order statuses
Payment methods
Financial release types (lançamentos)
Other fields with predefined value sets

How to use

Always reference the exact values as documented below, including case sensitivity and underscores.

Important

When integrating with the API:

Consult this documentation for the accepted ENUM values for each endpoint.
Validate values before sending them to the API.
Implement proper handling for responses containing unknown or unexpected ENUMs.
Periodically update your implementation as new ENUM versions are released.

ENUM Descriptions

Order Status

ENUM Value	Description	Related Endpoints
`INVOICED`	Order has been invoiced	`POST /order` `GET /order` `POST /reconciliation`
`PAID_WAITING_DELIVERY`	Payment confirmed, awaiting delivery	`POST /order` `GET /order` `POST /reconciliation`
`CONCLUDED`	Order successfully completed	`POST /order` `GET /order` `POST /reconciliation`
`CANCELED`	Order has been canceled	`POST /order` `GET /order` `POST /reconciliation`

Payment Methods

ENUM Value	Description	Related Endpoints
`IN_CASH`	One-time full payment (In cash)	`POST /order` `GET /order`

Financial Release Types

ENUM Value	Description	Related Endpoints
`COMISSION`	Sales commission	`POST /order` `GET /order` `POST /reconciliation`
`SHIP`	Shipping/Freight	`POST /order` `GET /order` `POST /reconciliation`
`RETURN_COMISSION`	Commission refund/reversal	`POST /order` `GET /order` `POST /reconciliation`
`RETURN_SHIP`	Shipping refund/reversal	`POST /order` `GET /order` `POST /reconciliation`
`SALE`	Direct sale	`POST /order` `GET /order` `POST /reconciliation`
`ADJUSTMENT`	Adjustment	`POST /order` `GET /order` `POST /reconciliation`

Notification Types

ENUM Value	Description	Related Endpoints
`TEST_NOTIFICATION`	Registered URL test	`POST to the integrator's URL`
`ACCOUNT_CREATED`	Account created	`POST to the integrator's URL`
`RECONCILIATION_COMPLETED`	Reconciliation completed	`POST to the integrator's URL`
`BLOCKED_TEMPORARY`	Temporary block	`POST to the integrator's URL`
`BLOCKED_PERMANENT`	Permanent block	`POST to the integrator's URL`
`UNLOCKED`	Account unlocked	`POST to the integrator's URL`

ENUM Overview​

ENUM Descriptions​

Order Status​

Payment Methods​

Financial Release Types​

Notification Types​