Remove Coupon

delete https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/orders/{orderId}/coupons/{couponCode}

Removes a coupon that had been previously applied to the order.

Response

Response body

object

orderNumber

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

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

int32 | null

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

partialOrderNumber

int32 | null

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

partialOrderCount

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

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

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

array of strings | null

Actions available to the payment

availableActions

shopperNotes

object

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

giftMessage

string | null

Gift message associated with this order.

comments

string | null

Comments associated with this order.

deliveryInstructions

string | null

DeliveryInstructions associated with this order.

customerAccountId

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.

string | null

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

alternateContact

object

firstName

string | null

First Name of alternate contact during order process

lastNameOrSurname

string | null

Last Name of alternate contact during order process

emailAddress

string | null

Email Address of alternate contact during order process

phoneNumber

string | null

Phone Number of alternate contact during order process

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

double

Total amount of money collected on the order via payments.

attributes

array of objects | null

attributes

object

auditInfo

object

fullyQualifiedName

string | null

attributeDefinitionId

int32 | null

values

array | null

values

adjustment

object

amount

double | null

description

string | null

internalComment

string | null

shippingAdjustment

object

amount

double | null

description

string | null

internalComment

string | null

handlingAdjustment

object

amount

double | null

description

string | null

internalComment

string | null

shippingDiscounts

array of objects | null

shippingDiscounts

object

methodCode

string | null

Unique identifier of the shipping method discount.

discount

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.

handlingDiscounts

array of objects | null

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

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

handlingAmount

double | null

Order level handling fees excluding any discounts.

handlingSubTotal

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

double | null

Handling fees including any discounts.

dutyAmount

double | null

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

dutyTotal

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

date-time | null

When the customer placed (submitted) the order.

shipmentCreationOffset

int32 | null

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

releaseShipmentDate

date-time | null

cancelledDate

date-time | null

Date the order was cancelled.

closedDate

date-time | null

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

acceptedDate

date-time | null

When the order was accepted by the merchant

notes

array of objects | null

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

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

items

array of objects | null

List of items in the order.

items

object

string | null

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

destinationId

string | null

The destination associated with this item when used with a multi-ship checkout.

originalCartItemId

string | null

Unique identifier of the cart item that is associated with this line item.
(This is the original Cart Item ID expressed as a GUID.)

fulfillmentLocationCode

string | null

Location code from which to obtain this item

fulfillmentMethod

string | null

Fulfillment method used to fulfill this item

dutyAmount

double | null

Indicate Duty Amount for this item.

expectedDeliveryDate

date-time | null

Expected Delivery Date of shipment

subscription

object

isReservationEnabled

boolean

Flag to indicate reserve inventory in cart

giftInfo

object

priceMode

string | null

Determines if the item is using external or internal(catalog) pricing

returnRuleInfo

object

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

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

substituteInfo

object

validationResults

array of objects | null

Validation results for the order when processes against validation capabilities.

validationResults

object

validationId

string | null

Identifier set by the capability that states the id of this specific validation attempt

validatorName

string | null

Identifier set by the capability that states the specific name of this validator.

validatorType

string | null

Identifies the type of the validator (types are enumerated in OrderValidatorTypeConst)

status

string | null

Status of the order validation result. See OrderValidatorStatusConst for options.

createdDate

date-time | null

DateTime that this validation result was created

messages

array of objects | null

Messages returned by the order validator

messages

object

orderItemId

string | null

Order item id that this message applies to. Can be empty.

messageType

string | null

Identifier to indicate the type of the message, See OrderValidatorMessageTypeConst for options.

message

string | null

Actual message returned by the validator.

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.

paymentType

string | null

Type of payment, such as credit card, check by mail, or PayPal.
see Mozu.CommerceRuntime.Contracts.Payments.PaymentTypeConst for valid values

paymentWorkflow

string | null

billingContact

object

isSameBillingShippingAddress

boolean

Indicates that billing and shipping address are the same

card

object

If the customer is paying by credit card, the card holder's details, such as the name on the card, number, billing
address, and expiration dates.

token

object

purchaseOrder

object

Purchase order payment

check

object

auditInfo

object

storeCreditCode

string | null

The store credit to use for this purchase

storeCreditType

string | null

The type of store credit used for this purchase

customCreditType

string | null

Name of custom stored credit type

externalTransactionId

string | null

Transaction Id from third party payment source like Visa Checkout, Amazon

isRecurring

boolean

Indicates whether the payment is used in recurring transactions. ex- subscription payments

recurringTransactionId

string | null

Recurring Payment Id returned by Payment Gateway
networkTransactionId for vantiv
previousTransactionId for cybersource etc

data

object | null

Custom data from payment providers

Has additional fields

payments

array of objects | 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.

payments

object

string | null

Unique identifier of this order transaction.

groupId

object

paymentServiceTransactionId

string | null

Unique identifier of the transaction, specified by the payment service processesing this transaction.

availableActions

array of strings | null

Actions available to the payment

availableActions

orderId

string | null

Unique identifier of the order with which this transaction is associated.

paymentType

string | null

Type of Payment

paymentWorkflow

string | null

The source of data for this payment. By default, this will be set to 'mozu'

externalTransactionId

string | null

The external/third party transaction Id for this payment. This is used to store the transaction Id from digital wallet like Visa Checkout

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.

data

object | null

Custom data from payment providers

Has additional fields

status

string | null

Current status of this transaction which are described by the PaymentStatusConst class.

subPayments

array of objects | null

List of sub payments that correspond to child orders in case of multiship orders.

subPayments

object

status

string | null

amountCollected

double

amountCredited

double

amountRequested

double

amountRefunded

double

target

object

interactions

array of objects | null

List of intereactions for this transaction. A transaction is created upon authorization and lasts across the payment
interchange, which can consist of multiple interactions, such as consecutive captures.

interactions

object

string | null

Unique identifier of this payment transaction interaction.

gatewayInteractionId

int32 | null

Unique identifier of the gateway interaction. Used for credit card transactions, where the
payment service creates a GatewayInteractionId for each transaction interaction.

paymentId

string | null

Unique identifier of the original transaction of which this current interaction is a part.

orderId

string | null

Unique identifier of the order with which this transaction is associated.

target

object

currencyCode

string | null

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

interactionType

string | null

Types of transaction interactions which can be "Authorization," "Capture," "AuthorizeAndCapture,"
"Void," or "Credit," "CheckRequested," or "CheckReceived."

checkNumber

string | null

If paying by check, the check number.

status

string | null

Status of the payment transaction interaction which can be either "Success" or "Failure."

paymentEntryStatus

string | null

Status of the payment when the transaction interaction was created

isRecurring

boolean | null

If true, the product is purchased or fulfilled at regular intervals, for example, a monthly billing or a subscription. (Not currently implemented.)

isManual

boolean

If the payment is a manual payment, this is set to true

isPending

boolean

If true, indicates payment action is still pending and not yet confirmed.

gatewayTransactionId

string | null

Unique identifier of the transaction supplied by PCIaaS.

gatewayAuthCode

string | null

If required by the payment gateway, the authorization code of the transaction. Supplied by PCIaaS.

gatewayAVSCodes

string | null

Gateway AVS Codes. Supplied by PCIaaS.

gatewayCVV2Codes

string | null

Gateway CVV2 Codes. Supplied by PCIaaS.

gatewayResponseCode

string | null

Gateway response code. Supplied by PCIaaS.

gatewayResponseText

string | null

Gateway response text. Supplied by PCIaaS.

gatewayResponseData

array of objects | null

A List of payment response data required to act on authorization when using external order management systems

gatewayResponseData

object

key

string | null

Key from payment gateway

value

string | null

Value from payment gateway

paymentTransactionInteractionIdReference

int32 | null

Unique identifier of previous PaymentTransactionInteraction that this PaymentTransactionInteraction is modifying.
For instance, when crediting a capture, set the PaymentTransactionInteractionIdReference to the capture PaymentTransactionInteractionID.

amount

double | null

Amount of funds associated with this interaction.

note

string | null

Note to be entered by merchant/application

interactionDate

date-time | null

Date the interaction occurred

auditInfo

object

returnId

string | null

Return Id, if the interaction is a Credit for a return-refund.

refundId

string | null

Refund Id, if the interaction is for a stand alone refund.

capturableShipmentsSummary

array of objects | null

Stores pairings of shipment number to shipment total for all captured shipments. This was added for generating TLogs.

capturableShipmentsSummary

object

shipmentNumber

int32

The identifying number of the shipment affected by the payment action

shipmentTotal

double

The shipment's total when the payment action occurred

amountApplied

double

The amount applied by the payment action

isRecurring

boolean

If true, the product is purchased or fulfilled at regular intervals, for example,
monthly billing or a subscription. (Not currently supported.)

amountCollected

double

Amount collected on the payment

amountCredited

double

Amount credited back to the payment.

amountRequested

double

Derived from the Amount on the initial payment create, used to help storefront determine how much can be captured for multiple payments.
See Order.AmountRemainingForPayment for an example.

changeMessages

array of objects | null

Change messages related to the payment.

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

gatewayGiftCard

object

installmentPlanCode

string | null

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

refunds

array of objects | 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.

refunds

object

string | null

Unique identifier of this order transaction.

orderId

string | null

Unique identifier of the order with which this refund is associated.

reason

string | null

Merchant-entered reason for this refund.

reasonCode

string | null

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

amount

double

Amount refunded.

refundMethod

string | null

Refund Method.

auditInfo

object

credits

array of objects | null

credits

object

string | null

Unique identifier of this order transaction.

parentPaymentId

string | null

The paymentid of the Parent Payment associated with this Credit (if applicable).

parentPaymentInteractionId

string | null

amount

double

Amount credited.

giftCard

object

auditInfo

object

packages

array of objects | null

Shipping package associated with this order.

packages

object

shippingMethodCode

string | null

Code describing the shipping method.

shippingMethodName

string | null

Name of the shipping method

shipmentId

string | null

ID of the related shipment

trackingNumber

string | null

Tracking number of this package (to support classic use cases)

trackingNumbers

array of strings | null

Tracking number of this package

trackingNumbers

packagingType

string | null

Packaging type of this package

hasLabel

boolean

If there is a shipping label present for this Package, this will be set to true

measurements

object

Physical dimensions of the package required to ship the product and its weight.

carrier

string | null

Carrier of this package

signatureRequired

boolean | null

SignatureRequired for this package

trackings

array of objects | null

Tracking number and url data for this package

trackings

object

attributes

object | null

Has additional fields

number

string | null

url

string | null

packingSlipItemDetails

array of objects | null

PackingSlipItemDetails for this package

packingSlipItemDetails

object

attributes

object | null

Gets or Sets Attributes

Has additional fields

lineId

int32 | null

Gets or Sets LineId

originalOrderItemId

string | null

Gets or Sets OriginalOrderItemId

quantity

int32 | null

Gets or Sets Quantity

packingSlipNumber

int32 | null

PackingSlipNumber for this package

returnTrackings

array of objects | null

returnTrackings

object

attributes

object | null

Has additional fields

number

string | null

url

string | null

returnTrackingNumbers

array of strings | null

returnTrackingNumbers

returnCarrier

string | null

packageId

string | null

manifestId

string | null

labelFormat

string | null

integratorId

string | null

fxcbPackNotificationId

string | null

fxcbDocumentsUrl

string | null

attributes

object | null

Has additional fields

string | null

ID of the fulfillment unit.

code

string | null

A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form
{fulfillmentUnitType} #{next available int}

status

string | null

Status of the fulfillment unit
See FulfillmentStatusConst

items

array of objects | null

List of items in the fulfillment unit

items

object

productCode

string | null

Code of the Product to be fulfilled.

quantity

int32

Quantity of the order item

fulfillmentItemType

string | null

The type of fulfillment item

lineId

int32 | null

The line id associated with the fulfillment.

optionAttributeFQN

string | null

fulfillmentDate

date-time | null

Date of the pickup

fulfillmentLocationCode

string | null

Location code from which to obtain this item

auditInfo

object

availableActions

array of strings | null

Actions that can be taken on this fulfillment unit

availableActions

changeMessages

array of objects | null

Change messages related to the fulfillment unit.

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

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

pickups

array of objects | null

Fulfillment pickups associated with this order.

pickups

object

string | null

ID of the fulfillment unit.

code

string | null

A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form
{fulfillmentUnitType} #{next available int}

status

string | null

Status of the fulfillment unit
See FulfillmentStatusConst

items

array of objects | null

List of items in the fulfillment unit

items

object

productCode

string | null

Code of the Product to be fulfilled.

quantity

int32

Quantity of the order item

fulfillmentItemType

string | null

The type of fulfillment item

lineId

int32 | null

The line id associated with the fulfillment.

optionAttributeFQN

string | null

fulfillmentDate

date-time | null

Date of the pickup

fulfillmentLocationCode

string | null

Location code from which to obtain this item

auditInfo

object

availableActions

array of strings | null

Actions that can be taken on this fulfillment unit

availableActions

changeMessages

array of objects | null

Change messages related to the fulfillment unit.

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

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

digitalPackages

array of objects | null

Fulfillment digital packages associated with this order.

digitalPackages

object

string | null

ID of the fulfillment unit.

code

string | null

A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form
{fulfillmentUnitType} #{next available int}

status

string | null

Status of the fulfillment unit
See FulfillmentStatusConst

items

array of objects | null

List of items in the fulfillment unit

items

object

giftCardCode

string | null

productCode

string | null

Code of the Product to be fulfilled.

quantity

int32

Quantity of the order item

fulfillmentItemType

string | null

The type of fulfillment item

lineId

int32 | null

The line id associated with the fulfillment.

optionAttributeFQN

string | null

fulfillmentDate

date-time | null

Date of the pickup

fulfillmentLocationCode

string | null

Location code from which to obtain this item

auditInfo

object

availableActions

array of strings | null

Actions that can be taken on this fulfillment unit

availableActions

changeMessages

array of objects | null

Change messages related to the fulfillment unit.

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

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

shipments

array of objects | null

Package shipments associated with this order.

shipments

object

string | null

ID of the shipment

externalShipmentId

string | null

number

int32 | null

orderId

string | null

orderNumber

int32

string | null

currencyCode

string | null

customerAccountId

int32 | null

customerTaxId

string | null

shipmentType

string | null

shippingMethodCode

string | null

shippingMethodName

string | null

fulfillmentLocationCode

string | null

origin

object

destination

object

shipmentStatus

string | null

shipmentStatusReason

object

transferShipmentNumbers

array of int32s | null

transferShipmentNumbers

isTransfer

boolean | null

originalShipmentNumber

int32 | null

parentCheckoutNumber

int32 | null

parentShipmentNumber

int32 | null

fulfillmentStatus

string | null

workflowProcessId

string | null

workflowProcessContainerId

string | null

workflowState

object

backorderCreatedDate

int32 | null

fulfillmentDate

date-time | null

futureDate

date-time | null

orderSubmitDate

date-time | null

pickStatus

string | null

pickType

string | null

changeMessages

array of objects | null

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

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

packages

array of objects | null

packages

object

shippingMethodCode

string | null

Code describing the shipping method.

shippingMethodName

string | null

Name of the shipping method

shipmentId

string | null

ID of the related shipment

trackingNumber

string | null

Tracking number of this package (to support classic use cases)

trackingNumbers

array of strings | null

Tracking number of this package

trackingNumbers

packagingType

string | null

Packaging type of this package

hasLabel

boolean

If there is a shipping label present for this Package, this will be set to true

measurements

object

Physical dimensions of the package required to ship the product and its weight.

carrier

string | null

Carrier of this package

signatureRequired

boolean | null

SignatureRequired for this package

trackings

array of objects | null

Tracking number and url data for this package

trackings

object

attributes

object | null

Has additional fields

number

string | null

url

string | null

packingSlipItemDetails

array of objects | null

PackingSlipItemDetails for this package

packingSlipItemDetails

object

attributes

object | null

Gets or Sets Attributes

Has additional fields

lineId

int32 | null

Gets or Sets LineId

originalOrderItemId

string | null

Gets or Sets OriginalOrderItemId

quantity

int32 | null

Gets or Sets Quantity

packingSlipNumber

int32 | null

PackingSlipNumber for this package

returnTrackings

array of objects | null

returnTrackings

object

attributes

object | null

Has additional fields

number

string | null

url

string | null

returnTrackingNumbers

array of strings | null

returnTrackingNumbers

returnCarrier

string | null

packageId

string | null

manifestId

string | null

labelFormat

string | null

integratorId

string | null

fxcbPackNotificationId

string | null

fxcbDocumentsUrl

string | null

attributes

object | null

Has additional fields

string | null

ID of the fulfillment unit.

code

string | null

A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form
{fulfillmentUnitType} #{next available int}

status

string | null

Status of the fulfillment unit
See FulfillmentStatusConst

items

array of objects | null

List of items in the fulfillment unit

items

object

productCode

string | null

Code of the Product to be fulfilled.

quantity

int32

Quantity of the order item

fulfillmentItemType

string | null

The type of fulfillment item

lineId

int32 | null

The line id associated with the fulfillment.

optionAttributeFQN

string | null

fulfillmentDate

date-time | null

Date of the pickup

fulfillmentLocationCode

string | null

Location code from which to obtain this item

auditInfo

object

availableActions

array of strings | null

Actions that can be taken on this fulfillment unit

availableActions

changeMessages

array of objects | null

Change messages related to the fulfillment unit.

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

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

items

array of objects | null

items

object

lineId

int32

originalOrderItemId

string | null

parentId

string | null

productCode

string | null

variationProductCode

string | null

optionAttributeFQN

string | null

name

string | null

auditInfo

object

fulfillmentLocationCode

string | null

imageUrl

string | null

isTaxable

boolean

quantity

int32

unitPrice

double

actualPrice

double

overridePrice

double | null

itemDiscount

double

lineItemCost

double

itemTax

double

shipping

double

shippingDiscount

double

shippingTax

double

handling

double

handlingDiscount

double

handlingTax

double

duty

double

isPackagedStandAlone

boolean | null

readyForPickupQuantity

int32 | null

backorderReleaseDate

date-time | null

measurements

object

Physical dimensions of the package required to ship the product and its weight.

options

array of objects | null

options

object

name

string | null

Name of the product option that appears with the order item in the language specified by LocaleCode.

value

string

Value of the product option.

shopperEnteredValue

string

The value entered by the shopper if this is an option that requires shopper input, for example, a monogram.

attributeFQN

string | null

Value of the product option.

dataType

string | null

Value of the product option.

stringValue

string | null

Value of the product option.

data

object | null

Has additional fields

taxData

object | null

Has additional fields

weightedShipmentAdjustment

double

weightedLineItemTaxAdjustment

double

weightedShippingAdjustment

double

weightedShippingTaxAdjustment

double

weightedHandlingAdjustment

double

weightedHandlingTaxAdjustment

double

weightedDutyAdjustment

double

taxableShipping

double

taxableLineItemCost

double

taxableHandling

double

fulfillmentFields

array of objects | null

fulfillmentFields

object

name

string | null

userEnteredValue

string

required

boolean

isAssemblyRequired

boolean | null

parentItemId

string | null

childItemIds

array of strings | null

childItemIds

giftCards

array of objects | null

giftCards

object

activationDate

date-time | null

cardNumber

string | null

code

string | null

creditType

string | null

creditValue

double | null

currencyCode

string | null

currentBalance

double | null

customerId

int32 | null

expirationDate

date-time | null

initialBalance

double | null

locatorName

string | null

inventoryTags

array of objects | null

inventoryTags

object

name

string | null

value

string | null

lineItemAdjustment

double | null

isReservedInventory

boolean

cartItemId

string | null

sku

string | null

partNumber

string | null

upc

string | null

isSubstitutable

boolean | null

originalLineId

int32 | null

originalQuantity

int32 | null

substituteQuantity

int32 | null

purchaseLocation

string | null

isGift

boolean | null

Indicate item is gift or not

giftMessage

string | null

Gift message for item

priceMode

string | null

Determines if the item is using external or internal(catalog) pricing

serialNumber

string | null

condition

string | null

substituteInfo

object

allowsSubstitution

boolean | null

returnRuleInfo

object

canceledItems

array of objects | null

canceledItems

object

originalQuantity

int32 | null

canceledReason

object

auditInfo

object

lineId

int32

originalOrderItemId

string | null

parentId

string | null

productCode

string | null

variationProductCode

string | null

optionAttributeFQN

string | null

name

string | null

fulfillmentLocationCode

string | null

imageUrl

string | null

isTaxable

boolean

quantity

int32

unitPrice

double

actualPrice

double

overridePrice

double | null

itemDiscount

double

lineItemCost

double

itemTax

double

shipping

double

shippingDiscount

double

shippingTax

double

handling

double

handlingDiscount

double

handlingTax

double

duty

double

isPackagedStandAlone

boolean | null

readyForPickupQuantity

int32 | null

backorderReleaseDate

date-time | null

measurements

object

Physical dimensions of the package required to ship the product and its weight.

options

array of objects | null

options

object

name

string | null

Name of the product option that appears with the order item in the language specified by LocaleCode.

value

string

Value of the product option.

shopperEnteredValue

string

The value entered by the shopper if this is an option that requires shopper input, for example, a monogram.

attributeFQN

string | null

Value of the product option.

dataType

string | null

Value of the product option.

stringValue

string | null

Value of the product option.

data

object | null

Has additional fields

taxData

object | null

Has additional fields

weightedShipmentAdjustment

double

weightedLineItemTaxAdjustment

double

weightedShippingAdjustment

double

weightedShippingTaxAdjustment

double

weightedHandlingAdjustment

double

weightedHandlingTaxAdjustment

double

weightedDutyAdjustment

double

taxableShipping

double

taxableLineItemCost

double

taxableHandling

double

fulfillmentFields

array of objects | null

fulfillmentFields

object

name

string | null

userEnteredValue

string

required

boolean

isAssemblyRequired

boolean | null

parentItemId

string | null

childItemIds

array of strings | null

childItemIds

giftCards

array of objects | null

giftCards

object

activationDate

date-time | null

cardNumber

string | null

code

string | null

creditType

string | null

creditValue

double | null

currencyCode

string | null

currentBalance

double | null

customerId

int32 | null

expirationDate

date-time | null

initialBalance

double | null

locatorName

string | null

inventoryTags

array of objects | null

inventoryTags

object

name

string | null

value

string | null

lineItemAdjustment

double | null

isReservedInventory

boolean

cartItemId

string | null

sku

string | null

partNumber

string | null

upc

string | null

isSubstitutable

boolean | null

originalLineId

int32 | null

substituteQuantity

int32 | null

purchaseLocation

string | null

isGift

boolean | null

Indicate item is gift or not

giftMessage

string | null

Gift message for item

priceMode

string | null

Determines if the item is using external or internal(catalog) pricing

serialNumber

string | null

condition

string | null

substituteInfo

object

allowsSubstitution

boolean | null

returnRuleInfo

object

data

object | null

Has additional fields

taxData

object | null

Has additional fields

auditInfo

object

shipmentAdjustment

double

lineItemSubtotal

double

lineItemTaxAdjustment

double

lineItemTaxTotal

double

lineItemTotal

double

shippingAdjustment

double

shippingSubtotal

double

shippingTaxAdjustment

double

shippingTaxTotal

double

shippingTotal

double

handlingAdjustment

double

handlingSubtotal

double

handlingTaxAdjustment

double

handlingTaxTotal

double

handlingTotal

double

dutyAdjustment

double

dutyTotal

double

total

double

cost

double | null

externalOrderId

string | null

isExpress

boolean | null

isFlatRateShipping

boolean | null

readyToCapture

boolean

pickupInfo

object | null

Has additional fields

shopperNotes

object

customer

object

shipmentNotes

array of objects | null

shipmentNotes

object

attributes

object | null

Has additional fields

auditInfo

object

noteId

string | null

noteText

string | null

role

string | null

username

string | null

alternateContact

object

substitutedItems

array of objects | null

substitutedItems

object

actualPrice

double | null

allocatedQuantity

int32 | null

allowsBackOrder

boolean | null

allowsFutureAllocate

boolean | null

allowsSubstitution

boolean | null

appeasementReason

object

attributes

object | null

Has additional fields

auditInfo

object

autoSubstitution

boolean | null

backorderReleaseDate

date-time | null

cartItemId

string | null

childItemIds

array of strings | null

childItemIds

condition

string | null

creditCurrencyCode

string | null

creditValue

double | null

data

object | null

Has additional fields

duty

double | null

expectedDeliveryDate

date-time | null

fulfillmentFields

array of objects | null

fulfillmentFields

object

name

string | null

required

boolean | null

userEnteredValue

string

giftCards

array of objects | null

giftCards

object

activationDate

date-time | null

cardNumber

string | null

code

string | null

creditType

string | null

creditValue

double | null

currencyCode

string | null

currentBalance

double | null

customerId

int32 | null

expirationDate

date-time | null

initialBalance

double | null

giftMessage

string | null

goodsType

string | null

handling

double | null

handlingDiscount

double | null

handlingTax

double | null

height

double | null

imageUrl

string | null

inventoryAllocations

array of objects | null

inventoryAllocations

object

auditInfo

object

condition

string | null

date

date-time | null

fulfilledDate

date-time | null

inventoryId

int32 | null

lotCode

string | null

quantity

int32 | null

serialNumber

string | null

sku

string | null

status

string | null

inventoryTags

array of objects | null

inventoryTags

object

name

string | null

value

string | null

isAssemblyRequired

boolean | null

isGift

boolean | null

isPackagedStandAlone

boolean | null

isReservedInventory

boolean | null

isTaxable

boolean | null

itemDiscount

double | null

itemTax

double | null

length

double | null

lineId

int32 | null

lineItemAdjustment

double | null

lineItemCost

double | null

locatorName

string | null

manageStock

boolean | null

name

string | null

optionAttributeFQN

string | null

options

array of objects | null

options

object

attributeFQN

string | null

attributes

object | null

Has additional fields

dataType

string | null

name

string | null

shopperEnteredValue

string

stringValue

string | null

value

string

originalLineId

int32 | null

originalOrderItemId

string | null

originalQuantity

int32 | null

overridePrice

double | null

parentItemId

string | null

partNumber

string | null

priceMode

string | null

productCode

string | null

purchaseLocation

string | null

quantity

int32 | null

readyForPickupQuantity

int32 | null

returnRuleInfo

object

serialNumber

string | null

shipping

double | null

shippingDiscount

double | null

shippingTax

double | null

sku

string | null

substituteInfo

object

substituteItemLineIds

array of int32s | null

substituteItemLineIds

substituteQuantity

int32 | null

substituteReason

object

taxData

string

taxableHandling

double | null

taxableLineItemCost

double | null

taxableShipping

double | null

transferQuantity

int32 | null

trueTransferQuantity

int32 | null

unitPrice

double | null

upc

string | null

variationProductCode

string | null

weight

double | null

weightUnit

string | null

weightedDutyAdjustment

double | null

weightedHandlingAdjustment

double | null

weightedHandlingTaxAdjustment

double | null

weightedLineItemTaxAdjustment

double | null

weightedShipmentAdjustment

double | null

weightedShippingAdjustment

double | null

weightedShippingTaxAdjustment

double | null

width

double | null

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

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

array of strings | null

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

couponCodes

invalidCoupons

array of objects | null

A list of invalid coupons that were attempted on the order

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

amountAvailableForRefund

double

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

amountRemainingForPayment

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

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

subscriptionIds

array of strings | null

All the subscriptions associated with the current order.

subscriptionIds

continuityOrderOrdinal

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.

userId

string | null

Unique identifier of the shopper who created the cart.

string | null

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

tenantId

int32 | null

Unique identifier of the Tenant.

siteId

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

fulfillmentContact

object

isDestinationCommercial

boolean | null

Indicates that the destination is commercial

shippingMethodCode

string | null

Code that uniquely identifies the shipping method such as "Ground," "Overnight," or "Digital."
The site's shipping settings lists the valid shipping methods specified for this site.

shippingMethodName

string | null

Readable name of the shipping method

data

object | null

Custom data originated by the shipping service.

Has additional fields

auditInfo

object

orderDiscounts

array of objects | 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.

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

suggestedDiscounts

array of objects | null

suggestedDiscounts

object

productCode

string | null

autoAdd

boolean

discountId

int32

hasMultipleProducts

boolean

hasOptions

boolean

rejectedDiscounts

array of objects | null

rejectedDiscounts

object

productCode

string | null

autoAdd

boolean

discountId

int32

hasMultipleProducts

boolean

hasOptions

boolean

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

subtotal

double | null

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

discountedSubtotal

double | null

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

discountTotal

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

double | null

Subtotal minus the discounted total

shippingTotal

double | null

Shipping does not appear on cart.

shippingSubTotal

double | null

Shipping total without discounts applied.

shippingTaxTotal

double | null

Not implemented. Tax does not appear on cart.

handlingTaxTotal

double | null

Total tax on handling

itemTaxTotal

double | null

Not implemented. Tax does not appear on cart.

taxTotal

double | null

Tax does not appear on cart.

feeTotal

double | null

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

total

double | null

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

lineItemSubtotalWithOrderAdjustments

double | null

Line Item Subtotals with Order Adjustments

shippingAmountBeforeDiscountsAndAdjustments

double | null

Shipping Amount before discount and adjustments

lastValidationDate

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

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

array of objects | 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.

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

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

extendedProperties

array of objects | null

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

extendedProperties

object

key

string | null

value

string | null

discountThresholdMessages

array of objects | null

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

discountThresholdMessages

object

discountId

int32

message

string | null

thresholdValue

double

showOnCheckout

boolean

showInCart

boolean

requiresCouponCode

boolean

auditInfo

object

updateDate

date-time | null

createDate

date-time | null

updateBy

string | null

createBy

string | null

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request DELETE \
2
     --url https://t0-s0.sandbox.mozu.com/api/commerce/orders/orderId/coupons/couponCode \
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