Skip to main content
API docs by Redocly

Order Management Service (v2025.10.14-0)

Download OpenAPI specification:Download

Basic Order Operations

Operations related to basic order management

Get Order

This endpoint returns the requested order.

Authorizations:
idp
path Parameters
orderId
required
string (Technical Order ID) ^[0-9a-f]{24}$

Responses

Response samples

Content type
application/json
{
  • "order": {
    }
}

Update Order

This endpoint updates the requested order.

Authorizations:
idp
path Parameters
orderId
required
string (Technical Order ID) ^[0-9a-f]{24}$
Request Body schema: application/json
required
object
object (Customer/delivery information)
Default: {"first_name":null,"last_name":null,"email":null,"phone":null,"organization":null,"address":null,"postal_code":null,"state":null,"city":null,"country_code":null,"vat_id":null,"eori":null,"door_code":null,"delivery_instructions":null}
merchants_id
string or null (Merchant's own identifier for the order.) non-empty
object or null (Currently set processing lock for the order.)
Array of objects (Items in the order.)

Responses

Request samples

Content type
application/json
{
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "order": {
    }
}

Get List of Orders

This endpoint returns a list of orders.

Authorizations:
idp
query Parameters
status
string
Enum: "draft" "passive" "confirmed" "waiting_products" "problem" "processing" "processed" "returning" "returned" "cancelled" "deleted"

Filter orders by order status.

has_product_id
string^[0-9a-f]{24}$

Filter orders that contain at least one item with the specified product ID.

offset
number >= 0
Default: 0

Number of orders to skip from the start of the result set.

limit
number [ 1 .. 1000 ]
Default: 250

Maximum number of orders to return.

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Create a New Order

This endpoint creates a new order to Logitrail.

Authorizations:
idp
Request Body schema: application/json
required
object
object (Customer/delivery information)
Default: {"first_name":null,"last_name":null,"email":null,"phone":null,"organization":null,"address":null,"postal_code":null,"state":null,"city":null,"country_code":null,"vat_id":null,"eori":null,"door_code":null,"delivery_instructions":null}
merchants_id
string or null (Merchant's own identifier for the order.) non-empty
object or null (Currently set processing lock for the order.)
process_hold
boolean or null (Set or unset the processing hold for the order.)
Array of objects (Items in the order.)

Responses

Request samples

Content type
application/json
{
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "order": {
    }
}

Statistics and Reports

Operations related to order statistics and reports.

Get Order Statistics

This endpoint returns statistics about orders for requesting merchant.

Authorizations:
idp

Responses

Response samples

Content type
application/json
{
  • "order_statistics": {
    }
}

Get Waiting Products In Orders

This endpoint returns a list of products that are missing from orders and blocking the fulfillment of those orders.

Authorizations:
idp

Responses

Response samples

Content type
application/json
{
  • "waiting_products": [
    ]
}