Order Workflow

This page provides detailed information regarding the order submission workflows within the Koncili API.

---

Order Submission

• New Order: Identified and submitted by the integrator. Only orders with an INVOICED status or higher will be accepted.
• Order Updates: Any significant changes, such as status or value updates, must be submitted as a new full request.
• Koncili API: Validates, processes, and forwards the data.
• Koncili: Stores the information and prepares the data for the reconciliation process.

Validations

Requests sent via POST /order undergo several validation stages before being accepted:

1. Channel Validation (account):
   The account specified in the payload must be enabled for API imports. Otherwise, the request will be rejected.

2. Entry Type Validation:
   The type field within the extracts list accepts 3 valid values: SALE, COMISSION, and SHIP. Any other value will result in an error.

3. Date Validation:
   Dates in the payload must be consistent. This includes the chronological order of events and the presence of mandatory fields based on the order status.

4. Order Status Validation (status):
   Accepted order statuses include INVOICED, PAID_WAITING_DELIVERY, CONCLUDED, and CANCELED.

   For each status, the following fields are mandatory:

   Status	Mandatory Dates
   INVOICED	No additional mandatory dates
   PAID_WAITING_DELIVERY	sendDate, estimatedDeliveryDate
   CONCLUDED	sendDate, estimatedDeliveryDate, deliveryDate
   CANCELED	cancelDate

Best Practices

Orders must be submitted via the POST operation. For any subsequent modification to an order, a new request must be made to the same endpoint, containing the complete and updated order information.

Order Query

The GET operation allows you to retrieve details of an order previously submitted to Koncili.
This endpoint can be used for data verification, system synchronization, or verifying the submission status.

Status Update

Updates are consolidated every 30 minutes.
If your query does not reflect the current state of the order, please repeat the request after this interval.

Validations

The request sent via GET /order undergoes several validation steps before being accepted:

1. Channel Validation (account):
   The account specified in the request must be enabled for API imports. Otherwise, the request will be rejected.

2. Order Lookup:
   The requested order must exist within Koncili. If the record is not found, the request will return an error.

Order Deletion

The DELETE operation allows for the removal of an order previously submitted to Koncili.

Validations

The request sent via DELETE /order undergoes several validation stages before being accepted:

1. Channel Validation (account):
   The account specified in the request must be enabled for API imports. Otherwise, the request will be rejected.

2. Order Lookup:
   The requested order must exist within Koncili. If the record is not found, the request will return an error.

3. API Import Verification:
   The order must have been originally submitted via the API. If this is not the case, the request will return an error.

4. Reconciliation Status Check:
   The order must not be reconciled. If the order has already been reconciled, the request will return an error.

Important!

Order deletion should be performed with caution; once a record is removed, it cannot be recovered.