--- title: "Perform Payment Action" method: POST path: "/commerce/checkouts/{checkoutId}/payments/{paymentId}/actions" tags: ["Checkout"] --- # Perform Payment Action `POST /commerce/checkouts/{checkoutId}/payments/{paymentId}/actions` Sets the action of the specified payment transaction interaction. Available actions depend on the current status of the payment transaction. \r\nIf in doubt, get a list of available payment actions first. Note that for order management-only systems that use No-Operation payment gateways, such as due to the payments being processed by an external storefront or service instead of UCP, these actions will not actually be performed by UCP and instead will be automatically marked as a success. ## Path parameters - `checkoutId` string, required - `paymentId` string, required ## Query parameters - `responseFields` string ## Request body - PaymentAction - `actionName` string, nullable — Name of the Action to post - `amount` number, double, nullable — Amount of funds to withdraw to pay for this order. - `cancelUrl` string, nullable — If paying by Paypal Express or some other potential non-gateway payment provider, a cancel redirect URL must be provided. This will be used if something goes wrong on the third-party side. - `checkNumber` string, nullable — If paying by check, the check number. - `currencyCode` string, nullable — ISO currency code for the transaction. Currently, only USD is supported. - `data` object, nullable — Custom data from payment providers - `externalTransactionId` string, nullable - `installmentPlanCode` string, nullable — Stores the Installment Plan code. Installment is only supported on subscription orders - `interactionDate` string, date-time, nullable — Date the interaction occurred - `manualGatewayInteraction` PaymentGatewayInteraction — Represents a manually entered payment gateway interaction. - `gatewayAVSCodes` string, nullable — Not populated by incoming request. - `gatewayAuthCode` string, nullable — Gateway Transaction Id from PCIaaS. Not populated by incoming request. - `gatewayCVV2Codes` string, nullable — Not populated by incoming request. - `gatewayInteractionId` integer, nullable — Gateway Transaction Id from PCIaaS. Not populated by incoming request. - `gatewayResponseCode` string, nullable — Not populated by incoming request. - `gatewayResponseText` string, nullable — Gateway response text. Supplied by PCIaaS. - `gatewayTransactionId` string, nullable — Gateway Transaction Id from PCIaaS. Not populated by incoming request. - `isOrderRefund` boolean — Indicates the manual interaction is for a refund on an order. - `newBillingInfo` CommerceRuntimeBillingInfo — Customer's payment details such as payment type (credit card, check by mail, or PayPal) and cardholder information if payment is by credit card. - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `billingContact` CommerceRuntimeContact - `address` CommerceRuntimeAddress - `address1` string, nullable - `address2` string, nullable - `address3` string, nullable - `address4` string, nullable - `addressType` string, nullable - `cityOrTown` string, nullable - `countryCode` string, nullable - `isValidated` boolean, nullable - `postalOrZipCode` string, nullable - `stateOrProvince` string, nullable - `companyOrOrganization` string, nullable - `email` string, email, nullable - `firstName` string, nullable - `id` integer, nullable - `lastNameOrSurname` string, nullable - `middleNameOrInitial` string, nullable - `phoneNumbers` CommerceRuntimePhone - `home` string, nullable - `mobile` string, nullable - `work` string, nullable - `card` PaymentCard — If the customer is paying by credit card, the card holder's details, such as the name on the card, number, billing address, and expiration dates. - `bin` string, nullable — Year when the card expires. - `cardNumberPartOrMask` string, nullable — The visible part of the card number that the merchant uses to refer to payment information, for example, the last for digits of the card number. - `ccLastFour` string, nullable — Last four digit of Credit card Only for OMS Only tenant. - `expireMonth` integer — Month when the card expires. - `expireYear` integer — Year when the card expires. - `isCardInfoSaved` boolean — If true, the card information is stored in the customer's account. - `isTokenized` boolean — If true, the card is tokenized by external provider - `isUsedRecurring` boolean, nullable — If true, the credit card is charged on a regular interval, such as for a subscription. (Not supported currently.) - `nameOnCard` string, nullable — Card holder's name as it appears on the card. - `paymentOrCardType` string, nullable — Card type such as Visa, MasterCard, American Express, or Discover. - `paymentServiceCardId` string, nullable — Credit card number. - `check` CheckPayment - `checkNumber` string, nullable - `customCreditType` string, nullable — Name of custom stored credit type - `data` object, nullable — Custom data from payment providers - `externalTransactionId` string, nullable — Transaction Id from third party payment source like Visa Checkout, Amazon - `isRecurring` boolean — Indicates whether the payment is used in recurring transactions. ex- subscription payments - `isSameBillingShippingAddress` boolean — Indicates that billing and shipping address are the same - `paymentType` string, nullable — Type of payment, such as credit card, check by mail, or PayPal. see Mozu.CommerceRuntime.Contracts.Payments.PaymentTypeConst for valid values - `paymentWorkflow` string, nullable - `purchaseOrder` PurchaseOrderPayment — Purchase order payment - `customFields` CommerceRuntimePurchaseOrderCustomField[], nullable — Memo/custom fields - `code` string, nullable - `label` string, nullable - `value` string, nullable - `paymentTerm` CommerceRuntimePurchaseOrderPaymentTerm - `code` string, nullable - `description` string, nullable - `purchaseOrderNumber` string, nullable — Purchase order number - `recurringTransactionId` string, nullable — Recurring Payment Id returned by Payment Gateway networkTransactionId for vantiv previousTransactionId for cybersource etc - `storeCreditCode` string, nullable — The store credit to use for this purchase - `storeCreditType` string, nullable — The type of store credit used for this purchase - `token` PaymentToken - `paymentServiceTokenId` string, nullable - `type` string, nullable - `recaptcha` string, nullable — Recaptcha for validation. - `referenceSourcePaymentId` string, nullable — Reference payment id from which to copy the billing info. - `returnUrl` string, nullable — If paying by Paypal Express or some other potential non-gateway payment provider, a return redirect URL must be provided. ## Response `200` OK - Checkout - `acceptsMarketing` boolean, nullable — Does the customer accept marketing - `alternateContact` AlternateContact - `emailAddress` string, email — Email Address of alternate contact during order process - `firstName` string — First Name of alternate contact during order process - `lastNameOrSurname` string — Last Name of alternate contact during order process - `phoneNumber` string, nullable — Phone Number of alternate contact during order process - `amountRemainingForPayment` number, double — A counter for how much of the total has not been claimed by payments. This is computed by Total - (sum of Payments where State is not Voided/Declined) - `attributes` CommerceRuntimeOrderAttribute[], nullable - `attributeDefinitionId` integer, nullable - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `fullyQualifiedName` string, nullable - `values` unknown[], nullable - unknown - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `availableActions` string[], nullable - `channelCode` string, nullable — Unique identifier of the channel for this item. - `couponCodes` string[], nullable — Coupon codes associated with this order. - `currencyCode` string, nullable — ISO Currency Code. - `customerAccountId` integer, nullable — Unique identifier of the customer account. - `customerInteractionType` string, nullable — Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown - `customerTaxId` string, nullable — The customers tax ID. If Customer Account ID exists in the system, will set this. - `data` object, nullable — Custom data for a given vendor set within the commerce process. - `destinations` CommerceRuntimeDestination[], nullable - `data` object, nullable — Custom data - `destinationContact` CommerceRuntimeContact - `address` CommerceRuntimeAddress - `address1` string, nullable - `address2` string, nullable - `address3` string, nullable - `address4` string, nullable - `addressType` string, nullable - `cityOrTown` string, nullable - `countryCode` string, nullable - `isValidated` boolean, nullable - `postalOrZipCode` string, nullable - `stateOrProvince` string, nullable - `companyOrOrganization` string, nullable - `email` string, email, nullable - `firstName` string, nullable - `id` integer, nullable - `lastNameOrSurname` string, nullable - `middleNameOrInitial` string, nullable - `phoneNumbers` CommerceRuntimePhone - `home` string, nullable - `mobile` string, nullable - `work` string, nullable - `id` string, nullable — An identifier for this entry. - `isDestinationCommercial` boolean, nullable — Indicates that the destination is commercial - `discountThresholdMessages` CommerceRuntimeThresholdMessage[], nullable — List of Mozu.CommerceRuntime.Contracts.Commerce.ThresholdMessage objects that are valid for the current value of the cart/order. - `discountId` integer - `message` string, nullable - `requiresCouponCode` boolean - `showInCart` boolean - `showOnCheckout` boolean - `thresholdValue` number, double - `dutyTotal` number, double, nullable — Total duty fees - `email` string, nullable — Email address for checkout - `feeTotal` number, double — Total Fees - `groupings` CheckoutGrouping[], nullable — List of checkout grouping. - `destinationId` string, nullable — The DestinationId used by items in this grouping, which may be `null`. - `dutyAmount` number, double, nullable — Any duty fee applied directly to this group. Items can also have their own duty fee. - `dutyTotal` number, double — Total raw duty amounts for this group. - `fulfillmentMethod` string, nullable — The FulfillmentMethod used by items in this grouping. - `handlingAmount` number, double, nullable — The handling fee amount that's applicable to this grouping. - `handlingDiscounts` CommerceRuntimeAppliedDiscount[], nullable - `couponCode` string, nullable — Code of the coupon associated with the discount if a coupon code is required to get the discount. - `data` object, nullable — Stores any custom data sent from external discounts. - `discount` CommerceRuntimeDiscount — Discounts that apply to the order, if any. For example, when the subtotal of the order exceeds a certain amount, or for free shipping. - `expirationDate` string, date-time, nullable — Date when the discount expires. Default is null (no expiration date). - `hasMultipleTargetProducts` boolean — Indicates that the discount targets more than a product. Used primarily for BoGa discounts with multiple targets. - `id` integer — Unique identifier of the discount. - `itemIds` string[], nullable — List of discounts for each order item. - `name` string, nullable — Name of the discount in the language specified by LocaleCode. - `excluded` boolean, nullable — Determines whether or not this discount is set up to be ignored by the pricing runtime. - `groupId` string, nullable — Group identifier for the discount. - `impact` number, double, nullable — Value of the discount applied. This is a negative number to be subtracted from the original price to get the final price. - `handlingSubTotal` number, double — The total raw handling amounts minus handling discounts. - `handlingTax` number, double, nullable — Group-level handling tax. Does not account for item handling tax. - `handlingTaxTotal` number, double — The total handling tax for this group, accounting for both group-level and item-level handling tax. - `handlingTotal` number, double — The total handling cost for this group, accounting for discounts and tax. - `id` string, nullable — A unique identifier for this grouping. - `itemLevelHandlingDiscountTotal` number, double — The total value of item-level handling discounts applied to this group. - `itemLevelShippingDiscountTotal` number, double — The total value of item-level shipping discounts applied to this group. - `orderItemIds` string[], nullable — Identifiers of the items that make up this grouping. - `orderLevelHandlingDiscountTotal` number, double — The total value of order-level (group-level) handling discounts applied to this group. - `orderLevelShippingDiscountTotal` number, double — The total value of order-level (group-level) shipping discounts applied to this group. - `shippingAmount` number, double, nullable — If a shipping method applies directly to this grouping (versus the items), this is the raw shipping amount for the group. - `shippingDiscounts` ShippingDiscount[], nullable - `discount` CommerceRuntimeAppliedDiscount — Discount applied to the order, which is a negative number to be subtracted from the original price to get the final price. If multiple discounts for the order exist, this is the value most advantageous to the shopper. - `couponCode` string, nullable — Code of the coupon associated with the discount if a coupon code is required to get the discount. - `data` object, nullable — Stores any custom data sent from external discounts. - `discount` CommerceRuntimeDiscount — Discounts that apply to the order, if any. For example, when the subtotal of the order exceeds a certain amount, or for free shipping. - `expirationDate` string, date-time, nullable — Date when the discount expires. Default is null (no expiration date). - `hasMultipleTargetProducts` boolean — Indicates that the discount targets more than a product. Used primarily for BoGa discounts with multiple targets. - `id` integer — Unique identifier of the discount. - `itemIds` string[], nullable — List of discounts for each order item. - `name` string, nullable — Name of the discount in the language specified by LocaleCode. - `excluded` boolean, nullable — Determines whether or not this discount is set up to be ignored by the pricing runtime. - `groupId` string, nullable — Group identifier for the discount. - `impact` number, double, nullable — Value of the discount applied. This is a negative number to be subtracted from the original price to get the final price. - `methodCode` string, nullable — Unique identifier of the shipping method discount. - `shippingMethodCode` string, nullable — Code that uniquely identifies the shipping method such as "Ground," "Overnight," or "Digital." The site's shipping settings lists the valid shipping methods specified for this site. - `shippingMethodName` string, nullable — Readable name of the shipping method. - `shippingSubTotal` number, double — The raw shipping amount minus shipping discounts. - `shippingTax` number, double, nullable — Group-level shipping tax. Does not account for item shipping tax. - `shippingTaxTotal` number, double — The total shipping tax for this group, accounting for both group-level and item-level shipping tax. - `shippingTotal` number, double — The total shipping cost for this group, accounting for discounts and tax. - `standaloneGroup` boolean — Indicates whether a non ship group should combine with a ship group - `taxData` object, nullable - `handlingSubTotal` number, double — Pre-Discounted Handling Subtotal of the CommerceAggregate and its Items. Returns `null` if the calculated value is negative. - `handlingTaxTotal` number, double — Total tax on handling. - `handlingTotal` number, double — Overall handling total, accounting for line and order-level handling costs, any handling discounts, and handling tax. - `id` string, nullable — Unique identifier. - `invalidCoupons` InvalidCoupon[], nullable — A list of invalid coupons that were attempted on the order. - `couponCode` string, nullable — Code that identifies the coupon. - `createDate` string, date-time — Create date of the invalid coupon. - `discountId` integer - `reason` string, nullable — Description text of the reason. - `reasonCode` integer — Code that identifies the reason the coupon was invalid. - `ipAddress` string, nullable — IP address of the user placing the order. (User or customer?) - `isTaxExempt` boolean, nullable — Unique identifier of the customer account. - `itemLevelHandlingDiscountTotal` number, double — The total value of item-level handling discounts. - `itemLevelProductDiscountTotal` number, double — The total value of item-level product discounts. - `itemLevelShippingDiscountTotal` number, double — The total value of item-level shipping discounts. - `itemTaxTotal` number, double — Total tax on products. - `itemTotal` number, double — The total product cost, accounting for discounts and tax. - `items` CommerceRuntimeOrderItem[], nullable — List of items in the checkout. - `adjustedLineItemSubtotal` number, double, nullable — Order Level taxable sub total - `attributes` OrderLineAttribute[], nullable — Extensible attributes for this order line. - `attributeDefinitionId` integer, nullable - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `fullyQualifiedName` string, nullable - `values` unknown[], nullable - unknown - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `autoAddDiscountId` integer, nullable — Track the discoutid from which the item was auto added - `callOffOrderItemId` string, nullable — Identifier of the originating Call-Off Order line item, if this item was released from a Call-Off Order line. Null for standard order items. - `childItemIds` string[], nullable — List of Child Item Ids for this order item - `data` object, nullable — Custom data for a given vendor set within the commerce process. - `deliveryWindow` CommerceRuntimeDeliveryWindow - `endTime` string, date-time — End time for delivery window. - `startTime` string, date-time — Start time for delivery window. - `destinationId` string, nullable — The destination associated with this item when used with a multi-ship checkout. - `discountTotal` number, double, nullable — How much the shopper saves with the applied discount or sale price. This is a negative number. - `discountedTotal` number, double, nullable — Subtotal minus any discounts. - `dutyAmount` number, double, nullable — Duty or Tariff for this item - `expectedDeliveryDate` string, date-time, nullable — Expected Delivery Date of shipment - `extendedTotal` number, double, nullable — Line item extended total (quantity multiplied by unit extended price) before discounts. - `feeTotal` number, double, nullable — Not implemented. Total cost of fees that apply to this item. - `fulfillmentLocationCode` string, nullable — Location code from which to obtain this item - `fulfillmentMethod` string, nullable — Fulfillment method used to fulfill this item - `giftInfo` GiftInfo - `giftMessage` string, nullable — Item level gift message - `isGiftItem` boolean, nullable — Flag to indicate whether the item is a gift item - `handlingAmount` number, double, nullable — Product-level handling fee for this item (e.g. special packaging, hazmat fees). This does NOT include order-level handling fees — those are in Mozu.CommerceRuntime.Contracts.Commerce.CommerceItem.WeightedOrderHandlingFee. Total handling on the shipment = HandlingAmount + WeightedOrderHandlingFee. - `id` string, nullable — Unique identifier of the order line item. System-supplied and read-only. - `inventoryTags` InventoryTags[], nullable - `name` string, nullable - `value` string, nullable - `isAssemblyRequired` boolean — Assembly Required for this order item - `isRecurring` boolean, nullable — If true, the cart item lists a product that can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription. - `isReservationEnabled` boolean — Flag to indicate reserve inventory in cart - `isTaxable` boolean, nullable — Not implemented. If true, the cart item is eligible for tax. - `itemTaxTotal` number, double, nullable — Total price of taxes that apply to products in this item. - `lineId` integer, nullable — The line id assigned to the order item. Visible only in the Admin, this is set from the Admin or in CommerceRuntime when a cart is converted to an order. - `lineItemAdjustment` number, double, nullable - `localeCode` string, nullable — Locale code for language that appears in text and descriptions on the site, for example, en_US. This is not the currency code. Currently only en_US is supported. - `originalCartItemId` string, nullable — Unique identifier of the cart item that is associated with this line item. (This is the original Cart Item ID expressed as a GUID.) - `parentItemId` string, nullable — Indicates Parent Item Id for this order item - `priceMode` string, nullable — Determines if the item is using external or internal(catalog) pricing - `product` CommerceRuntimeProduct — The product as it appears on the order item. - `allocationExpiration` string, date-time, nullable — Allocation ID associated with this product on this order. - `allocationId` integer, nullable — Allocation ID associated with this product on this order. - `bundledProducts` CommerceRuntimeBundledProduct[], nullable — Products bundled with this product (if the current product is a bundle) - `allocationExpiration` string, date-time, nullable — Allocation ID associated with this product on this order. - `allocationId` integer, nullable — Allocation ID associated with this product on this order. - `creditValue` number, double, nullable — Credit value. Only populated if the bundled product is a gift card or digital credit - `deltaPrice` number, double, nullable — Only populated for extras - `description` string, nullable — Short description of the product in the language specified by LocaleCode. - `fulfillmentStatus` string, nullable — Fulfillment status of the product. - `goodsType` string, nullable — Goods Type - `imageUrl` string, nullable — ImageUrl of product - `isPackagedStandAlone` boolean — Indicates that this product ships by itself. - `measurements` CommerceRuntimePackageMeasurements — Physical dimensions of the package required to ship the product and its weight. - `height` CommerceRuntimeMeasurement - `unit` string, nullable - `value` number, double, nullable - `length` CommerceRuntimeMeasurement - `unit` string, nullable - `value` number, double, nullable - `weight` CommerceRuntimeMeasurement - `unit` string, nullable - `value` number, double, nullable - `width` CommerceRuntimeMeasurement - `unit` string, nullable - `value` number, double, nullable - `name` string, nullable — Name of the product, this is the current value of the product's name in the language specified by LocaleCode. - `optionAttributeFQN` string, nullable — Fully Qualified Name of the selected option's attribute - `optionValue` unknown - `productCode` string, nullable — Merchant-created code that uniquely identifies the product. - `productReservationId` integer, nullable — Reservation ID associated with this product in the bundle. - `quantity` integer — Quantity of the product included in the bundle. - `stock` ProductStock - `aggregateInventory` integer, nullable - `availableDate` string, date-time, nullable - `availableFutureInventories` integer - `futureInventories` CommerceRuntimeFutureInventory[], nullable - `allocated` integer, nullable - `available` integer, nullable - `createDate` string, date-time, nullable - `deliveryDate` string, date-time, nullable - `futureInventoryID` integer, nullable - `onhand` integer, nullable - `pending` integer, nullable - `isOnBackOrder` boolean - `isSubstitutable` boolean, nullable - `manageStock` boolean - `stockAvailable` integer, nullable - `totalAvailableStock` integer - `categories` CommerceRuntimeCategory[], nullable — Categories to which this product belongs. - `id` integer, nullable — Unique identifier of the category. System-supplied and read-only. - `parent` object - `condition` string, nullable — Condition - `description` string, nullable — Short description of the product in the language specified by LocaleCode. - `discountsRestricted` boolean, nullable — Is the product discount restricted - `discountsRestrictedEndDate` string, date-time, nullable — Product discount restriction end date - `discountsRestrictedStartDate` string, date-time, nullable — Product discount restriction start date - `fulfillmentFields` CommerceRuntimeFulfillmentField[], nullable — List of unique product identifiers for an item on shipment - `name` string, nullable - `required` boolean - `userEnteredValue` unknown - `fulfillmentStatus` string, nullable — Fulfillment status of the product. - `fulfillmentTypesSupported` string[], nullable — Types of fulfillment that are supported for this product. - `goodsType` string, nullable — Goods Type - `imageAlternateText` string, nullable — Descriptive text of the image associated with the product in the language specified by LocaleCode. - `imageUrl` string, nullable — URL of the image that appears next to the product on the order item. Optional. - `isPackagedStandAlone` boolean — Indicates that this product ships by itself. - `isRecurring` boolean, nullable — If true, the product is purchased or fulfilled at regular intervals, for example, a monthly billing or a subscription. - `isTaxable` boolean, nullable — If true, the product is eligible for tax. - `measurements` CommerceRuntimePackageMeasurements — Physical dimensions of the package required to ship the product and its weight. - `height` CommerceRuntimeMeasurement - `unit` string, nullable - `value` number, double, nullable - `length` CommerceRuntimeMeasurement - `unit` string, nullable - `value` number, double, nullable - `weight` CommerceRuntimeMeasurement - `unit` string, nullable - `value` number, double, nullable - `width` CommerceRuntimeMeasurement - `unit` string, nullable - `value` number, double, nullable - `mfgPartNumber` string, nullable — Manufacturing Part Number of the product. - `name` string, nullable — Name of the product, this is the current value of the product's name in the language specified by LocaleCode. - `options` CommerceRuntimeProductOption[], nullable — If the product contains configurable or stand-alone options, the list of product options that the shopper selected for this product. - `attributeFQN` string, nullable — Value of the product option. - `dataType` string, nullable — Value of the product option. - `name` string, nullable — Name of the product option that appears with the order item in the language specified by LocaleCode. - `shopperEnteredValue` unknown - `stringValue` string, nullable — Value of the product option. - `value` unknown - `price` CommerceRuntimeProductPrice — Price of the product with any sale and discounts applied. - `creditValue` number, double, nullable — Credit Value when the product happens to be a gift card or similar product - `isOverRidePriceSalePrice` boolean, nullable — Indicate that External Price (TenantOverridePrice) is a Sale Price. And is used to calculate the line item discounts. - `msrp` number, double, nullable — MSRP of product. - `price` number, double, nullable — Price of the product. This is the price that the merchant intends to sell the product if no sale price is present. - `priceListCode` string, nullable — Pricelist code for the product - `priceListEntryMode` string, nullable — Pricelist entry mode of the product. Note: possible values are below 1. null : Product doesn't participate in pricelist 2. Bulk : Bulk volume price available(unit price vary based on quantity) 3. Simple: - `salePrice` number, double, nullable — Current sale price of the product, which is a specific numerical amount (not a percentage off). - `tenantOverridePrice` number, double, nullable — An override price applied on the product by the tenant. - `productCode` string, nullable — Merchant-created code that uniquely identifies the product. - `productReservationId` integer, nullable — Reservation ID associated with this product in the bundle. - `productType` string, nullable — Type of product, which can be a product with configurable options, a product with stand-alone options, or a simple product with no options. - `productUsage` string, nullable — Usage of the product, primarily used to indicate a bundle in this context - `properties` CommerceRuntimeProductProperty[], nullable — If the product contains properties, the list of properties that the shopper selected for this product. - `attributeFQN` string, nullable - `dataType` string, nullable - `isMultiValue` boolean - `name` string, nullable - `values` CommerceRuntimeProductPropertyValue[], nullable - `stringValue` string, nullable - `value` unknown - `serialNumber` string, nullable — Serial Number - `sku` string, nullable — Product Identifier specific to the store - `stock` ProductStock - `aggregateInventory` integer, nullable - `availableDate` string, date-time, nullable - `availableFutureInventories` integer - `futureInventories` CommerceRuntimeFutureInventory[], nullable - `allocated` integer, nullable - `available` integer, nullable - `createDate` string, date-time, nullable - `deliveryDate` string, date-time, nullable - `futureInventoryID` integer, nullable - `onhand` integer, nullable - `pending` integer, nullable - `isOnBackOrder` boolean - `isSubstitutable` boolean, nullable - `manageStock` boolean - `stockAvailable` integer, nullable - `totalAvailableStock` integer - `upc` string, nullable — Universal Product Code of the product. - `variationProductCode` string, nullable — For configurable products, the unique identifier of the product variation that has been selected. - `productDiscount` CommerceRuntimeAppliedLineItemProductDiscount - `appliesToSalePrice` boolean, nullable — Determines if the discount applies to the sale price of the order - `discountQuantity` integer — The number of the line item that can be used for this particular discount. - `productDiscounts` CommerceRuntimeAppliedLineItemProductDiscount[], nullable — A list of discounts applied to the product - `appliesToSalePrice` boolean, nullable — Determines if the discount applies to the sale price of the order - `discountQuantity` integer — The number of the line item that can be used for this particular discount. - `purchaseLocation` string, nullable — The location where the product is being purchased.. default is null. Products can have different prices by purchaseLocation via custom priceListResolution... - `quantity` integer — Number of products ordered. - `returnRuleInfo` ReturnRuleInfo - `isReturnable` boolean, nullable — Indicate product is returnable or not - `maxDays` integer, nullable — Return window within which an item can be returned - `maxQty` integer, nullable — Maximum quantity that can be returned - `ruleCode` string, nullable — Return rule code which is applied - `shippingAmountBeforeDiscountsAndAdjustments` number, double, nullable — Shipping amount before Discounts and adjustments - `shippingDiscounts` CommerceRuntimeAppliedLineItemShippingDiscount[], nullable — A discount applied to the shipping - `discount` CommerceRuntimeAppliedDiscount — Discount applied to the order, which is a negative number to be subtracted from the original price to get the final price. If multiple discounts for the order exist, this is the value most advantageous to the shopper. - `couponCode` string, nullable — Code of the coupon associated with the discount if a coupon code is required to get the discount. - `data` object, nullable — Stores any custom data sent from external discounts. - `discount` CommerceRuntimeDiscount — Discounts that apply to the order, if any. For example, when the subtotal of the order exceeds a certain amount, or for free shipping. - `expirationDate` string, date-time, nullable — Date when the discount expires. Default is null (no expiration date). - `hasMultipleTargetProducts` boolean — Indicates that the discount targets more than a product. Used primarily for BoGa discounts with multiple targets. - `id` integer — Unique identifier of the discount. - `itemIds` string[], nullable — List of discounts for each order item. - `name` string, nullable — Name of the discount in the language specified by LocaleCode. - `excluded` boolean, nullable — Determines whether or not this discount is set up to be ignored by the pricing runtime. - `groupId` string, nullable — Group identifier for the discount. - `impact` number, double, nullable — Value of the discount applied. This is a negative number to be subtracted from the original price to get the final price. - `discountQuantity` integer — The number of the line item that can be used for this particular discount. - `impactPerUnit` number, double — The impact of this discount pur discount quantity. - `methodCode` string, nullable — Unique identifier of the shipping method discount. - `shippingMethodCode` string, nullable — Code that uniquely identifies the shipping method. - `shippingMethodName` string, nullable — Readable name of the shipping method. - `shippingTaxTotal` number, double, nullable — Total price of taxes that apply to the shipping of this item. - `shippingTotal` number, double, nullable — Total price of shipping that apply to this item. - `subscription` SubscriptionInfo - `frequency` Frequency - `unit` string, nullable - `value` integer - `required` boolean, nullable — Indicates commerce item is subscribed or not. - `trial` Trial - `duration` integer — Trial duration in days - `enabled` boolean — Indicates if the trial is enabled - `substituteProductCode` string, nullable — Product code to substitute once the trial period is finished. - `substituteProductOptions` CommerceRuntimeProductOption[], nullable — Configurable Options to substitute once the trial period is finished. - `attributeFQN` string, nullable — Value of the product option. - `dataType` string, nullable — Value of the product option. - `name` string, nullable — Name of the product option that appears with the order item in the language specified by LocaleCode. - `shopperEnteredValue` unknown - `stringValue` string, nullable — Value of the product option. - `value` unknown - `substituteProductQuantity` integer — Product quantity to substitute once the trail period is finished. - `substituteVariationProductCode` string, nullable — Variation product code to substitute once the trail period is finished. - `substituteInfo` SubstituteInfo - `optIn` string, nullable — Determines if and when substitution is allowed. Allowed values are `None`, `Yes`, `No`, or `OnlyAtFulfillment`. Default is `None`. - `substituteProductCode` string, nullable — Allows user to provide a specific product that should be substituted if substitution occurs. - `substituteVariantCode` string, nullable — Allows user to provide a specific variant that should be substituted if substitution occurs. - `subtotal` number, double, nullable — Line item subtotal (quantity multiplied by price) before discounts. - `suggestions` Suggestion[], nullable — Routing suggestions - `futureDate` string, date-time, nullable — Used for future inventory suggestions. - `locationCode` string, nullable — Location Code - `productCode` string, nullable — Unique identifier for the product. - `quantity` integer — Quantity - `suggestionType` string, nullable — Indicate whether suggestion is Transfer or Future. - `transferToLocationCode` string, nullable — Used in STH Consolidation, to indicate consolidation location on Transfer suggestion. - `taxData` object, nullable — Storage for any additional/custom tax data. - `taxableTotal` number, double, nullable — Line item subtotal (quantity multiplied by price) before discounts. - `total` number, double, nullable — Total price of this cart item taking into account any discounts. - `totalWithWeightedShippingAndHandling` number, double, nullable — Line item total with line item, Tax, Weighted Tax with Weighted shipping and handling costs - `totalWithoutWeightedShippingAndHandling` number, double, nullable — Taxable Subtotal including Weighted Order amounts - `unitPrice` CommerceUnitPrice — Pricing details for the product listed on a cart item, including the original price, discount amount, and final price. - `extendedAmount` number, double, nullable — Extended amount, this is in order of precedence: OverrideAmount, SaleAmount, ListAmount - `listAmount` number, double, nullable — Product list amount. - `overrideAmount` number, double, nullable — Amount as manually overridden by the Merchant - `saleAmount` number, double, nullable — Sale amount indicated on the product. - `weightedOrderAdjustment` number, double, nullable — Order Level Manual Adjustment applied to this Item - `weightedOrderDiscount` number, double, nullable — Order Level Discount applied to this Item - `weightedOrderDuty` number, double, nullable — Order Level Duty applied to this Item - `weightedOrderHandlingAdjustment` number, double, nullable — Order-level handling manual adjustment allocated to this item. - `weightedOrderHandlingFee` number, double, nullable — Order-level handling fee allocated to this item (e.g. flat handling fee spread across all items). This is separate from product-level handling in Mozu.CommerceRuntime.Contracts.Commerce.CommerceItem.HandlingAmount. Total handling on the shipment = HandlingAmount + WeightedOrderHandlingFee. - `weightedOrderHandlingFeeDiscount` number, double, nullable — Order-level handling fee discount allocated to this item. - `weightedOrderHandlingFeeTax` number, double, nullable — Total handling tax for this item (covers both product-level and order-level handling tax combined). On the shipment item, this is split into: HandlingTax (total) and WeightedOrderHandlingFeeTax (order-level portion only). - `weightedOrderShipping` number, double, nullable — Order Level Shipping applied to this Item - `weightedOrderShippingDiscount` number, double, nullable — Order Level Shipping discount applied to this Item - `weightedOrderShippingManualAdjustment` number, double, nullable — Order Level Shipping Manual Adjustment applied to this Item - `weightedOrderShippingTax` number, double, nullable — Order Level Shipping Tax applied to this Item - `weightedOrderTax` number, double, nullable — Order Level tax applied to this Item - `locationCode` string, nullable — Identifies the location at which the order was placed if the order was placed externally. - `number` integer, nullable — A checkout number that is only assigned after the checkout is placed. - `orderDiscounts` CommerceRuntimeAppliedDiscount[], nullable - `couponCode` string, nullable — Code of the coupon associated with the discount if a coupon code is required to get the discount. - `data` object, nullable — Stores any custom data sent from external discounts. - `discount` CommerceRuntimeDiscount — Discounts that apply to the order, if any. For example, when the subtotal of the order exceeds a certain amount, or for free shipping. - `expirationDate` string, date-time, nullable — Date when the discount expires. Default is null (no expiration date). - `hasMultipleTargetProducts` boolean — Indicates that the discount targets more than a product. Used primarily for BoGa discounts with multiple targets. - `id` integer — Unique identifier of the discount. - `itemIds` string[], nullable — List of discounts for each order item. - `name` string, nullable — Name of the discount in the language specified by LocaleCode. - `excluded` boolean, nullable — Determines whether or not this discount is set up to be ignored by the pricing runtime. - `groupId` string, nullable — Group identifier for the discount. - `impact` number, double, nullable — Value of the discount applied. This is a negative number to be subtracted from the original price to get the final price. - `orderLevelHandlingDiscountTotal` number, double — The total value of order-level (group-level) handling discounts. - `orderLevelProductDiscountTotal` number, double — The total value of order-level (group-level) product discounts. - `orderLevelShippingDiscountTotal` number, double — The total value of order-level (group-level) shipping discounts. - `originalCartId` string, nullable — Unique identifier for the cart that was converted to checkout. - `payments` CommerceRuntimePayment[], nullable — Payment transaction associated with this checkout. It is the entire payment interchange between the merchant who is forwarding the customer's payment information and the payment service who is authorizing and capturing payment. Payment can be either by credit card, check, or PayPal. - `amountCollected` number, double — Amount collected on the payment - `amountCredited` number, double — Amount credited back to the payment. - `amountRequested` number, double — Derived from the Amount on the initial payment create, used to help storefront determine how much can be captured for multiple payments. See Order.AmountRemainingForPayment for an example. - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `availableActions` string[], nullable — Actions available to the payment - `billingInfo` CommerceRuntimeBillingInfo — Customer's payment details such as payment type (credit card, check by mail, or PayPal) and cardholder information if payment is by credit card. - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `billingContact` CommerceRuntimeContact - `address` CommerceRuntimeAddress - `address1` string, nullable - `address2` string, nullable - `address3` string, nullable - `address4` string, nullable - `addressType` string, nullable - `cityOrTown` string, nullable - `countryCode` string, nullable - `isValidated` boolean, nullable - `postalOrZipCode` string, nullable - `stateOrProvince` string, nullable - `companyOrOrganization` string, nullable - `email` string, email, nullable - `firstName` string, nullable - `id` integer, nullable - `lastNameOrSurname` string, nullable - `middleNameOrInitial` string, nullable - `phoneNumbers` CommerceRuntimePhone - `home` string, nullable - `mobile` string, nullable - `work` string, nullable - `card` PaymentCard — If the customer is paying by credit card, the card holder's details, such as the name on the card, number, billing address, and expiration dates. - `bin` string, nullable — Year when the card expires. - `cardNumberPartOrMask` string, nullable — The visible part of the card number that the merchant uses to refer to payment information, for example, the last for digits of the card number. - `ccLastFour` string, nullable — Last four digit of Credit card Only for OMS Only tenant. - `expireMonth` integer — Month when the card expires. - `expireYear` integer — Year when the card expires. - `isCardInfoSaved` boolean — If true, the card information is stored in the customer's account. - `isTokenized` boolean — If true, the card is tokenized by external provider - `isUsedRecurring` boolean, nullable — If true, the credit card is charged on a regular interval, such as for a subscription. (Not supported currently.) - `nameOnCard` string, nullable — Card holder's name as it appears on the card. - `paymentOrCardType` string, nullable — Card type such as Visa, MasterCard, American Express, or Discover. - `paymentServiceCardId` string, nullable — Credit card number. - `check` CheckPayment - `checkNumber` string, nullable - `customCreditType` string, nullable — Name of custom stored credit type - `data` object, nullable — Custom data from payment providers - `externalTransactionId` string, nullable — Transaction Id from third party payment source like Visa Checkout, Amazon - `isRecurring` boolean — Indicates whether the payment is used in recurring transactions. ex- subscription payments - `isSameBillingShippingAddress` boolean — Indicates that billing and shipping address are the same - `paymentType` string, nullable — Type of payment, such as credit card, check by mail, or PayPal. see Mozu.CommerceRuntime.Contracts.Payments.PaymentTypeConst for valid values - `paymentWorkflow` string, nullable - `purchaseOrder` PurchaseOrderPayment — Purchase order payment - `customFields` CommerceRuntimePurchaseOrderCustomField[], nullable — Memo/custom fields - `code` string, nullable - `label` string, nullable - `value` string, nullable - `paymentTerm` CommerceRuntimePurchaseOrderPaymentTerm - `code` string, nullable - `description` string, nullable - `purchaseOrderNumber` string, nullable — Purchase order number - `recurringTransactionId` string, nullable — Recurring Payment Id returned by Payment Gateway networkTransactionId for vantiv previousTransactionId for cybersource etc - `storeCreditCode` string, nullable — The store credit to use for this purchase - `storeCreditType` string, nullable — The type of store credit used for this purchase - `token` PaymentToken - `paymentServiceTokenId` string, nullable - `type` string, nullable - `changeMessages` CommerceRuntimeChangeMessage[], nullable — Change messages related to the payment. - `amount` number, double, nullable — Monetary amount that pertains to the change if applicable - `appId` string, nullable — App Id that identifies the user that performed the related change - `appKey` string, nullable — App Key - `appName` string, nullable — App Name - `attributes` object, nullable — Additional Data. This property will be a Dictionary of objects. - `correlationId` string, nullable — Correlation Id - `createDate` string, date-time, nullable — When the message was created. System-supplied. Read-only. - `id` string, nullable — Unique identifier of the message. System-supplied. Read-only. - `identifier` string, nullable — Unique identifier to what the message pertains, which can be a cart item, cart or another generic entity. System-supplied. Read-only. - `message` string, nullable — Human readable message. System-supplied. Read-only. - `metadata` unknown - `newValue` string, nullable — Current price of the item. System-supplied. Read-only. - `oldValue` string, nullable — Original price of the item. System-supplied. Read-only. - `subject` string, nullable — Text on the subject line of the message, for example, the product name. System-supplied. Read-only. - `subjectType` string, nullable — Subject of the message, for example, "Product." System-supplied. Read-only. - `success` boolean, nullable — Indicates if the message is related to a success or failure. - `userFirstName` string, nullable — User First Name - `userId` string, nullable — User Id that identifies the user that performed the related change - `userLastName` string, nullable — User Last Name - `userScopeType` string, nullable — User Type (e.g. Shopper, Admin, etc.) - `verb` string, nullable — Action applicable to the message. This can be "Increased," when the product price has increased, "Decreased," when the product price has decreased, and "Invalidated," when the product is no longer available. System-supplied. Read-only. - `data` object, nullable — Custom data from payment providers - `externalTransactionId` string, nullable — The external/third party transaction Id for this payment. This is used to store the transaction Id from digital wallet like Visa Checkout - `gatewayGiftCard` GatewayGiftCard - `amount` number, double - `cardNumber` string, nullable - `cardPin` string, nullable - `currencyCode` string, nullable - `id` string, nullable - `groupId` PaymentActionTarget - `targetId` string, nullable — The Id of the Checkout/Order/Return to target. - `targetNumber` integer, nullable — The number of the Checkout/Order/Return to target. - `targetType` string, nullable — Specifies if the Mozu.CommerceRuntime.Contracts.Payments.PaymentActionTarget.TargetId is a Checkout Id, Order Id, or Return Id. - `id` string, nullable — Unique identifier of this order transaction. - `installmentPlanCode` string, nullable — Stores the Installment Plan code. Installment is only supported on subscription orders - `interactions` CommerceRuntimePaymentInteraction[], nullable — List of intereactions for this transaction. A transaction is created upon authorization and lasts across the payment interchange, which can consist of multiple interactions, such as consecutive captures. - `amount` number, double, nullable — Amount of funds associated with this interaction. - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `capturableShipmentsSummary` CapturableShipmentSummary[], nullable — Stores pairings of shipment number to shipment total for all captured shipments. This was added for generating TLogs. - `amountApplied` number, double — The amount applied by the payment action - `shipmentNumber` integer — The identifying number of the shipment affected by the payment action - `shipmentTotal` number, double — The shipment's total when the payment action occurred - `checkNumber` string, nullable — If paying by check, the check number. - `currencyCode` string, nullable — ISO currency code for the transaction. Currently, only USD is supported. - `gatewayAVSCodes` string, nullable — Gateway AVS Codes. Supplied by PCIaaS. - `gatewayAuthCode` string, nullable — If required by the payment gateway, the authorization code of the transaction. Supplied by PCIaaS. - `gatewayCVV2Codes` string, nullable — Gateway CVV2 Codes. Supplied by PCIaaS. - `gatewayInteractionId` integer, nullable — Unique identifier of the gateway interaction. Used for credit card transactions, where the payment service creates a GatewayInteractionId for each transaction interaction. - `gatewayResponseCode` string, nullable — Gateway response code. Supplied by PCIaaS. - `gatewayResponseData` PaymentGatewayResponseData[], nullable — A List of payment response data required to act on authorization when using external order management systems - `key` string, nullable — Key from payment gateway - `value` string, nullable — Value from payment gateway - `gatewayResponseText` string, nullable — Gateway response text. Supplied by PCIaaS. - `gatewayTransactionId` string, nullable — Unique identifier of the transaction supplied by PCIaaS. - `id` string, nullable — Unique identifier of this payment transaction interaction. - `interactionDate` string, date-time, nullable — Date the interaction occurred - `interactionType` string, nullable — Types of transaction interactions which can be "Authorization," "Capture," "AuthorizeAndCapture," "Void," or "Credit," "CheckRequested," or "CheckReceived." - `isManual` boolean — If the payment is a manual payment, this is set to true - `isPending` boolean — If true, indicates payment action is still pending and not yet confirmed. - `isRecurring` boolean, nullable — If true, the product is purchased or fulfilled at regular intervals, for example, a monthly billing or a subscription. (Not currently implemented.) - `note` string, nullable — Note to be entered by merchant/application - `orderId` string, nullable — Unique identifier of the order with which this transaction is associated. - `paymentEntryStatus` string, nullable — Status of the payment when the transaction interaction was created - `paymentId` string, nullable — Unique identifier of the original transaction of which this current interaction is a part. - `paymentTransactionInteractionIdReference` integer, nullable — Unique identifier of previous PaymentTransactionInteraction that this PaymentTransactionInteraction is modifying. For instance, when crediting a capture, set the PaymentTransactionInteractionIdReference to the capture PaymentTransactionInteractionID. - `refundId` string, nullable — Refund Id, if the interaction is for a stand alone refund. - `returnId` string, nullable — Return Id, if the interaction is a Credit for a return-refund. - `status` string, nullable — Status of the payment transaction interaction which can be either "Success" or "Failure." - `target` PaymentActionTarget - `targetId` string, nullable — The Id of the Checkout/Order/Return to target. - `targetNumber` integer, nullable — The number of the Checkout/Order/Return to target. - `targetType` string, nullable — Specifies if the Mozu.CommerceRuntime.Contracts.Payments.PaymentActionTarget.TargetId is a Checkout Id, Order Id, or Return Id. - `isRecurring` boolean — If true, the product is purchased or fulfilled at regular intervals, for example, monthly billing or a subscription. (Not currently supported.) - `orderId` string, nullable — Unique identifier of the order with which this transaction is associated. - `paymentServiceTransactionId` string, nullable — Unique identifier of the transaction, specified by the payment service processesing this transaction. - `paymentType` string, nullable — Type of Payment - `paymentWorkflow` string, nullable — The source of data for this payment. By default, this will be set to 'mozu' - `status` string, nullable — Current status of this transaction which are described by the PaymentStatusConst class. - `subPayments` SubPayment[], nullable — List of sub payments that correspond to child orders in case of multiship orders. - `amountCollected` number, double - `amountCredited` number, double - `amountRefunded` number, double - `amountRequested` number, double - `status` string, nullable - `target` PaymentActionTarget - `targetId` string, nullable — The Id of the Checkout/Order/Return to target. - `targetNumber` integer, nullable — The number of the Checkout/Order/Return to target. - `targetType` string, nullable — Specifies if the Mozu.CommerceRuntime.Contracts.Payments.PaymentActionTarget.TargetId is a Checkout Id, Order Id, or Return Id. - `priceListCode` string, nullable — Pricelist code for the checkout - `shippingSubTotal` number, double — Shipping does not appear on cart. - `shippingTaxTotal` number, double — Total tax on shipping. - `shippingTotal` number, double — Overall shipping total, accounting for item and order-level shipping costs, any shipping discounts, and shipping tax. - `shopperNotes` CommerceRuntimeShopperNotes — Notes that the shopper has added to this order, for example, a gift message or other comments. - `comments` string, nullable — Comments associated with this order. - `deliveryInstructions` string, nullable — DeliveryInstructions associated with this order. - `giftMessage` string, nullable — Gift message associated with this order. - `siteId` integer — Unique identifier of the Site. - `sourceDevice` string, nullable — Source device of the user placing the order. (User or customer?) - `subTotal` number, double — Subtotal before any coupon codes, taxes, fees, etc. - `submittedDate` string, date-time, nullable — When the customer placed (submitted) the order. - `suggestedDiscounts` SuggestedDiscount[], nullable - `autoAdd` boolean - `discountId` integer - `hasMultipleProducts` boolean - `hasOptions` boolean - `productCode` string, nullable - `taxData` object, nullable — Storage for any additional/custom tax data. - `tenantId` integer — Unique identifier of the Tenant. - `total` number, double — Final total - `type` string, nullable — Is this Order Online or Offline? Online means shopper entered at checkout, offline means a phone order. - `visitId` string, nullable — Identifies the Visit ID that was current when the order was placed or when the cart was last updated. - `webSessionId` string, nullable — Identifies the web session used to place the order or last update the cart. --- [API](https://skmtc.net/kibocommerce/apis/customer.md) · [All operations](https://skmtc.net/kibocommerce/apis/customer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kibocommerce/customer/versions/47c0cf7b75ab/schema)