Skip to main content
POST
/
commerce
/
orders
Error
A valid request URL is required to generate request examples
{
  "userId": "<string>",
  "id": "<string>",
  "tenantId": 123,
  "siteId": 123,
  "channelCode": "<string>",
  "currencyCode": "<string>",
  "visitId": "<string>",
  "webSessionId": "<string>",
  "customerInteractionType": "<string>",
  "fulfillmentInfo": {
    "fulfillmentContact": {
      "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,
    "shippingMethodCode": "<string>",
    "shippingMethodName": "<string>",
    "data": {},
    "auditInfo": {
      "updateDate": "2023-11-07T05:31:56Z",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "createBy": "<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": {}
    }
  ],
  "suggestedDiscounts": [
    {
      "productCode": "<string>",
      "autoAdd": true,
      "discountId": 123,
      "hasMultipleProducts": true,
      "hasOptions": true
    }
  ],
  "rejectedDiscounts": [
    {
      "productCode": "<string>",
      "autoAdd": true,
      "discountId": 123,
      "hasMultipleProducts": true,
      "hasOptions": true
    }
  ],
  "data": {},
  "taxData": {},
  "subtotal": 123,
  "discountedSubtotal": 123,
  "discountTotal": 123,
  "discountedTotal": 123,
  "shippingTotal": 123,
  "shippingSubTotal": 123,
  "shippingTaxTotal": 123,
  "handlingTaxTotal": 123,
  "itemTaxTotal": 123,
  "taxTotal": 123,
  "feeTotal": 123,
  "total": 123,
  "lineItemSubtotalWithOrderAdjustments": 123,
  "shippingAmountBeforeDiscountsAndAdjustments": 123,
  "lastValidationDate": "2023-11-07T05:31:56Z",
  "expirationDate": "2023-11-07T05:31:56Z",
  "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": {}
    }
  ],
  "extendedProperties": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "discountThresholdMessages": [
    {
      "discountId": 123,
      "message": "<string>",
      "thresholdValue": 123,
      "showOnCheckout": true,
      "showInCart": true,
      "requiresCouponCode": true
    }
  ],
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "orderNumber": 123,
  "locationCode": "<string>",
  "version": "<string>",
  "parentOrderId": "<string>",
  "parentOrderNumber": 123,
  "parentCheckoutId": "<string>",
  "parentCheckoutNumber": 123,
  "partialOrderNumber": 123,
  "partialOrderCount": 123,
  "isPartialOrder": true,
  "parentReturnId": "<string>",
  "parentReturnNumber": 123,
  "originalCartId": "<string>",
  "originalQuoteId": "<string>",
  "originalQuoteNumber": 123,
  "priceListCode": "<string>",
  "availableActions": [
    "<string>"
  ],
  "shopperNotes": {
    "giftMessage": "<string>",
    "comments": "<string>",
    "deliveryInstructions": "<string>"
  },
  "customerAccountId": 123,
  "customerTaxId": "<string>",
  "isTaxExempt": true,
  "email": "<string>",
  "alternateContact": {
    "firstName": "<string>",
    "lastNameOrSurname": "<string>",
    "emailAddress": "<string>",
    "phoneNumber": "<string>"
  },
  "ipAddress": "<string>",
  "sourceDevice": "<string>",
  "acceptsMarketing": true,
  "status": "<string>",
  "type": "<string>",
  "paymentStatus": "<string>",
  "returnStatus": "<string>",
  "isEligibleForReturns": true,
  "totalCollected": 123,
  "attributes": [
    {
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "fullyQualifiedName": "<string>",
      "attributeDefinitionId": 123,
      "values": [
        "<unknown>"
      ]
    }
  ],
  "adjustment": {
    "amount": 123,
    "description": "<string>",
    "internalComment": "<string>"
  },
  "shippingAdjustment": {
    "amount": 123,
    "description": "<string>",
    "internalComment": "<string>"
  },
  "handlingAdjustment": {
    "amount": 123,
    "description": "<string>",
    "internalComment": "<string>"
  },
  "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": {}
    }
  ],
  "handlingAmount": 123,
  "handlingSubTotal": 123,
  "handlingTotal": 123,
  "dutyAmount": 123,
  "dutyTotal": 123,
  "fulfillmentStatus": "<string>",
  "isFulfillable": true,
  "submittedDate": "2023-11-07T05:31:56Z",
  "shipmentCreationOffset": 123,
  "releaseShipmentDate": "2023-11-07T05:31:56Z",
  "cancelledDate": "2023-11-07T05:31:56Z",
  "closedDate": "2023-11-07T05:31:56Z",
  "acceptedDate": "2023-11-07T05:31:56Z",
  "notes": [
    {
      "id": "<string>",
      "text": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<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>"
        }
      ]
    }
  ],
  "validationResults": [
    {
      "validationId": "<string>",
      "validatorName": "<string>",
      "validatorType": "<string>",
      "status": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "messages": [
        {
          "orderItemId": "<string>",
          "messageType": "<string>",
          "message": "<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": {}
  },
  "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>"
    }
  ],
  "refunds": [
    {
      "id": "<string>",
      "orderId": "<string>",
      "reason": "<string>",
      "reasonCode": "<string>",
      "payment": {
        "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>"
      },
      "amount": 123,
      "refundMethod": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      }
    }
  ],
  "credits": [
    {
      "id": "<string>",
      "parentPaymentId": "<string>",
      "parentPaymentInteractionId": "<string>",
      "amount": 123,
      "giftCard": {
        "id": "<string>",
        "cardNumber": "<string>",
        "cardPin": "<string>",
        "amount": 123,
        "currencyCode": "<string>"
      },
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      }
    }
  ],
  "packages": [
    {
      "id": "<string>",
      "code": "<string>",
      "status": "<string>",
      "items": [
        {
          "productCode": "<string>",
          "quantity": 123,
          "fulfillmentItemType": "<string>",
          "lineId": 123,
          "optionAttributeFQN": "<string>"
        }
      ],
      "fulfillmentDate": "2023-11-07T05:31:56Z",
      "fulfillmentLocationCode": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "availableActions": [
        "<string>"
      ],
      "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": {}
        }
      ],
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<string>",
      "shipmentId": "<string>",
      "trackingNumber": "<string>",
      "trackingNumbers": [
        "<string>"
      ],
      "packagingType": "<string>",
      "hasLabel": true,
      "measurements": {
        "height": {
          "unit": "<string>",
          "value": 123
        },
        "width": {
          "unit": "<string>",
          "value": 123
        },
        "length": {
          "unit": "<string>",
          "value": 123
        },
        "weight": {
          "unit": "<string>",
          "value": 123
        }
      },
      "carrier": "<string>",
      "signatureRequired": true,
      "trackings": [
        {
          "attributes": {},
          "number": "<string>",
          "url": "<string>"
        }
      ],
      "packingSlipItemDetails": [
        {
          "attributes": {},
          "lineId": 123,
          "originalOrderItemId": "<string>",
          "quantity": 123
        }
      ],
      "packingSlipNumber": 123,
      "returnTrackings": [
        {
          "attributes": {},
          "number": "<string>",
          "url": "<string>"
        }
      ],
      "returnTrackingNumbers": [
        "<string>"
      ],
      "returnCarrier": "<string>",
      "packageId": "<string>",
      "manifestId": "<string>",
      "labelFormat": "<string>",
      "integratorId": "<string>",
      "fxcbPackNotificationId": "<string>",
      "fxcbDocumentsUrl": "<string>",
      "attributes": {}
    }
  ],
  "pickups": [
    {
      "id": "<string>",
      "code": "<string>",
      "status": "<string>",
      "items": [
        {
          "productCode": "<string>",
          "quantity": 123,
          "fulfillmentItemType": "<string>",
          "lineId": 123,
          "optionAttributeFQN": "<string>"
        }
      ],
      "fulfillmentDate": "2023-11-07T05:31:56Z",
      "fulfillmentLocationCode": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "availableActions": [
        "<string>"
      ],
      "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": {}
        }
      ]
    }
  ],
  "digitalPackages": [
    {
      "id": "<string>",
      "code": "<string>",
      "status": "<string>",
      "items": [
        {
          "productCode": "<string>",
          "quantity": 123,
          "fulfillmentItemType": "<string>",
          "lineId": 123,
          "optionAttributeFQN": "<string>",
          "giftCardCode": "<string>"
        }
      ],
      "fulfillmentDate": "2023-11-07T05:31:56Z",
      "fulfillmentLocationCode": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "availableActions": [
        "<string>"
      ],
      "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": {}
        }
      ]
    }
  ],
  "shipments": [
    {
      "id": "<string>",
      "externalShipmentId": "<string>",
      "number": 123,
      "orderId": "<string>",
      "orderNumber": 123,
      "email": "<string>",
      "currencyCode": "<string>",
      "customerAccountId": 123,
      "customerTaxId": "<string>",
      "shipmentType": "<string>",
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<string>",
      "fulfillmentLocationCode": "<string>",
      "origin": {
        "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
        }
      },
      "destination": {
        "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": {}
      },
      "shipmentStatus": "<string>",
      "shipmentStatusReason": {
        "reasonCode": "<string>",
        "moreInfo": "<string>"
      },
      "transferShipmentNumbers": [
        123
      ],
      "isTransfer": true,
      "originalShipmentNumber": 123,
      "parentCheckoutNumber": 123,
      "parentShipmentNumber": 123,
      "fulfillmentStatus": "<string>",
      "workflowProcessId": "<string>",
      "workflowProcessContainerId": "<string>",
      "workflowState": {
        "attributes": {},
        "auditInfo": {
          "updateDate": "2023-11-07T05:31:56Z",
          "createDate": "2023-11-07T05:31:56Z",
          "updateBy": "<string>",
          "createBy": "<string>"
        },
        "completedDate": "2023-11-07T05:31:56Z",
        "processInstanceId": "<string>",
        "shipmentState": "<string>",
        "taskList": [
          {
            "links": {},
            "active": true,
            "attributes": {},
            "completed": true,
            "completedDate": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "inputs": [
              {
                "helpMessage": "<string>",
                "label": "<string>",
                "maxLength": 123,
                "maximum": 123,
                "minLength": 123,
                "minimum": 123,
                "name": "<string>",
                "options": [
                  "<unknown>"
                ],
                "pattern": "<string>",
                "required": true,
                "type": "<string>"
              }
            ],
            "name": "<string>",
            "skippable": true,
            "subject": "<string>",
            "taskId": "<string>"
          }
        ]
      },
      "backorderCreatedDate": 123,
      "fulfillmentDate": "2023-11-07T05:31:56Z",
      "futureDate": "2023-11-07T05:31:56Z",
      "orderSubmitDate": "2023-11-07T05:31:56Z",
      "pickStatus": "<string>",
      "pickType": "<string>",
      "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": {}
        }
      ],
      "packages": [
        {
          "id": "<string>",
          "code": "<string>",
          "status": "<string>",
          "items": [
            {
              "productCode": "<string>",
              "quantity": 123,
              "fulfillmentItemType": "<string>",
              "lineId": 123,
              "optionAttributeFQN": "<string>"
            }
          ],
          "fulfillmentDate": "2023-11-07T05:31:56Z",
          "fulfillmentLocationCode": "<string>",
          "auditInfo": {
            "updateDate": "2023-11-07T05:31:56Z",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "createBy": "<string>"
          },
          "availableActions": [
            "<string>"
          ],
          "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": {}
            }
          ],
          "shippingMethodCode": "<string>",
          "shippingMethodName": "<string>",
          "shipmentId": "<string>",
          "trackingNumber": "<string>",
          "trackingNumbers": [
            "<string>"
          ],
          "packagingType": "<string>",
          "hasLabel": true,
          "measurements": {
            "height": {
              "unit": "<string>",
              "value": 123
            },
            "width": {
              "unit": "<string>",
              "value": 123
            },
            "length": {
              "unit": "<string>",
              "value": 123
            },
            "weight": {
              "unit": "<string>",
              "value": 123
            }
          },
          "carrier": "<string>",
          "signatureRequired": true,
          "trackings": [
            {
              "attributes": {},
              "number": "<string>",
              "url": "<string>"
            }
          ],
          "packingSlipItemDetails": [
            {
              "attributes": {},
              "lineId": 123,
              "originalOrderItemId": "<string>",
              "quantity": 123
            }
          ],
          "packingSlipNumber": 123,
          "returnTrackings": [
            {
              "attributes": {},
              "number": "<string>",
              "url": "<string>"
            }
          ],
          "returnTrackingNumbers": [
            "<string>"
          ],
          "returnCarrier": "<string>",
          "packageId": "<string>",
          "manifestId": "<string>",
          "labelFormat": "<string>",
          "integratorId": "<string>",
          "fxcbPackNotificationId": "<string>",
          "fxcbDocumentsUrl": "<string>",
          "attributes": {}
        }
      ],
      "items": [
        {
          "lineId": 123,
          "originalOrderItemId": "<string>",
          "parentId": "<string>",
          "productCode": "<string>",
          "variationProductCode": "<string>",
          "optionAttributeFQN": "<string>",
          "name": "<string>",
          "auditInfo": {
            "updateDate": "2023-11-07T05:31:56Z",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "createBy": "<string>"
          },
          "fulfillmentLocationCode": "<string>",
          "imageUrl": "<string>",
          "isTaxable": true,
          "quantity": 123,
          "unitPrice": 123,
          "actualPrice": 123,
          "overridePrice": 123,
          "itemDiscount": 123,
          "lineItemCost": 123,
          "itemTax": 123,
          "shipping": 123,
          "shippingDiscount": 123,
          "shippingTax": 123,
          "handling": 123,
          "handlingDiscount": 123,
          "handlingTax": 123,
          "duty": 123,
          "isPackagedStandAlone": true,
          "readyForPickupQuantity": 123,
          "backorderReleaseDate": "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
            }
          },
          "options": [
            {
              "name": "<string>",
              "value": "<unknown>",
              "shopperEnteredValue": "<unknown>",
              "attributeFQN": "<string>",
              "dataType": "<string>",
              "stringValue": "<string>"
            }
          ],
          "data": {},
          "taxData": {},
          "weightedShipmentAdjustment": 123,
          "weightedLineItemTaxAdjustment": 123,
          "weightedShippingAdjustment": 123,
          "weightedShippingTaxAdjustment": 123,
          "weightedHandlingAdjustment": 123,
          "weightedHandlingTaxAdjustment": 123,
          "weightedDutyAdjustment": 123,
          "taxableShipping": 123,
          "taxableLineItemCost": 123,
          "taxableHandling": 123,
          "fulfillmentFields": [
            {
              "name": "<string>",
              "userEnteredValue": "<unknown>",
              "required": true
            }
          ],
          "isAssemblyRequired": true,
          "parentItemId": "<string>",
          "childItemIds": [
            "<string>"
          ],
          "giftCards": [
            {
              "activationDate": "2023-11-07T05:31:56Z",
              "cardNumber": "<string>",
              "code": "<string>",
              "creditType": "<string>",
              "creditValue": 123,
              "currencyCode": "<string>",
              "currentBalance": 123,
              "customerId": 123,
              "expirationDate": "2023-11-07T05:31:56Z",
              "initialBalance": 123
            }
          ],
          "locatorName": "<string>",
          "inventoryTags": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "lineItemAdjustment": 123,
          "isReservedInventory": true,
          "cartItemId": "<string>",
          "sku": "<string>",
          "partNumber": "<string>",
          "upc": "<string>",
          "isSubstitutable": true,
          "originalLineId": 123,
          "originalQuantity": 123,
          "substituteQuantity": 123,
          "purchaseLocation": "<string>",
          "isGift": true,
          "giftMessage": "<string>",
          "priceMode": "<string>",
          "serialNumber": "<string>",
          "condition": "<string>",
          "substituteInfo": {
            "optIn": "<string>",
            "substituteProductCode": "<string>",
            "substituteVariantCode": "<string>"
          },
          "allowsSubstitution": true,
          "returnRuleInfo": {
            "isReturnable": true,
            "maxQty": 123,
            "maxDays": 123,
            "ruleCode": "<string>"
          },
          "substitutionType": "<string>",
          "bundleInfo": {
            "attributes": {},
            "imageUrl": "<string>",
            "name": "<string>",
            "productCode": "<string>",
            "quantity": 123,
            "unitPrice": 123
          },
          "expectedDeliveryDate": "2023-11-07T05:31:56Z"
        }
      ],
      "canceledItems": [
        {
          "lineId": 123,
          "originalOrderItemId": "<string>",
          "parentId": "<string>",
          "productCode": "<string>",
          "variationProductCode": "<string>",
          "optionAttributeFQN": "<string>",
          "name": "<string>",
          "auditInfo": {
            "updateDate": "2023-11-07T05:31:56Z",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "createBy": "<string>"
          },
          "fulfillmentLocationCode": "<string>",
          "imageUrl": "<string>",
          "isTaxable": true,
          "quantity": 123,
          "unitPrice": 123,
          "actualPrice": 123,
          "overridePrice": 123,
          "itemDiscount": 123,
          "lineItemCost": 123,
          "itemTax": 123,
          "shipping": 123,
          "shippingDiscount": 123,
          "shippingTax": 123,
          "handling": 123,
          "handlingDiscount": 123,
          "handlingTax": 123,
          "duty": 123,
          "isPackagedStandAlone": true,
          "readyForPickupQuantity": 123,
          "backorderReleaseDate": "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
            }
          },
          "options": [
            {
              "name": "<string>",
              "value": "<unknown>",
              "shopperEnteredValue": "<unknown>",
              "attributeFQN": "<string>",
              "dataType": "<string>",
              "stringValue": "<string>"
            }
          ],
          "data": {},
          "taxData": {},
          "weightedShipmentAdjustment": 123,
          "weightedLineItemTaxAdjustment": 123,
          "weightedShippingAdjustment": 123,
          "weightedShippingTaxAdjustment": 123,
          "weightedHandlingAdjustment": 123,
          "weightedHandlingTaxAdjustment": 123,
          "weightedDutyAdjustment": 123,
          "taxableShipping": 123,
          "taxableLineItemCost": 123,
          "taxableHandling": 123,
          "fulfillmentFields": [
            {
              "name": "<string>",
              "userEnteredValue": "<unknown>",
              "required": true
            }
          ],
          "isAssemblyRequired": true,
          "parentItemId": "<string>",
          "childItemIds": [
            "<string>"
          ],
          "giftCards": [
            {
              "activationDate": "2023-11-07T05:31:56Z",
              "cardNumber": "<string>",
              "code": "<string>",
              "creditType": "<string>",
              "creditValue": 123,
              "currencyCode": "<string>",
              "currentBalance": 123,
              "customerId": 123,
              "expirationDate": "2023-11-07T05:31:56Z",
              "initialBalance": 123
            }
          ],
          "locatorName": "<string>",
          "inventoryTags": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "lineItemAdjustment": 123,
          "isReservedInventory": true,
          "cartItemId": "<string>",
          "sku": "<string>",
          "partNumber": "<string>",
          "upc": "<string>",
          "isSubstitutable": true,
          "originalLineId": 123,
          "originalQuantity": 123,
          "substituteQuantity": 123,
          "purchaseLocation": "<string>",
          "isGift": true,
          "giftMessage": "<string>",
          "priceMode": "<string>",
          "serialNumber": "<string>",
          "condition": "<string>",
          "substituteInfo": {
            "optIn": "<string>",
            "substituteProductCode": "<string>",
            "substituteVariantCode": "<string>"
          },
          "allowsSubstitution": true,
          "returnRuleInfo": {
            "isReturnable": true,
            "maxQty": 123,
            "maxDays": 123,
            "ruleCode": "<string>"
          },
          "substitutionType": "<string>",
          "bundleInfo": {
            "attributes": {},
            "imageUrl": "<string>",
            "name": "<string>",
            "productCode": "<string>",
            "quantity": 123,
            "unitPrice": 123
          },
          "expectedDeliveryDate": "2023-11-07T05:31:56Z",
          "canceledReason": {
            "reasonCode": "<string>",
            "description": "<string>",
            "moreInfo": "<string>"
          }
        }
      ],
      "data": {},
      "taxData": {},
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "shipmentAdjustment": 123,
      "lineItemSubtotal": 123,
      "lineItemTaxAdjustment": 123,
      "lineItemTaxTotal": 123,
      "lineItemTotal": 123,
      "shippingAdjustment": 123,
      "shippingSubtotal": 123,
      "shippingTaxAdjustment": 123,
      "shippingTaxTotal": 123,
      "shippingTotal": 123,
      "handlingAdjustment": 123,
      "handlingSubtotal": 123,
      "handlingTaxAdjustment": 123,
      "handlingTaxTotal": 123,
      "handlingTotal": 123,
      "dutyAdjustment": 123,
      "dutyTotal": 123,
      "total": 123,
      "cost": 123,
      "externalOrderId": "<string>",
      "isExpress": true,
      "isFlatRateShipping": true,
      "readyToCapture": true,
      "pickupInfo": {},
      "shopperNotes": {
        "comments": "<string>",
        "deliveryInstructions": "<string>",
        "giftMessage": "<string>"
      },
      "customer": {
        "customerContact": {
          "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
          }
        },
        "data": "<unknown>",
        "isDestinationCommercial": true
      },
      "shipmentNotes": [
        {
          "attributes": {},
          "auditInfo": {
            "updateDate": "2023-11-07T05:31:56Z",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "createBy": "<string>"
          },
          "noteId": "<string>",
          "noteText": "<string>",
          "role": "<string>",
          "username": "<string>"
        }
      ],
      "alternateContact": {
        "firstName": "<string>",
        "lastNameOrSurname": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>"
      },
      "substitutedItems": [
        {
          "actualPrice": 123,
          "allocatedQuantity": 123,
          "allowsBackOrder": true,
          "allowsFutureAllocate": true,
          "allowsSubstitution": true,
          "appeasementReason": {
            "reasonCode": "<string>",
            "moreInfo": "<string>"
          },
          "attributes": {},
          "auditInfo": {
            "updateDate": "2023-11-07T05:31:56Z",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "createBy": "<string>"
          },
          "autoSubstitution": true,
          "backorderReleaseDate": "2023-11-07T05:31:56Z",
          "bundleInfo": {
            "attributes": {},
            "imageUrl": "<string>",
            "name": "<string>",
            "productCode": "<string>",
            "quantity": 123,
            "unitPrice": 123
          },
          "cartItemId": "<string>",
          "childItemIds": [
            "<string>"
          ],
          "condition": "<string>",
          "creditCurrencyCode": "<string>",
          "creditValue": 123,
          "data": {},
          "duty": 123,
          "expectedDeliveryDate": "2023-11-07T05:31:56Z",
          "fulfillmentFields": [
            {
              "name": "<string>",
              "required": true,
              "userEnteredValue": "<unknown>"
            }
          ],
          "giftCards": [
            {
              "activationDate": "2023-11-07T05:31:56Z",
              "cardNumber": "<string>",
              "code": "<string>",
              "creditType": "<string>",
              "creditValue": 123,
              "currencyCode": "<string>",
              "currentBalance": 123,
              "customerId": 123,
              "expirationDate": "2023-11-07T05:31:56Z",
              "initialBalance": 123
            }
          ],
          "giftMessage": "<string>",
          "goodsType": "<string>",
          "handling": 123,
          "handlingDiscount": 123,
          "handlingTax": 123,
          "height": 123,
          "imageUrl": "<string>",
          "inventoryAllocations": [
            {
              "auditInfo": {
                "updateDate": "2023-11-07T05:31:56Z",
                "createDate": "2023-11-07T05:31:56Z",
                "updateBy": "<string>",
                "createBy": "<string>"
              },
              "condition": "<string>",
              "date": "2023-11-07T05:31:56Z",
              "fulfilledDate": "2023-11-07T05:31:56Z",
              "inventoryId": 123,
              "lotCode": "<string>",
              "originalQuantity": 123,
              "quantity": 123,
              "serialNumber": "<string>",
              "sku": "<string>",
              "status": "<string>"
            }
          ],
          "inventoryTags": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "isAssemblyRequired": true,
          "isGift": true,
          "isPackagedStandAlone": true,
          "isReservedInventory": true,
          "isTaxable": true,
          "itemDiscount": 123,
          "itemTax": 123,
          "length": 123,
          "lineId": 123,
          "lineItemAdjustment": 123,
          "lineItemCost": 123,
          "locatorName": "<string>",
          "manageStock": true,
          "name": "<string>",
          "optionAttributeFQN": "<string>",
          "options": [
            {
              "attributeFQN": "<string>",
              "attributes": {},
              "dataType": "<string>",
              "name": "<string>",
              "shopperEnteredValue": "<unknown>",
              "stringValue": "<string>",
              "value": "<unknown>"
            }
          ],
          "originalLineId": 123,
          "originalOrderItemId": "<string>",
          "originalQuantity": 123,
          "overridePrice": 123,
          "parentItemId": "<string>",
          "partNumber": "<string>",
          "priceMode": "<string>",
          "productCode": "<string>",
          "purchaseLocation": "<string>",
          "quantity": 123,
          "readyForPickupQuantity": 123,
          "returnRuleInfo": {
            "attributes": {},
            "isReturnable": true,
            "maxDays": 123,
            "maxQty": 123,
            "ruleCode": "<string>"
          },
          "serialNumber": "<string>",
          "shipping": 123,
          "shippingDiscount": 123,
          "shippingTax": 123,
          "sku": "<string>",
          "substituteInfo": {
            "optIn": "<string>",
            "substituteProductCode": "<string>",
            "substituteVariantCode": "<string>"
          },
          "substituteItemLineIds": [
            123
          ],
          "substituteQuantity": 123,
          "substituteReason": {
            "reasonCode": "<string>",
            "moreInfo": "<string>"
          },
          "substitutionType": "<string>",
          "taxData": "<unknown>",
          "taxableHandling": 123,
          "taxableLineItemCost": 123,
          "taxableShipping": 123,
          "transferQuantity": 123,
          "trueTransferQuantity": 123,
          "unitPrice": 123,
          "upc": "<string>",
          "variationProductCode": "<string>",
          "weight": 123,
          "weightUnit": "<string>",
          "weightedDutyAdjustment": 123,
          "weightedHandlingAdjustment": 123,
          "weightedHandlingTaxAdjustment": 123,
          "weightedLineItemTaxAdjustment": 123,
          "weightedShipmentAdjustment": 123,
          "weightedShippingAdjustment": 123,
          "weightedShippingTaxAdjustment": 123,
          "width": 123
        }
      ],
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "holdReleaseDate": "2023-11-07T05:31:56Z"
    }
  ],
  "isDraft": true,
  "hasDraft": true,
  "isImport": true,
  "isHistoricalImport": true,
  "importDate": "2023-11-07T05:31:56Z",
  "isUnified": true,
  "externalId": "<string>",
  "couponCodes": [
    "<string>"
  ],
  "invalidCoupons": [
    {
      "couponCode": "<string>",
      "reasonCode": 123,
      "reason": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "discountId": 123
    }
  ],
  "amountAvailableForRefund": 123,
  "amountRemainingForPayment": 123,
  "amountRefunded": 123,
  "readyToCapture": true,
  "isOptInForSms": true,
  "forceSTHConsolidationOnSplitShipments": true,
  "forceDeliveryConsolidationOnSplitShipments": true,
  "subscriptionIds": [
    "<string>"
  ],
  "continuityOrderOrdinal": 123,
  "reservationId": "<string>",
  "restrictEdit": true,
  "restrictCancellation": true,
  "isContinuityOrder": true,
  "canceledItems": [
    {
      "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>"
        }
      ],
      "originalQuantity": 123,
      "canceledQuantity": 123,
      "ruleCode": "<string>"
    }
  ],
  "shippingGroups": [
    {
      "id": "<string>",
      "fulfillmentMethod": "<string>",
      "orderItemIds": [
        "<string>"
      ],
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<string>",
      "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": {}
        }
      ],
      "shippingTaxTotal": 123,
      "shippingTotal": 123,
      "handlingTaxTotal": 123,
      "handlingTotal": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

cartId
string

Unique identifier of the cart. This is the original cart ID expressed as a GUID.

quoteId
string

Unique identifier of the quote.

responseFields
string

limits which fields are returned in the response body

Body

application/json

All properties of the order to place.

Order form.

userId
string | null

Unique identifier of the shopper who created the cart.

id
string | null

Unique identifier of the CommerceAggregate object (e.g. order, cart, wishlist, etc.).

tenantId
integer<int32> | null

Unique identifier of the Tenant.

siteId
integer<int32> | null

Unique identifier of the Site.

channelCode
string | null

Unique identifier of the channel for this item.

currencyCode
string | null

ISO Currency Code. Currently, only USD is supported.

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

fulfillmentInfo
object

Shipment information, which includes the shipping address, price, estimated delivery date, tracking information, method (for example, Ground, Overnight, or Pick-up), carrier (for example, USPS, UPS, FedEx), and current status (for example, Not Shipped, In Transit, Delayed, or Returned To Sender).

orderDiscounts
object[] | null

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.

suggestedDiscounts
object[] | null
rejectedDiscounts
object[] | null
data
object

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

taxData
object

Storage for any additional/custom tax data.

subtotal
number<double> | null

Combined price for all cart items, including all selected options but excluding any discounts.

discountedSubtotal
number<double> | null

Combined price for all cart items, including all selected options as well as any discounts.

discountTotal
number<double> | null

Amount of the discounts applied to all items in the cart. This is a negative number. This also includes the order level discounts.

discountedTotal
number<double> | null

Subtotal minus the discounted total

shippingTotal
number<double> | null

Shipping does not appear on cart.

shippingSubTotal
number<double> | null

Shipping total without discounts applied.

shippingTaxTotal
number<double> | null

Not implemented. Tax does not appear on cart.

handlingTaxTotal
number<double> | null

Total tax on handling

itemTaxTotal
number<double> | null

Not implemented. Tax does not appear on cart.

taxTotal
number<double> | null

Tax does not appear on cart.

feeTotal
number<double> | null

Not implemented. Total cost of fees for all items in the cart.

total
number<double> | null

Final total amount of the order including all discounts, shipping, and tax.

lineItemSubtotalWithOrderAdjustments
number<double> | null

Line Item Subtotals with Order Adjustments

shippingAmountBeforeDiscountsAndAdjustments
number<double> | null

Shipping Amount before discount and adjustments

lastValidationDate
string<date-time> | null

Occasionally the commerce runtime may validate that item/product names, descriptions, and prices have not changed. If changed, it updates LastValidationDate.

expirationDate
string<date-time> | null

When the order will no longer be active. That is, the order is considered abandoned. Orders of anonymous shoppers expire after 14 days of inactivity. An order never expires for shoppers who are logged into their account. Date in UTC Date/Time.

changeMessages
object[] | null

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.

extendedProperties
object[] | null

Extra properties (key-value pairs) that extend the primary object. Think of this as a property bag of string keys and string values.

discountThresholdMessages
object[] | null

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

auditInfo
object
orderNumber
integer<int32> | null

Order Number. This is an integer that is only assigned after an order is placed and enters the open state.

locationCode
string | null

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

version
string | null

Version for concurrency purposes

parentOrderId
string | null

If this Order has a parent order, this should be the parent's ID.

parentOrderNumber
integer<int32> | null

If this order has a parent order, this should be the parent's Mozu.CommerceRuntime.Contracts.Orders.Order.OrderNumber.

parentCheckoutId
string | null

If this order originated from a multi-ship enabled site, this is the identifier of the originating checkout.

parentCheckoutNumber
integer<int32> | null

If this order originated from a multi-ship enabled site, this is the number of the originating checkout.

partialOrderNumber
integer<int32> | null

If this order originated from a checkout, this is a sequence number out of the total orders created from that checkout.

partialOrderCount
integer<int32> | null

If this order originated from a checkout, this is the total number of orders created from that checkout.

isPartialOrder
boolean

Returns {true} if this order originated from a checkout and has sibling partial orders, otherwise {false}.

parentReturnId
string | null

If this order was created as part of a return, this should be the return's ID.

parentReturnNumber
integer<int32> | null

If this order was created as part of a return, this should be the return's ReturnNumber.

originalCartId
string | null

Unique identifier for the cart that was converted to order.

originalQuoteId
string | null

If this order originated from a quote, this is the identifier of the originating quote.

originalQuoteNumber
integer<int32> | null

If this order originated from a quote, this is the number of the originating quote.

priceListCode
string | null

Pricelist code for the order

availableActions
string[] | null

Actions available to the payment

shopperNotes
object

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

customerAccountId
integer<int32> | null

Unique identifier of the customer account.

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.

email
string | null

Email address of the customer at the time the order is placed.

alternateContact
object
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?)

acceptsMarketing
boolean | null

Does the customer accept marketing

status
string | null

Current status of the order, which can be viewed in OrderStatusConst. System-supplied and read-only.

type
string | null

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

paymentStatus
string | null

Current status of payment, which can be "Null," "AwaitingCheck," "AwaitingPayment," "Paid," "Authorized," or "Void." System-supplied and read-only.

returnStatus
string | null

System-supplied and read-only.

isEligibleForReturns
boolean

Marker for determining if the order is a) complete or b) has some items that are shipped and not part of any other return

totalCollected
number<double>

Total amount of money collected on the order via payments.

attributes
object[] | null
adjustment
object
shippingAdjustment
object
handlingAdjustment
object
shippingDiscounts
object[] | null
handlingDiscounts
object[] | null

The list of historically-applied handling discounts. The active one will have IsExcluded == false

handlingAmount
number<double> | null

Order level handling fees excluding any discounts.

handlingSubTotal
number<double> | null

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)

handlingTotal
number<double> | null

Handling fees including any discounts.

dutyAmount
number<double> | null

Order level duty or tariff amount. Does not take into account duties or tariffs specifically on items on the order

dutyTotal
number<double> | null

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)

fulfillmentStatus
string | null

Current fulfillment status, which can be "NotFulfilled,", "PartiallyFulfilled", or "Fufilled." System-supplied and read-only. Values are available in FulfillmentStatusConst of this class.

isFulfillable
boolean

Flag to indicate whether it is safe to proceed with fulfillment on shipments on the order.

submittedDate
string<date-time> | null

When the customer placed (submitted) the order.

shipmentCreationOffset
integer<int32> | null

Release Shipment After(in minutes) (Order Submitted Date).

releaseShipmentDate
string<date-time> | null
cancelledDate
string<date-time> | null

Date the order was cancelled.

closedDate
string<date-time> | null

Date the order was closed. A closed order means that the order has been processed and items shipped.

acceptedDate
string<date-time> | null

When the order was accepted by the merchant

notes
object[] | null

Internal notes that a merchant may add to the order. Maximum 250 characters.

items
object[] | null

List of items in the order.

validationResults
object[] | null

Validation results for the order when processes against validation capabilities.

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

payments
object[] | null

Payment transaction associated with this order. 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.

refunds
object[] | null

Refunds associated with this order. A refund is a single exchange of money from merchant to customer that either encapsulates a refund to a credit card or an issuance of a store credit. Refunds does not reduce the 'amount collected' on an order and it is possible for refunds to exceed the total order amount.

credits
object[] | null
packages
object[] | null

Shipping package associated with this order.

pickups
object[] | null

Fulfillment pickups associated with this order.

digitalPackages
object[] | null

Fulfillment digital packages associated with this order.

shipments
object[] | null

Package shipments associated with this order.

isDraft
boolean | null

Is this order a draft version

hasDraft
boolean | null

Does this order have a draft version.

isImport
boolean | null

Was this order initiated from an external system

isHistoricalImport
boolean | null

Indicates this was an order in a terminal state (completed/canceled) that was imported into the system for historical purposes.

importDate
string<date-time> | null

Date this item was imported

isUnified
boolean

Was this order created by the Unified platform.

externalId
string | null

An order number to link this order to an external system

couponCodes
string[] | null

Coupon codes associated with this order. Only set on order import.

invalidCoupons
object[] | null

A list of invalid coupons that were attempted on the order

amountAvailableForRefund
number<double>

This property represents AmountCaptured - AmountRefunded via returns. It is read only.

amountRemainingForPayment
number<double>

A counter for how much of the order total has not been claimed by payments. This is computed by Order.Total-(sum of Order.Payments where State is not voided/declined)

amountRefunded
number<double>

A counter for how much money has been issued in refunds. This calculated field does NOT include refunds issued in returns.

readyToCapture
boolean
isOptInForSms
boolean

Whether the shopper opts in to curbside text notifications.

forceSTHConsolidationOnSplitShipments
boolean | null

Overrides the Fulfillment SiteSetting value for ForceSTHConsolidationOnSplitShipments. TODO autogen instead of manual addition

forceDeliveryConsolidationOnSplitShipments
boolean | null

Overrides the Fulfillment SiteSetting value for ForceDeliveryConsolidationOnSplitShipments. TODO autogen instead of manual addition

subscriptionIds
string[] | null

All the subscriptions associated with the current order.

continuityOrderOrdinal
integer<int32>

The ordinal to track the Continuity order.

reservationId
string | null

Inventory Reservation id for order.

restrictEdit
boolean | null

Setting this flag on the order will restrict user from editing the order

restrictCancellation
boolean | null

Settings this flag on the order will restrict user from Cancelling the order

isContinuityOrder
boolean

Flag to check if the order is continuityOrder.

canceledItems
object[] | null

Items canceled on the Order due to Rule violation

shippingGroups
object[] | null

List of order grouping.

Response

Success

Order form.

userId
string | null

Unique identifier of the shopper who created the cart.

id
string | null

Unique identifier of the CommerceAggregate object (e.g. order, cart, wishlist, etc.).

tenantId
integer<int32> | null

Unique identifier of the Tenant.

siteId
integer<int32> | null

Unique identifier of the Site.

channelCode
string | null

Unique identifier of the channel for this item.

currencyCode
string | null

ISO Currency Code. Currently, only USD is supported.

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

fulfillmentInfo
object

Shipment information, which includes the shipping address, price, estimated delivery date, tracking information, method (for example, Ground, Overnight, or Pick-up), carrier (for example, USPS, UPS, FedEx), and current status (for example, Not Shipped, In Transit, Delayed, or Returned To Sender).

orderDiscounts
object[] | null

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.

suggestedDiscounts
object[] | null
rejectedDiscounts
object[] | null
data
object

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

taxData
object

Storage for any additional/custom tax data.

subtotal
number<double> | null

Combined price for all cart items, including all selected options but excluding any discounts.

discountedSubtotal
number<double> | null

Combined price for all cart items, including all selected options as well as any discounts.

discountTotal
number<double> | null

Amount of the discounts applied to all items in the cart. This is a negative number. This also includes the order level discounts.

discountedTotal
number<double> | null

Subtotal minus the discounted total

shippingTotal
number<double> | null

Shipping does not appear on cart.

shippingSubTotal
number<double> | null

Shipping total without discounts applied.

shippingTaxTotal
number<double> | null

Not implemented. Tax does not appear on cart.

handlingTaxTotal
number<double> | null

Total tax on handling

itemTaxTotal
number<double> | null

Not implemented. Tax does not appear on cart.

taxTotal
number<double> | null

Tax does not appear on cart.

feeTotal
number<double> | null

Not implemented. Total cost of fees for all items in the cart.

total
number<double> | null

Final total amount of the order including all discounts, shipping, and tax.

lineItemSubtotalWithOrderAdjustments
number<double> | null

Line Item Subtotals with Order Adjustments

shippingAmountBeforeDiscountsAndAdjustments
number<double> | null

Shipping Amount before discount and adjustments

lastValidationDate
string<date-time> | null

Occasionally the commerce runtime may validate that item/product names, descriptions, and prices have not changed. If changed, it updates LastValidationDate.

expirationDate
string<date-time> | null

When the order will no longer be active. That is, the order is considered abandoned. Orders of anonymous shoppers expire after 14 days of inactivity. An order never expires for shoppers who are logged into their account. Date in UTC Date/Time.

changeMessages
object[] | null

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.

extendedProperties
object[] | null

Extra properties (key-value pairs) that extend the primary object. Think of this as a property bag of string keys and string values.

discountThresholdMessages
object[] | null

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

auditInfo
object
orderNumber
integer<int32> | null

Order Number. This is an integer that is only assigned after an order is placed and enters the open state.

locationCode
string | null

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

version
string | null

Version for concurrency purposes

parentOrderId
string | null

If this Order has a parent order, this should be the parent's ID.

parentOrderNumber
integer<int32> | null

If this order has a parent order, this should be the parent's Mozu.CommerceRuntime.Contracts.Orders.Order.OrderNumber.

parentCheckoutId
string | null

If this order originated from a multi-ship enabled site, this is the identifier of the originating checkout.

parentCheckoutNumber
integer<int32> | null

If this order originated from a multi-ship enabled site, this is the number of the originating checkout.

partialOrderNumber
integer<int32> | null

If this order originated from a checkout, this is a sequence number out of the total orders created from that checkout.

partialOrderCount
integer<int32> | null

If this order originated from a checkout, this is the total number of orders created from that checkout.

isPartialOrder
boolean

Returns {true} if this order originated from a checkout and has sibling partial orders, otherwise {false}.

parentReturnId
string | null

If this order was created as part of a return, this should be the return's ID.

parentReturnNumber
integer<int32> | null

If this order was created as part of a return, this should be the return's ReturnNumber.

originalCartId
string | null

Unique identifier for the cart that was converted to order.

originalQuoteId
string | null

If this order originated from a quote, this is the identifier of the originating quote.

originalQuoteNumber
integer<int32> | null

If this order originated from a quote, this is the number of the originating quote.

priceListCode
string | null

Pricelist code for the order

availableActions
string[] | null

Actions available to the payment

shopperNotes
object

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

customerAccountId
integer<int32> | null

Unique identifier of the customer account.

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.

email
string | null

Email address of the customer at the time the order is placed.

alternateContact
object
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?)

acceptsMarketing
boolean | null

Does the customer accept marketing

status
string | null

Current status of the order, which can be viewed in OrderStatusConst. System-supplied and read-only.

type
string | null

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

paymentStatus
string | null

Current status of payment, which can be "Null," "AwaitingCheck," "AwaitingPayment," "Paid," "Authorized," or "Void." System-supplied and read-only.

returnStatus
string | null

System-supplied and read-only.

isEligibleForReturns
boolean

Marker for determining if the order is a) complete or b) has some items that are shipped and not part of any other return

totalCollected
number<double>

Total amount of money collected on the order via payments.

attributes
object[] | null
adjustment
object
shippingAdjustment
object
handlingAdjustment
object
shippingDiscounts
object[] | null
handlingDiscounts
object[] | null

The list of historically-applied handling discounts. The active one will have IsExcluded == false

handlingAmount
number<double> | null

Order level handling fees excluding any discounts.

handlingSubTotal
number<double> | null

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)

handlingTotal
number<double> | null

Handling fees including any discounts.

dutyAmount
number<double> | null

Order level duty or tariff amount. Does not take into account duties or tariffs specifically on items on the order

dutyTotal
number<double> | null

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)

fulfillmentStatus
string | null

Current fulfillment status, which can be "NotFulfilled,", "PartiallyFulfilled", or "Fufilled." System-supplied and read-only. Values are available in FulfillmentStatusConst of this class.

isFulfillable
boolean

Flag to indicate whether it is safe to proceed with fulfillment on shipments on the order.

submittedDate
string<date-time> | null

When the customer placed (submitted) the order.

shipmentCreationOffset
integer<int32> | null

Release Shipment After(in minutes) (Order Submitted Date).

releaseShipmentDate
string<date-time> | null
cancelledDate
string<date-time> | null

Date the order was cancelled.

closedDate
string<date-time> | null

Date the order was closed. A closed order means that the order has been processed and items shipped.

acceptedDate
string<date-time> | null

When the order was accepted by the merchant

notes
object[] | null

Internal notes that a merchant may add to the order. Maximum 250 characters.

items
object[] | null

List of items in the order.

validationResults
object[] | null

Validation results for the order when processes against validation capabilities.

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

payments
object[] | null

Payment transaction associated with this order. 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.

refunds
object[] | null

Refunds associated with this order. A refund is a single exchange of money from merchant to customer that either encapsulates a refund to a credit card or an issuance of a store credit. Refunds does not reduce the 'amount collected' on an order and it is possible for refunds to exceed the total order amount.

credits
object[] | null
packages
object[] | null

Shipping package associated with this order.

pickups
object[] | null

Fulfillment pickups associated with this order.

digitalPackages
object[] | null

Fulfillment digital packages associated with this order.

shipments
object[] | null

Package shipments associated with this order.

isDraft
boolean | null

Is this order a draft version

hasDraft
boolean | null

Does this order have a draft version.

isImport
boolean | null

Was this order initiated from an external system

isHistoricalImport
boolean | null

Indicates this was an order in a terminal state (completed/canceled) that was imported into the system for historical purposes.

importDate
string<date-time> | null

Date this item was imported

isUnified
boolean

Was this order created by the Unified platform.

externalId
string | null

An order number to link this order to an external system

couponCodes
string[] | null

Coupon codes associated with this order. Only set on order import.

invalidCoupons
object[] | null

A list of invalid coupons that were attempted on the order

amountAvailableForRefund
number<double>

This property represents AmountCaptured - AmountRefunded via returns. It is read only.

amountRemainingForPayment
number<double>

A counter for how much of the order total has not been claimed by payments. This is computed by Order.Total-(sum of Order.Payments where State is not voided/declined)

amountRefunded
number<double>

A counter for how much money has been issued in refunds. This calculated field does NOT include refunds issued in returns.

readyToCapture
boolean
isOptInForSms
boolean

Whether the shopper opts in to curbside text notifications.

forceSTHConsolidationOnSplitShipments
boolean | null

Overrides the Fulfillment SiteSetting value for ForceSTHConsolidationOnSplitShipments. TODO autogen instead of manual addition

forceDeliveryConsolidationOnSplitShipments
boolean | null

Overrides the Fulfillment SiteSetting value for ForceDeliveryConsolidationOnSplitShipments. TODO autogen instead of manual addition

subscriptionIds
string[] | null

All the subscriptions associated with the current order.

continuityOrderOrdinal
integer<int32>

The ordinal to track the Continuity order.

reservationId
string | null

Inventory Reservation id for order.

restrictEdit
boolean | null

Setting this flag on the order will restrict user from editing the order

restrictCancellation
boolean | null

Settings this flag on the order will restrict user from Cancelling the order

isContinuityOrder
boolean

Flag to check if the order is continuityOrder.

canceledItems
object[] | null

Items canceled on the Order due to Rule violation

shippingGroups
object[] | null

List of order grouping.