> ## 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.

# Get Call Off Order

> Get Call Off Order



## OpenAPI

````yaml /openapi/openapi_commerce.json get /commerce/callofforders/{callOffOrderId}
openapi: 3.0.1
info:
  description: |-
    <div id="overview_COMMERCE">
                <h2>COMMERCE</h2>
                <p>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.</p>
                <p>Use the <strong>Carts</strong> 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.</p>
                <p>Use the <strong>Channels</strong> and <strong>Channel Groups</strong> 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.</p>
                <p>Use the <strong>Checkouts</strong> resource to track a shopper's order items and their intended destinations on sites that
                    have the multiple shipment feature enabled.</p>
                <p>Use the <strong>Orders</strong> resource to manage all components of order processing, payment, and order-level
                    fulfillment.</p>
                <p>Use the <strong>Quotes</strong> resource to support B2B functionality by managing order quotes, similar to wishlists.</p>
                <p>Use the <strong>Returns</strong> 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.</p>
                <p>Use the <strong>Wish Lists</strong> 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 <strong>Wish List Items</strong>
                    resource allows you to manage the individual items in a wish list.</p>
            </div>
  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/{callOffOrderId}:
    get:
      tags:
        - CallOffOrder
      summary: Get Call Off Order
      description: Get Call Off Order
      parameters:
        - in: path
          name: callOffOrderId
          required: true
          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/CallOffOrder'
            text/json:
              schema:
                $ref: '#/components/schemas/CallOffOrder'
            text/plain:
              schema:
                $ref: '#/components/schemas/CallOffOrder'
          description: OK
components:
  schemas:
    CallOffOrder:
      description: >-
        A buyer's delivery request, either linked to a Blanket Order or
        standalone.
      properties:
        attributes:
          description: "Custom attributes extending AbstractAttribute. Flows downstream to\r\nSales Orders and Shipments in later phases."
          items:
            $ref: '#/components/schemas/CallOffOrderAttribute'
          nullable: true
          type: array
        auditInfo:
          $ref: '#/components/schemas/CoreApiContractsAuditInfo'
        availableActions:
          description: >-
            Actions valid for the current status. Computed on read; not
            persisted.
          items:
            type: string
          nullable: true
          type: array
        blanketOrderId:
          description: "Identifier of the parent Blanket Order if this call-off draws from one;\r\nnull for standalone call-offs."
          nullable: true
          type: string
        cancelledBy:
          description: User who cancelled the call-off order.
          nullable: true
          type: string
        cancelledDate:
          description: Cancellation timestamp.
          format: date-time
          nullable: true
          type: string
        cancelledReason:
          $ref: '#/components/schemas/CommerceRuntimeCanceledReason'
        changeMessages:
          description: "Change messages describing mutations to this call-off order.\r\nHydrated from a separate collection on read; not embedded on the document."
          items:
            $ref: '#/components/schemas/CallOffOrderChangeMessage'
          nullable: true
          type: array
        channelCode:
          description: Channel origin (e.g. "wholesale", "ecommerce", "EDI").
          nullable: true
          type: string
        completedAt:
          description: Timestamp when all lines reached terminal status.
          format: date-time
          nullable: true
          type: string
        creditHold:
          $ref: '#/components/schemas/CreditHoldStatus'
        currencyCode:
          description: "Currency code (ISO 4217). Must match the parent Blanket Order currency\r\nwhen one is referenced."
          nullable: true
          type: string
        customerAccountId:
          description: B2B Account identifier. Must reference an active B2B account.
          format: int32
          nullable: true
          type: integer
        data:
          description: Vendor / extension custom data, free-form JSON.
          nullable: true
          type: object
        destinations:
          description: "Shipping destinations. Items reference these by DestinationId\r\n(IDestinationContainer pattern)."
          items:
            $ref: '#/components/schemas/CommerceRuntimeDestination'
          nullable: true
          type: array
        externalId:
          description: "Buyer's own reference number / idempotency key (e.g. release number from\r\nan ERP). Unique per tenant when supplied."
          nullable: true
          type: string
        id:
          description: System-generated unique identifier (MozuObjectId).
          nullable: true
          type: string
        items:
          description: Requested product line items.
          items:
            $ref: '#/components/schemas/CallOffOrderItem'
          nullable: true
          type: array
        notes:
          description: Structured notes attached to the call-off order.
          items:
            $ref: '#/components/schemas/OrderNote'
          nullable: true
          type: array
        number:
          description: Human-readable sequential number, auto-generated per tenant.
          format: int32
          nullable: true
          type: integer
        reservationId:
          description: "Inventory reservation identifier. Set when inventory is reserved\r\nfor this call-off order."
          nullable: true
          type: string
        siteId:
          description: Site identifier. Populated from the API context on read.
          format: int32
          type: integer
        status:
          description: "Current call-off order status. One of: Hold, PartiallyReserved,\r\nPartiallyReleased, Completed, Cancelled."
          nullable: true
          type: string
        tenantId:
          description: Tenant identifier. Populated from the API context on read.
          format: int32
          type: integer
        totalAmount:
          description: "Denormalized header total — sum of non-cancelled line LineTotal values.\r\nSystem-maintained; not client-settable."
          format: double
          type: number
        version:
          description: "Optimistic locking version. Initialized to \"1\" and incremented as a\r\nstring on each update."
          nullable: true
          type: string
      type: object
    CallOffOrderAttribute:
      description: "Custom attribute for Call-Off Orders, following the same pattern\r\nas BlanketOrderAttribute and OrderAttribute."
      properties:
        attributeDefinitionId:
          format: int32
          nullable: true
          type: integer
        auditInfo:
          $ref: '#/components/schemas/CoreApiContractsAuditInfo'
        fullyQualifiedName:
          nullable: true
          type: string
        values:
          items: {}
          nullable: true
          type: array
      type: object
    CoreApiContractsAuditInfo:
      properties:
        createBy:
          nullable: true
          type: string
        createDate:
          format: date-time
          nullable: true
          type: string
        updateBy:
          nullable: true
          type: string
        updateDate:
          format: date-time
          nullable: true
          type: string
      type: object
    CommerceRuntimeCanceledReason:
      allOf:
        - $ref: '#/components/schemas/Reason'
        - additionalProperties: false
          type: object
    CallOffOrderChangeMessage:
      description: Audit trail entry for Call-Off Order lifecycle events.
      properties:
        body:
          description: Human-readable description of what changed.
          nullable: true
          type: string
        callOffOrderId:
          description: Identifier of the parent call-off order this message belongs to.
          nullable: true
          type: string
        createBy:
          description: User who triggered the change.
          nullable: true
          type: string
        createDate:
          description: Timestamp when the change was recorded.
          format: date-time
          type: string
        id:
          description: System-generated change message identifier.
          nullable: true
          type: string
        identifier:
          description: "Optional identifier of the specific sub-entity that changed\r\n(e.g. line id)."
          nullable: true
          type: string
        newValue:
          description: New value when the change represents a single-field mutation.
          nullable: true
          type: string
        oldValue:
          description: Prior value when the change represents a single-field mutation.
          nullable: true
          type: string
        siteId:
          description: Site identifier.
          format: int32
          type: integer
        subject:
          description: Subject of the change (e.g. "status", "line.status").
          nullable: true
          type: string
        tenantId:
          description: Tenant identifier.
          format: int32
          type: integer
      type: object
    CreditHoldStatus:
      description: "Header-level credit-hold state for a CallOffOrder. Replaces the per-item\r\nCreditHold + CreditHoldReason fields that lived on CallOffOrderItem prior\r\nto this change — credit-hold is a header concern (one decision per order)\r\nnot a per-line concern."
      properties:
        onHold:
          description: True when the order is on credit hold.
          type: boolean
        reason:
          $ref: '#/components/schemas/CreditHoldReason'
      type: object
    CommerceRuntimeDestination:
      properties:
        data:
          description: Custom data
          nullable: true
          type: object
        destinationContact:
          $ref: '#/components/schemas/CommerceRuntimeContact'
        id:
          description: An identifier for this entry.
          nullable: true
          type: string
        isDestinationCommercial:
          description: Indicates that the destination is commercial
          nullable: true
          type: boolean
      type: object
    CallOffOrderItem:
      description: A requested product quantity for delivery to a specific address.
      properties:
        actualDeliveryDate:
          description: >-
            Actual delivery date, recorded once the line has been physically
            delivered.
          format: date-time
          nullable: true
          type: string
        attributes:
          description: Line-level custom attributes extending AbstractAttribute.
          items:
            $ref: '#/components/schemas/CallOffOrderItemAttribute'
          nullable: true
          type: array
        blanketOrderItemId:
          description: "Identifier of the Blanket Order item this item draws from. Required\r\nwhen the parent call-off references a Blanket Order."
          nullable: true
          type: string
        cancelledBy:
          description: User who cancelled this line.
          nullable: true
          type: string
        cancelledDate:
          description: Line cancellation timestamp.
          format: date-time
          nullable: true
          type: string
        cancelledReason:
          $ref: '#/components/schemas/CommerceRuntimeCanceledReason'
        destinationId:
          description: "Identifier of the Destination in the parent call-off's Destinations\r\ncollection that this line ships to."
          nullable: true
          type: string
        expectedDeliveryDate:
          description: >-
            Expected delivery date, typically provided by the supplier or
            fulfillment system.
          format: date-time
          nullable: true
          type: string
        fillRate:
          description: Computed fill ratio (ReservedQty / RequestedQty). Phase 2+.
          format: double
          nullable: true
          type: number
        fulfillmentLocationCode:
          description: "Pickup location code. Meaningful only when `FulfillmentType == \"Pickup\"`;\r\nignored for Ship / Digital / Curbside / Delivery (downstream Order\r\nRouting handles those). Carried into the SalesOrder created by the\r\nRelease Rules Engine (spec 005 FR-021)."
          nullable: true
          type: string
        fulfillmentType:
          description: "Per-line fulfillment method. One of: Ship, Pickup, Digital, Curbside, Delivery.\r\nIn a future release, CallOffOrderItem may extend FulfillableCommerceItem."
          nullable: true
          type: string
        id:
          description: System-generated item identifier.
          nullable: true
          type: string
        inventoryTags:
          description: "Name-value pairs scoping the inventory pool for reservation. Set at\r\nitem creation and immutable once a reservation exists."
          items:
            $ref: '#/components/schemas/InventoryTags'
          nullable: true
          type: array
        lineId:
          description: Sequential line identifier within the call-off, auto-assigned.
          format: int32
          nullable: true
          type: integer
        lineTotal:
          description: "Total amount for this line. Client-supplied in Mode 1; computed in\r\nMode 2."
          format: double
          nullable: true
          type: number
        product:
          $ref: '#/components/schemas/CallOffOrderProductReference'
        releasedDate:
          description: Timestamp when this line was released to a Sales Order (Phase 3).
          format: date-time
          nullable: true
          type: string
        releasedQty:
          description: "Quantity released to a Sales Order. Written in Phase 3; zero in\r\nPhases 1–2."
          format: int32
          type: integer
        requestedDeliveryDate:
          description: Buyer-requested delivery date for this line.
          format: date-time
          nullable: true
          type: string
        requestedQty:
          description: Buyer-requested quantity.
          format: int32
          type: integer
        requestedShipDate:
          description: "Buyer-requested ship date. Must fall within the parent Blanket Order's\r\nvalidity period when a Blanket Order is referenced."
          format: date-time
          nullable: true
          type: string
        reservedQty:
          description: "Quantity reserved by the inventory reservation engine.\r\nWritten in Phase 2; zero in Phase 1."
          format: int32
          type: integer
        salesOrderId:
          description: "The SalesOrder id this line was released into. Null until the line\r\ntransitions to `Released` by the Release Rules Engine (spec 005).\r\nImmutable thereafter."
          nullable: true
          type: string
        status:
          description: "Current line status. One of: Hold, PartiallyReserved, Released,\r\nConverted, Cancelled."
          nullable: true
          type: string
        unitPrice:
          description: "Per-line unit price. Overridable — may come from the Blanket Order,\r\nbe client-supplied, or be buyer-negotiated."
          format: double
          nullable: true
          type: number
      type: object
    OrderNote:
      description: >-
        Internal notes that a merchant may add to the order. Maximum 250
        characters.
      properties:
        auditInfo:
          $ref: '#/components/schemas/CoreApiContractsAuditInfo'
        id:
          description: Unique identifier of the note. System-supplied and read-only.
          nullable: true
          type: string
        text:
          description: Text of the note. Maximum 250 characters.
          maxLength: 500
          nullable: false
          type: string
      type: object
    Reason:
      properties:
        description:
          nullable: true
          type: string
        moreInfo:
          nullable: true
          type: string
        reasonCode:
          nullable: true
          type: string
      type: object
    CreditHoldReason:
      allOf:
        - $ref: '#/components/schemas/Reason'
        - additionalProperties: false
          type: object
    CommerceRuntimeContact:
      properties:
        address:
          $ref: '#/components/schemas/CommerceRuntimeAddress'
        companyOrOrganization:
          nullable: true
          type: string
        email:
          format: email
          nullable: true
          type: string
        firstName:
          nullable: true
          type: string
        id:
          format: int32
          nullable: true
          type: integer
        lastNameOrSurname:
          nullable: true
          type: string
        middleNameOrInitial:
          nullable: true
          type: string
        phoneNumbers:
          $ref: '#/components/schemas/CommerceRuntimePhone'
      type: object
    CallOffOrderItemAttribute:
      description: "Custom attribute for Call-Off Order line items, following the same pattern\r\nas CallOffOrderAttribute."
      properties:
        attributeDefinitionId:
          format: int32
          nullable: true
          type: integer
        auditInfo:
          $ref: '#/components/schemas/CoreApiContractsAuditInfo'
        fullyQualifiedName:
          nullable: true
          type: string
        values:
          items: {}
          nullable: true
          type: array
      type: object
    InventoryTags:
      properties:
        name:
          nullable: true
          type: string
        value:
          nullable: true
          type: string
      type: object
    CallOffOrderProductReference:
      description: Lightweight product identity for Call-Off Order Items.
      properties:
        name:
          description: Display name of the product.
          nullable: true
          type: string
        productCode:
          description: "Product code (SKU). Must match the Blanket Order line product when\r\nthe parent call-off references a Blanket Order."
          nullable: true
          type: string
      type: object
    CommerceRuntimeAddress:
      properties:
        address1:
          nullable: true
          type: string
        address2:
          nullable: true
          type: string
        address3:
          nullable: true
          type: string
        address4:
          nullable: true
          type: string
        addressType:
          nullable: true
          type: string
        cityOrTown:
          nullable: true
          type: string
        countryCode:
          nullable: true
          pattern: ^[A-Z]{2}$
          type: string
        isValidated:
          nullable: true
          type: boolean
        postalOrZipCode:
          nullable: true
          type: string
        stateOrProvince:
          nullable: true
          type: string
      type: object
    CommerceRuntimePhone:
      properties:
        home:
          nullable: true
          type: string
        mobile:
          nullable: true
          type: string
        work:
          nullable: true
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: JWT Authorization header using the Bearer scheme.
      scheme: bearer
      type: http

````