A valid request URL is required to generate request examples{
"id": "<string>",
"siteId": 123,
"tenantId": 123,
"number": 123,
"parentOrderId": "<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>",
"fulfillmentLocationCode": "<string>",
"fulfillmentMethod": "<string>",
"parentItemCode": "<string>",
"isOnetimeItem": true,
"shippingMethodCode": "<string>",
"shippingMethodName": "<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>"
},
"priceListCode": "<string>",
"notes": [
{
"id": "<string>",
"text": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<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": {}
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<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>"
}
},
"userId": "<string>",
"customerAccountId": 123,
"email": "<string>",
"customerTaxId": "<string>",
"isTaxExempt": true,
"currencyCode": "<string>",
"data": {},
"taxData": {},
"channelCode": "<string>",
"locationCode": "<string>",
"ipAddress": "<string>",
"sourceDevice": "<string>",
"visitId": "<string>",
"webSessionId": "<string>",
"customerInteractionType": "<string>",
"frequency": {
"unit": "<string>",
"value": 123
},
"previousFrequency": {
"unit": "<string>",
"value": 123
},
"frequencyAuditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"nextOrderDate": "2023-11-07T05:31:56Z",
"previousNextOrderDate": "2023-11-07T05:31:56Z",
"nextOrderDateAuditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"lastContinuityOrderDateOnSubPaused": "2023-11-07T05:31:56Z",
"ordinal": 123,
"paymentErrorCode": "<string>",
"trial": {
"enabled": true,
"duration": 123,
"substituteProductCode": "<string>",
"substituteProductQuantity": 123,
"substituteVariationProductCode": "<string>",
"substituteProductOptions": [
{
"name": "<string>",
"value": "<unknown>",
"shopperEnteredValue": "<unknown>",
"attributeFQN": "<string>",
"dataType": "<string>",
"stringValue": "<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": {}
}
],
"subTotal": 123,
"itemLevelProductDiscountTotal": 123,
"itemLevelAdjustmentsTotal": 123,
"orderLevelProductDiscountTotal": 123,
"itemTaxTotal": 123,
"adjustment": {
"amount": 123,
"description": "<string>",
"internalComment": "<string>"
},
"itemTotal": 123,
"total": 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": {}
}
}
],
"itemLevelShippingDiscountTotal": 123,
"orderLevelShippingDiscountTotal": 123,
"shippingAmount": 123,
"shippingAdjustment": {
"amount": 123,
"description": "<string>",
"internalComment": "<string>"
},
"shippingSubTotal": 123,
"shippingTax": 123,
"shippingTaxTotal": 123,
"shippingTotal": 123,
"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": {}
}
],
"itemLevelHandlingDiscountTotal": 123,
"orderLevelHandlingDiscountTotal": 123,
"handlingAmount": 123,
"handlingAdjustment": {
"amount": 123,
"description": "<string>",
"internalComment": "<string>"
},
"handlingSubTotal": 123,
"handlingTax": 123,
"handlingTaxTotal": 123,
"handlingTotal": 123,
"dutyAmount": 123,
"dutyTotal": 123,
"feeTotal": 123,
"status": "<string>",
"reasons": [
{
"reasonCode": "<string>",
"description": "<string>",
"moreInfo": "<string>",
"actionName": "<string>"
}
],
"couponCodes": [
"<string>"
],
"invalidCoupons": [
{
"couponCode": "<string>",
"reasonCode": 123,
"reason": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"discountId": 123
}
],
"isImport": true,
"externalId": "<string>",
"lineItemSubtotalWithOrderAdjustments": 123,
"discountedSubtotal": 123,
"nextOrderDateOffsetCounter": 123,
"skipCounter": 123,
"isDraft": true,
"hasDraft": true,
"isPartialDraft": true,
"isOrderReminderEmailSent": true,
"isReactivationReminderEmailSent": true,
"reactivationDate": "2023-11-07T05:31:56Z",
"pauseDate": "2023-11-07T05:31:56Z",
"attributes": [
{
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"fullyQualifiedName": "<string>",
"attributeDefinitionId": 123,
"values": [
"<unknown>"
]
}
],
"processingErrorMessage": "<string>",
"lastOrderNowDate": "2023-11-07T05:31:56Z"
}Update the info for an existing subscription
A valid request URL is required to generate request examples{
"id": "<string>",
"siteId": 123,
"tenantId": 123,
"number": 123,
"parentOrderId": "<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>",
"fulfillmentLocationCode": "<string>",
"fulfillmentMethod": "<string>",
"parentItemCode": "<string>",
"isOnetimeItem": true,
"shippingMethodCode": "<string>",
"shippingMethodName": "<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>"
},
"priceListCode": "<string>",
"notes": [
{
"id": "<string>",
"text": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<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": {}
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<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>"
}
},
"userId": "<string>",
"customerAccountId": 123,
"email": "<string>",
"customerTaxId": "<string>",
"isTaxExempt": true,
"currencyCode": "<string>",
"data": {},
"taxData": {},
"channelCode": "<string>",
"locationCode": "<string>",
"ipAddress": "<string>",
"sourceDevice": "<string>",
"visitId": "<string>",
"webSessionId": "<string>",
"customerInteractionType": "<string>",
"frequency": {
"unit": "<string>",
"value": 123
},
"previousFrequency": {
"unit": "<string>",
"value": 123
},
"frequencyAuditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"nextOrderDate": "2023-11-07T05:31:56Z",
"previousNextOrderDate": "2023-11-07T05:31:56Z",
"nextOrderDateAuditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"lastContinuityOrderDateOnSubPaused": "2023-11-07T05:31:56Z",
"ordinal": 123,
"paymentErrorCode": "<string>",
"trial": {
"enabled": true,
"duration": 123,
"substituteProductCode": "<string>",
"substituteProductQuantity": 123,
"substituteVariationProductCode": "<string>",
"substituteProductOptions": [
{
"name": "<string>",
"value": "<unknown>",
"shopperEnteredValue": "<unknown>",
"attributeFQN": "<string>",
"dataType": "<string>",
"stringValue": "<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": {}
}
],
"subTotal": 123,
"itemLevelProductDiscountTotal": 123,
"itemLevelAdjustmentsTotal": 123,
"orderLevelProductDiscountTotal": 123,
"itemTaxTotal": 123,
"adjustment": {
"amount": 123,
"description": "<string>",
"internalComment": "<string>"
},
"itemTotal": 123,
"total": 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": {}
}
}
],
"itemLevelShippingDiscountTotal": 123,
"orderLevelShippingDiscountTotal": 123,
"shippingAmount": 123,
"shippingAdjustment": {
"amount": 123,
"description": "<string>",
"internalComment": "<string>"
},
"shippingSubTotal": 123,
"shippingTax": 123,
"shippingTaxTotal": 123,
"shippingTotal": 123,
"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": {}
}
],
"itemLevelHandlingDiscountTotal": 123,
"orderLevelHandlingDiscountTotal": 123,
"handlingAmount": 123,
"handlingAdjustment": {
"amount": 123,
"description": "<string>",
"internalComment": "<string>"
},
"handlingSubTotal": 123,
"handlingTax": 123,
"handlingTaxTotal": 123,
"handlingTotal": 123,
"dutyAmount": 123,
"dutyTotal": 123,
"feeTotal": 123,
"status": "<string>",
"reasons": [
{
"reasonCode": "<string>",
"description": "<string>",
"moreInfo": "<string>",
"actionName": "<string>"
}
],
"couponCodes": [
"<string>"
],
"invalidCoupons": [
{
"couponCode": "<string>",
"reasonCode": 123,
"reason": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"discountId": 123
}
],
"isImport": true,
"externalId": "<string>",
"lineItemSubtotalWithOrderAdjustments": 123,
"discountedSubtotal": 123,
"nextOrderDateOffsetCounter": 123,
"skipCounter": 123,
"isDraft": true,
"hasDraft": true,
"isPartialDraft": true,
"isOrderReminderEmailSent": true,
"isReactivationReminderEmailSent": true,
"reactivationDate": "2023-11-07T05:31:56Z",
"pauseDate": "2023-11-07T05:31:56Z",
"attributes": [
{
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"fullyQualifiedName": "<string>",
"attributeDefinitionId": 123,
"values": [
"<unknown>"
]
}
],
"processingErrorMessage": "<string>",
"lastOrderNowDate": "2023-11-07T05:31:56Z"
}JWT Authorization header using the Bearer scheme.
The subscription identifier.
limits which fields are returned in the response body
The subscription.
Unique identifier.
Unique identifier of the Site.
Unique identifier of the Tenant.
Subscription number.
The parent order id from which the subscription was created.
List of items in the Subscription.
Show child attributes
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. (PayPal not currently supported.)
Show child attributes
Price-list code for the Subscription
Notes
Show child attributes
Change Messages
Show child attributes
Show child attributes
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).
Show child attributes
Unique identifier of the customer account.
Email address for checkout
ISO Currency Code.
Custom data for a given vendor set within the commerce process.
Storage for any additional/custom tax data.
Unique identifier of the channel for this item.
Identifies the location at which the order was placed if the order was placed externally.
IP address of the user placing the order. (User or customer?)
Source device of the user placing the order. (User or customer?)
Identifies the Visit ID that was current when the order was placed or when the cart was last updated.
Identifies the web session used to place the order or last update the cart.
Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Subtotal before any coupon codes, taxes, fees, etc.
The total value of item-level product discounts.
The total value of all line item adjustments
The total value of order-level (group-level) product discounts.
Total tax on products.
Show child attributes
The total product cost, accounting for discounts and tax.
Final total
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Coupon codes associated with this Subscription.
A list of invalid coupons that were attempted on the Subscription
Show child attributes
Line Item Subtotals with Order Adjustments
Discounted Subtotal
counter to keep track of nextOrderDate limit.
counter to keep track of skip limit
Is this subscription a draft version
Does this subscription have a draft version.
Is this subscription draft is a partial draft.
Has order reminder email sent.
Has reactivation reminder email sent.
This property is being used for reactivation email templete
Show child attributes
LastErrorMessage from subscription ProcessingInfo.
Indicate when "order now" and "partial order now" performed last time.
Success
Unique identifier.
Unique identifier of the Site.
Unique identifier of the Tenant.
Subscription number.
The parent order id from which the subscription was created.
List of items in the Subscription.
Show child attributes
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. (PayPal not currently supported.)
Show child attributes
Price-list code for the Subscription
Notes
Show child attributes
Change Messages
Show child attributes
Show child attributes
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).
Show child attributes
Unique identifier of the customer account.
Email address for checkout
The customers tax ID. If Customer Account ID exists in the system, will set this.
Unique identifier of the customer account.
ISO Currency Code.
Custom data for a given vendor set within the commerce process.
Storage for any additional/custom tax data.
Unique identifier of the channel for this item.
Identifies the location at which the order was placed if the order was placed externally.
IP address of the user placing the order. (User or customer?)
Source device of the user placing the order. (User or customer?)
Identifies the Visit ID that was current when the order was placed or when the cart was last updated.
Identifies the web session used to place the order or last update the cart.
Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Subtotal before any coupon codes, taxes, fees, etc.
The total value of item-level product discounts.
The total value of all line item adjustments
The total value of order-level (group-level) product discounts.
Total tax on products.
Show child attributes
The total product cost, accounting for discounts and tax.
Final total
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Coupon codes associated with this Subscription.
A list of invalid coupons that were attempted on the Subscription
Show child attributes
Line Item Subtotals with Order Adjustments
Discounted Subtotal
counter to keep track of nextOrderDate limit.
counter to keep track of skip limit
Is this subscription a draft version
Does this subscription have a draft version.
Is this subscription draft is a partial draft.
Has order reminder email sent.
Has reactivation reminder email sent.
This property is being used for reactivation email templete
Show child attributes
LastErrorMessage from subscription ProcessingInfo.
Indicate when "order now" and "partial order now" performed last time.