Kibo Commerce · Schema

Order

Order form.

CompanyCommerceE-CommerceHeadless CommerceOrder ManagementB2BConsumerInventoryFulfillment

Properties

Name Type Description
acceptedDate stringnull When the order was accepted by the merchant
acceptsMarketing booleannull Does the customer accept marketing
adjustment object
alternateContact object
amountAvailableForRefund number This property represents AmountCaptured - AmountRefunded via returns. It is read only.
amountRefunded number A counter for how much money has been issued in refunds. This calculated field does NOT include refunds issued in returns.
amountRemainingForPayment number A counter for how much of the order total has not been claimed by payments. This is computed by Order.Total-(sum of Order.Payments where State is not voided/declined)
attributes arraynull
auditInfo object
availableActions arraynull Actions available to the payment
billingInfo object
callOffOrderId stringnull Identifier of the originating Call-Off Order, if this Sales Order was released from a Call-Off Order. Null for standard orders.
canceledItems arraynull Items canceled on the Order due to Rule violation
cancelledDate stringnull Date the order was cancelled.
changeMessages arraynull List of messages displayed by the system based on the last cart action, for example, when a product price has changed or is out-of-stock. System-supplied and read-only.
channelCode stringnull Unique identifier of the channel for this item.
closedDate stringnull Date the order was closed. A closed order means that the order has been processed and items shipped.
continuityOrderOrdinal integer The ordinal to track the Continuity order.
couponCodes arraynull Coupon codes associated with this order. Only set on order import.
credits arraynull
currencyCode stringnull ISO Currency Code. Currently, only USD is supported.
customerAccountId integernull Unique identifier of the customer account.
customerInteractionType stringnull Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown
customerTaxId stringnull The customers tax ID. If Customer Account ID exists in the system, will set this.
data objectnull Custom data for a given vendor set within the commerce process.
digitalPackages arraynull Fulfillment digital packages associated with this order.
discountThresholdMessages arraynull List of Mozu.CommerceRuntime.Contracts.Commerce.ThresholdMessage objects that are valid for the current value of the cart/order.
discountTotal numbernull Amount of the discounts applied to all items in the cart. This is a negative number. This also includes the order level discounts.
discountedSubtotal numbernull Combined price for all cart items, including all selected options as well as any discounts.
discountedTotal numbernull Subtotal minus the discounted total
dutyAmount numbernull Order level duty or tariff amount. Does not take into account duties or tariffs specifically on items on the order
dutyTotal numbernull Duties or tariffs for the Order as well as OrderItems (e.g. if the Order has a $5 duty or tariff for any reason and an OrderItem has a $2 duty or tariff then the value in this property would be $7)
email stringnull Email address of the customer at the time the order is placed.
expirationDate stringnull When the order will no longer be active. That is, the order is considered abandoned. Orders of anonymous shoppers expire after 14 days of inactivity. An order never expires for shoppers who are logged
extendedProperties arraynull Extra properties (key-value pairs) that extend the primary object. Think of this as a property bag of string keys and string values.
externalId stringnull An order number to link this order to an external system
feeTotal numbernull Not implemented. Total cost of fees for all items in the cart.
forceDeliveryConsolidationOnSplitShipments booleannull Overrides the Fulfillment SiteSetting value for `ForceDeliveryConsolidationOnSplitShipments`. TODO autogen instead of manual addition
forceSTHConsolidationOnSplitShipments booleannull Overrides the Fulfillment SiteSetting value for `ForceSTHConsolidationOnSplitShipments`. TODO autogen instead of manual addition
fulfillmentInfo object
fulfillmentStatus stringnull Current fulfillment status, which can be "NotFulfilled,", "PartiallyFulfilled", or "Fufilled." System-supplied and read-only. Values are available in FulfillmentStatusConst of this class.
handlingAdjustment object
handlingAmount numbernull Order level handling fees excluding any discounts.
handlingDiscounts arraynull The list of historically-applied handling discounts. The active one will have IsExcluded == false
handlingSubTotal numbernull Handling fees for the Order as well as OrderItems (e.g. if the Order has a $5 handling fee and an OrderItem has a $2 handling fee per item quantity and the quantity of items is 2 then the value in thi
handlingTaxTotal numbernull Total tax on handling
handlingTotal numbernull Handling fees including any discounts.
hasDraft booleannull Does this order have a draft version.
id stringnull Unique identifier of the CommerceAggregate object (e.g. order, cart, wishlist, etc.).
importDate stringnull Date this item was imported
invalidCoupons arraynull A list of invalid coupons that were attempted on the order
ipAddress stringnull IP address of the user placing the order. (User or customer?)
isContinuityOrder boolean Flag to check if the order is continuityOrder.
isDraft booleannull Is this order a draft version
isEligibleForReturns boolean Marker for determining if the order is a) complete or b) has some items that are shipped and not part of any other return
isFulfillable boolean Flag to indicate whether it is safe to proceed with fulfillment on shipments on the order.
isHistoricalImport booleannull Indicates this was an order in a terminal state (completed/canceled) that was imported into the system for historical purposes.
isImport booleannull Was this order initiated from an external system
isOptInForSms boolean Whether the shopper opts in to curbside text notifications.
isPartialOrder boolean Returns `true` if this order originated from a checkout and has sibling partial orders, otherwise `false`.
isTaxExempt booleannull Unique identifier of the customer account.
isUnified boolean Was this order created by the Unified platform.
itemTaxTotal numbernull Not implemented. Tax does not appear on cart.
items arraynull List of items in the order.
lastValidationDate stringnull Occasionally the commerce runtime may validate that item/product names, descriptions, and prices have not changed. If changed, it updates LastValidationDate.
lineItemSubtotalWithOrderAdjustments numbernull Line Item Subtotals with Order Adjustments
locationCode stringnull Identifies the location at which the order was placed if the order was placed externally.
notes arraynull Internal notes that a merchant may add to the order. Maximum 250 characters.
orderDiscounts arraynull The discount that has been applied to the cart itself. If multiple discounts exist, this is the discount that the system applies because it offers the best savings for the shopper. This is a negative
orderNumber integernull Order Number. This is an integer that is only assigned after an order is placed and enters the open state.
originalCartId stringnull Unique identifier for the cart that was converted to order.
originalQuoteId stringnull If this order originated from a quote, this is the identifier of the originating quote.
originalQuoteNumber integernull If this order originated from a quote, this is the number of the originating quote.
packages arraynull Shipping package associated with this order.
parentCheckoutId stringnull If this order originated from a multi-ship enabled site, this is the identifier of the originating checkout.
parentCheckoutNumber integernull If this order originated from a multi-ship enabled site, this is the number of the originating checkout.
parentOrderId stringnull If this Order has a parent order, this should be the parent's ID.
parentOrderNumber integernull If this order has a parent order, this should be the parent's Mozu.CommerceRuntime.Contracts.Orders.Order.OrderNumber.
parentReturnId stringnull If this order was created as part of a return, this should be the return's ID.
parentReturnNumber integernull If this order was created as part of a return, this should be the return's ReturnNumber.
partialOrderCount integernull If this order originated from a checkout, this is the total number of orders created from that checkout.
partialOrderNumber integernull If this order originated from a checkout, this is a sequence number out of the total orders created from that checkout.
paymentStatus stringnull Current status of payment, which can be "Null," "AwaitingCheck," "AwaitingPayment," "Paid," "Authorized," or "Void." System-supplied and read-only.
payments arraynull Payment transaction associated with this order. It is the entire payment interchange between the merchant who is forwarding the customer's payment information and the payment service who is authorizin
pickups arraynull Fulfillment pickups associated with this order.
priceListCode stringnull Pricelist code for the order
readyToCapture boolean
refunds arraynull Refunds associated with this order. A refund is a single exchange of money from merchant to customer that either encapsulates a refund to a credit card or an issuance of a store credit. Refunds does n
rejectedDiscounts arraynull
releaseShipmentDate stringnull
reservationId stringnull Inventory Reservation id for order.
restrictCancellation booleannull Settings this flag on the order will restrict user from Cancelling the order
restrictEdit booleannull Setting this flag on the order will restrict user from editing the order
returnStatus stringnull System-supplied and read-only.
shipmentCreationOffset integernull Release Shipment After(in minutes) (Order Submitted Date).
shipments arraynull Package shipments associated with this order.
shippingAdjustment object
shippingAmountBeforeDiscountsAndAdjustments numbernull Shipping Amount before discount and adjustments
shippingDiscounts arraynull
shippingGroups arraynull List of order grouping.
shippingSubTotal numbernull Shipping total without discounts applied.
shippingTaxTotal numbernull Not implemented. Tax does not appear on cart.
shippingTotal numbernull Shipping does not appear on cart.
shopperNotes object
siteId integernull Unique identifier of the Site.
sourceDevice stringnull Source device of the user placing the order. (User or customer?)
status stringnull Current status of the order, which can be viewed in OrderStatusConst. System-supplied and read-only.
submittedDate stringnull When the customer placed (submitted) the order.
subscriptionIds arraynull All the subscriptions associated with the current order.
subtotal numbernull Combined price for all cart items, including all selected options but excluding any discounts.
suggestedDiscounts arraynull
taxData objectnull Storage for any additional/custom tax data.
taxTotal numbernull Tax does not appear on cart.
tenantId integernull Unique identifier of the Tenant.
total numbernull Final total amount of the order including all discounts, shipping, and tax.
totalCollected number Total amount of money collected on the order via payments.
type stringnull Is this Order Online or Offline? Online means shopper entered at checkout, offline means a phone order.
userId stringnull Unique identifier of the shopper who created the cart.
validationResults arraynull Validation results for the order when processes against validation capabilities.
version stringnull Version for concurrency purposes
visitId stringnull Identifies the Visit ID that was current when the order was placed or when the cart was last updated.
webSessionId stringnull Identifies the web session used to place the order or last update the cart.
View JSON Schema on GitHub

JSON Schema

kibo-commerce-order-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/kibo-commerce/main/json-schema/kibo-commerce-order-schema.json",
  "title": "Order",
  "description": "Order form.",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kibo-commerce-commerce-openapi.yml#/components/schemas/Order",
  "properties": {
    "acceptedDate": {
      "description": "When the order was accepted by the merchant",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "acceptsMarketing": {
      "description": "Does the customer accept marketing",
      "type": [
        "boolean",
        "null"
      ]
    },
    "adjustment": {
      "$ref": "#/$defs/Adjustment"
    },
    "alternateContact": {
      "$ref": "#/$defs/AlternateContact"
    },
    "amountAvailableForRefund": {
      "description": "This property represents AmountCaptured - AmountRefunded via returns.\nIt is read only.",
      "format": "double",
      "type": "number"
    },
    "amountRefunded": {
      "description": "A counter for how much money has been issued in refunds.\nThis calculated field does NOT include refunds issued in returns.",
      "format": "double",
      "type": "number"
    },
    "amountRemainingForPayment": {
      "description": "A counter for how much of the order total has not been claimed by payments.\nThis is computed by Order.Total-(sum of Order.Payments where State is not voided/declined)",
      "format": "double",
      "type": "number"
    },
    "attributes": {
      "items": {
        "$ref": "#/$defs/OrderAttribute"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "auditInfo": {
      "$ref": "#/$defs/CoreApiContractsAuditInfo"
    },
    "availableActions": {
      "description": "Actions available to the payment",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "billingInfo": {
      "$ref": "#/$defs/BillingInfo"
    },
    "callOffOrderId": {
      "description": "Identifier of the originating Call-Off Order, if this Sales Order was released\nfrom a Call-Off Order. Null for standard orders.",
      "type": [
        "string",
        "null"
      ]
    },
    "canceledItems": {
      "description": "Items canceled on the Order due to Rule violation",
      "items": {
        "$ref": "#/$defs/OrderCanceledItem"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "cancelledDate": {
      "description": "Date the order was cancelled.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "changeMessages": {
      "description": "List of messages displayed by the system based on the last cart action, for example, when a product price has changed or is out-of-stock. System-supplied and read-only.",
      "items": {
        "$ref": "#/$defs/ChangeMessage"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "channelCode": {
      "description": "Unique identifier of the channel for this item.",
      "type": [
        "string",
        "null"
      ]
    },
    "closedDate": {
      "description": "Date the order was closed. A closed order means that the order has been processed and items shipped.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "continuityOrderOrdinal": {
      "description": "The ordinal to track the Continuity order.",
      "format": "int32",
      "type": "integer"
    },
    "couponCodes": {
      "description": "Coupon codes associated with this order.  Only set on order import.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "credits": {
      "items": {
        "$ref": "#/$defs/Credit"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "currencyCode": {
      "description": "ISO Currency Code. Currently, only USD is supported.",
      "type": [
        "string",
        "null"
      ]
    },
    "customerAccountId": {
      "description": "Unique identifier of the customer account.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "customerInteractionType": {
      "description": "Determines the interaction type that a customer will use to create this object.\nValid values are: Website, Store, Call, Unknown",
      "type": [
        "string",
        "null"
      ]
    },
    "customerTaxId": {
      "description": "The customers tax ID.  If Customer Account ID exists in the system, will set this.",
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "description": "Custom data for a given vendor set within the commerce process.",
      "type": [
        "object",
        "null"
      ]
    },
    "digitalPackages": {
      "description": "Fulfillment digital packages associated with this order.",
      "items": {
        "$ref": "#/$defs/DigitalPackage"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "discountThresholdMessages": {
      "description": "List of Mozu.CommerceRuntime.Contracts.Commerce.ThresholdMessage objects that are valid for the current value of the cart/order.",
      "items": {
        "$ref": "#/$defs/ThresholdMessage"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "discountTotal": {
      "description": "Amount of the discounts applied to all items in the cart. This is a negative number.  This also includes the order level discounts.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "discountedSubtotal": {
      "description": "Combined price for all cart items, including all selected options as well as any discounts.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "discountedTotal": {
      "description": "Subtotal minus the discounted total",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "dutyAmount": {
      "description": "Order level duty or tariff amount. Does not take into account duties or tariffs specifically on items on the order",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "dutyTotal": {
      "description": "Duties or tariffs for the Order as well as OrderItems (e.g. if the Order has a $5 duty or tariff for any reason and an OrderItem has a $2 duty or tariff then the value in this property would be $7)",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "email": {
      "description": "Email address of the customer at the time the order is placed.",
      "type": [
        "string",
        "null"
      ]
    },
    "expirationDate": {
      "description": "When the order will no longer be active. That is, the order is considered abandoned. \nOrders of anonymous shoppers expire after 14 days of inactivity. \nAn order never expires for shoppers who are logged into their account. \nDate in UTC Date/Time.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "extendedProperties": {
      "description": "Extra properties (key-value pairs) that extend the primary object. Think of this as a property bag of string keys and string values.",
      "items": {
        "$ref": "#/$defs/ExtendedProperty"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "externalId": {
      "description": "An order number to link this order to an external system",
      "type": [
        "string",
        "null"
      ]
    },
    "feeTotal": {
      "description": "Not implemented. Total cost of fees for all items in the cart.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "forceDeliveryConsolidationOnSplitShipments": {
      "description": "Overrides the Fulfillment SiteSetting value for `ForceDeliveryConsolidationOnSplitShipments`.\nTODO autogen instead of manual addition",
      "type": [
        "boolean",
        "null"
      ]
    },
    "forceSTHConsolidationOnSplitShipments": {
      "description": "Overrides the Fulfillment SiteSetting value for `ForceSTHConsolidationOnSplitShipments`.\nTODO autogen instead of manual addition",
      "type": [
        "boolean",
        "null"
      ]
    },
    "fulfillmentInfo": {
      "$ref": "#/$defs/FulfillmentInfo"
    },
    "fulfillmentStatus": {
      "description": "Current fulfillment status, which can be \"NotFulfilled,\", \"PartiallyFulfilled\", or \"Fufilled.\" \nSystem-supplied and read-only.  Values are available in FulfillmentStatusConst of this class.",
      "type": [
        "string",
        "null"
      ]
    },
    "handlingAdjustment": {
      "$ref": "#/$defs/Adjustment"
    },
    "handlingAmount": {
      "description": "Order level handling fees excluding any discounts.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "handlingDiscounts": {
      "description": "The list of historically-applied handling discounts.  The active one will have IsExcluded == false",
      "items": {
        "$ref": "#/$defs/AppliedDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "handlingSubTotal": {
      "description": "Handling fees for the Order as well as OrderItems (e.g. if the Order has a $5 handling fee and an OrderItem has a $2 handling fee per item quantity and the quantity of items is 2 then the value in this property would be $9)",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "handlingTaxTotal": {
      "description": "Total tax on handling",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "handlingTotal": {
      "description": "Handling fees including any discounts.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "hasDraft": {
      "description": "Does this order have a draft version.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "id": {
      "description": "Unique identifier of the CommerceAggregate object (e.g. order, cart, wishlist, etc.).",
      "type": [
        "string",
        "null"
      ]
    },
    "importDate": {
      "description": "Date this item was imported",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "invalidCoupons": {
      "description": "A list of invalid coupons that were attempted on the order",
      "items": {
        "$ref": "#/$defs/InvalidCoupon"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "ipAddress": {
      "description": "IP address of the user placing the order. (User or customer?)",
      "type": [
        "string",
        "null"
      ]
    },
    "isContinuityOrder": {
      "description": "Flag to check if the order is continuityOrder.",
      "type": "boolean"
    },
    "isDraft": {
      "description": "Is this order a draft version",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isEligibleForReturns": {
      "description": "Marker for determining if the order is a) complete or b) has some items that are shipped and not part of any other return",
      "type": "boolean"
    },
    "isFulfillable": {
      "description": "Flag to indicate whether it is safe to proceed with fulfillment on shipments on the order.",
      "type": "boolean"
    },
    "isHistoricalImport": {
      "description": "Indicates this was an order in a terminal state (completed/canceled) that was imported into the system for historical purposes.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isImport": {
      "description": "Was this order initiated from an external system",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isOptInForSms": {
      "description": "Whether the shopper opts in to curbside text notifications.",
      "type": "boolean"
    },
    "isPartialOrder": {
      "description": "Returns `true` if this order originated from a checkout and has sibling partial orders, otherwise `false`.",
      "type": "boolean"
    },
    "isTaxExempt": {
      "description": "Unique identifier of the customer account.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isUnified": {
      "description": "Was this order created by the Unified platform.",
      "type": "boolean"
    },
    "itemTaxTotal": {
      "description": "Not implemented. Tax does not appear on cart.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "items": {
      "description": "List of items in the order.",
      "items": {
        "$ref": "#/$defs/OrderItem"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "lastValidationDate": {
      "description": "Occasionally the commerce runtime may validate that item/product names, descriptions, and prices have not changed. \nIf changed, it updates LastValidationDate.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "lineItemSubtotalWithOrderAdjustments": {
      "description": "Line Item Subtotals with Order Adjustments",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "locationCode": {
      "description": "Identifies the location at which the order was placed if the order was placed externally.",
      "type": [
        "string",
        "null"
      ]
    },
    "notes": {
      "description": "Internal notes that a merchant may add to the order. Maximum 250 characters.",
      "items": {
        "$ref": "#/$defs/OrderNote"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "orderDiscounts": {
      "description": "The discount that has been applied to the cart itself. If multiple discounts exist, this is the discount that the system applies because it offers the best savings for the shopper. This is a negative number.",
      "items": {
        "$ref": "#/$defs/AppliedDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "orderNumber": {
      "description": "Order Number. This is an integer that is only assigned after an order is placed and enters the open state.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "originalCartId": {
      "description": "Unique identifier for the cart that was converted to order.",
      "type": [
        "string",
        "null"
      ]
    },
    "originalQuoteId": {
      "description": "If this order originated from a quote, this is the identifier of the originating quote.",
      "type": [
        "string",
        "null"
      ]
    },
    "originalQuoteNumber": {
      "description": "If this order originated from a quote, this is the number of the originating quote.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "packages": {
      "description": "Shipping package associated with this order.",
      "items": {
        "$ref": "#/$defs/CommerceRuntimePackage"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "parentCheckoutId": {
      "description": "If this order originated from a multi-ship enabled site, this is the identifier of the originating checkout.",
      "type": [
        "string",
        "null"
      ]
    },
    "parentCheckoutNumber": {
      "description": "If this order originated from a multi-ship enabled site, this is the number of the originating checkout.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "parentOrderId": {
      "description": "If this Order has a parent order, this should be the parent's ID.",
      "type": [
        "string",
        "null"
      ]
    },
    "parentOrderNumber": {
      "description": "If this order has a parent order, this should be the parent's Mozu.CommerceRuntime.Contracts.Orders.Order.OrderNumber.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "parentReturnId": {
      "description": "If this order was created as part of a return, this should be the return's ID.",
      "type": [
        "string",
        "null"
      ]
    },
    "parentReturnNumber": {
      "description": "If this order was created as part of a return, this should be the return's ReturnNumber.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "partialOrderCount": {
      "description": "If this order originated from a checkout, this is the total number of orders created from that checkout.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "partialOrderNumber": {
      "description": "If this order originated from a checkout, this is a sequence number out of the total orders created from that checkout.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "paymentStatus": {
      "description": "Current status of payment, which can be \"Null,\" \"AwaitingCheck,\" \"AwaitingPayment,\" \"Paid,\" \"Authorized,\" or \"Void.\" \nSystem-supplied and read-only.",
      "type": [
        "string",
        "null"
      ]
    },
    "payments": {
      "description": "Payment transaction associated with this order. It is the entire payment interchange between the merchant \nwho is forwarding the customer's payment information and the payment service who is authorizing and \ncapturing payment. Payment can be either by credit card, check, or PayPal.",
      "items": {
        "$ref": "#/$defs/Payment"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "pickups": {
      "description": "Fulfillment pickups associated with this order.",
      "items": {
        "$ref": "#/$defs/Pickup"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "priceListCode": {
      "description": "Pricelist code for the order",
      "type": [
        "string",
        "null"
      ]
    },
    "readyToCapture": {
      "type": "boolean"
    },
    "refunds": {
      "description": "Refunds associated with this order. A refund is a single exchange of money from merchant to customer\nthat either encapsulates a refund to a credit card or an issuance of a store credit.\nRefunds does not reduce the 'amount collected' on an order and it is possible for refunds to exceed the total order amount.",
      "items": {
        "$ref": "#/$defs/Refund"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "rejectedDiscounts": {
      "items": {
        "$ref": "#/$defs/SuggestedDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "releaseShipmentDate": {
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "reservationId": {
      "description": "Inventory Reservation id for order.",
      "type": [
        "string",
        "null"
      ]
    },
    "restrictCancellation": {
      "description": "Settings this flag on the order will restrict user from Cancelling the order",
      "type": [
        "boolean",
        "null"
      ]
    },
    "restrictEdit": {
      "description": "Setting this flag on the order will restrict user from editing the order",
      "type": [
        "boolean",
        "null"
      ]
    },
    "returnStatus": {
      "description": "System-supplied and read-only.",
      "type": [
        "string",
        "null"
      ]
    },
    "shipmentCreationOffset": {
      "description": "Release Shipment After(in minutes) (Order Submitted Date).",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "shipments": {
      "description": "Package shipments associated with this order.",
      "items": {
        "$ref": "#/$defs/Shipment"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "shippingAdjustment": {
      "$ref": "#/$defs/Adjustment"
    },
    "shippingAmountBeforeDiscountsAndAdjustments": {
      "description": "Shipping Amount before discount and adjustments",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "shippingDiscounts": {
      "items": {
        "$ref": "#/$defs/ShippingDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "shippingGroups": {
      "description": "List of order grouping.",
      "items": {
        "$ref": "#/$defs/ShippingGrouping"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "shippingSubTotal": {
      "description": "Shipping total without discounts applied.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "shippingTaxTotal": {
      "description": "Not implemented. Tax does not appear on cart.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "shippingTotal": {
      "description": "Shipping does not appear on cart.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "shopperNotes": {
      "$ref": "#/$defs/ShopperNotes"
    },
    "siteId": {
      "description": "Unique identifier of the Site.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "sourceDevice": {
      "description": "Source device of the user placing the order. (User or customer?)",
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "description": "Current status of the order, which can be viewed in OrderStatusConst. System-supplied and read-only.",
      "type": [
        "string",
        "null"
      ]
    },
    "submittedDate": {
      "description": "When the customer placed (submitted) the order.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "subscriptionIds": {
      "description": "All the subscriptions associated with the current order.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "subtotal": {
      "description": "Combined price for all cart items, including all selected options but excluding any discounts.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "suggestedDiscounts": {
      "items": {
        "$ref": "#/$defs/SuggestedDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "taxData": {
      "description": "Storage for any additional/custom tax data.",
      "type": [
        "object",
        "null"
      ]
    },
    "taxTotal": {
      "description": "Tax does not appear on cart.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "tenantId": {
      "description": "Unique identifier of the Tenant.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "total": {
      "description": "Final total amount of the order including all discounts, shipping, and tax.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "totalCollected": {
      "description": "Total amount of money collected on the order via payments.",
      "format": "double",
      "type": "number"
    },
    "type": {
      "description": "Is this Order Online or Offline? Online means shopper entered at checkout, offline means a phone order.",
      "type": [
        "string",
        "null"
      ]
    },
    "userId": {
      "description": "Unique identifier of the shopper who created the cart.",
      "type": [
        "string",
        "null"
      ]
    },
    "validationResults": {
      "description": "Validation results for the order when processes against validation capabilities.",
      "items": {
        "$ref": "#/$defs/OrderValidationResult"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "version": {
      "description": "Version for concurrency purposes",
      "type": [
        "string",
        "null"
      ]
    },
    "visitId": {
      "description": "Identifies the Visit ID that was current when the order was placed or when the cart was last updated.",
      "type": [
        "string",
        "null"
      ]
    },
    "webSessionId": {
      "description": "Identifies the web session used to place the order or last update the cart.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "type": "object",
  "$defs": {
    "AbstractFulfillmentItem": {
      "properties": {
        "fulfillmentItemType": {
          "description": "The type of fulfillment item",
          "type": [
            "string",
            "null"
          ]
        },
        "lineId": {
          "description": "The line id associated with the fulfillment.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "optionAttributeFQN": {
          "type": [
            "string",
            "null"
          ]
        },
        "productCode": {
          "description": "Code of the Product to be fulfilled.",
          "type": [
            "string",
            "null"
          ]
        },
        "quantity": {
          "description": "Quantity of the order item",
          "format": "int32",
          "nullable": false,
          "type": "integer"
        }
      },
      "type": "object"
    },
    "Address": {
      "properties": {
        "address1": {
          "type": [
            "string",
            "null"
          ]
        },
        "address2": {
          "type": [
            "string",
            "null"
          ]
        },
        "address3": {
          "type": [
            "string",
            "null"
          ]
        },
        "address4": {
          "type": [
            "string",
            "null"
          ]
        },
        "addressType": {
          "type": [
            "string",
            "null"
          ]
        },
        "cityOrTown": {
          "type": [
            "string",
            "null"
          ]
        },
        "countryCode": {
          "type": [
            "string",
            "null"
          ]
        },
        "isValidated": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "postalOrZipCode": {
          "type": [
            "string",
            "null"
          ]
        },
        "stateOrProvince": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "Adjustment": {
      "properties": {
        "amount": {
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "description": {
          "maxLength": 1000,
          "nullable": false,
          "type": "string"
        },
        "internalComment": {
          "maxLength": 1000,
          "nullable": false,
          "type": "string"
        }
      },
      "type": "object"
    },
    "AlternateContact": {
      "properties": {
        "emailAddress": {
          "description": "Email Address of alternate contact during order process",
          "format": "email",
          "minLength": 1,
          "nullable": false,
          "type": "string"
        },
        "firstName": {
          "description": "First Name of alternate contact during order process",
          "minLength": 1,
          "nullable": false,
          "type": "string"
        },
        "lastNameOrSurname": {
          "description": "Last Name of alternate contact during order process",
          "minLength": 1,
          "nullable": false,
          "type": "string"
        },
        "phoneNumber": {
          "description": "Phone Number of alternate contact during order process",
          "pattern": "^[0-9]+$",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "AppliedDiscount": {
      "description": "Discount applied to the order, which is a negative number to be subtracted from the original price to get the final price. \nIf multiple discounts for the order exist, this is the value most advantageous to the shopper.",
      "properties": {
        "couponCode": {
          "description": "Code of the coupon associated with the discount if a coupon code is required to get the discount.",
          "type": [
            "string",
            "null"
          ]
        },
        "data": {
          "description": "Stores any custom data sent from external discounts.",
          "type": [
            "object",
            "null"
          ]
        },
        "discount": {
          "$ref": "#/$defs/Discount"
        },
        "excluded": {
          "description": "Determines whether or not this discount is set up to be ignored by the pricing runtime.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "groupId": {
          "description": "Group identifier for the discount.",
          "type": [
            "string",
            "null"
          ]
        },
        "impact": {
          "description": "Value of the discount applied. This is a negative number to be subtracted from the original price to get the final price.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "AppliedLineItemProductDiscount": {
      "properties": {
        "appliesToSalePrice": {
          "description": "Determines if the discount applies to the sale price of the order",
          "type": [
            "boolean",
            "null"
          ]
        },
        "discountQuantity": {
          "description": "The number of the line item that can be used for this particular discount.",
          "format": "int32",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "AppliedLineItemShippingDiscount": {
      "properties": {
        "discount": {
          "$ref": "#/$defs/AppliedDiscount"
        },
        "discountQuantity": {
          "description": "The number of the line item that can be used for this particular discount.",
          "format": "int32",
          "type": "integer"
        },
        "impactPerUnit": {
          "description": "The impact of this discount pur discount quantity.",
          "format": "double",
          "type": "number"
        },
        "methodCode": {
          "description": "Unique identifier of the shipping method discount.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "BillingInfo": {
      "description": "Customer's payment details such as payment type (credit card, check by mail, or PayPal)\nand cardholder information if payment is by credit card.",
      "properties": {
        "auditInfo": {
          "$ref": "#/$defs/CoreApiContractsAuditInfo"
        },
        "billingContact": {
          "$ref": "#/$defs/Contact"
        },
        "card": {
          "$ref": "#/$defs/PaymentCard"
        },
        "check": {
          "$ref": "#/$defs/CheckPayment"
        },
        "customCreditType": {
          "description": "Name of custom stored credit type",
          "type": [
            "string",
            "null"
          ]
        },
        "data": {
          "description": "Custom data from payment providers",
          "type": [
            "object",
            "null"
          ]
        },
        "externalToken": {
          "$ref": "#/$defs/ExternalPaymentToken"
        },
        "externalTransactionId": {
          "description": "Transaction Id from third party payment source like Visa Checkout, Amazon",
          "type": [
            "string",
            "null"
          ]
        },
        "isRecurring": {
          "description": "Indicates whether the payment is used in recurring transactions. ex- subscription payments",
          "type": "boolean"
        },
        "isSameBillingShippingAddress": {
          "description": "Indicates that billing and shipping address are the same",
          "type": "boolean"
        },
        "paymentType": {
          "description": "Type

# --- truncated at 32 KB (190 KB total) ---
# Full source: https://artifacts.apis.io/kibo-commerce/json-schema/kibo-commerce-order-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/kibo-commerce-order"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.