{ "$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 of payment, such as credit card, check by mail, or PayPal.\nsee Mozu.CommerceRuntime.Contracts.Payments.PaymentTypeConst for valid values", "type": [ "string", "null" ] }, "paymentWorkflow": { "type": [ "string", "null" ] }, "purchaseOrder": { "$ref": "#/$defs/PurchaseOrderPayment" }, "recurringTransactionId": { "description": "Recurring Payment Id returned by Payment Gateway\nnetworkTransactionId for vantiv\npreviousTransactionId for cybersource etc", "type": [ "string", "null" ] }, "storeCreditCode": { "description": "The store credit to use for this purchase", "type": [ "string", "null" ] }, "storeCreditType": { "description": "The type of store credit used for this purchase", "type": [ "string", "null" ] }, "token": { "$ref": "#/$defs/PaymentToken" } }, "type": "object" }, "BundleInfo": { "properties": { "attributes": { "additionalProperties": { "nullable": true }, "type": [ "object", "null" ] }, "imageUrl": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "productCode": { "type": [ "string", "null" ] }, "quantity": { "format": "int32", "type": [ "integer", "null" ] }, "unitPrice": { "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "BundledProduct": { "description": "Describes products that are bundled inside of a main bundle product.", "properties": { "allocationExpiration": { "description": "Allocation ID associated with this product on this order.", "format": "date-time", "type": [ "string", "null" ] }, "allocationId": { "description": "Allocation ID associated with this product on this order.", "format": "int32", "type": [ "integer", "null" ] }, "creditValue": { "description": "Credit value. Only populated if the bundled product is a gift card or digital credit", "format": "double", "type": [ "number", "null" ] }, "deltaPrice": { "description": "Only populated for extras", "format": "double", "type": [ "number", "null" ] }, "description": { "description": "Short description of the product in the language specified by LocaleCode.", "type": [ "string", "null" ] }, "fulfillmentStatus": { "description": "Fulfillment status of the product.", "type": [ "string", "null" ] }, "goodsType": { "description": "Goods Type", "type": [ "string", "null" ] }, "imageUrl": { "description": "ImageUrl of product", "type": [ "string", "null" ] }, "isPackagedStandAlone": { "description": "Indicates that this product ships by itself.", "type": "boolean" }, "measurements": { "$ref": "#/$defs/PackageMeasurements" }, "name": { "description": "Name of the product, this is the current value of the product's name in the language specified by LocaleCode.", "type": [ "string", "null" ] }, "optionAttributeFQN": { "description": "Fully Qualified Name of the selected option's attribute", "type": [ "string", "null" ] }, "optionValue": { "description": "Value of the selected option", "nullable": true }, "productCode": { "description": "Merchant-created code that uniquely identifies the product.", "type": [ "string", "null" ] }, "productReservationId": { "description": "Reservation ID associated with this product in the bundle.", "format": "int32", "type": [ "integer", "null" ] }, "quantity": { "description": "Quantity of the product included in the bundle.", "format": "int32", "type": "integer" }, "stock": { "$ref": "#/$defs/ProductStock" } }, "type": "object" }, "CanceledReason": { "allOf": [ { "$ref": "#/$defs/Reason" }, { "additionalProperties": false, "type": "object" } ] }, "CapturableShipmentSummary": { "properties": { "amountApplied": { "description": "The amount applied by the payment action", "format": "double", "nullable": false, "type": "number" }, "shipmentNumber": { "description": "The identifying number of the shipment affected by the payment action", "format": "int32", "nullable": false, "type": "integer" }, "shipmentTotal": { "description": "The shipment's total when the payment action occurred", "format": "double", "nullable": false, "type": "number" } }, "type": "object" }, "Category": { "description": "Categories to which the product belongs. Discounts can apply to categories where any product in the category is discounted.", "properties": { "id": { "description": "Unique identifier of the category. System-supplied and read-only.", "format": "int32", "type": [ "integer", "null" ] }, "parent": { "$ref": "#/$defs/Category" } }, "type": "object" }, "ChangeMessage": { "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", "type": [ "number", "null" ] }, "appId": { "description": "App Id that identifies the user that performed the related change", "type": [ "string", "null" ] }, "appKey": { "description": "App Key", "type": [ "string", "null" ] }, "appName": { "description": "App Name", "type": [ "string", "null" ] }, "attributes": { "additionalProperties": { "nullable": true }, "description": "Additional Data. This property will be a Dictionary of objects.", "type": [ "object", "null" ] }, "correlationId": { "description": "Correlation Id", "type": [ "string", "null" ] }, "createDate": { "description": "When the message was created. System-supplied. Read-only.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the message. System-supplied. Read-only.", "type": [ "string", "null" ] }, "identifier": { "description": "Unique identifier to what the message pertains, which can be a cart item, cart or another generic entity. System-supplied. Read-only.", "type": [ "string", "null" ] }, "message": { "description": "Human readable message. System-supplied. Read-only.", "type": [ "string", "null" ] }, "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.", "type": [ "string", "null" ] }, "oldValue": { "deprecated": true, "description": "Original price of the item. System-supplied. Read-only.", "type": [ "string", "null" ] }, "subject": { "description": "Text on the subject line of the message, for example, the product name. System-supplied. Read-only.", "type": [ "string", "null" ] }, "subjectType": { "description": "Subject of the message, for example, \"Product.\" System-supplied. Read-only.", "type": [ "string", "null" ] }, "success": { "description": "Indicates if the message is related to a success or failure.", "type": [ "boolean", "null" ] }, "userFirstName": { "description": "User First Name", "type": [ "string", "null" ] }, "userId": { "description": "User Id that identifies the user that performed the related change", "type": [ "string", "null" ] }, "userLastName": { "description": "User Last Name", "type": [ "string", "null" ] }, "userScopeType": { "description": "User Type (e.g. Shopper, Admin, etc.)", "type": [ "string", "null" ] }, "verb": { "description": "Action applicable to the message. This can be \"Increased,\" when the product price has increased, \"Decreased,\" when the \nproduct price has decreased, and \"Invalidated,\" when the product is no longer available. System-supplied. Read-only.", "type": [ "string", "null" ] } }, "type": "object" }, "CheckPayment": { "properties": { "checkNumber": { "type": [ "string", "null" ] } }, "type": "object" }, "CollectionOfDigitalPackageItem": { "properties": { "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "availableActions": { "description": "Actions that can be taken on this fulfillment unit", "items": { "type": "string" }, "type": [ "array", "null" ] }, "changeMessages": { "description": "Change messages related to the fulfillment unit.", "items": { "$ref": "#/$defs/ChangeMessage" }, "type": [ "array", "null" ] }, "code": { "description": "A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form\n {fulfillmentUnitType} #{next available int}", "type": [ "string", "null" ] }, "fulfillmentDate": { "description": "Date of the pickup", "format": "date-time", "type": [ "string", "null" ] }, "fulfillmentLocationCode": { "description": "Location code from which to obtain this item", "type": [ "string", "null" ] }, "id": { "description": "ID of the fulfillment unit.", "type": [ "string", "null" ] }, "items": { "description": "List of items in the fulfillment unit", "items": { "$ref": "#/$defs/DigitalPackageItem" }, "type": [ "array", "null" ] }, "status": { "description": "Status of the fulfillment unit\nSee FulfillmentStatusConst", "type": [ "string", "null" ] } }, "type": "object" }, "CollectionOfPickupItem": { "properties": { "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "availableActions": { "description": "Actions that can be taken on this fulfillment unit", "items": { "type": "string" }, "type": [ "array", "null" ] }, "changeMessages": { "description": "Change messages related to the fulfillment unit.", "items": { "$ref": "#/$defs/ChangeMessage" }, "type": [ "array", "null" ] }, "code": { "description": "A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form\n {fulfillmentUnitType} #{next available int}", "type": [ "string", "null" ] }, "fulfillmentDate": { "description": "Date of the pickup", "format": "date-time", "type": [ "string", "null" ] }, "fulfillmentLocationCode": { "description": "Location code from which to obtain this item", "type": [ "string", "null" ] }, "id": { "description": "ID of the fulfillment unit.", "type": [ "string", "null" ] }, "items": { "description": "List of items in the fulfillment unit", "items": { "$ref": "#/$defs/PickupItem" }, "type": [ "array", "null" ] }, "status": { "description": "Status of the fulfillment unit\nSee FulfillmentStatusConst", "type": [ "string", "null" ] } }, "type": "object" }, "CommerceRuntimePackage": { "description": "Describes a package that will be shipped to somebody", "properties": { "attributes": { "additionalProperties": { "nullable": true }, "type": [ "object", "null" ] }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "availableActions": { "description": "Actions that can be taken on this fulfillment unit", "items": { "type": "string" }, "type": [ "array", "null" ] }, "carrier": { "description": "Carrier of this package", "type": [ "string", "null" ] }, "changeMessages": { "description": "Change messages related to the fulfillment unit.", "items": { "$ref": "#/$defs/ChangeMessage" }, "type": [ "array", "null" ] }, "code": { "description": "A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form\n {fulfillmentUnitType} #{next available int}", "type": [ "string", "null" ] }, "fulfillmentDate": { "description": "Date of the pickup", "format": "date-time", "type": [ "string", "null" ] }, "fulfillmentLocationCode": { "description": "Location code from which to obtain this item", "type": [ "string", "null" ] }, "fxcbDocumentsUrl": { "type": [ "string", "null" ] }, "fxcbPackNotificationId": { "type": [ "string", "null" ] }, "hasLabel": { "description": "If there is a shipping label present for this Package, this will be set to true", "nullable": false, "type": "boolean" }, "id": { "description": "ID of the fulfillment unit.", "type": [ "string", "null" ] }, "integratorId": { "type": [ "string", "null" ] }, "items": { "description": "List of items in the fulfillment unit", "items": { "$ref": "#/$defs/PackageItem" }, "type": [ "array", "null" ] }, "labelFormat": { "type": [ "string", "null" ] }, "manifestId": { "type": [ "string", "null" ] }, "measurements": { "$ref": "#/$defs/PackageMeasurements" }, "packageId": { "type": [ "string", "null" ] }, "packagingType": { "description": "Packaging type of this package", "type": [ "string", "null" ] }, "packingSlipItemDetails": { "description": "PackingSlipItemDetails for this package", "items": { "$ref": "#/$defs/PackingSlipItemDetail" }, "type": [ "array", "null" ] }, "packingSlipNumber": { "description": "PackingSlipNumber for this package", "format": "int32", "type": [ "integer", "null" ] }, "returnCarrier": { "type": [ "string", "null" ] }, "returnTrackingNumbers": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "returnTrackings": { "items": { "$ref": "#/$defs/Tracking" }, "type": [ "array", "null" ] }, "shipmentId": { "description": "ID of the related shipment", "type": [ "string", "null" ] }, "shippingMethodCode": { "description": "Code describing the shipping method.", "type": [ "string", "null" ] }, "shippingMethodName": { "description": "Name of the shipping method", "type": [ "string", "null" ] }, "signatureRequired": { "description": "SignatureRequired for this package", "type": [ "boolean", "null" ] }, "status": { "description": "Status of the fulfillment unit\nSee FulfillmentStatusConst", "type": [ "string", "null" ] }, "trackingNumber": { "description": "Tracking number of this package (to support classic use cases)", "type": [ "string", "null" ] }, "trackingNumbers": { "description": "Tracking number of this package", "items": { "type": "string" }, "type": [ "array", "null" ] }, "trackings": { "description": "Tracking number and url data for this package", "items": { "$ref": "#/$defs/Tracking" }, "type": [ "array", "null" ] } }, "type": "object" }, "CommerceUnitPrice": { "description": "Pricing details for the product listed on a cart item, including the original price, discount amount, and final price.", "properties": { "extendedAmount": { "description": "Extended amount, this is in order of precedence: OverrideAmount, SaleAmount, ListAmount", "format": "double", "type": [ "number", "null" ] }, "listAmount": { "description": "Product list amount.", "format": "double", "type": [ "number", "null" ] }, "overrideAmount": { "description": "Amount as manually overridden by the Merchant", "format": "double", "type": [ "number", "null" ] }, "saleAmount": { "description": "Sale amount indicated on the product.", "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "Contact": { "properties": { "address": { "$ref": "#/$defs/Address" }, "companyOrOrganization": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "firstName": { "type": [ "string", "null" ] }, "id": { "format": "int32", "type": [ "integer", "null" ] }, "lastNameOrSurname": { "type": [ "string", "null" ] }, "middleNameOrInitial": { "type": [ "string", "null" ] }, "phoneNumbers": { "$ref": "#/$defs/Phone" } }, "type": "object" }, "CoreApiContractsAuditInfo": { "properties": { "createBy": { "type": [ "string", "null" ] }, "createDate": { "format": "date-time", "type": [ "string", "null" ] }, "updateBy": { "type": [ "string", "null" ] }, "updateDate": { "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "Credit": { "properties": { "amount": { "description": "Amount credited.", "format": "double", "type": "number" }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "giftCard": { "$ref": "#/$defs/GatewayGiftCard" }, "id": { "description": "Unique identifier of this order transaction.", "type": [ "string", "null" ] }, "parentPaymentId": { "description": "The paymentid of the Parent Payment associated with this Credit (if applicable).", "type": [ "string", "null" ] }, "parentPaymentInteractionId": { "type": [ "string", "null" ] } }, "type": "object" }, "Customer": { "properties": { "customerContact": { "$ref": "#/$defs/Contact" }, "data": { "description": "Custom data", "nullable": true }, "isDestinationCommercial": { "description": "Destination Commercial Flag", "type": [ "boolean", "null" ] } }, "type": "object" }, "DeliveryWindow": { "properties": { "endTime": { "description": "End time for delivery window.", "format": "date-time", "type": "string" }, "startTime": { "description": "Start time for delivery window.", "format": "date-time", "type": "string" } }, "type": "object" }, "Destination": { "properties": { "data": { "description": "Custom data", "type": [ "object", "null" ] }, "destinationContact": { "$ref": "#/$defs/Contact" }, "id": { "description": "An identifier for this entry.", "type": [ "string", "null" ] }, "isDestinationCommercial": { "description": "Indicates that the destination is commercial", "type": [ "boolean", "null" ] } }, "type": "object" }, "DigitalPackage": { "allOf": [ { "$ref": "#/$defs/CollectionOfDigitalPackageItem" }, { "additionalProperties": false, "type": "object" } ] }, "DigitalPackageItem": { "properties": { "fulfillmentItemType": { "description": "The type of fulfillment item", "type": [ "string", "null" ] }, "giftCardCode": { "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", "type": "integer" } }, "type": "object" }, "Discount": { "description": "Discounts that apply to the order, if any. For example, when the \nsubtotal of the order exceeds a certain amount, or for free shipping.", "properties": { "expirationDate": { "description": "Date when the discount expires. Default is null (no expiration date).", "format": "date-time", "type": [ "string", "null" ] }, "hasMultipleTargetProducts": { "description": "Indicates that the discount targets more than a product. Used\nprimarily for BoGa discounts with multiple targets.", "type": "boolean" }, "id": { "description": "Unique identifier of the discount.", "format": "int32", "type": "integer" }, "itemIds": { "description": "List of discounts for each order item.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "name": { "description": "Name of the discount in the language specified by LocaleCode.", "type": [ "string", "null" ] } }, "type": "object" }, "ExtendedProperty": { "properties": { "key": { "maxLength": 128, "minLength": 1, "nullable": false, "type": "string" }, "value": { "maxLength": 800, "type": [ "string", "null" ] } }, "type": "object" }, "ExternalPaymentToken": { "description": "Structured payment token for external (non-Mozu) payment processors.\n\nDistinct from legacy PaymentToken (Apple Pay / PayPal).\n\nUsed in COM-10873 externally tokenized payments feature.\n\nValidation rules:\n- All three fields (PaymentServiceTokenId, Type, Provider) are required\n- Type must match BillingInfo.PaymentType (case-insensitive)\n- Feature gate (externalTokenizationEnabled) must be true", "properties": { "paymentServiceTokenId": { "description": "Actual token value from the external payment provider.", "type": [ "string", "null" ] }, "provider": { "description": "External token provider identifier (e.g., \"Stripe\", \"Square\", \"PayPal\").", "type": [ "string", "null" ] }, "type": { "description": "Payment method type (e.g., \"CreditCard\", \"PayPal\", \"ApplePay\").\nMust match BillingInfo.PaymentType exactly (case-insensitive).", "type": [ "string", "null" ] } }, "type": "object" }, "Frequency": { "properties": { "unit": { "type": [ "string", "null" ] }, "value": { "format": "int32", "nullable": false, "type": "integer" } }, "type": "object" }, "FulfillmentAlternateContact": { "properties": { "email": { "description": "Email Address of alternate contact during order process", "type": [ "string", "null" ] }, "firstName": { "description": "First Name of alternate contact during order process", "type": [ "string", "null" ] }, "lastNameOrSurname": { "description": "Last Name of alternate contact during order process", "type": [ "string", "null" ] }, "phoneNumber": { "description": "Phone Number of alternate contact during order process", "type": [ "string", "null" ] } }, "type": "object" }, "FulfillmentCanceledItem": { "properties": { "actualPrice": { "format": "double", "type": "number" }, "allowsSubstitution": { "type": [ "boolean", "null" ] }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "backorderReleaseDate": { "format": "date-time", "type": [ "string", "null" ] }, "bundleInfo": { "$ref": "#/$defs/BundleInfo" }, "canceledReason": { "$ref": "#/$defs/CanceledReason" }, "cartItemId": { "type": [ "string", "null" ] }, "childItemIds": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "condition": { "type": [ "string", "null" ] }, "data": { "type": [ "object", "null" ] }, "duty": { "format": "double", "type": "number" }, "expectedDeliveryDate": { "format": "date-time", "type": [ "string", "null" ] }, "fulfillmentFields": { "items": { "$ref": "#/$defs/FulfillmentField" }, "type": [ "array", "null" ] }, "fulfillmentLocationCode": { "type": [ "string", "null" ] }, "giftCards": { "items": { "$ref": "#/$defs/GiftCard" }, "type": [ "array", "null" ] }, "giftMessage": { "description": "Gift message for item", "type": [ "string", "null" ] }, "handling": { "description": "Total handling amount for this item, combining both product-level and order-level handling fees.\nTo get the product-level handling portion: Handling - WeightedOrderHandlingFee.", "format": "double", "type": "number" }, "handlingDiscount": { "format": "double", "type": "number" }, "handlingTax": { "description": "Total handling tax for this item, combining both product-level and order-level handling tax.\nTo get the product-level handling tax: HandlingTax - WeightedOrderHandlingFeeTax.", "format": "double", "type": "number" }, "imageUrl": { "type": [ "string", "null" ] }, "inventoryTags": { "items": { "$ref": "#/$defs/InventoryTags" }, "type": [ "array", "null" ] }, "isAssemblyRequired": { "type": [ "boolean", "null" ] }, "isGift": { "description": "Indicate item is gift or not", "type": [ "boolean", "null" ] }, "isPackagedStandAlone": { "type": [ "boolean", "null" ] }, "isReservedInventory": { "type": "boolean" }, "isSubstitutable": { "type": [ "boolean", "null" ] }, "isTaxable": { "type": "boolean" }, "itemDiscount": { "format": "double", "type": "number" }, "itemTax": { "format": "double", "type": "number" }, "lineAttributes": { "description": "Extensible attributes for this shipment line.\nNamed `LineAttributes` rather than `Attributes` because\n`Attributes` is already a System.Collections.Generic.Dictionary`2 of\nproduct attributes on Mozu.CommerceRuntime.Contracts.Fulfillment.ShipmentItem.", "items": { "$ref": "#/$defs/ShipmentLineAttribute" }, "type": [ "array", "null" ] }, "lineId": { "format": "int32", "type": "integer" }, "lineItemAdjustment": { "format": "double", "type": [ "number", "null" ] }, "lineItemCost": { "format": "double", "type": "number" }, "locatorName": { "type": [ "string", "null" ] }, "measurements": { "$ref": "#/$defs/PackageMeasurements" }, "name": { "type": [ "string", "null" ] }, "optionAttributeFQN": { "type": [ "string", "null" ] }, "options": { "items": { "$ref": "#/$defs/ProductOption" }, "type": [ "array", "null" ] }, "originalLineId": { "format": "int32", "type": [ "integer", "null" ] }, "originalOrderItemId": { "type": [ "string", "null" ] }, "originalQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "overridePrice": { "format": "double", "type": [ "number", "null" ] }, "parentId": { "type": [ "string", "null" ] }, "parentItemId": { "type": [ "string", "null" ] }, "partNumber": { "type": [ "string", "null" ] }, "priceMode": { "description": "Determines if the item is using external or internal(catalog) pricing", "type": [ "string", "null" ] }, "productCode": { "type": [ "string", "null" ] }, "purchaseLocation": { "type": [ "string", "null" ] }, "quantity": { "format": "int32", "type": "integer" }, "readyForPickupQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "returnRuleInfo": { "$ref": "#/$defs/ReturnRuleInfo" }, "serialNumber": { "type": [ "string", "null" ] }, "shipping": { "format": "double", "type": "number" }, "shippingDiscount": { "format": "double", "type": "number" }, "shippingTax": { "format": "double", "type": "number" }, "sku": { "type": [ "string", "null" ] }, "substituteInfo": { "$ref": "#/$defs/SubstituteInfo" }, "substituteQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "substitutionType": { "type": [ "string", "null" ] }, "taxData": { "type": [ "object", "null" ] }, "taxableHandling": { "format": "double", "type": "number" }, "taxableLineItemCost": { "format": "double", "type": "number" }, "taxableShipping": { "format": "double", "type": "number" }, "timeFenceDays": { "description": "Time-fence tolerance (days), carried from the originating OrderItem (Call-Off release,\nspec COM-10941 follow-up). Null for shipment items not tied to a Call-Off Order line.", "format": "int32", "type": [ "integer", "null" ] }, "unitPrice": { "format": "double", "type": "number" }, "upc": { "type": [ "string", "null" ] }, "variationProductCode": { "type": [ "string", "null" ] }, "weightedDutyAdjustment": { "format": "double", "type": "number" }, "weightedHandlingAdjustment": { "format": "double", "type": "number" }, "weightedHandlingTaxAdjustment": { "format": "double", "type": "number" }, "weightedLineItemTaxAdjustment": { "format": "double", "type": "number" }, "weightedOrderHandlingFee": { "description": "Order-level handling fee allocated to this item. This represents only the order-level portion\nof handling, not product-level handling fees. Product-level handling can be derived as:\nHandling - WeightedOrderHandlingFee.\nDuring item cancellation with Granular Retention, order-level handling is retained on active items\nwhile product-level handling scales proportionally with quantity.", "format": "double", "type": "number" }, "weightedOrderHandlingFeeDiscount": { "description": "Discount applied to the order-level handling fee only.", "format": "double", "type": "number" }, "weightedOrderHandlingFeeTax": { "description": "Tax on the order-level handling fee only (not total handling tax).\nProduct-level handling tax can be derived as: HandlingTax - WeightedOrderHandlingFeeTax.", "format": "double", "type": "number" }, "weightedShipmentAdjustment": { "format": "double", "type": "number" }, "weightedShippingAdjustment": { "format": "double", "type": "number" }, "weightedShippingTaxAdjustment": { "format": "double", "type": "number" } }, "type": "object" }, "FulfillmentField": { "properties": { "name": { "type": [ "string", "null" ] }, "required": { "type": "boolean" }, "userEnteredValue": { "nullable": true } }, "type": "object" }, "FulfillmentInfo": { "description": "Shipment information, which includes the shipping address, price, estimated delivery date, tracking information, method (for example, Ground, Overnight, or Pick-up), \ncarrier (for example, USPS, UPS, FedEx), and current status (for example, Not Shipped, In Transit, Delayed, or Returned To Sender).", "properties": { "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "data": { "description": "Custom data originated by the shipping service.", "type": [ "object", "null" ] }, "fulfillmentContact": { "$ref": "#/$defs/Contact" }, "isDestinationCommercial": { "description": "Indicates that the destination is commercial", "type": [ "boolean", "null" ] }, "shippingMethodCode": { "description": "Code that uniquely identifies the shipping method such as \"Ground,\" \"Overnight,\" or \"Digital.\"\nThe site's shipping settings lists the valid shipping methods specified for this site.", "type": [ "string", "null" ] }, "shippingMethodName": { "description": "Readable name of the shipping method", "type": [ "string", "null" ] } }, "type": "object" }, "FulfillmentServiceAppeasementReason": { "properties": { "moreInfo": { "type": [ "string", "null" ] }, "reasonCode": { "type": [ "string", "null" ] } }, "type": "object" }, "FulfillmentServiceAuditInfo": { "properties": { "createBy": { "type": [ "string", "null" ] }, "createDate": { "format": "date-time", "type": [ "string", "null" ] }, "updateBy": { "type": [ "string", "null" ] }, "updateDate": { "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "FulfillmentServiceBundleInfo": { "properties": { "attributes": { "additionalProperties": { "nullable": true }, "type": [ "object", "null" ] }, "imageUrl": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "productCode": { "type": [ "string", "null" ] }, "quantity": { "format": "int32", "type": [ "integer", "null" ] }, "unitPrice": { "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "FulfillmentServiceFulfillmentField": { "properties": { "name": { "type": [ "string", "null" ] }, "required": { "nullable": false, "type": "boolean" }, "userEnteredValue": { "nullable": true } }, "type": "object" }, "FulfillmentServiceGiftCard": { "properties": { "activationDate": { "format": "date-time", "type": [ "string", "null" ] }, "cardNumber": { "type": [ "string", "null" ] }, "code": { "type": [ "string", "null" ] }, "creditType": { "type": [ "string", "null" ] }, "creditValue": { "format": "double", "type": [ "number", "null" ] }, "currencyCode": { "type": [ "string", "null" ] }, "currentBalance": { "format": "double", "type": [ "number", "null" ] }, "customerId": { "format": "int32", "type": [ "integer", "null" ] }, "expirationDate": { "format": "date-time", "type": [ "string", "null" ] }, "initialBalance": { "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "FulfillmentServiceInventoryAllocation": { "properties": { "auditInfo": { "$ref": "#/$defs/FulfillmentServiceAuditInfo" }, "condition": { "type": [ "string", "null" ] }, "date": { "format": "date-time", "type": [ "string", "null" ] }, "fulfilledDate": { "format": "date-time", "type": [ "string", "null" ] }, "inventoryId": { "format": "int32", "type": [ "integer", "null" ] }, "lotCode": { "type": [ "string", "null" ] }, "originalQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "quantity": { "format": "int32", "type": [ "integer", "null" ] }, "serialNumber": { "type": [ "string", "null" ] }, "sku": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "type": "object" }, "FulfillmentServiceInventoryTag": { "properties": { "name": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "type": "object" }, "FulfillmentServiceProductOption": { "properties": { "attributeFQN": { "type": [ "string", "null" ] }, "attributes": { "additionalProperties": { "nullable": true }, "type": [ "object", "null" ] }, "dataType": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "shopperEnteredValue": { "nullable": true }, "stringValue": { "type": [ "string", "null" ] }, "value": { "nullable": true } }, "type": "object" }, "FulfillmentServiceReturnRuleInfo": { "properties": { "attributes": { "additionalProperties": { "nullable": true }, "type": [ "object", "null" ] }, "isReturnable": { "type": [ "boolean", "null" ] }, "maxDays": { "format": "int32", "type": [ "integer", "null" ] }, "maxQty": { "format": "int32", "type": [ "integer", "null" ] }, "ruleCode": { "type": [ "string", "null" ] } }, "type": "object" }, "FulfillmentServiceShipmentItemAttribute": { "properties": { "attributeDefinitionId": { "format": "int32", "type": [ "integer", "null" ] }, "attributes": { "additionalProperties": { "nullable": true }, "type": [ "object", "null" ] }, "auditInfo": { "$ref": "#/$defs/FulfillmentServiceAuditInfo" }, "fullyQualifiedName": { "type": [ "string", "null" ] }, "values": { "items": {}, "type": [ "array", "null" ] } }, "type": "object" }, "FulfillmentServiceSubstituteInfo": { "properties": { "optIn": { "type": [ "string", "null" ] }, "substituteProductCode": { "type": [ "string", "null" ] }, "substituteVariantCode": { "type": [ "string", "null" ] } }, "type": "object" }, "FulfillmentServiceSubstituteReason": { "properties": { "moreInfo": { "type": [ "string", "null" ] }, "reasonCode": { "type": [ "string", "null" ] } }, "type": "object" }, "FulfillmentShopperNotes": { "properties": { "comments": { "type": [ "string", "null" ] }, "deliveryInstructions": { "type": [ "string", "null" ] }, "giftMessage": { "type": [ "string", "null" ] } }, "type": "object" }, "FulfillmentTask": { "properties": { "active": { "type": [ "boolean", "null" ] }, "attributes": { "additionalProperties": { "nullable": true }, "type": [ "object", "null" ] }, "completed": { "type": [ "boolean", "null" ] }, "completedDate": { "format": "date-time", "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "inputs": { "items": { "$ref": "#/$defs/TaskInput" }, "type": [ "array", "null" ] }, "links": { "additionalProperties": { "$ref": "#/$defs/Link" }, "type": [ "object", "null" ] }, "name": { "type": [ "string", "null" ] }, "skippable": { "type": [ "boolean", "null" ] }, "subject": { "type": [ "string", "null" ] }, "taskId": { "type": [ "string", "null" ] } }, "type": "object" }, "FutureInventory": { "properties": { "allocated": { "format": "int32", "type": [ "integer", "null" ] }, "available": { "format": "int32", "type": [ "integer", "null" ] }, "createDate": { "format": "date-time", "type": [ "string", "null" ] }, "deliveryDate": { "format": "date-time", "type": [ "string", "null" ] }, "futureInventoryID": { "format": "int32", "type": [ "integer", "null" ] }, "onhand": { "format": "int32", "type": [ "integer", "null" ] }, "pending": { "format": "int32", "type": [ "integer", "null" ] } }, "type": "object" }, "GatewayGiftCard": { "properties": { "amount": { "format": "double", "nullable": false, "type": "number" }, "cardNumber": { "type": [ "string", "null" ] }, "cardPin": { "type": [ "string", "null" ] }, "currencyCode": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] } }, "type": "object" }, "GiftCard": { "properties": { "activationDate": { "format": "date-time", "type": [ "string", "null" ] }, "cardNumber": { "type": [ "string", "null" ] }, "code": { "type": [ "string", "null" ] }, "creditType": { "type": [ "string", "null" ] }, "creditValue": { "format": "double", "type": [ "number", "null" ] }, "currencyCode": { "type": [ "string", "null" ] }, "currentBalance": { "format": "double", "type": [ "number", "null" ] }, "customerId": { "format": "int32", "type": [ "integer", "null" ] }, "expirationDate": { "format": "date-time", "type": [ "string", "null" ] }, "initialBalance": { "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "GiftInfo": { "properties": { "giftMessage": { "description": "Item level gift message", "maxLength": 500, "type": [ "string", "null" ] }, "isGiftItem": { "description": "Flag to indicate whether the item is a gift item", "type": [ "boolean", "null" ] } }, "type": "object" }, "InvalidCoupon": { "description": "Represents a coupon that is considered invalid by the Mozu pricing service.", "properties": { "couponCode": { "description": "Code that identifies the coupon.", "type": [ "string", "null" ] }, "createDate": { "description": "Create date of the invalid coupon.", "format": "date-time", "nullable": false, "type": "string" }, "discountId": { "format": "int32", "nullable": false, "type": "integer" }, "reason": { "description": "Description text of the reason.", "type": [ "string", "null" ] }, "reasonCode": { "description": "Code that identifies the reason the coupon was invalid.", "format": "int32", "nullable": false, "type": "integer" } }, "type": "object" }, "InventoryTags": { "properties": { "name": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "type": "object" }, "Link": { "properties": { "deprecation": { "type": [ "string", "null" ] }, "href": { "type": [ "string", "null" ] }, "hreflang": { "type": [ "string", "null" ] }, "media": { "type": [ "string", "null" ] }, "rel": { "type": [ "string", "null" ] }, "templated": { "type": [ "boolean", "null" ] }, "title": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] } }, "type": "object" }, "Measurement": { "properties": { "unit": { "type": [ "string", "null" ] }, "value": { "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "OrderAttribute": { "properties": { "attributeDefinitionId": { "format": "int32", "type": [ "integer", "null" ] }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "fullyQualifiedName": { "type": [ "string", "null" ] }, "values": { "items": {}, "type": [ "array", "null" ] } }, "type": "object" }, "OrderCanceledItem": { "properties": { "canceledQuantity": { "description": "Quantity Canceled on the OrderItem", "format": "int32", "type": "integer" }, "originalQuantity": { "description": "Original Quantity of OrderItem before Cancellation", "format": "int32", "type": "integer" }, "ruleCode": { "description": "Max Quantity Rule Code that was violated and led to Item Cancellation", "type": [ "string", "null" ] } }, "type": "object" }, "OrderItem": { "description": "A single line item of an order.", "properties": { "adjustedLineItemSubtotal": { "description": "Order Level taxable sub total", "format": "double", "type": [ "number", "null" ] }, "attributes": { "description": "Extensible attributes for this order line.", "items": { "$ref": "#/$defs/OrderLineAttribute" }, "type": [ "array", "null" ] }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "autoAddDiscountId": { "description": "Track the discoutid from which the item was auto added", "format": "int32", "type": [ "integer", "null" ] }, "callOffOrderItemId": { "description": "Identifier of the originating Call-Off Order line item, if this item was released\nfrom a Call-Off Order line. Null for standard order items.", "type": [ "string", "null" ] }, "childItemIds": { "description": "List of Child Item Ids for this order item", "items": { "type": "string" }, "type": [ "array", "null" ] }, "data": { "description": "Custom data for a given vendor set within the commerce process.", "type": [ "object", "null" ] }, "deliveryWindow": { "$ref": "#/$defs/DeliveryWindow" }, "destinationId": { "description": "The destination associated with this item when used with a multi-ship checkout.", "type": [ "string", "null" ] }, "discountTotal": { "description": "How much the shopper saves with the applied discount or sale price. This is a negative number.", "format": "double", "type": [ "number", "null" ] }, "discountedTotal": { "description": "Subtotal minus any discounts.", "format": "double", "type": [ "number", "null" ] }, "dutyAmount": { "description": "Duty or Tariff for this item", "format": "double", "type": [ "number", "null" ] }, "expectedDeliveryDate": { "description": "Expected Delivery Date of shipment", "format": "date-time", "type": [ "string", "null" ] }, "extendedTotal": { "description": "Line item extended total (quantity multiplied by unit extended price) before discounts.", "format": "double", "type": [ "number", "null" ] }, "feeTotal": { "description": "Not implemented. Total cost of fees that apply to this item.", "format": "double", "type": [ "number", "null" ] }, "fulfillmentLocationCode": { "description": "Location code from which to obtain this item", "type": [ "string", "null" ] }, "fulfillmentMethod": { "description": "Fulfillment method used to fulfill this item", "type": [ "string", "null" ] }, "giftInfo": { "$ref": "#/$defs/GiftInfo" }, "handlingAmount": { "description": "Product-level handling fee for this item (e.g. special packaging, hazmat fees).\nThis does NOT include order-level handling fees — those are in Mozu.CommerceRuntime.Contracts.Commerce.CommerceItem.WeightedOrderHandlingFee.\nTotal handling on the shipment = HandlingAmount + WeightedOrderHandlingFee.", "format": "double", "type": [ "number", "null" ] }, "id": { "description": "Unique identifier of the order line item. System-supplied and read-only.", "type": [ "string", "null" ] }, "inventoryTags": { "items": { "$ref": "#/$defs/InventoryTags" }, "type": [ "array", "null" ] }, "isAssemblyRequired": { "description": "Assembly Required for this order item", "type": "boolean" }, "isRecurring": { "description": "If true, the cart item lists a product that can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.", "type": [ "boolean", "null" ] }, "isReservationEnabled": { "description": "Flag to indicate reserve inventory in cart", "type": "boolean" }, "isTaxable": { "description": "Not implemented. If true, the cart item is eligible for tax.", "type": [ "boolean", "null" ] }, "itemTaxTotal": { "description": "Total price of taxes that apply to products in this item.", "format": "double", "type": [ "number", "null" ] }, "lineId": { "description": "The line id assigned to the order item. Visible only in the Admin, this is set from the Admin or\nin CommerceRuntime when a cart is converted to an order.", "format": "int32", "type": [ "integer", "null" ] }, "lineItemAdjustment": { "format": "double", "type": [ "number", "null" ] }, "localeCode": { "description": "Locale code for language that appears in text and descriptions on the site, for example, en_US. \nThis is not the currency code. Currently only en_US is supported.", "type": [ "string", "null" ] }, "originalCartItemId": { "description": "Unique identifier of the cart item that is associated with this line item. \n(This is the original Cart Item ID expressed as a GUID.)", "type": [ "string", "null" ] }, "parentItemId": { "description": "Indicates Parent Item Id for this order item", "type": [ "string", "null" ] }, "priceMode": { "description": "Determines if the item is using external or internal(catalog) pricing", "type": [ "string", "null" ] }, "product": { "$ref": "#/$defs/Product" }, "productDiscount": { "$ref": "#/$defs/AppliedLineItemProductDiscount" }, "productDiscounts": { "description": "A list of discounts applied to the product", "items": { "$ref": "#/$defs/AppliedLineItemProductDiscount" }, "type": [ "array", "null" ] }, "purchaseLocation": { "description": "The location where the product is being purchased.. default is null. Products can have different prices\nby purchaseLocation via custom priceListResolution...", "type": [ "string", "null" ] }, "quantity": { "description": "Number of products ordered.", "format": "int32", "type": "integer" }, "requestedShipDate": { "description": "Requested ship date carried from the Call-Off Order line (spec COM-10941 follow-up).", "format": "date-time", "type": [ "string", "null" ] }, "returnRuleInfo": { "$ref": "#/$defs/ReturnRuleInfo" }, "shippingAmountBeforeDiscountsAndAdjustments": { "description": "Shipping amount before Discounts and adjustments", "format": "double", "type": [ "number", "null" ] }, "shippingDiscounts": { "description": "A discount applied to the shipping", "items": { "$ref": "#/$defs/AppliedLineItemShippingDiscount" }, "type": [ "array", "null" ] }, "shippingMethodCode": { "description": "Code that uniquely identifies the shipping method.", "type": [ "string", "null" ] }, "shippingMethodName": { "description": "Readable name of the shipping method.", "type": [ "string", "null" ] }, "shippingTaxTotal": { "description": "Total price of taxes that apply to the shipping of this item.", "format": "double", "type": [ "number", "null" ] }, "shippingTotal": { "description": "Total price of shipping that apply to this item.", "format": "double", "type": [ "number", "null" ] }, "subscription": { "$ref": "#/$defs/SubscriptionInfo" }, "substituteInfo": { "$ref": "#/$defs/SubstituteInfo" }, "subtotal": { "description": "Line item subtotal (quantity multiplied by price) before discounts.", "format": "double", "type": [ "number", "null" ] }, "suggestions": { "description": "Routing suggestions", "items": { "$ref": "#/$defs/Suggestion" }, "type": [ "array", "null" ] }, "taxData": { "description": "Storage for any additional/custom tax data.", "type": [ "object", "null" ] }, "taxableTotal": { "description": "Line item subtotal (quantity multiplied by price) before discounts.", "format": "double", "type": [ "number", "null" ] }, "timeFenceDays": { "description": "Time-fence tolerance (days) carried from the Call-Off Order line's bound ReservationRule.", "format": "int32", "type": [ "integer", "null" ] }, "total": { "description": "Total price of this cart item taking into account any discounts.", "format": "double", "type": [ "number", "null" ] }, "totalWithWeightedShippingAndHandling": { "description": "Line item total with line item, Tax, Weighted Tax with Weighted shipping and handling costs", "format": "double", "type": [ "number", "null" ] }, "totalWithoutWeightedShippingAndHandling": { "description": "Taxable Subtotal including Weighted Order amounts", "format": "double", "type": [ "number", "null" ] }, "unitPrice": { "$ref": "#/$defs/CommerceUnitPrice" }, "weightedOrderAdjustment": { "description": "Order Level Manual Adjustment applied to this Item", "format": "double", "type": [ "number", "null" ] }, "weightedOrderDiscount": { "description": "Order Level Discount applied to this Item", "format": "double", "type": [ "number", "null" ] }, "weightedOrderDuty": { "description": "Order Level Duty applied to this Item", "format": "double", "type": [ "number", "null" ] }, "weightedOrderHandlingAdjustment": { "description": "Order-level handling manual adjustment allocated to this item.", "format": "double", "type": [ "number", "null" ] }, "weightedOrderHandlingFee": { "description": "Order-level handling fee allocated to this item (e.g. flat handling fee spread across all items).\nThis is separate from product-level handling in Mozu.CommerceRuntime.Contracts.Commerce.CommerceItem.HandlingAmount.\nTotal handling on the shipment = HandlingAmount + WeightedOrderHandlingFee.", "format": "double", "type": [ "number", "null" ] }, "weightedOrderHandlingFeeDiscount": { "description": "Order-level handling fee discount allocated to this item.", "format": "double", "type": [ "number", "null" ] }, "weightedOrderHandlingFeeTax": { "description": "Total handling tax for this item (covers both product-level and order-level handling tax combined).\nOn the shipment item, this is split into: HandlingTax (total) and WeightedOrderHandlingFeeTax (order-level portion only).", "format": "double", "type": [ "number", "null" ] }, "weightedOrderShipping": { "description": "Order Level Shipping applied to this Item", "format": "double", "type": [ "number", "null" ] }, "weightedOrderShippingDiscount": { "description": "Order Level Shipping discount applied to this Item", "format": "double", "type": [ "number", "null" ] }, "weightedOrderShippingManualAdjustment": { "description": "Order Level Shipping Manual Adjustment applied to this Item", "format": "double", "type": [ "number", "null" ] }, "weightedOrderShippingTax": { "description": "Order Level Shipping Tax applied to this Item", "format": "double", "type": [ "number", "null" ] }, "weightedOrderTax": { "description": "Order Level tax applied to this Item", "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "OrderLineAttribute": { "description": "Attribute instance on an Order line item.", "properties": { "attributeDefinitionId": { "format": "int32", "type": [ "integer", "null" ] }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "fullyQualifiedName": { "type": [ "string", "null" ] }, "values": { "items": {}, "type": [ "array", "null" ] } }, "type": "object" }, "OrderNote": { "description": "Internal notes that a merchant may add to the order. Maximum 250 characters.", "properties": { "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "id": { "description": "Unique identifier of the note. System-supplied and read-only.", "type": [ "string", "null" ] }, "text": { "description": "Text of the note. Maximum 250 characters.", "maxLength": 500, "nullable": false, "type": "string" } }, "type": "object" }, "OrderValidationMessage": { "description": "Validation message returned by an order validator.", "properties": { "message": { "description": "Actual message returned by the validator.", "type": [ "string", "null" ] }, "messageType": { "description": "Identifier to indicate the type of the message, See OrderValidatorMessageTypeConst for options.", "type": [ "string", "null" ] }, "orderItemId": { "description": "Order item id that this message applies to. Can be empty.", "type": [ "string", "null" ] } }, "type": "object" }, "OrderValidationResult": { "description": "The result of an order validator.", "properties": { "createdDate": { "description": "DateTime that this validation result was created", "format": "date-time", "type": [ "string", "null" ] }, "messages": { "description": "Messages returned by the order validator", "items": { "$ref": "#/$defs/OrderValidationMessage" }, "type": [ "array", "null" ] }, "status": { "description": "Status of the order validation result. See OrderValidatorStatusConst for options.", "type": [ "string", "null" ] }, "validationId": { "description": "Identifier set by the capability that states the id of this specific validation attempt", "type": [ "string", "null" ] }, "validatorName": { "description": "Identifier set by the capability that states the specific name of this validator.", "type": [ "string", "null" ] }, "validatorType": { "description": "Identifies the type of the validator (types are enumerated in OrderValidatorTypeConst)", "type": [ "string", "null" ] } }, "type": "object" }, "PackageItem": { "allOf": [ { "$ref": "#/$defs/AbstractFulfillmentItem" }, { "additionalProperties": false, "type": "object" } ], "description": "An item in a package representing a particular product." }, "PackageMeasurements": { "description": "Physical dimensions of the package required to ship the product and its weight.", "properties": { "height": { "$ref": "#/$defs/Measurement" }, "length": { "$ref": "#/$defs/Measurement" }, "weight": { "$ref": "#/$defs/Measurement" }, "width": { "$ref": "#/$defs/Measurement" } }, "type": "object" }, "PackingSlipItemDetail": { "properties": { "attributes": { "additionalProperties": { "nullable": true }, "description": "Gets or Sets Attributes", "type": [ "object", "null" ] }, "lineId": { "description": "Gets or Sets LineId", "format": "int32", "type": [ "integer", "null" ] }, "originalOrderItemId": { "description": "Gets or Sets OriginalOrderItemId", "type": [ "string", "null" ] }, "quantity": { "description": "Gets or Sets Quantity", "format": "int32", "type": [ "integer", "null" ] } }, "type": "object" }, "Payment": { "description": "Payment transaction associated with this order. It is the entire payment interchange between the merchant who is forwarding the customer's payment \ninformation and the payment service who is authorizing and capturing payment. Payment can be either by credit card, check, or PayPal. (PayPal not\ncurrently supported.)", "properties": { "amountCollected": { "description": "Amount collected on the payment", "format": "double", "type": "number" }, "amountCredited": { "description": "Amount credited back to the payment.", "format": "double", "type": "number" }, "amountRequested": { "description": "Derived from the Amount on the initial payment create, used to help storefront determine how much can be captured for multiple payments.\nSee Order.AmountRemainingForPayment for an example.", "format": "double", "type": "number" }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "availableActions": { "description": "Actions available to the payment", "items": { "type": "string" }, "type": [ "array", "null" ] }, "billingInfo": { "$ref": "#/$defs/BillingInfo" }, "changeMessages": { "description": "Change messages related to the payment.", "items": { "$ref": "#/$defs/ChangeMessage" }, "type": [ "array", "null" ] }, "data": { "description": "Custom data from payment providers", "type": [ "object", "null" ] }, "externalTransactionId": { "description": "The external/third party transaction Id for this payment. This is used to store the transaction Id from digital wallet like Visa Checkout", "type": [ "string", "null" ] }, "gatewayGiftCard": { "$ref": "#/$defs/GatewayGiftCard" }, "groupId": { "$ref": "#/$defs/PaymentActionTarget" }, "id": { "description": "Unique identifier of this order transaction.", "type": [ "string", "null" ] }, "installmentPlanCode": { "description": "Stores the Installment Plan code. Installment is only supported on subscription orders", "type": [ "string", "null" ] }, "interactions": { "description": "List of interactions for this transaction. A transaction is created upon authorization and lasts across the payment \r\ninterchange, which can consist of multiple interactions, such as consecutive captures.", "items": { "$ref": "#/$defs/PaymentInteraction" }, "type": [ "array", "null" ] }, "isRecurring": { "description": "If true, the product is purchased or fulfilled at regular intervals, for example, \nmonthly billing or a subscription. (Not currently supported.)", "type": "boolean" }, "orderId": { "description": "Unique identifier of the order with which this transaction is associated.", "type": [ "string", "null" ] }, "paymentServiceTransactionId": { "description": "Unique identifier of the transaction, specified by the payment service processesing this transaction.", "type": [ "string", "null" ] }, "paymentType": { "description": "Type of Payment", "type": [ "string", "null" ] }, "paymentWorkflow": { "description": "The source of data for this payment. By default, this will be set to 'mozu'", "type": [ "string", "null" ] }, "status": { "description": "Current status of this transaction which are described by the PaymentStatusConst class.", "type": [ "string", "null" ] }, "subPayments": { "description": "List of sub payments that correspond to child orders in case of multiship orders.", "items": { "$ref": "#/$defs/SubPayment" }, "type": [ "array", "null" ] } }, "type": "object" }, "PaymentActionTarget": { "properties": { "targetId": { "description": "The Id of the Checkout/Order/Return to target.", "type": [ "string", "null" ] }, "targetNumber": { "description": "The number of the Checkout/Order/Return to target.", "format": "int32", "type": [ "integer", "null" ] }, "targetType": { "description": "Specifies if the Mozu.CommerceRuntime.Contracts.Payments.PaymentActionTarget.TargetId is a Checkout Id, Order Id, or Return Id.", "type": [ "string", "null" ] } }, "type": "object" }, "PaymentCard": { "description": "If the customer is paying by credit card, the card holder's details, such as the name on the card, number, billing \naddress, and expiration dates.", "properties": { "bin": { "description": "Year when the card expires.", "type": [ "string", "null" ] }, "cardNumberPartOrMask": { "description": "The visible part of the card number that the merchant uses to refer to \npayment information, for example, the last for digits of the card number.", "type": [ "string", "null" ] }, "ccLastFour": { "description": "Last four digit of Credit card\nOnly for OMS Only tenant.", "type": [ "string", "null" ] }, "expireMonth": { "description": "Month when the card expires.", "format": "int32", "type": "integer" }, "expireYear": { "description": "Year when the card expires.", "format": "int32", "type": "integer" }, "isCardInfoSaved": { "description": "If true, the card information is stored in the customer's account.", "type": "boolean" }, "isTokenized": { "description": "If true, the card is tokenized by external provider", "type": "boolean" }, "isUsedRecurring": { "description": "If true, the credit card is charged on a regular interval, such as for a subscription. (Not supported currently.)", "type": [ "boolean", "null" ] }, "nameOnCard": { "description": "Card holder's name as it appears on the card.", "type": [ "string", "null" ] }, "paymentOrCardType": { "description": "Card type such as Visa, MasterCard, American Express, or Discover.", "type": [ "string", "null" ] }, "paymentServiceCardId": { "description": "Credit card number.", "type": [ "string", "null" ] } }, "type": "object" }, "PaymentGatewayResponseData": { "description": "Payment gateway response data", "properties": { "key": { "description": "Key from payment gateway", "type": [ "string", "null" ] }, "value": { "description": "Value from payment gateway", "type": [ "string", "null" ] } }, "type": "object" }, "PaymentInteraction": { "description": "A single interaction of a potential list of interactions for a transaction. The scope of the transaction is the entire payment\r\ninterchange. It is created upon authorization and is used for all subsequent interactions performed against the authorize,\r\nsuch as consecutive captures.", "properties": { "amount": { "description": "Amount of funds associated with this interaction.", "format": "double", "type": [ "number", "null" ] }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "capturableShipmentsSummary": { "description": "Stores pairings of shipment number to shipment total for all captured shipments. This was added for generating TLogs.", "items": { "$ref": "#/$defs/CapturableShipmentSummary" }, "type": [ "array", "null" ] }, "checkNumber": { "description": "If paying by check, the check number.", "type": [ "string", "null" ] }, "currencyCode": { "description": "ISO currency code for the transaction. Currently, only USD is supported.", "type": [ "string", "null" ] }, "gatewayAVSCodes": { "description": "Gateway AVS Codes. Supplied by PCIaaS.", "type": [ "string", "null" ] }, "gatewayAuthCode": { "description": "If required by the payment gateway, the authorization code of the transaction. Supplied by PCIaaS.", "type": [ "string", "null" ] }, "gatewayCVV2Codes": { "description": "Gateway CVV2 Codes. Supplied by PCIaaS.", "type": [ "string", "null" ] }, "gatewayInteractionId": { "description": "Unique identifier of the gateway interaction. Used for credit card transactions, where the\npayment service creates a GatewayInteractionId for each transaction interaction.", "format": "int32", "type": [ "integer", "null" ] }, "gatewayResponseCode": { "description": "Gateway response code. Supplied by PCIaaS.", "type": [ "string", "null" ] }, "gatewayResponseData": { "description": "A List of payment response data required to act on authorization when using external order management systems", "items": { "$ref": "#/$defs/PaymentGatewayResponseData" }, "type": [ "array", "null" ] }, "gatewayResponseText": { "description": "Gateway response text. Supplied by PCIaaS.", "type": [ "string", "null" ] }, "gatewayTransactionId": { "description": "Unique identifier of the transaction supplied by PCIaaS.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of this payment transaction interaction.", "type": [ "string", "null" ] }, "interactionDate": { "description": "Date the interaction occurred", "format": "date-time", "type": [ "string", "null" ] }, "interactionType": { "description": "Types of transaction interactions which can be \"Authorization,\" \"Capture,\" \"AuthorizeAndCapture,\"\n\"Void,\" or \"Credit,\" \"CheckRequested,\" or \"CheckReceived.\"", "type": [ "string", "null" ] }, "isManual": { "description": "If the payment is a manual payment, this is set to true", "nullable": false, "type": "boolean" }, "isPending": { "description": "If true, indicates payment action is still pending and not yet confirmed.", "nullable": false, "type": "boolean" }, "isRecurring": { "description": "If true, the product is purchased or fulfilled at regular intervals, for example, a monthly billing or a subscription. (Not currently implemented.)", "type": [ "boolean", "null" ] }, "note": { "description": "Note to be entered by merchant/application", "type": [ "string", "null" ] }, "orderId": { "description": "Unique identifier of the order with which this transaction is associated.", "type": [ "string", "null" ] }, "paymentEntryStatus": { "description": "Status of the payment when the transaction interaction was created", "type": [ "string", "null" ] }, "paymentId": { "description": "Unique identifier of the original transaction of which this current interaction is a part.", "type": [ "string", "null" ] }, "paymentTransactionInteractionIdReference": { "description": "Unique identifier of previous PaymentTransactionInteraction that this PaymentTransactionInteraction is modifying.\nFor instance, when crediting a capture, set the PaymentTransactionInteractionIdReference to the capture PaymentTransactionInteractionID.", "format": "int32", "type": [ "integer", "null" ] }, "refundId": { "description": "Refund Id, if the interaction is for a stand alone refund.", "type": [ "string", "null" ] }, "returnId": { "description": "Return Id, if the interaction is a Credit for a return-refund.", "type": [ "string", "null" ] }, "status": { "description": "Status of the payment transaction interaction which can be either \"Success\" or \"Failure.\"", "type": [ "string", "null" ] }, "target": { "$ref": "#/$defs/PaymentActionTarget" } }, "type": "object" }, "PaymentToken": { "properties": { "paymentServiceTokenId": { "type": [ "string", "null" ] }, "provider": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] } }, "type": "object" }, "Phone": { "properties": { "home": { "type": [ "string", "null" ] }, "mobile": { "type": [ "string", "null" ] }, "work": { "type": [ "string", "null" ] } }, "type": "object" }, "Pickup": { "allOf": [ { "$ref": "#/$defs/CollectionOfPickupItem" }, { "additionalProperties": false, "type": "object" } ], "description": "Represents a pickup by a customer from a merchant." }, "PickupItem": { "allOf": [ { "$ref": "#/$defs/AbstractFulfillmentItem" }, { "additionalProperties": false, "type": "object" } ], "description": "Item that goes into the pickup to determine which items will be picked up." }, "Product": { "description": "The product as it appears on the order item.", "properties": { "allocationExpiration": { "description": "Allocation ID associated with this product on this order.", "format": "date-time", "type": [ "string", "null" ] }, "allocationId": { "description": "Allocation ID associated with this product on this order.", "format": "int32", "type": [ "integer", "null" ] }, "bundledProducts": { "description": "Products bundled with this product (if the current product is a bundle)", "items": { "$ref": "#/$defs/BundledProduct" }, "type": [ "array", "null" ] }, "categories": { "description": "Categories to which this product belongs.", "items": { "$ref": "#/$defs/Category" }, "type": [ "array", "null" ] }, "condition": { "description": "Condition", "type": [ "string", "null" ] }, "description": { "description": "Short description of the product in the language specified by LocaleCode.", "type": [ "string", "null" ] }, "discountsRestricted": { "description": "Is the product discount restricted", "type": [ "boolean", "null" ] }, "discountsRestrictedEndDate": { "description": "Product discount restriction end date", "format": "date-time", "type": [ "string", "null" ] }, "discountsRestrictedStartDate": { "description": "Product discount restriction start date", "format": "date-time", "type": [ "string", "null" ] }, "fulfillmentFields": { "description": "List of unique product identifiers for an item on shipment", "items": { "$ref": "#/$defs/FulfillmentField" }, "type": [ "array", "null" ] }, "fulfillmentStatus": { "description": "Fulfillment status of the product.", "type": [ "string", "null" ] }, "fulfillmentTypesSupported": { "description": "Types of fulfillment that are supported for this product.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "goodsType": { "description": "Goods Type", "type": [ "string", "null" ] }, "imageAlternateText": { "description": "Descriptive text of the image associated with the product in the language specified by LocaleCode.", "type": [ "string", "null" ] }, "imageUrl": { "description": "URL of the image that appears next to the product on the order item. Optional.", "type": [ "string", "null" ] }, "isPackagedStandAlone": { "description": "Indicates that this product ships by itself.", "type": "boolean" }, "isRecurring": { "description": "If true, the product is purchased or fulfilled at regular intervals, for example, a monthly billing or a subscription.", "type": [ "boolean", "null" ] }, "isTaxable": { "description": "If true, the product is eligible for tax.", "type": [ "boolean", "null" ] }, "measurements": { "$ref": "#/$defs/PackageMeasurements" }, "mfgPartNumber": { "description": "Manufacturing Part Number of the product.", "type": [ "string", "null" ] }, "name": { "description": "Name of the product, this is the current value of the product's name in the language specified by LocaleCode.", "type": [ "string", "null" ] }, "options": { "description": "If the product contains configurable or stand-alone options, the list of product options that the shopper selected for this product.", "items": { "$ref": "#/$defs/ProductOption" }, "type": [ "array", "null" ] }, "price": { "$ref": "#/$defs/ProductPrice" }, "productCode": { "description": "Merchant-created code that uniquely identifies the product.", "type": [ "string", "null" ] }, "productReservationId": { "description": "Reservation ID associated with this product in the bundle.", "format": "int32", "type": [ "integer", "null" ] }, "productType": { "description": "Type of product, which can be a product with configurable options, a product with stand-alone options, or a simple product with no options.", "type": [ "string", "null" ] }, "productUsage": { "description": "Usage of the product, primarily used to indicate a bundle in this context", "type": [ "string", "null" ] }, "properties": { "description": "If the product contains properties, the list of properties that the shopper selected for this product.", "items": { "$ref": "#/$defs/ProductProperty" }, "type": [ "array", "null" ] }, "serialNumber": { "description": "Serial Number", "type": [ "string", "null" ] }, "sku": { "description": "Product Identifier specific to the store", "type": [ "string", "null" ] }, "stock": { "$ref": "#/$defs/ProductStock" }, "upc": { "description": "Universal Product Code of the product.", "type": [ "string", "null" ] }, "variationProductCode": { "description": "For configurable products, the unique identifier of the product variation that has been selected.", "type": [ "string", "null" ] } }, "type": "object" }, "ProductOption": { "description": "Product option for the product listed on this order item. If the product contains \nconfigurable or stand-alone options, this is a product option that the shopper has selected.", "properties": { "attributeFQN": { "description": "Value of the product option.", "type": [ "string", "null" ] }, "dataType": { "description": "Value of the product option.", "type": [ "string", "null" ] }, "name": { "description": "Name of the product option that appears with the order item in the language specified by LocaleCode.", "type": [ "string", "null" ] }, "shopperEnteredValue": { "description": "The value entered by the shopper if this is an option that requires shopper input, for example, a monogram.", "nullable": true }, "stringValue": { "description": "Value of the product option.", "type": [ "string", "null" ] }, "value": { "description": "Value of the product option.", "nullable": true } }, "type": "object" }, "ProductPrice": { "description": "Price of the product with any sale and discounts applied.", "properties": { "creditValue": { "description": "Credit Value when the product happens to be a gift card or similar product", "format": "double", "type": [ "number", "null" ] }, "isOverRidePriceSalePrice": { "description": "Indicate that External Price (TenantOverridePrice) is a Sale Price. And is used to calculate the line item discounts.", "type": [ "boolean", "null" ] }, "msrp": { "description": "MSRP of product.", "format": "double", "type": [ "number", "null" ] }, "price": { "description": "Price of the product. This is the price that the merchant intends to sell the product if no sale price is present.", "format": "double", "type": [ "number", "null" ] }, "priceListCode": { "description": "Pricelist code for the product", "type": [ "string", "null" ] }, "priceListEntryMode": { "description": "Pricelist entry mode of the product.\nNote: possible values are below\n1. null : Product doesn't participate in pricelist\n2. Bulk : Bulk volume price available(unit price vary based on quantity)\n3. Simple:", "type": [ "string", "null" ] }, "salePrice": { "description": "Current sale price of the product, which is a specific numerical amount (not a percentage off).", "format": "double", "type": [ "number", "null" ] }, "tenantOverridePrice": { "description": "An override price applied on the product by the tenant.", "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "ProductProperty": { "properties": { "attributeFQN": { "type": [ "string", "null" ] }, "dataType": { "type": [ "string", "null" ] }, "isMultiValue": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "values": { "items": { "$ref": "#/$defs/ProductPropertyValue" }, "type": [ "array", "null" ] } }, "type": "object" }, "ProductPropertyValue": { "properties": { "stringValue": { "type": [ "string", "null" ] }, "value": { "nullable": true } }, "type": "object" }, "ProductStock": { "properties": { "aggregateInventory": { "format": "int32", "type": [ "integer", "null" ] }, "availableDate": { "format": "date-time", "type": [ "string", "null" ] }, "availableFutureInventories": { "format": "int32", "nullable": false, "readOnly": true, "type": "integer" }, "futureInventories": { "items": { "$ref": "#/$defs/FutureInventory" }, "type": [ "array", "null" ] }, "isOnBackOrder": { "nullable": false, "type": "boolean" }, "isSubstitutable": { "type": [ "boolean", "null" ] }, "manageStock": { "nullable": false, "type": "boolean" }, "stockAvailable": { "format": "int32", "type": [ "integer", "null" ] }, "totalAvailableStock": { "format": "int32", "nullable": false, "readOnly": true, "type": "integer" } }, "type": "object" }, "PurchaseOrderCustomField": { "properties": { "code": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "type": "object" }, "PurchaseOrderPayment": { "description": "Purchase order payment", "properties": { "customFields": { "description": "Memo/custom fields", "items": { "$ref": "#/$defs/PurchaseOrderCustomField" }, "type": [ "array", "null" ] }, "paymentTerm": { "$ref": "#/$defs/PurchaseOrderPaymentTerm" }, "purchaseOrderNumber": { "description": "Purchase order number", "type": [ "string", "null" ] } }, "type": "object" }, "PurchaseOrderPaymentTerm": { "properties": { "code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } }, "type": "object" }, "Reason": { "properties": { "description": { "type": [ "string", "null" ] }, "moreInfo": { "type": [ "string", "null" ] }, "reasonCode": { "type": [ "string", "null" ] } }, "type": "object" }, "Refund": { "description": "Refund associated with an 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.\nA refund does not reduce the 'amount collected' on an order and it is possible for a refund to exceed the total order amount.", "properties": { "amount": { "description": "Amount refunded.", "format": "double", "type": "number" }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "id": { "description": "Unique identifier of this order transaction.", "type": [ "string", "null" ] }, "orderId": { "description": "Unique identifier of the order with which this refund is associated.", "type": [ "string", "null" ] }, "payment": { "$ref": "#/$defs/Payment" }, "reason": { "description": "Merchant-entered reason for this refund.", "type": [ "string", "null" ] }, "reasonCode": { "type": [ "string", "null" ] }, "refundMethod": { "description": "Refund Method.", "type": [ "string", "null" ] } }, "type": "object" }, "ReturnRuleInfo": { "properties": { "isReturnable": { "description": "Indicate product is returnable or not", "type": [ "boolean", "null" ] }, "maxDays": { "description": "Return window within which an item can be returned", "format": "int32", "type": [ "integer", "null" ] }, "maxQty": { "description": "Maximum quantity that can be returned", "format": "int32", "type": [ "integer", "null" ] }, "ruleCode": { "description": "Return rule code which is applied", "type": [ "string", "null" ] } }, "type": "object" }, "Shipment": { "properties": { "alternateContact": { "$ref": "#/$defs/FulfillmentAlternateContact" }, "attributes": { "items": { "$ref": "#/$defs/ShipmentAttribute" }, "type": [ "array", "null" ] }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "backorderCreatedDate": { "format": "int32", "type": [ "integer", "null" ] }, "canceledItems": { "items": { "$ref": "#/$defs/FulfillmentCanceledItem" }, "type": [ "array", "null" ] }, "changeMessages": { "items": { "$ref": "#/$defs/ChangeMessage" }, "type": [ "array", "null" ] }, "cost": { "format": "double", "type": [ "number", "null" ] }, "currencyCode": { "type": [ "string", "null" ] }, "customer": { "$ref": "#/$defs/Customer" }, "customerAccountId": { "format": "int32", "type": [ "integer", "null" ] }, "customerTaxId": { "readOnly": true, "type": [ "string", "null" ] }, "data": { "type": [ "object", "null" ] }, "destination": { "$ref": "#/$defs/Destination" }, "dutyAdjustment": { "format": "double", "type": "number" }, "dutyTotal": { "format": "double", "type": "number" }, "email": { "type": [ "string", "null" ] }, "expectedDeliveryDate": { "format": "date-time", "type": [ "string", "null" ] }, "externalOrderId": { "type": [ "string", "null" ] }, "externalShipmentId": { "type": [ "string", "null" ] }, "fulfillmentDate": { "format": "date-time", "type": [ "string", "null" ] }, "fulfillmentLocationCode": { "type": [ "string", "null" ] }, "fulfillmentStatus": { "type": [ "string", "null" ] }, "futureDate": { "format": "date-time", "type": [ "string", "null" ] }, "groupId": { "description": "Identifier of the order-level shipping group (`ShippingGrouping.Id`) whose items are fulfilled\nby this shipment. Distinct from the internal routing group key stored on the domain entity.", "type": [ "string", "null" ] }, "handlingAdjustment": { "format": "double", "type": "number" }, "handlingSubtotal": { "format": "double", "type": "number" }, "handlingTaxAdjustment": { "format": "double", "type": "number" }, "handlingTaxTotal": { "format": "double", "type": "number" }, "handlingTotal": { "format": "double", "type": "number" }, "holdReleaseDate": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "ID of the shipment", "type": [ "string", "null" ] }, "isExpress": { "type": [ "boolean", "null" ] }, "isFlatRateShipping": { "type": [ "boolean", "null" ] }, "isTransfer": { "type": [ "boolean", "null" ] }, "items": { "items": { "$ref": "#/$defs/ShipmentItem" }, "type": [ "array", "null" ] }, "lineItemSubtotal": { "format": "double", "type": "number" }, "lineItemTaxAdjustment": { "format": "double", "type": "number" }, "lineItemTaxTotal": { "format": "double", "type": "number" }, "lineItemTotal": { "format": "double", "type": "number" }, "number": { "format": "int32", "type": [ "integer", "null" ] }, "orderId": { "type": [ "string", "null" ] }, "orderNumber": { "format": "int32", "type": "integer" }, "orderSubmitDate": { "format": "date-time", "type": [ "string", "null" ] }, "origin": { "$ref": "#/$defs/Contact" }, "originalShipmentNumber": { "format": "int32", "type": [ "integer", "null" ] }, "packages": { "items": { "$ref": "#/$defs/CommerceRuntimePackage" }, "type": [ "array", "null" ] }, "parentCheckoutNumber": { "format": "int32", "type": [ "integer", "null" ] }, "parentShipmentNumber": { "format": "int32", "type": [ "integer", "null" ] }, "pickStatus": { "type": [ "string", "null" ] }, "pickType": { "type": [ "string", "null" ] }, "pickupInfo": { "type": [ "object", "null" ] }, "readyToCapture": { "type": "boolean" }, "requestedShipDate": { "description": "Requested ship date, carried from the originating OrderItem (Call-Off release, spec\nCOM-10941 follow-up). Null for shipments not tied to a Call-Off Order line.", "format": "date-time", "type": [ "string", "null" ] }, "shipmentAdjustment": { "format": "double", "type": "number" }, "shipmentNotes": { "items": { "$ref": "#/$defs/ShipmentNote" }, "type": [ "array", "null" ] }, "shipmentStatus": { "type": [ "string", "null" ] }, "shipmentStatusReason": { "$ref": "#/$defs/ShipmentStatusReason" }, "shipmentType": { "type": [ "string", "null" ] }, "shippingAdjustment": { "format": "double", "type": "number" }, "shippingMethodCode": { "type": [ "string", "null" ] }, "shippingMethodName": { "type": [ "string", "null" ] }, "shippingSubtotal": { "format": "double", "type": "number" }, "shippingTaxAdjustment": { "format": "double", "type": "number" }, "shippingTaxTotal": { "format": "double", "type": "number" }, "shippingTotal": { "format": "double", "type": "number" }, "shopperNotes": { "$ref": "#/$defs/FulfillmentShopperNotes" }, "substitutedItems": { "items": { "$ref": "#/$defs/SubstitutedItem" }, "type": [ "array", "null" ] }, "taxData": { "type": [ "object", "null" ] }, "total": { "format": "double", "type": "number" }, "transferShipmentNumbers": { "items": { "format": "int32", "type": "integer" }, "type": [ "array", "null" ] }, "workflowProcessContainerId": { "type": [ "string", "null" ] }, "workflowProcessId": { "type": [ "string", "null" ] }, "workflowState": { "$ref": "#/$defs/WorkflowState" } }, "type": "object" }, "ShipmentAttribute": { "description": "Attribute instance on a Shipment entity.\nSeparate from OrderAttribute for type safety and future divergence.", "properties": { "attributeDefinitionId": { "format": "int32", "type": [ "integer", "null" ] }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "fullyQualifiedName": { "type": [ "string", "null" ] }, "values": { "items": {}, "type": [ "array", "null" ] } }, "type": "object" }, "ShipmentItem": { "properties": { "actualPrice": { "format": "double", "type": "number" }, "allowsSubstitution": { "type": [ "boolean", "null" ] }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "backorderReleaseDate": { "format": "date-time", "type": [ "string", "null" ] }, "bundleInfo": { "$ref": "#/$defs/BundleInfo" }, "cartItemId": { "type": [ "string", "null" ] }, "childItemIds": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "condition": { "type": [ "string", "null" ] }, "data": { "type": [ "object", "null" ] }, "duty": { "format": "double", "type": "number" }, "expectedDeliveryDate": { "format": "date-time", "type": [ "string", "null" ] }, "fulfillmentFields": { "items": { "$ref": "#/$defs/FulfillmentField" }, "type": [ "array", "null" ] }, "fulfillmentLocationCode": { "type": [ "string", "null" ] }, "giftCards": { "items": { "$ref": "#/$defs/GiftCard" }, "type": [ "array", "null" ] }, "giftMessage": { "description": "Gift message for item", "type": [ "string", "null" ] }, "handling": { "description": "Total handling amount for this item, combining both product-level and order-level handling fees.\nTo get the product-level handling portion: Handling - WeightedOrderHandlingFee.", "format": "double", "type": "number" }, "handlingDiscount": { "format": "double", "type": "number" }, "handlingTax": { "description": "Total handling tax for this item, combining both product-level and order-level handling tax.\nTo get the product-level handling tax: HandlingTax - WeightedOrderHandlingFeeTax.", "format": "double", "type": "number" }, "imageUrl": { "type": [ "string", "null" ] }, "inventoryTags": { "items": { "$ref": "#/$defs/InventoryTags" }, "type": [ "array", "null" ] }, "isAssemblyRequired": { "type": [ "boolean", "null" ] }, "isGift": { "description": "Indicate item is gift or not", "type": [ "boolean", "null" ] }, "isPackagedStandAlone": { "type": [ "boolean", "null" ] }, "isReservedInventory": { "type": "boolean" }, "isSubstitutable": { "type": [ "boolean", "null" ] }, "isTaxable": { "type": "boolean" }, "itemDiscount": { "format": "double", "type": "number" }, "itemTax": { "format": "double", "type": "number" }, "lineAttributes": { "description": "Extensible attributes for this shipment line.\nNamed `LineAttributes` rather than `Attributes` because\n`Attributes` is already a System.Collections.Generic.Dictionary`2 of\nproduct attributes on Mozu.CommerceRuntime.Contracts.Fulfillment.ShipmentItem.", "items": { "$ref": "#/$defs/ShipmentLineAttribute" }, "type": [ "array", "null" ] }, "lineId": { "format": "int32", "type": "integer" }, "lineItemAdjustment": { "format": "double", "type": [ "number", "null" ] }, "lineItemCost": { "format": "double", "type": "number" }, "locatorName": { "type": [ "string", "null" ] }, "measurements": { "$ref": "#/$defs/PackageMeasurements" }, "name": { "type": [ "string", "null" ] }, "optionAttributeFQN": { "type": [ "string", "null" ] }, "options": { "items": { "$ref": "#/$defs/ProductOption" }, "type": [ "array", "null" ] }, "originalLineId": { "format": "int32", "type": [ "integer", "null" ] }, "originalOrderItemId": { "type": [ "string", "null" ] }, "originalQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "overridePrice": { "format": "double", "type": [ "number", "null" ] }, "parentId": { "type": [ "string", "null" ] }, "parentItemId": { "type": [ "string", "null" ] }, "partNumber": { "type": [ "string", "null" ] }, "priceMode": { "description": "Determines if the item is using external or internal(catalog) pricing", "type": [ "string", "null" ] }, "productCode": { "type": [ "string", "null" ] }, "purchaseLocation": { "type": [ "string", "null" ] }, "quantity": { "format": "int32", "type": "integer" }, "readyForPickupQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "returnRuleInfo": { "$ref": "#/$defs/ReturnRuleInfo" }, "serialNumber": { "type": [ "string", "null" ] }, "shipping": { "format": "double", "type": "number" }, "shippingDiscount": { "format": "double", "type": "number" }, "shippingTax": { "format": "double", "type": "number" }, "sku": { "type": [ "string", "null" ] }, "substituteInfo": { "$ref": "#/$defs/SubstituteInfo" }, "substituteQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "substitutionType": { "type": [ "string", "null" ] }, "taxData": { "type": [ "object", "null" ] }, "taxableHandling": { "format": "double", "type": "number" }, "taxableLineItemCost": { "format": "double", "type": "number" }, "taxableShipping": { "format": "double", "type": "number" }, "timeFenceDays": { "description": "Time-fence tolerance (days), carried from the originating OrderItem (Call-Off release,\nspec COM-10941 follow-up). Null for shipment items not tied to a Call-Off Order line.", "format": "int32", "type": [ "integer", "null" ] }, "unitPrice": { "format": "double", "type": "number" }, "upc": { "type": [ "string", "null" ] }, "variationProductCode": { "type": [ "string", "null" ] }, "weightedDutyAdjustment": { "format": "double", "type": "number" }, "weightedHandlingAdjustment": { "format": "double", "type": "number" }, "weightedHandlingTaxAdjustment": { "format": "double", "type": "number" }, "weightedLineItemTaxAdjustment": { "format": "double", "type": "number" }, "weightedOrderHandlingFee": { "description": "Order-level handling fee allocated to this item. This represents only the order-level portion\nof handling, not product-level handling fees. Product-level handling can be derived as:\nHandling - WeightedOrderHandlingFee.\nDuring item cancellation with Granular Retention, order-level handling is retained on active items\nwhile product-level handling scales proportionally with quantity.", "format": "double", "type": "number" }, "weightedOrderHandlingFeeDiscount": { "description": "Discount applied to the order-level handling fee only.", "format": "double", "type": "number" }, "weightedOrderHandlingFeeTax": { "description": "Tax on the order-level handling fee only (not total handling tax).\nProduct-level handling tax can be derived as: HandlingTax - WeightedOrderHandlingFeeTax.", "format": "double", "type": "number" }, "weightedShipmentAdjustment": { "format": "double", "type": "number" }, "weightedShippingAdjustment": { "format": "double", "type": "number" }, "weightedShippingTaxAdjustment": { "format": "double", "type": "number" } }, "type": "object" }, "ShipmentLineAttribute": { "description": "Attribute instance on a Shipment line item.", "properties": { "attributeDefinitionId": { "format": "int32", "type": [ "integer", "null" ] }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "fullyQualifiedName": { "type": [ "string", "null" ] }, "values": { "items": {}, "type": [ "array", "null" ] } }, "type": "object" }, "ShipmentNote": { "properties": { "attributes": { "additionalProperties": { "nullable": true }, "type": [ "object", "null" ] }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "noteId": { "type": [ "string", "null" ] }, "noteText": { "type": [ "string", "null" ] }, "role": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] } }, "type": "object" }, "ShipmentStatusReason": { "properties": { "moreInfo": { "type": [ "string", "null" ] }, "reasonCode": { "type": [ "string", "null" ] } }, "type": "object" }, "ShippingDiscount": { "description": "Value of the shipping discount.", "properties": { "discount": { "$ref": "#/$defs/AppliedDiscount" }, "methodCode": { "description": "Unique identifier of the shipping method discount.", "type": [ "string", "null" ] } }, "type": "object" }, "ShippingGrouping": { "properties": { "fulfillmentLocationCode": { "description": "The Fulfillment location used by items in this grouping.", "type": [ "string", "null" ] }, "fulfillmentMethod": { "description": "The FulfillmentMethod used by items in this grouping.", "type": [ "string", "null" ] }, "handlingAmount": { "description": "Group level order handling fees.", "format": "double", "type": [ "number", "null" ] }, "handlingDiscounts": { "items": { "$ref": "#/$defs/AppliedDiscount" }, "type": [ "array", "null" ] }, "handlingTax": { "description": "Group level order handling taxes.", "format": "double", "type": [ "number", "null" ] }, "handlingTaxTotal": { "description": "The total handling tax for this group, accounting for both group-level and item-level handling tax.", "format": "double", "type": "number" }, "handlingTotal": { "description": "The total handling cost for this group, accounting for discounts and tax.", "format": "double", "type": "number" }, "id": { "description": "A unique identifier for this grouping.", "type": [ "string", "null" ] }, "orderItemIds": { "description": "Identifiers of the items that make up this grouping.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "shippingDiscounts": { "items": { "$ref": "#/$defs/ShippingDiscount" }, "type": [ "array", "null" ] }, "shippingMethodCode": { "description": "Code that uniquely identifies the shipping method such as \"Ground,\" \"Overnight\".", "type": [ "string", "null" ] }, "shippingMethodName": { "description": "Readable name of the shipping method.", "type": [ "string", "null" ] }, "shippingTaxTotal": { "description": "The total shipping tax for this group, accounting for both group-level and item-level shipping tax.", "format": "double", "type": "number" }, "shippingTotal": { "description": "The total shipping cost for this group, accounting for discounts and tax.", "format": "double", "type": "number" } }, "type": "object" }, "ShopperNotes": { "description": "Notes that the shopper has added to this order, for example, a gift message or other comments.", "properties": { "comments": { "description": "Comments associated with this order.", "type": [ "string", "null" ] }, "deliveryInstructions": { "description": "DeliveryInstructions associated with this order.", "type": [ "string", "null" ] }, "giftMessage": { "description": "Gift message associated with this order.", "type": [ "string", "null" ] } }, "type": "object" }, "SubPayment": { "properties": { "amountCollected": { "format": "double", "nullable": false, "type": "number" }, "amountCredited": { "format": "double", "nullable": false, "type": "number" }, "amountRefunded": { "format": "double", "nullable": false, "type": "number" }, "amountRequested": { "format": "double", "nullable": false, "type": "number" }, "status": { "type": [ "string", "null" ] }, "target": { "$ref": "#/$defs/PaymentActionTarget" } }, "type": "object" }, "SubscriptionInfo": { "properties": { "frequency": { "$ref": "#/$defs/Frequency" }, "required": { "description": "Indicates commerce item is subscribed or not.", "type": [ "boolean", "null" ] }, "trial": { "$ref": "#/$defs/Trial" } }, "type": "object" }, "SubstituteInfo": { "properties": { "optIn": { "description": "Determines if and when substitution is allowed. Allowed values are `None`, `Yes`, `No`, or `OnlyAtFulfillment`. Default is `None`.", "type": [ "string", "null" ] }, "substituteProductCode": { "description": "Allows user to provide a specific product that should be substituted if substitution occurs.", "type": [ "string", "null" ] }, "substituteVariantCode": { "description": "Allows user to provide a specific variant that should be substituted if substitution occurs.", "type": [ "string", "null" ] } }, "type": "object" }, "SubstitutedItem": { "properties": { "actualPrice": { "format": "double", "type": [ "number", "null" ] }, "allocatedQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "allowsBackOrder": { "type": [ "boolean", "null" ] }, "allowsFutureAllocate": { "type": [ "boolean", "null" ] }, "allowsSubstitution": { "type": [ "boolean", "null" ] }, "appeasementReason": { "$ref": "#/$defs/FulfillmentServiceAppeasementReason" }, "attributes": { "additionalProperties": { "nullable": true }, "type": [ "object", "null" ] }, "auditInfo": { "$ref": "#/$defs/FulfillmentServiceAuditInfo" }, "autoSubstitution": { "type": [ "boolean", "null" ] }, "backorderReleaseDate": { "format": "date-time", "type": [ "string", "null" ] }, "bundleInfo": { "$ref": "#/$defs/FulfillmentServiceBundleInfo" }, "cartItemId": { "type": [ "string", "null" ] }, "childItemIds": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "condition": { "type": [ "string", "null" ] }, "creditCurrencyCode": { "type": [ "string", "null" ] }, "creditValue": { "format": "double", "type": [ "number", "null" ] }, "data": { "additionalProperties": { "nullable": true }, "type": [ "object", "null" ] }, "duty": { "format": "double", "type": [ "number", "null" ] }, "expectedDeliveryDate": { "format": "date-time", "type": [ "string", "null" ] }, "fulfillmentFields": { "items": { "$ref": "#/$defs/FulfillmentServiceFulfillmentField" }, "type": [ "array", "null" ] }, "giftCards": { "items": { "$ref": "#/$defs/FulfillmentServiceGiftCard" }, "type": [ "array", "null" ] }, "giftMessage": { "type": [ "string", "null" ] }, "goodsType": { "type": [ "string", "null" ] }, "handling": { "format": "double", "type": [ "number", "null" ] }, "handlingDiscount": { "format": "double", "type": [ "number", "null" ] }, "handlingTax": { "format": "double", "type": [ "number", "null" ] }, "height": { "format": "double", "type": [ "number", "null" ] }, "imageUrl": { "type": [ "string", "null" ] }, "inventoryAllocations": { "items": { "$ref": "#/$defs/FulfillmentServiceInventoryAllocation" }, "type": [ "array", "null" ] }, "inventoryTags": { "items": { "$ref": "#/$defs/FulfillmentServiceInventoryTag" }, "type": [ "array", "null" ] }, "isAssemblyRequired": { "type": [ "boolean", "null" ] }, "isGift": { "type": [ "boolean", "null" ] }, "isPackagedStandAlone": { "type": [ "boolean", "null" ] }, "isReservedInventory": { "type": [ "boolean", "null" ] }, "isTaxable": { "type": [ "boolean", "null" ] }, "itemDiscount": { "format": "double", "type": [ "number", "null" ] }, "itemTax": { "format": "double", "type": [ "number", "null" ] }, "length": { "format": "double", "type": [ "number", "null" ] }, "lineId": { "format": "int32", "type": [ "integer", "null" ] }, "lineItemAdjustment": { "format": "double", "type": [ "number", "null" ] }, "lineItemCost": { "format": "double", "type": [ "number", "null" ] }, "locatorName": { "type": [ "string", "null" ] }, "manageStock": { "type": [ "boolean", "null" ] }, "name": { "type": [ "string", "null" ] }, "optionAttributeFQN": { "type": [ "string", "null" ] }, "options": { "items": { "$ref": "#/$defs/FulfillmentServiceProductOption" }, "type": [ "array", "null" ] }, "originalLineId": { "format": "int32", "type": [ "integer", "null" ] }, "originalOrderItemId": { "type": [ "string", "null" ] }, "originalQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "overridePrice": { "format": "double", "type": [ "number", "null" ] }, "parentItemId": { "type": [ "string", "null" ] }, "partNumber": { "type": [ "string", "null" ] }, "priceMode": { "type": [ "string", "null" ] }, "productCode": { "type": [ "string", "null" ] }, "purchaseLocation": { "type": [ "string", "null" ] }, "quantity": { "format": "int32", "type": [ "integer", "null" ] }, "readyForPickupQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "returnRuleInfo": { "$ref": "#/$defs/FulfillmentServiceReturnRuleInfo" }, "serialNumber": { "type": [ "string", "null" ] }, "shipmentItemAttributes": { "items": { "$ref": "#/$defs/FulfillmentServiceShipmentItemAttribute" }, "type": [ "array", "null" ] }, "shipping": { "format": "double", "type": [ "number", "null" ] }, "shippingDiscount": { "format": "double", "type": [ "number", "null" ] }, "shippingTax": { "format": "double", "type": [ "number", "null" ] }, "sku": { "type": [ "string", "null" ] }, "stockValidationStatus": { "type": [ "string", "null" ] }, "substituteInfo": { "$ref": "#/$defs/FulfillmentServiceSubstituteInfo" }, "substituteItemLineIds": { "items": { "format": "int32", "type": "integer" }, "type": [ "array", "null" ] }, "substituteQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "substituteReason": { "$ref": "#/$defs/FulfillmentServiceSubstituteReason" }, "substitutionType": { "type": [ "string", "null" ] }, "taxData": { "nullable": true }, "taxableHandling": { "format": "double", "type": [ "number", "null" ] }, "taxableLineItemCost": { "format": "double", "type": [ "number", "null" ] }, "taxableShipping": { "format": "double", "type": [ "number", "null" ] }, "timeFenceDays": { "format": "int32", "type": [ "integer", "null" ] }, "transferQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "trueTransferQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "unitPrice": { "format": "double", "type": [ "number", "null" ] }, "upc": { "type": [ "string", "null" ] }, "validatedQuantity": { "format": "int32", "type": [ "integer", "null" ] }, "variationProductCode": { "type": [ "string", "null" ] }, "weight": { "format": "double", "type": [ "number", "null" ] }, "weightUnit": { "type": [ "string", "null" ] }, "weightedDutyAdjustment": { "format": "double", "type": [ "number", "null" ] }, "weightedHandlingAdjustment": { "format": "double", "type": [ "number", "null" ] }, "weightedHandlingTaxAdjustment": { "format": "double", "type": [ "number", "null" ] }, "weightedLineItemTaxAdjustment": { "format": "double", "type": [ "number", "null" ] }, "weightedOrderHandlingFee": { "format": "double", "type": [ "number", "null" ] }, "weightedOrderHandlingFeeDiscount": { "format": "double", "type": [ "number", "null" ] }, "weightedOrderHandlingFeeTax": { "format": "double", "type": [ "number", "null" ] }, "weightedShipmentAdjustment": { "format": "double", "type": [ "number", "null" ] }, "weightedShippingAdjustment": { "format": "double", "type": [ "number", "null" ] }, "weightedShippingTaxAdjustment": { "format": "double", "type": [ "number", "null" ] }, "width": { "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "SuggestedDiscount": { "properties": { "autoAdd": { "nullable": false, "type": "boolean" }, "discountId": { "format": "int32", "nullable": false, "type": "integer" }, "hasMultipleProducts": { "nullable": false, "type": "boolean" }, "hasOptions": { "nullable": false, "type": "boolean" }, "productCode": { "type": [ "string", "null" ] } }, "type": "object" }, "Suggestion": { "properties": { "futureDate": { "description": "Used for future inventory suggestions.", "format": "date-time", "type": [ "string", "null" ] }, "locationCode": { "description": "Location Code", "type": [ "string", "null" ] }, "productCode": { "description": "Unique identifier for the product.", "type": [ "string", "null" ] }, "quantity": { "description": "Quantity", "format": "int32", "nullable": false, "type": "integer" }, "suggestionType": { "description": "Indicate whether suggestion is Transfer or Future.", "type": [ "string", "null" ] }, "transferToLocationCode": { "description": "Used in STH Consolidation, to indicate consolidation location on Transfer suggestion.", "type": [ "string", "null" ] } }, "type": "object" }, "TaskInput": { "properties": { "helpMessage": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "maxLength": { "format": "int32", "type": [ "integer", "null" ] }, "maximum": { "format": "double", "type": "number" }, "minLength": { "format": "int32", "type": [ "integer", "null" ] }, "minimum": { "format": "double", "type": "number" }, "name": { "type": [ "string", "null" ] }, "options": { "items": {}, "type": [ "array", "null" ] }, "pattern": { "type": [ "string", "null" ] }, "required": { "type": [ "boolean", "null" ] }, "type": { "type": [ "string", "null" ] } }, "type": "object" }, "ThresholdMessage": { "properties": { "discountId": { "format": "int32", "type": "integer" }, "message": { "type": [ "string", "null" ] }, "requiresCouponCode": { "type": "boolean" }, "showInCart": { "type": "boolean" }, "showOnCheckout": { "type": "boolean" }, "thresholdValue": { "format": "double", "type": "number" } }, "type": "object" }, "Tracking": { "properties": { "attributes": { "additionalProperties": { "nullable": true }, "type": [ "object", "null" ] }, "number": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "type": "object" }, "Trial": { "properties": { "duration": { "description": "Trial duration in days", "format": "int32", "nullable": false, "type": "integer" }, "enabled": { "description": "Indicates if the trial is enabled", "nullable": false, "type": "boolean" }, "substituteProductCode": { "description": "Product code to substitute once the trial period is finished.", "type": [ "string", "null" ] }, "substituteProductOptions": { "description": "Configurable Options to substitute once the trial period is finished.", "items": { "$ref": "#/$defs/ProductOption" }, "type": [ "array", "null" ] }, "substituteProductQuantity": { "description": "Product quantity to substitute once the trail period is finished.", "format": "int32", "nullable": false, "type": "integer" }, "substituteVariationProductCode": { "description": "Variation product code to substitute once the trail period is finished.", "type": [ "string", "null" ] } }, "type": "object" }, "WorkflowState": { "properties": { "attributes": { "additionalProperties": { "nullable": true }, "type": [ "object", "null" ] }, "auditInfo": { "$ref": "#/$defs/CoreApiContractsAuditInfo" }, "completedDate": { "format": "date-time", "type": [ "string", "null" ] }, "processInstanceId": { "type": [ "string", "null" ] }, "shipmentState": { "type": [ "string", "null" ] }, "taskList": { "items": { "$ref": "#/$defs/FulfillmentTask" }, "type": [ "array", "null" ] } }, "type": "object" } } }