Get Subscriptions

get https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/subscriptions

Retrieves a list of subscriptions according to any specified filter criteria and sort options.

Response

Response body

object

startIndex

int32

pageSize

int32

pageCount

int32

totalCount

int32

items

array of objects | null

items

object

string | null

Unique identifier.

siteId

int32

Unique identifier of the Site.

tenantId

int32

Unique identifier of the Tenant.

number

int32

Subscription number.

parentOrderId

string | null

The parent order id from which the subscription was created.

items

array of objects | null

List of items in the Subscription.

items

object

string | null

Unique identifier of the order line item. System-supplied and read-only.

fulfillmentLocationCode

string | null

Location code from which to obtain this item

fulfillmentMethod

string | null

Fulfillment method used to fulfill this item

parentItemCode

string | null

Product code of the parent item if split because of the splitItemOnSubsription attribute on the item

isOnetimeItem

boolean

is onetime item

localeCode

string | null

Locale code for language that appears in text and descriptions on the site, for example, en_US.
This is not the currency code. Currently only en_US is supported.

purchaseLocation

string | null

The location where the product is being purchased.. default is null. Products can have different prices
by purchaseLocation via custom priceListResolution...

lineId

int32 | null

The line id assigned to the order item. Visible only in the Admin, this is set from the Admin or
in CommerceRuntime when a cart is converted to an order.

product

object

The product as it appears on the order item.

quantity

int32

Number of products ordered.

isRecurring

boolean | null

If true, the cart item lists a product that can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.

isTaxable

boolean | null

Not implemented. If true, the cart item is eligible for tax.

subtotal

double | null

Line item subtotal (quantity multiplied by price) before discounts.

extendedTotal

double | null

Line item extended total (quantity multiplied by unit extended price) before discounts.

taxableTotal

double | null

Line item subtotal (quantity multiplied by price) before discounts.

discountTotal

double | null

How much the shopper saves with the applied discount or sale price. This is a negative number.

discountedTotal

double | null

Subtotal minus any discounts.

itemTaxTotal

double | null

Total price of taxes that apply to products in this item.

shippingTaxTotal

double | null

Total price of taxes that apply to the shipping of this item.

shippingTotal

double | null

Total price of shipping that apply to this item.

handlingAmount

double | null

Handling Amount for this item

feeTotal

double | null

Not implemented. Total cost of fees that apply to this item.

total

double | null

Total price of this cart item taking into account any discounts.

unitPrice

object

Pricing details for the product listed on a cart item, including the original price, discount amount, and final price.

productDiscount

object

Discount applied to the order, which is a negative number to be subtracted from the original price to get the final price.
If multiple discounts for the order exist, this is the value most advantageous to the shopper.

productDiscounts

array of objects | null

A list of discounts applied to the product

productDiscounts

object

appliesToSalePrice

boolean | null

Determines if the discount applies to the sale price of the order

discountQuantity

int32

The number of the line item that can be used for this particular discount.

productQuantity

int32 | null

deprecated

Quantity of products priced. This is always one unless calculating pricing on the order or cart.

impactPerUnit

double | null

deprecated

Impact for a quantity of one product; that is, the value of the discount for one product.

impact

double | null

Value of the discount applied. This is a negative number to be subtracted from the original price to get the final price.

discount

object

Discounts that apply to the order, if any. For example, when the
subtotal of the order exceeds a certain amount, or for free shipping.

couponCode

string | null

Code of the coupon associated with the discount if a coupon code is required to get the discount.

excluded

boolean | null

Determines whether or not this discount is set up to be ignored by the pricing runtime.

data

object | null

Stores any custom data sent from external discounts.

Has additional fields

shippingDiscounts

array of objects | null

A discount applied to the shipping

shippingDiscounts

object

methodCode

string | null

Unique identifier of the shipping method discount.

discount

object

discountQuantity

int32

The number of the line item that can be used for this particular discount.

impactPerUnit

double

The impact of this discount pur discount quantity.

data

object | null

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

Has additional fields

taxData

object | null

Storage for any additional/custom tax data.

Has additional fields

auditInfo

object

shippingAmountBeforeDiscountsAndAdjustments

double | null

Shipping amount before Discounts and adjustments

weightedOrderAdjustment

double | null

Order Level Manual Adjustment applied to this Item

weightedOrderDiscount

double | null

Order Level Discount applied to this Item

adjustedLineItemSubtotal

double | null

Order Level taxable sub total

totalWithoutWeightedShippingAndHandling

double | null

Taxable Subtotal including Weighted Order amounts

weightedOrderTax

double | null

Order Level tax applied to this Item

weightedOrderShipping

double | null

Order Level Shipping applied to this Item

weightedOrderShippingDiscount

double | null

Order Level Shipping discount applied to this Item

weightedOrderShippingManualAdjustment

double | null

Order Level Shipping Manual Adjustment applied to this Item

weightedOrderShippingTax

double | null

Order Level Shipping Tax applied to this Item

weightedOrderHandlingFee

double | null

Order Level handling fee applied to this item

weightedOrderHandlingFeeTax

double | null

Order Level handling fee tax applied to this item

weightedOrderHandlingFeeDiscount

double | null

Order Level handling fee discount applied to this item

weightedOrderDuty

double | null

Order Level Duty applied to this Item

totalWithWeightedShippingAndHandling

double | null

Line item total with line item, Tax, Weighted Tax with Weighted shipping and handling costs

weightedOrderHandlingAdjustment

double | null

Order level handling adjusment that applies to this item.

autoAddDiscountId

int32 | null

Track the discoutid from which the item was auto added

isAssemblyRequired

boolean

Assembly Required for this order item

childItemIds

array of strings | null

List of Child Item Ids for this order item

childItemIds

parentItemId

string | null

Indicates Parent Item Id for this order item

inventoryTags

array of objects | null

inventoryTags

object

name

string | null

value

string | null

lineItemAdjustment

double | null

dutyAmount

double | null

Indicate Duty Amount for this item.

substituteInfo

object

payment

object

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

priceListCode

string | null

Price-list code for the Subscription

notes

array of objects | null

Notes

notes

object

string | null

Unique identifier of the note. System-supplied and read-only.

text

string | null

Text of the note. Maximum 250 characters.

auditInfo

object

changeMessages

array of objects | null

Change Messages

changeMessages

object

string | null

Unique identifier of the message. System-supplied. Read-only.

correlationId

string | null

Correlation Id

userId

string | null

User Id that identifies the user that performed the related change

userFirstName

string | null

User First Name

userLastName

string | null

User Last Name

userScopeType

string | null

User Type (e.g. Shopper, Admin, etc.)

appId

string | null

App Id that identifies the user that performed the related change

appKey

string | null

App Key

appName

string | null

App Name

subjectType

string | null

Subject of the message, for example, "Product." System-supplied. Read-only.

success

boolean | null

Indicates if the message is related to a success or failure.

identifier

string | null

Unique identifier to what the message pertains, which can be a cart item, cart or another generic entity. System-supplied. Read-only.

subject

string | null

Text on the subject line of the message, for example, the product name. System-supplied. Read-only.

verb

string | null

Action applicable to the message. This can be "Increased," when the product price has increased, "Decreased," when the
product price has decreased, and "Invalidated," when the product is no longer available. System-supplied. Read-only.

message

string | null

Human readable message. System-supplied. Read-only.

metadata

string

Data. This property will be a JSON array that will contain 0-N items, when there is 1 item it will still be an array containing only one item. System-supplied. Read-only.

oldValue

string | null

deprecated

Original price of the item. System-supplied. Read-only.

newValue

string | null

deprecated

Current price of the item. System-supplied. Read-only.

amount

double | null

deprecated

Monetary amount that pertains to the change if applicable

createDate

date-time | null

When the message was created. System-supplied. Read-only.

attributes

object | null

Additional Data. This property will be a Dictionary of objects.

Has additional fields

auditInfo

object

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

userId

string | null

customerAccountId

int32 | null

Unique identifier of the customer account.

string | null

Email address for checkout

customerTaxId

string | null

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

isTaxExempt

boolean | null

Unique identifier of the customer account.

currencyCode

string | null

ISO Currency Code.

data

object | null

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

Has additional fields

taxData

object | null

Storage for any additional/custom tax data.

Has additional fields

channelCode

string | null

Unique identifier of the channel for this item.

locationCode

string | null

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

ipAddress

string | null

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

sourceDevice

string | null

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

visitId

string | null

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

webSessionId

string | null

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

customerInteractionType

string | null

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

frequency

object

previousFrequency

object

frequencyAuditInfo

object

nextOrderDate

date-time | null

previousNextOrderDate

date-time | null

nextOrderDateAuditInfo

object

lastContinuityOrderDateOnSubPaused

date-time | null

ordinal

int32

paymentErrorCode

string | null

trial

object

orderDiscounts

array of objects | null

orderDiscounts

object

impact

double | null

Value of the discount applied. This is a negative number to be subtracted from the original price to get the final price.

discount

object

Discounts that apply to the order, if any. For example, when the
subtotal of the order exceeds a certain amount, or for free shipping.

couponCode

string | null

Code of the coupon associated with the discount if a coupon code is required to get the discount.

excluded

boolean | null

Determines whether or not this discount is set up to be ignored by the pricing runtime.

data

object | null

Stores any custom data sent from external discounts.

Has additional fields

subTotal

double

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

itemLevelProductDiscountTotal

double

The total value of item-level product discounts.

itemLevelAdjustmentsTotal

double

The total value of all line item adjustments

orderLevelProductDiscountTotal

double

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

itemTaxTotal

double

Total tax on products.

adjustment

object

itemTotal

double

The total product cost, accounting for discounts and tax.

total

double

Final total

shippingDiscounts

array of objects | null

shippingDiscounts

object

methodCode

string | null

Unique identifier of the shipping method discount.

discount

object

itemLevelShippingDiscountTotal

double

orderLevelShippingDiscountTotal

double

shippingAmount

double

shippingAdjustment

object

shippingSubTotal

double

shippingTax

double | null

shippingTaxTotal

double

shippingTotal

double

handlingDiscounts

array of objects | null

handlingDiscounts

object

impact

double | null

Value of the discount applied. This is a negative number to be subtracted from the original price to get the final price.

discount

object

Discounts that apply to the order, if any. For example, when the
subtotal of the order exceeds a certain amount, or for free shipping.

couponCode

string | null

Code of the coupon associated with the discount if a coupon code is required to get the discount.

excluded

boolean | null

Determines whether or not this discount is set up to be ignored by the pricing runtime.

data

object | null

Stores any custom data sent from external discounts.

Has additional fields

itemLevelHandlingDiscountTotal

double

orderLevelHandlingDiscountTotal

double

handlingAmount

double | null

handlingAdjustment

object

handlingSubTotal

double

handlingTax

double | null

handlingTaxTotal

double

handlingTotal

double

dutyAmount

double | null

dutyTotal

double

feeTotal

double

status

string | null

reasons

array of objects | null

reasons

object

reasonCode

string | null

description

string | null

moreInfo

string | null

actionName

string | null

couponCodes

array of strings | null

Coupon codes associated with this Subscription.

couponCodes

invalidCoupons

array of objects | null

A list of invalid coupons that were attempted on the Subscription

invalidCoupons

object

couponCode

string | null

Code that identifies the coupon.

reasonCode

int32

Code that identifies the reason the coupon was invalid.

reason

string | null

Description text of the reason.

createDate

date-time

Create date of the invalid coupon.

discountId

int32

isImport

boolean

externalId

string | null

lineItemSubtotalWithOrderAdjustments

double | null

Line Item Subtotals with Order Adjustments

discountedSubtotal

double

Discounted Subtotal

nextOrderDateOffsetCounter

int32 | null

counter to keep track of nextOrderDate limit.

skipCounter

int32 | null

counter to keep track of skip limit

isDraft

boolean | null

Is this subscription a draft version

hasDraft

boolean | null

Does this subscription have a draft version.

isPartialDraft

boolean

Is this subscription draft is a partial draft.

isOrderReminderEmailSent

boolean

Has order reminder email sent.

isReactivationReminderEmailSent

boolean

Has reactivation reminder email sent.

reactivationDate

date-time

This property is being used for reactivation email templete

pauseDate

date-time | null

attributes

array of objects | null

attributes

object

auditInfo

object

fullyQualifiedName

string | null

attributeDefinitionId

int32 | null

values

array | null

values

processingErrorMessage

string | null

LastErrorMessage from subscription ProcessingInfo.

lastOrderNowDate

date-time | null

Indicate when "order now" and "partial order now" performed last time.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://t0-s0.sandbox.mozu.com/api/commerce/subscriptions \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success