Order Service API 1.0.0

Order Service

This service is responsible for processing orders in our system.

Main operations

  • Creating an order
  • Updating status
  • Sending notifications

How to use

  1. Subscribe to the orders/created topic to receive new orders
  2. Send updates to orders/status
  3. Monitor notifications in orders/notifications

Servers

  • kafka://kafka.example.com:9092/kafkaproduction

    Production Kafka Broker

    Security:
    security.protocol:PLAINTEXT
  • kafka://localhost:9092/kafkadevelopment

    Local Kafka Broker

    Security:
    security.protocol:PLAINTEXT

Operations

  • SEND orders/created

    Creating a new order

    This topic is used to publish information about new orders.

    Important

    • All amounts are specified in kopecks
    • All dates are in ISO 8601 format
    • Order ID must be unique

    Sending a new order

    Operation IDsendOrder

    Available only on servers:

    Accepts the following message:

    New OrderorderCreated
    Message IDorderCreated
    object

    Order Schema

    The main entity describing an order in the system

    Examples

  • SEND orders/status

    Updating order status

    Used to track the lifecycle of an order

    Sending a status update

    Operation IDsendStatus

    Available only on servers:

    Accepts the following message:

    Order Status ChangedstatusChanged
    Message IDstatusChanged
    object

    Order status update

    Examples

  • RECEIVE orders/created

    Creating a new order

    This topic is used to publish information about new orders.

    Important

    • All amounts are specified in kopecks
    • All dates are in ISO 8601 format
    • Order ID must be unique

    Receiving new orders

    Operation IDreceiveOrders

    Available only on servers:

    Accepts the following message:

    New OrderorderCreated
    Message IDorderCreated
    object

    Order Schema

    The main entity describing an order in the system

    Examples

  • RECEIVE orders/status

    Updating order status

    Used to track the lifecycle of an order

    Receiving status updates

    Operation IDreceiveStatusUpdates

    Available only on servers:

    Accepts the following message:

    Order Status ChangedstatusChanged
    Message IDstatusChanged
    object

    Order status update

    Examples

Messages

  • #1New OrderOrderCreated
    Message IDOrderCreated
    object

    Order Schema

    The main entity describing an order in the system

  • #2Order Status ChangedOrderStatusChanged
    Message IDOrderStatusChanged
    object

    Order status update

Schemas

  • object

    Order Schema

    The main entity describing an order in the system

  • object

    Order item

  • object

    Order status update