> ## 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 a Blanket Order by ID > Get a Blanket Order by ID. ## OpenAPI ````yaml /openapi/openapi_commerce.json get /commerce/blanketorders/{blanketOrderId} 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/blanketorders/{blanketOrderId}: get: tags: - BlanketOrder summary: Get a Blanket Order by ID description: Get a Blanket Order by ID. parameters: - in: path name: blanketOrderId 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/BlanketOrder' text/json: schema: $ref: '#/components/schemas/BlanketOrder' text/plain: schema: $ref: '#/components/schemas/BlanketOrder' description: OK components: schemas: BlanketOrder: description: "Represents a contractual commitment between the seller and a B2B Account\r\nto supply goods at predetermined prices and quantities over a specified period." properties: attributes: description: Custom attributes at the header level. items: $ref: '#/components/schemas/BlanketOrderAttribute' nullable: true type: array auditInfo: $ref: '#/components/schemas/CoreApiContractsAuditInfo' availableActions: description: >- Available lifecycle actions from the current status. Populated on read. items: type: string nullable: true type: array buyerContact: $ref: '#/components/schemas/AlternateContact' canceledReason: $ref: '#/components/schemas/CommerceRuntimeCanceledReason' cancelledDate: description: Date when the order was cancelled. System-supplied, read-only. format: date-time nullable: true type: string changeMessages: description: >- Change messages associated with this Blanket Order. Hydrated from a separate collection. items: $ref: '#/components/schemas/CommerceRuntimeChangeMessage' nullable: true type: array channelCode: description: Channel code for multi-channel context. nullable: true type: string currencyCode: description: Currency code (default "USD"). nullable: true type: string customerAccountId: format: int32 nullable: true type: integer data: description: Extensibility data bag for tenant-specific custom data. nullable: true type: object externalId: description: External reference identifier for integration with external systems. nullable: true type: string id: nullable: true type: string items: description: Product commitment Items for this Blanket Order. items: $ref: '#/components/schemas/BlanketOrderItem' nullable: true type: array notes: description: Internal notes for merchant use. items: $ref: '#/components/schemas/OrderNote' nullable: true type: array number: description: >- Auto-generated sequential Blanket Order number. System-supplied, read-only. format: int32 nullable: true type: integer priceListCode: description: Price list code for pricing context. nullable: true type: string sellerContact: $ref: '#/components/schemas/AlternateContact' siteId: format: int32 type: integer status: description: Current status managed by the StatusEngine transition table. nullable: true type: string tenantId: format: int32 type: integer userId: nullable: true type: string validityPeriod: $ref: '#/components/schemas/ValidityPeriod' version: description: Optimistic concurrency token. System-supplied. nullable: true type: string type: object BlanketOrderAttribute: description: "Custom attribute for Blanket Orders, following the same pattern\r\nas OrderAttribute and ReturnAttribute.\r\nInherits FullyQualifiedName, AttributeDefinitionId, and Values\r\nfrom AbstractAttribute." 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 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 nullable: true pattern: ^[0-9]+$ type: string type: object CommerceRuntimeCanceledReason: allOf: - $ref: '#/components/schemas/Reason' - additionalProperties: false type: object CommerceRuntimeChangeMessage: description: >- A message displayed by the system based on the last action, for example, when a product price has changed. System-supplied and read-only. properties: amount: deprecated: true description: Monetary amount that pertains to the change if applicable format: double nullable: true type: number appId: description: App Id that identifies the user that performed the related change nullable: true type: string appKey: description: App Key nullable: true type: string appName: description: App Name nullable: true type: string attributes: additionalProperties: nullable: true description: Additional Data. This property will be a Dictionary of objects. nullable: true type: object correlationId: description: Correlation Id nullable: true type: string createDate: description: When the message was created. System-supplied. Read-only. format: date-time nullable: true type: string id: description: Unique identifier of the message. System-supplied. Read-only. nullable: true type: string identifier: description: >- Unique identifier to what the message pertains, which can be a cart item, cart or another generic entity. System-supplied. Read-only. nullable: true type: string message: description: Human readable message. System-supplied. Read-only. nullable: true type: string metadata: description: >- Data. This property will be a JSON array that will contain 0-N items, when there is 1 item it will still be an array containing only one item. System-supplied. Read-only. nullable: true newValue: deprecated: true description: Current price of the item. System-supplied. Read-only. nullable: true type: string oldValue: deprecated: true description: Original price of the item. System-supplied. Read-only. nullable: true type: string subject: description: >- Text on the subject line of the message, for example, the product name. System-supplied. Read-only. nullable: true type: string subjectType: description: >- Subject of the message, for example, "Product." System-supplied. Read-only. nullable: true type: string success: description: Indicates if the message is related to a success or failure. nullable: true type: boolean userFirstName: description: User First Name nullable: true type: string userId: description: User Id that identifies the user that performed the related change nullable: true type: string userLastName: description: User Last Name nullable: true type: string userScopeType: description: User Type (e.g. Shopper, Admin, etc.) nullable: true type: string verb: description: "Action applicable to the message. This can be \"Increased,\" when the product price has increased, \"Decreased,\" when the \r\nproduct price has decreased, and \"Invalidated,\" when the product is no longer available. System-supplied. Read-only." nullable: true type: string type: object BlanketOrderItem: description: "A single product commitment within a Blanket Order.\r\nEach line tracks its own lifecycle independently." properties: attributes: description: "Line-level extensible attributes. Use Mozu.CommerceRuntime.Contracts.BlanketOrders.BlanketOrderAttribute on\r\n`BlanketOrder.Attributes` for header-level attributes." items: $ref: '#/components/schemas/BlanketOrderItemAttribute' nullable: true type: array auditInfo: $ref: '#/components/schemas/CoreApiContractsAuditInfo' consumedQuantity: description: Total quantity consumed by call-off orders. System-managed. format: int32 type: integer id: description: Unique identifier for this line. System-supplied. nullable: true type: string lineId: description: Auto-assigned sequential line number within the order. format: int32 nullable: true type: integer product: $ref: '#/components/schemas/BlanketOrderProductReference' quantity: description: Total committed quantity for this product line. format: int32 type: integer remainingQuantity: description: >- Remaining available quantity (Quantity - ConsumedQuantity). System-managed. format: int32 type: integer status: description: Current line status managed by the line-level transition table. nullable: true type: string unitPrice: description: Agreed unit price for this product line. format: double 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 ValidityPeriod: description: "Represents the validity window for a Blanket Order.\r\nCall-off orders can only be placed while the current date is within this period." properties: endDate: description: End date of the validity period. Must be after StartDate. format: date-time type: string startDate: description: >- Start date of the validity period. Must be today or in the future on creation. format: date-time type: string type: object Reason: properties: description: nullable: true type: string moreInfo: nullable: true type: string reasonCode: nullable: true type: string type: object BlanketOrderItemAttribute: description: "Attribute instance on a Blanket Order line item.\r\nSeparate from Mozu.CommerceRuntime.Contracts.BlanketOrders.BlanketOrderAttribute (header-level) for type safety\r\nand to allow consumers to distinguish header vs line attributes." 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 BlanketOrderProductReference: description: "Lightweight product identity for Blanket Order Items.\r\nContains the minimum fields needed to identify and display the product." properties: name: description: Product display name. nullable: true type: string productCode: description: Product code used for identification. nullable: true type: string type: object securitySchemes: bearerAuth: bearerFormat: JWT description: JWT Authorization header using the Bearer scheme. scheme: bearer type: http ````