Orders (Seller)

Overview

As a seller, you receive orders from buyers on Consentio. The Partner API lets you export these orders to your ERP, sync back external references, track post-acceptance modifications, and signal warehouse preparation.

Endpoints

Method	Endpoint	Description
GET	/v2/partner/{workspaceID}/order	Get orders by date range
PUT	/v2/partner/{workspaceID}/order/external	Update orders with external refs
GET	/v2/partner/{workspaceID}/order/edited	Get orders edited after acceptance
POST	/v2/partner/{workspaceID}/order/seen	Mark order changes as seen
POST	/v2/partner/{workspaceID}/order/{hashID}/prepare	Mark order as prepared (public)

Retrieving Orders

Fetch orders within a date range using from, to (RFC3339), and kind=sale. Optionally filter by status (accepted, pending, canceled, incomplete).

Each returned order includes items with product details, amounts, prices, delivery information, and the counterpart_id / external_id / external_status fields relevant to your perspective.

Syncing External References

After importing orders into your ERP, push back the external order ID and status using PUT /order/external. This enables bidirectional tracking between Consentio and your system. You can also use this endpoint to cancel orders.

Tracking Modifications

Orders can be edited after acceptance (e.g., quantity adjustments, item changes). Use the edited orders workflow to stay in sync:

sequenceDiagram
    participant ERP as ERP System
    participant API as Consentio API

    ERP->>API: GET /order/edited?from=...
    API-->>ERP: Orders with recorded changes

    ERP->>ERP: Process modifications

    ERP->>API: POST /order/seen
    API-->>ERP: 200 OK (changes acknowledged)

1. GET /order/edited - retrieve orders modified since a given date
2. Process changes in your ERP
3. POST /order/seen - acknowledge the modifications to prevent re-processing

Preparing Orders

The prepare endpoint (POST /order/{hashID}/prepare) marks all items in an order as prepared. This is typically called by warehouse or logistics systems. It is a public endpoint and does not require authentication.

Integration Workflow

Order Export (Consentio to ERP)

sequenceDiagram
    participant ERP as ERP System
    participant API as Consentio API

    ERP->>API: GET /order?kind=sale&status=accepted&from=...&to=...
    API-->>ERP: List of new orders

    ERP->>ERP: Create ERP records

    ERP->>API: PUT /order/external (sync IDs & statuses)
    API-->>ERP: 200 OK

Recommended Sync Cadence

• Poll for new accepted orders on a regular schedule
• Check for edited orders after each order sync
• Mark changes as seen after successful processing