Skip to main content
POST
/
commerce
/
checkouts
/
{checkoutId}
/
payments
/
actions
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "siteId": 123,
  "tenantId": 123,
  "number": 123,
  "originalCartId": "<string>",
  "submittedDate": "2023-11-07T05:31:56Z",
  "type": "<string>",
  "items": [
    {
      "localeCode": "<string>",
      "purchaseLocation": "<string>",
      "lineId": 123,
      "product": {
        "productCode": "<string>",
        "name": "<string>",
        "description": "<string>",
        "goodsType": "<string>",
        "isPackagedStandAlone": true,
        "stock": {
          "manageStock": true,
          "isOnBackOrder": true,
          "availableDate": "2023-11-07T05:31:56Z",
          "stockAvailable": 123,
          "aggregateInventory": 123,
          "futureInventories": [
            {
              "futureInventoryID": 123,
              "onhand": 123,
              "available": 123,
              "allocated": 123,
              "pending": 123,
              "deliveryDate": "2023-11-07T05:31:56Z",
              "createDate": "2023-11-07T05:31:56Z"
            }
          ],
          "availableFutureInventories": 123,
          "totalAvailableStock": 123,
          "isSubstitutable": true
        },
        "productReservationId": 123,
        "allocationId": 123,
        "allocationExpiration": "2023-11-07T05:31:56Z",
        "measurements": {
          "height": {
            "unit": "<string>",
            "value": 123
          },
          "width": {
            "unit": "<string>",
            "value": 123
          },
          "length": {
            "unit": "<string>",
            "value": 123
          },
          "weight": {
            "unit": "<string>",
            "value": 123
          }
        },
        "fulfillmentStatus": "<string>",
        "mfgPartNumber": "<string>",
        "upc": "<string>",
        "sku": "<string>",
        "fulfillmentTypesSupported": [
          "<string>"
        ],
        "imageAlternateText": "<string>",
        "imageUrl": "<string>",
        "variationProductCode": "<string>",
        "options": [
          {
            "name": "<string>",
            "value": "<unknown>",
            "shopperEnteredValue": "<unknown>",
            "attributeFQN": "<string>",
            "dataType": "<string>",
            "stringValue": "<string>"
          }
        ],
        "properties": [
          {
            "attributeFQN": "<string>",
            "name": "<string>",
            "dataType": "<string>",
            "isMultiValue": true,
            "values": [
              {
                "stringValue": "<string>",
                "value": "<unknown>"
              }
            ]
          }
        ],
        "categories": [
          {
            "id": 123,
            "parent": {}
          }
        ],
        "price": {
          "price": 123,
          "salePrice": 123,
          "tenantOverridePrice": 123,
          "msrp": 123,
          "creditValue": 123,
          "priceListCode": "<string>",
          "priceListEntryMode": "<string>",
          "isOverRidePriceSalePrice": true
        },
        "discountsRestricted": true,
        "discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
        "discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
        "isRecurring": true,
        "isTaxable": true,
        "productType": "<string>",
        "productUsage": "<string>",
        "serialNumber": "<string>",
        "condition": "<string>",
        "bundledProducts": [
          {
            "productCode": "<string>",
            "name": "<string>",
            "description": "<string>",
            "goodsType": "<string>",
            "isPackagedStandAlone": true,
            "stock": {
              "manageStock": true,
              "isOnBackOrder": true,
              "availableDate": "2023-11-07T05:31:56Z",
              "stockAvailable": 123,
              "aggregateInventory": 123,
              "futureInventories": [
                {
                  "futureInventoryID": 123,
                  "onhand": 123,
                  "available": 123,
                  "allocated": 123,
                  "pending": 123,
                  "deliveryDate": "2023-11-07T05:31:56Z",
                  "createDate": "2023-11-07T05:31:56Z"
                }
              ],
              "availableFutureInventories": 123,
              "totalAvailableStock": 123,
              "isSubstitutable": true
            },
            "productReservationId": 123,
            "allocationId": 123,
            "allocationExpiration": "2023-11-07T05:31:56Z",
            "measurements": {
              "height": {
                "unit": "<string>",
                "value": 123
              },
              "width": {
                "unit": "<string>",
                "value": 123
              },
              "length": {
                "unit": "<string>",
                "value": 123
              },
              "weight": {
                "unit": "<string>",
                "value": 123
              }
            },
            "fulfillmentStatus": "<string>",
            "quantity": 123,
            "optionAttributeFQN": "<string>",
            "optionValue": "<unknown>",
            "creditValue": 123,
            "deltaPrice": 123,
            "imageUrl": "<string>"
          }
        ],
        "fulfillmentFields": [
          {
            "name": "<string>",
            "userEnteredValue": "<unknown>",
            "required": true
          }
        ]
      },
      "quantity": 123,
      "isRecurring": true,
      "isTaxable": true,
      "subtotal": 123,
      "extendedTotal": 123,
      "taxableTotal": 123,
      "discountTotal": 123,
      "discountedTotal": 123,
      "itemTaxTotal": 123,
      "shippingTaxTotal": 123,
      "shippingTotal": 123,
      "handlingAmount": 123,
      "feeTotal": 123,
      "total": 123,
      "unitPrice": {
        "extendedAmount": 123,
        "listAmount": 123,
        "saleAmount": 123,
        "overrideAmount": 123
      },
      "productDiscount": {
        "groupId": "<string>",
        "impact": 123,
        "discount": {
          "id": 123,
          "name": "<string>",
          "itemIds": [
            "<string>"
          ],
          "expirationDate": "2023-11-07T05:31:56Z",
          "hasMultipleTargetProducts": true
        },
        "couponCode": "<string>",
        "excluded": true,
        "data": {},
        "productQuantity": 123,
        "impactPerUnit": 123,
        "appliesToSalePrice": true,
        "discountQuantity": 123
      },
      "productDiscounts": [
        {
          "groupId": "<string>",
          "impact": 123,
          "discount": {
            "id": 123,
            "name": "<string>",
            "itemIds": [
              "<string>"
            ],
            "expirationDate": "2023-11-07T05:31:56Z",
            "hasMultipleTargetProducts": true
          },
          "couponCode": "<string>",
          "excluded": true,
          "data": {},
          "productQuantity": 123,
          "impactPerUnit": 123,
          "appliesToSalePrice": true,
          "discountQuantity": 123
        }
      ],
      "shippingDiscounts": [
        {
          "methodCode": "<string>",
          "discount": {
            "groupId": "<string>",
            "impact": 123,
            "discount": {
              "id": 123,
              "name": "<string>",
              "itemIds": [
                "<string>"
              ],
              "expirationDate": "2023-11-07T05:31:56Z",
              "hasMultipleTargetProducts": true
            },
            "couponCode": "<string>",
            "excluded": true,
            "data": {}
          },
          "discountQuantity": 123,
          "impactPerUnit": 123
        }
      ],
      "data": {},
      "taxData": {},
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "shippingAmountBeforeDiscountsAndAdjustments": 123,
      "weightedOrderAdjustment": 123,
      "weightedOrderDiscount": 123,
      "adjustedLineItemSubtotal": 123,
      "totalWithoutWeightedShippingAndHandling": 123,
      "weightedOrderTax": 123,
      "weightedOrderShipping": 123,
      "weightedOrderShippingDiscount": 123,
      "weightedOrderShippingManualAdjustment": 123,
      "weightedOrderShippingTax": 123,
      "weightedOrderHandlingFee": 123,
      "weightedOrderHandlingFeeTax": 123,
      "weightedOrderHandlingFeeDiscount": 123,
      "weightedOrderDuty": 123,
      "totalWithWeightedShippingAndHandling": 123,
      "weightedOrderHandlingAdjustment": 123,
      "autoAddDiscountId": 123,
      "isAssemblyRequired": true,
      "childItemIds": [
        "<string>"
      ],
      "parentItemId": "<string>",
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "lineItemAdjustment": 123,
      "dutyAmount": 123,
      "substituteInfo": {
        "optIn": "<string>",
        "substituteProductCode": "<string>",
        "substituteVariantCode": "<string>"
      },
      "id": "<string>",
      "destinationId": "<string>",
      "originalCartItemId": "<string>",
      "fulfillmentLocationCode": "<string>",
      "fulfillmentMethod": "<string>",
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "subscription": {
        "required": true,
        "frequency": {
          "unit": "<string>",
          "value": 123
        },
        "trial": {
          "enabled": true,
          "duration": 123,
          "substituteProductCode": "<string>",
          "substituteProductQuantity": 123,
          "substituteVariationProductCode": "<string>",
          "substituteProductOptions": [
            {
              "name": "<string>",
              "value": "<unknown>",
              "shopperEnteredValue": "<unknown>",
              "attributeFQN": "<string>",
              "dataType": "<string>",
              "stringValue": "<string>"
            }
          ]
        }
      },
      "isReservationEnabled": true,
      "giftInfo": {
        "isGiftItem": true,
        "giftMessage": "<string>"
      },
      "priceMode": "<string>",
      "returnRuleInfo": {
        "isReturnable": true,
        "maxQty": 123,
        "maxDays": 123,
        "ruleCode": "<string>"
      },
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<string>",
      "deliveryWindow": {
        "startTime": "2023-11-07T05:31:56Z",
        "endTime": "2023-11-07T05:31:56Z"
      },
      "suggestions": [
        {
          "locationCode": "<string>",
          "suggestionType": "<string>",
          "quantity": 123,
          "productCode": "<string>",
          "futureDate": "2023-11-07T05:31:56Z",
          "transferToLocationCode": "<string>"
        }
      ]
    }
  ],
  "groupings": [
    {
      "id": "<string>",
      "destinationId": "<string>",
      "fulfillmentMethod": "<string>",
      "orderItemIds": [
        "<string>"
      ],
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<string>",
      "standaloneGroup": true,
      "shippingDiscounts": [
        {
          "methodCode": "<string>",
          "discount": {
            "groupId": "<string>",
            "impact": 123,
            "discount": {
              "id": 123,
              "name": "<string>",
              "itemIds": [
                "<string>"
              ],
              "expirationDate": "2023-11-07T05:31:56Z",
              "hasMultipleTargetProducts": true
            },
            "couponCode": "<string>",
            "excluded": true,
            "data": {}
          }
        }
      ],
      "handlingDiscounts": [
        {
          "groupId": "<string>",
          "impact": 123,
          "discount": {
            "id": 123,
            "name": "<string>",
            "itemIds": [
              "<string>"
            ],
            "expirationDate": "2023-11-07T05:31:56Z",
            "hasMultipleTargetProducts": true
          },
          "couponCode": "<string>",
          "excluded": true,
          "data": {}
        }
      ],
      "dutyAmount": 123,
      "dutyTotal": 123,
      "shippingAmount": 123,
      "shippingSubTotal": 123,
      "itemLevelShippingDiscountTotal": 123,
      "orderLevelShippingDiscountTotal": 123,
      "shippingTax": 123,
      "shippingTaxTotal": 123,
      "shippingTotal": 123,
      "handlingAmount": 123,
      "handlingSubTotal": 123,
      "itemLevelHandlingDiscountTotal": 123,
      "orderLevelHandlingDiscountTotal": 123,
      "handlingTax": 123,
      "handlingTaxTotal": 123,
      "handlingTotal": 123,
      "taxData": {}
    }
  ],
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "destinations": [
    {
      "id": "<string>",
      "destinationContact": {
        "id": 123,
        "email": "<string>",
        "firstName": "<string>",
        "middleNameOrInitial": "<string>",
        "lastNameOrSurname": "<string>",
        "companyOrOrganization": "<string>",
        "phoneNumbers": {
          "home": "<string>",
          "mobile": "<string>",
          "work": "<string>"
        },
        "address": {
          "address1": "<string>",
          "address2": "<string>",
          "address3": "<string>",
          "address4": "<string>",
          "cityOrTown": "<string>",
          "stateOrProvince": "<string>",
          "postalOrZipCode": "<string>",
          "countryCode": "<string>",
          "addressType": "<string>",
          "isValidated": true
        }
      },
      "isDestinationCommercial": true,
      "data": {}
    }
  ],
  "payments": [
    {
      "id": "<string>",
      "groupId": {
        "targetType": "<string>",
        "targetId": "<string>",
        "targetNumber": 123
      },
      "paymentServiceTransactionId": "<string>",
      "availableActions": [
        "<string>"
      ],
      "orderId": "<string>",
      "paymentType": "<string>",
      "paymentWorkflow": "<string>",
      "externalTransactionId": "<string>",
      "billingInfo": {
        "paymentType": "<string>",
        "paymentWorkflow": "<string>",
        "billingContact": {
          "id": 123,
          "email": "<string>",
          "firstName": "<string>",
          "middleNameOrInitial": "<string>",
          "lastNameOrSurname": "<string>",
          "companyOrOrganization": "<string>",
          "phoneNumbers": {
            "home": "<string>",
            "mobile": "<string>",
            "work": "<string>"
          },
          "address": {
            "address1": "<string>",
            "address2": "<string>",
            "address3": "<string>",
            "address4": "<string>",
            "cityOrTown": "<string>",
            "stateOrProvince": "<string>",
            "postalOrZipCode": "<string>",
            "countryCode": "<string>",
            "addressType": "<string>",
            "isValidated": true
          }
        },
        "isSameBillingShippingAddress": true,
        "card": {
          "paymentOrCardType": "<string>",
          "cardNumberPartOrMask": "<string>",
          "expireMonth": 123,
          "expireYear": 123,
          "bin": "<string>",
          "paymentServiceCardId": "<string>",
          "isUsedRecurring": true,
          "nameOnCard": "<string>",
          "isCardInfoSaved": true,
          "isTokenized": true,
          "ccLastFour": "<string>"
        },
        "token": {
          "paymentServiceTokenId": "<string>",
          "type": "<string>"
        },
        "purchaseOrder": {
          "purchaseOrderNumber": "<string>",
          "paymentTerm": {
            "code": "<string>",
            "description": "<string>"
          },
          "customFields": [
            {
              "code": "<string>",
              "label": "<string>",
              "value": "<string>"
            }
          ]
        },
        "check": {
          "checkNumber": "<string>"
        },
        "auditInfo": {
          "updateDate": "2023-11-07T05:31:56Z",
          "createDate": "2023-11-07T05:31:56Z",
          "updateBy": "<string>",
          "createBy": "<string>"
        },
        "storeCreditCode": "<string>",
        "storeCreditType": "<string>",
        "customCreditType": "<string>",
        "externalTransactionId": "<string>",
        "isRecurring": true,
        "recurringTransactionId": "<string>",
        "data": {}
      },
      "data": {},
      "status": "<string>",
      "subPayments": [
        {
          "status": "<string>",
          "amountCollected": 123,
          "amountCredited": 123,
          "amountRequested": 123,
          "amountRefunded": 123,
          "target": {
            "targetType": "<string>",
            "targetId": "<string>",
            "targetNumber": 123
          }
        }
      ],
      "interactions": [
        {
          "id": "<string>",
          "gatewayInteractionId": 123,
          "paymentId": "<string>",
          "orderId": "<string>",
          "target": {
            "targetType": "<string>",
            "targetId": "<string>",
            "targetNumber": 123
          },
          "currencyCode": "<string>",
          "interactionType": "<string>",
          "checkNumber": "<string>",
          "status": "<string>",
          "paymentEntryStatus": "<string>",
          "isRecurring": true,
          "isManual": true,
          "isPending": true,
          "gatewayTransactionId": "<string>",
          "gatewayAuthCode": "<string>",
          "gatewayAVSCodes": "<string>",
          "gatewayCVV2Codes": "<string>",
          "gatewayResponseCode": "<string>",
          "gatewayResponseText": "<string>",
          "gatewayResponseData": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "paymentTransactionInteractionIdReference": 123,
          "amount": 123,
          "note": "<string>",
          "interactionDate": "2023-11-07T05:31:56Z",
          "auditInfo": {
            "updateDate": "2023-11-07T05:31:56Z",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "createBy": "<string>"
          },
          "returnId": "<string>",
          "refundId": "<string>",
          "capturableShipmentsSummary": [
            {
              "shipmentNumber": 123,
              "shipmentTotal": 123,
              "amountApplied": 123
            }
          ]
        }
      ],
      "isRecurring": true,
      "amountCollected": 123,
      "amountCredited": 123,
      "amountRequested": 123,
      "changeMessages": [
        {
          "id": "<string>",
          "correlationId": "<string>",
          "userId": "<string>",
          "userFirstName": "<string>",
          "userLastName": "<string>",
          "userScopeType": "<string>",
          "appId": "<string>",
          "appKey": "<string>",
          "appName": "<string>",
          "subjectType": "<string>",
          "success": true,
          "identifier": "<string>",
          "subject": "<string>",
          "verb": "<string>",
          "message": "<string>",
          "metadata": "<unknown>",
          "oldValue": "<string>",
          "newValue": "<string>",
          "amount": 123,
          "createDate": "2023-11-07T05:31:56Z",
          "attributes": {}
        }
      ],
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "gatewayGiftCard": {
        "id": "<string>",
        "cardNumber": "<string>",
        "cardPin": "<string>",
        "amount": 123,
        "currencyCode": "<string>"
      },
      "installmentPlanCode": "<string>"
    }
  ],
  "amountRemainingForPayment": 123,
  "acceptsMarketing": true,
  "customerAccountId": 123,
  "email": "<string>",
  "alternateContact": {
    "firstName": "<string>",
    "lastNameOrSurname": "<string>",
    "emailAddress": "<string>",
    "phoneNumber": "<string>"
  },
  "customerTaxId": "<string>",
  "isTaxExempt": true,
  "currencyCode": "<string>",
  "priceListCode": "<string>",
  "attributes": [
    {
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "fullyQualifiedName": "<string>",
      "attributeDefinitionId": 123,
      "values": [
        "<unknown>"
      ]
    }
  ],
  "shopperNotes": {
    "giftMessage": "<string>",
    "comments": "<string>",
    "deliveryInstructions": "<string>"
  },
  "availableActions": [
    "<string>"
  ],
  "data": {},
  "taxData": {},
  "channelCode": "<string>",
  "locationCode": "<string>",
  "ipAddress": "<string>",
  "sourceDevice": "<string>",
  "visitId": "<string>",
  "webSessionId": "<string>",
  "customerInteractionType": "<string>",
  "orderDiscounts": [
    {
      "groupId": "<string>",
      "impact": 123,
      "discount": {
        "id": 123,
        "name": "<string>",
        "itemIds": [
          "<string>"
        ],
        "expirationDate": "2023-11-07T05:31:56Z",
        "hasMultipleTargetProducts": true
      },
      "couponCode": "<string>",
      "excluded": true,
      "data": {}
    }
  ],
  "couponCodes": [
    "<string>"
  ],
  "invalidCoupons": [
    {
      "couponCode": "<string>",
      "reasonCode": 123,
      "reason": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "discountId": 123
    }
  ],
  "suggestedDiscounts": [
    {
      "productCode": "<string>",
      "autoAdd": true,
      "discountId": 123,
      "hasMultipleProducts": true,
      "hasOptions": true
    }
  ],
  "discountThresholdMessages": [
    {
      "discountId": 123,
      "message": "<string>",
      "thresholdValue": 123,
      "showOnCheckout": true,
      "showInCart": true,
      "requiresCouponCode": true
    }
  ],
  "dutyTotal": 123,
  "feeTotal": 123,
  "subTotal": 123,
  "itemLevelProductDiscountTotal": 123,
  "orderLevelProductDiscountTotal": 123,
  "itemTaxTotal": 123,
  "itemTotal": 123,
  "shippingSubTotal": 123,
  "itemLevelShippingDiscountTotal": 123,
  "orderLevelShippingDiscountTotal": 123,
  "shippingTaxTotal": 123,
  "shippingTotal": 123,
  "handlingSubTotal": 123,
  "itemLevelHandlingDiscountTotal": 123,
  "orderLevelHandlingDiscountTotal": 123,
  "handlingTaxTotal": 123,
  "handlingTotal": 123,
  "total": 123
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
checkoutId
string
required

Unique identifier of the checkout whose payment action you want to change.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json

Action to be performed, along with any metadata.

​
actionName
string | null

Name of the Action to post

​
currencyCode
string | null

ISO currency code for the transaction. Currently, only USD is supported.

​
checkNumber
string | null

If paying by check, the check number.

​
returnUrl
string | null

If paying by Paypal Express or some other potential non-gateway payment provider, a return redirect URL must be provided.

​
cancelUrl
string | null

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.

​
amount
number<double> | null

Amount of funds to withdraw to pay for this order.

​
interactionDate
string<date-time> | null

Date the interaction occurred

​
newBillingInfo
object

Customer's payment details such as payment type (credit card, check by mail, or PayPal) and cardholder information if payment is by credit card.

​
referenceSourcePaymentId
string | null

Reference payment id from which to copy the billing info.

​
manualGatewayInteraction
object

Represents a manually entered payment gateway interaction.

​
externalTransactionId
string | null
​
data
object

Custom data from payment providers

​
recaptcha
string | null

Recaptcha for validation.

​
installmentPlanCode
string | null

Stores the Installment Plan code. Installment is only supported on subscription orders

Response

Success

​
id
string | null

Unique identifier.

​
siteId
integer<int32>

Unique identifier of the Site.

​
tenantId
integer<int32>

Unique identifier of the Tenant.

​
number
integer<int32> | null

A checkout number that is only assigned after the checkout is placed.

​
originalCartId
string | null

Unique identifier for the cart that was converted to checkout.

​
submittedDate
string<date-time> | null

When the customer placed (submitted) the order.

​
type
string | null

Is this Order Online or Offline? Online means shopper entered at checkout, offline means a phone order.

​
items
object[] | null

List of items in the checkout.

​
groupings
object[] | null

List of checkout grouping.

​
auditInfo
object
​
destinations
object[] | null
​
payments
object[] | null

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.

​
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)

​
acceptsMarketing
boolean | null

Does the customer accept marketing

​
customerAccountId
integer<int32> | null

Unique identifier of the customer account.

​
email
string | null

Email address for checkout

​
alternateContact
object
​
customerTaxId
string | null

The customers tax ID. If Customer Account ID exists in the system, will set this.

​
isTaxExempt
boolean | null

Unique identifier of the customer account.

​
currencyCode
string | null

ISO Currency Code.

​
priceListCode
string | null

Pricelist code for the checkout

​
attributes
object[] | null
​
shopperNotes
object

Notes that the shopper has added to this order, for example, a gift message or other comments.

​
availableActions
string[] | null
​
data
object

Custom data for a given vendor set within the commerce process.

​
taxData
object

Storage for any additional/custom tax data.

​
channelCode
string | null

Unique identifier of the channel for this item.

​
locationCode
string | null

Identifies the location at which the order was placed if the order was placed externally.

​
ipAddress
string | null

IP address of the user placing the order. (User or customer?)

​
sourceDevice
string | null

Source device of the user placing the order. (User or customer?)

​
visitId
string | null

Identifies the Visit ID that was current when the order was placed or when the cart was last updated.

​
webSessionId
string | null

Identifies the web session used to place the order or last update the cart.

​
customerInteractionType
string | null

Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown

​
orderDiscounts
object[] | null
​
couponCodes
string[] | null

Coupon codes associated with this order.

​
invalidCoupons
object[] | null

A list of invalid coupons that were attempted on the order.

​
suggestedDiscounts
object[] | null
​
discountThresholdMessages
object[] | null

List of Mozu.CommerceRuntime.Contracts.Commerce.ThresholdMessage objects that are valid for the current value of the cart/order.

​
dutyTotal
number<double> | null

Total duty fees

​
feeTotal
number<double>

Total Fees

​
subTotal
number<double>

Subtotal before any coupon codes, taxes, fees, etc.

​
itemLevelProductDiscountTotal
number<double>

The total value of item-level product discounts.

​
orderLevelProductDiscountTotal
number<double>

The total value of order-level (group-level) product discounts.

​
itemTaxTotal
number<double>

Total tax on products.

​
itemTotal
number<double>

The total product cost, accounting for discounts and tax.

​
shippingSubTotal
number<double>

Shipping does not appear on cart.

​
itemLevelShippingDiscountTotal
number<double>

The total value of item-level shipping discounts.

​
orderLevelShippingDiscountTotal
number<double>

The total value of order-level (group-level) shipping discounts.

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

​
handlingSubTotal
number<double>

Pre-Discounted Handling Subtotal of the CommerceAggregate and its Items. Returns {null} if the calculated value is negative.

​
itemLevelHandlingDiscountTotal
number<double>

The total value of item-level handling discounts.

​
orderLevelHandlingDiscountTotal
number<double>

The total value of order-level (group-level) handling discounts.

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

​
total
number<double>

Final total