> ## Documentation Index > Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt > Use this file to discover all available pages before exploring further. # Aggregate requested quantity across call-off orders spanning every site in the current tenant. > Sums `items[].requestedQty` and returns breakdowns by product code, customer, status, and requested ship month. Use the `filter` parameter to scope the aggregation (e.g. `items.product.productCode in [SKU1,SKU2]`, `customerAccountId eq 1234`, `items.status ne Cancelled`, `items.requestedShipDate ge 2026-01-01`). ## OpenAPI ````yaml /openapi/openapi_commerce.json get /commerce/callofforders/aggregate openapi: 3.0.1 info: description: |-

COMMERCE

The Commerce API interacts with the commerce entities of your tenant, including shoppers's active shopping carts, checkouts, submitted orders, wishlists, and returns as well as B2B quotes.

Use the Carts resource to manage storefront shopping carts as shoppers add and remove items for purchase. Each time a shopper's cart is modified, the Carts resource updates the estimated total with any applicable discounts.

Use the Channels and Channel Groups resources to manage the channels a company uses to create logical commercial business divisions based on region or types of sales, such as "US Online," "Amazon," or "EMEA Retail." All orders include a channel association that enables the company to perform financial reporting for each defined channel. Because channels are managed at the tenant level, you must associate all the tenant's sites with a channel. Sites that do not have a defined channel association cannot successfully submit orders.

Use the Checkouts resource to track a shopper's order items and their intended destinations on sites that have the multiple shipment feature enabled.

Use the Orders resource to manage all components of order processing, payment, and order-level fulfillment.

Use the Quotes resource to support B2B functionality by managing order quotes, similar to wishlists.

Use the Returns resource to manage returned items that were previously fufilled. Returns can include any number of items associated with an original order. Each return must either be associated with an original order or a product definition to represent each returned item.

Use the Wish Lists resource to manage the shopper wish lists of products associated with a customer account. Although customer accounts are managed at the tenant level, the system stores shopper wish lists at the site level. This enables the same customer to have wish lists for each of a merchant's sites. The Wish List Items resource allows you to manage the individual items in a wish list.

title: Cart/Checkout/Quote version: 0.0.1 servers: - description: Kibo Base URL url: '{baseUrl}/api' variables: baseUrl: default: https://t1000000.sb.usc1.gcp.kibocommerce.com description: Base URL security: - bearerAuth: [] paths: /commerce/callofforders/aggregate: get: tags: - CallOffOrder summary: >- Aggregate requested quantity across call-off orders spanning every site in the current tenant. description: >- Sums `items[].requestedQty` and returns breakdowns by product code, customer, status, and requested ship month. Use the `filter` parameter to scope the aggregation (e.g. `items.product.productCode in [SKU1,SKU2]`, `customerAccountId eq 1234`, `items.status ne Cancelled`, `items.requestedShipDate ge 2026-01-01`). parameters: - in: query name: filter schema: type: string - description: limits which fields are returned in the response body in: query name: responseFields schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CallOffOrderAggregateResult' text/json: schema: $ref: '#/components/schemas/CallOffOrderAggregateResult' text/plain: schema: $ref: '#/components/schemas/CallOffOrderAggregateResult' description: OK components: schemas: CallOffOrderAggregateResult: description: >- Result of aggregating call-off order requested quantity across all sites for a tenant. Includes the grand total and optional breakdowns by product code, customer account, order status, and requested ship month. properties: byCustomer: description: >- Requested quantity broken down by customer account. Each entry's `Key` is the customer account id as a string, or `"anonymous"` for orders without an account. items: $ref: '#/components/schemas/CallOffOrderDemandEntry' nullable: true type: array byProductCode: description: >- Requested quantity broken down by product code. Each entry's `Key` is a product code. Only product codes with at least one matching item appear here. items: $ref: '#/components/schemas/CallOffOrderDemandEntry' nullable: true type: array byRequestedShipMonth: description: >- Requested quantity broken down by the month of `items[].requestedShipDate`. Each entry's `Key` is an ISO-8601 month string (e.g. `"2026-03"`). Items without a requested ship date are excluded from this breakdown. items: $ref: '#/components/schemas/CallOffOrderDemandEntry' nullable: true type: array byStatus: description: >- Requested quantity broken down by call-off order status. Each entry's `Key` is the order-level status string (e.g. `"Open"`, `"Completed"`). items: $ref: '#/components/schemas/CallOffOrderDemandEntry' nullable: true type: array totalRequestedQty: description: >- Sum of `items[].requestedQty` across all matched call-off order items. format: int64 type: integer type: object CallOffOrderDemandEntry: description: >- A single bucket in a call-off order aggregate breakdown: the summed requested quantity for a group (product code, customer account, status, or month) plus a count of matching orders. properties: key: description: >- The grouping key value. Meaning depends on the breakdown dimension: product code string, customer account id string, order status string, or ISO-8601 month string (yyyy-MM) for the monthly breakdown. nullable: true type: string orderCount: description: Number of distinct call-off orders in this bucket. format: int32 type: integer totalRequestedQty: description: Sum of `items[].requestedQty` for call-off orders in this bucket. format: int64 type: integer type: object securitySchemes: bearerAuth: bearerFormat: JWT description: JWT Authorization header using the Bearer scheme. scheme: bearer type: http ````