REST API for Oracle Commerce Cloud December 2017

return

post

/ccadmin/v1/webhook/return

This Event is triggered when a return request is initiated

Request

Supported Media Types

application/json

Body Parameter

This Event is triggered when a return request is initiated

Root Schema : return_request

This Event is triggered when a return request is initiated

Properties

return: Type: object return

Additional Properties Allowed:

Nested Schema : return

Properties

actualShippingRefund: Type: integer
actualTaxRefund: Type: number
adjustmentAmount: Type: number
agentId: Type: string
allocatedAmount: Type: number
authorizationDate: Type: string
authorizationNumber: Type: string
comments: Type: string
generatedStoreCredit: Type: string
generatedStoreCreditItem: Type: string
nonReturnItemCostAdjustments: Type: array nonReturnItemCostAdjustments

Additional Properties Allowed:
nonReturnItemSubtotalAdjustment: Type: number
originatingOrder: Type: object originatingOrder

Additional Properties Allowed:
originOfReturn: Type: string
otherRefund: Type: integer
preReturnPromotionValue: Type: object preReturnPromotionValue

Additional Properties Allowed:
processed: Type: boolean
processImmediately: Type: boolean
processName: Type: string
refundMethodList: Type: array refundMethodList

Additional Properties Allowed:
refundSubtotal: Type: number
relatedReplacementOrders: Type: array relatedReplacementOrders

Additional Properties Allowed:
replaceItemCount: Type: integer
replacementOrder: Type: string
replacingItems: Type: boolean
returnCalculationOrder: Type: object returnCalculationOrder

Additional Properties Allowed:
returnFee: Type: integer
returningItems: Type: boolean
returnItemCount: Type: integer
returnItemList: Type: array returnItemList

Additional Properties Allowed:
returnPaymentState: Type: string
state: Type: string
submitExchangeAllowed: Type: boolean
suggestedShippingRefund: Type: integer
suggestedTaxRefund: Type: number
totalItemRefund: Type: number
totalOrderPromotionValueAdjustmentChange: Type: number
totalRefundAmount: Type: number
totalReturnItemRefund: Type: integer
unAdjustedRefundSubtotal: Type: number
unallocatedAmount: Type: integer

Nested Schema : nonReturnItemCostAdjustments

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : originatingOrder

Type: object

Properties

commerceItems: Type: array commerceItems

Additional Properties Allowed:

The commerce items (sometimes referred to as "line items") represent which actual skus are included in thef order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl.
creationTime: Type: integer
exchangeRate: Type: number

exchangeRate
id: Type: string
lastModifiedTime: Type: integer
locale: Type: string
organizationId: Type: string

The organization ID.
paymentGroupCount: Type: integer
paymentGroups: Type: array paymentGroups

Additional Properties Allowed:
priceInfo: Type: object priceInfo

Additional Properties Allowed:
profileId: Type: string
relationships: Type: array relationships

Additional Properties Allowed:
salesChannel: Type: string
secondaryCurrencyCode: Type: string

Secondary currencyCode
shippingGroupCount: Type: integer
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:
siteId: Type: string
state: Type: string
taxPriceInfo: Type: object taxPriceInfo

Additional Properties Allowed:
totalCommerceItemCount: Type: integer

Nested Schema : preReturnPromotionValue

Type: object

Properties

implicitOrderDiscount20on100: Type: number

Nested Schema : refundMethodList

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : relatedReplacementOrders

Type: array

Items

Nested Schema : returnCalculationOrder

Type: object

Properties

commerceItems: Type: array commerceItems

Additional Properties Allowed:

The commerce items (sometimes referred to as "line items") represent which actual skus are included in thef order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl.
creationTime: Type: integer
exchangeRate: Type: number

exchangeRate
id: Type: string
lastModifiedTime: Type: integer
locale: Type: string
organizationId: Type: string

The organization ID.
paymentGroupCount: Type: integer
paymentGroups: Type: array paymentGroups

Additional Properties Allowed:
priceInfo: Type: object priceInfo

Additional Properties Allowed:
profileId: Type: string
relationships: Type: array relationships

Additional Properties Allowed:
salesChannel: Type: string
secondaryCurrencyCode: Type: string

Secondary currencyCode
shippingGroupCount: Type: integer
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:
siteId: Type: string
state: Type: string
taxPriceInfo: Type: object taxPriceInfo

Additional Properties Allowed:
totalCommerceItemCount: Type: integer

Nested Schema : returnItemList

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

amountAdjustment: Type: integer
class: Type: string
commerceItemId: Type: string
manualAdjustmentShareAdjustment: Type: integer
orderDiscountShareAdjustment: Type: number
quantityAdjusted: Type: integer
shippingGroupId: Type: string
shippingShareAdjustment: Type: integer
taxShareAdjustment: Type: number

Nested Schema : commerceItems

Type: array

The commerce items (sometimes referred to as "line items") represent which actual skus are included in thef order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : paymentGroups

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

Properties

amount: Type: number
amountIsFinal: Type: boolean
currencyCode: Type: string
discountAmount: Type: number
discounted: Type: boolean
manualAdjustmentTotal: Type: integer
rawSubtotal: Type: number
shipping: Type: integer
tax: Type: number
total: Type: number

Nested Schema : relationships

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingGroups

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : taxPriceInfo

Type: object

Properties

amount: Type: number
amountIsFinal: Type: boolean
cityTax: Type: integer
countryTax: Type: integer
countyTax: Type: number
currencyCode: Type: string
discounted: Type: boolean
districtTax: Type: integer
isTaxIncluded: Type: boolean
miscTax: Type: integer
secondaryCurrencyTaxAmount: Type: number

tax amount in secondaryCurrency
stateTax: Type: number
valueAddedTax: Type: integer

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the item by the third party system.
availabilityDate: Type: string (date-time)

The availability date for preOrdered/backOrdered quantity.
backOrderQuantity: Type: integer

The back ordered quantity included.
catalogId: Type: string

The ID of the catalog which this commerce item references.
catalogKey: Type: string

The key of the catalog this commerce item references.
catalogRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
commerceItems: Type: array commerceItems

Additional Properties Allowed:
configuratorId: Type: string

Configuration ID for this commerce item.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a third party system.
externalId: Type: string

An optional, external ID for this commerce item.
externalPriceDetails: Type: object externalPriceDetails

Additional Properties Allowed:

Details about external pricing
id: Type: string

The internal/native ID for this commerce item.
preOrderQuantity: Type: integer

The pre ordered quantity included.
priceInfo: Type: object priceInfo

Additional Properties Allowed:

Details about pricing.
productDisplayName: Type: string

The product's display name. (read-only, obtained from the referenced product)
productId: Type: string

The ID of the product.
quantity: Type: integer

The quantity included.
returnedQuantity: Type: integer

The quantity returned.
state: Type: string

The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)
stateDetail: Type: string

Details about the state of this commerce item.

Nested Schema : commerceItems

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a third party system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Properties

externalPrice: Type: number

External price of this commerce item
externalPriceQuantity: Type: integer

external quantity of this commerce item

Nested Schema : priceInfo

Type: object

Details about pricing.

Properties

amount: Type: number

The monetary amount of this order.
amountIsFinal: Type: boolean

Whether the amount is final.
currencyCode: Type: string

The currency code for the monetary amounts. A three character currency code such as USD.
currentPriceDetailsSorted: Type: array currentPriceDetailsSorted

Additional Properties Allowed:

The current price details.
discountable: Type: boolean

Whether discountable.
discounted: Type: boolean

Whether the price is discounted.
listPrice: Type: number

The monetary amount of the list price.
onSale: Type: boolean

Whether is on sale.
priceListId: Type: string

The price list ID used for pricing.
quantityDiscounted: Type: integer

The quanity discounted.
rawTotalPrice: Type: number

The raw total price.
salePrice: Type: number

The sale price
shippingSurcharge: Type: number

Extra handling cost for shipping the product.

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the item by the configurator system.
catalogRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
commerceItems: Type: array commerceItems

Additional Properties Allowed:
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPriceDetails: Type: object externalPriceDetails

Additional Properties Allowed:

Details about external pricing
productId: Type: string

The ID of the product.
quantity: Type: integer

The quantity included.

Nested Schema : commerceItems

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Properties

externalPrice: Type: number

External price of this commerce item
externalPriceQuantity: Type: integer

external quantity of this commerce item

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the item by the configurator system.
catalogRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
commerceItems: Type: array commerceItems

Additional Properties Allowed:
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPriceDetails: Type: object externalPriceDetails

Additional Properties Allowed:

Details about external pricing
productId: Type: string

The ID of the product.
quantity: Type: integer

The quantity included.

Nested Schema : commerceItems

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Properties

externalPrice: Type: number

External price of this commerce item
externalPriceQuantity: Type: integer

external quantity of this commerce item

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the item by the configurator system.
catalogRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
commerceItems: Type: array commerceItems

Additional Properties Allowed:
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPriceDetails: Type: object externalPriceDetails

Additional Properties Allowed:

Details about external pricing
productId: Type: string

The ID of the product.
quantity: Type: integer

The quantity included.

Nested Schema : commerceItems

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Properties

externalPrice: Type: number

External price of this commerce item
externalPriceQuantity: Type: integer

external quantity of this commerce item

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the item by the configurator system.
catalogRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
commerceItems: Type: array commerceItems

Additional Properties Allowed:
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPriceDetails: Type: object externalPriceDetails

Additional Properties Allowed:

Details about external pricing
productId: Type: string

The ID of the product.
quantity: Type: integer

The quantity included.

Nested Schema : commerceItems

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Properties

externalPrice: Type: number

External price of this commerce item
externalPriceQuantity: Type: integer

external quantity of this commerce item

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the item by the configurator system.
catalogRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
commerceItems: Type: array commerceItems

Additional Properties Allowed:
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPriceDetails: Type: object externalPriceDetails

Additional Properties Allowed:

Details about external pricing
productId: Type: string

The ID of the product.
quantity: Type: integer

The quantity included.

Nested Schema : commerceItems

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Properties

externalPrice: Type: number

External price of this commerce item
externalPriceQuantity: Type: integer

external quantity of this commerce item

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the item by the configurator system.
catalogRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
commerceItems: Type: array commerceItems

Additional Properties Allowed:
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPriceDetails: Type: object externalPriceDetails

Additional Properties Allowed:

Details about external pricing
productId: Type: string

The ID of the product.
quantity: Type: integer

The quantity included.

Nested Schema : commerceItems

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Properties

externalPrice: Type: number

External price of this commerce item
externalPriceQuantity: Type: integer

external quantity of this commerce item

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the item by the configurator system.
catalogRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
commerceItems: Type: array commerceItems

Additional Properties Allowed:
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPriceDetails: Type: object externalPriceDetails

Additional Properties Allowed:

Details about external pricing
productId: Type: string

The ID of the product.
quantity: Type: integer

The quantity included.

Nested Schema : commerceItems

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Properties

externalPrice: Type: number

External price of this commerce item
externalPriceQuantity: Type: integer

external quantity of this commerce item

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the item by the configurator system.
catalogRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
commerceItems: Type: array commerceItems

Additional Properties Allowed:
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPriceDetails: Type: object externalPriceDetails

Additional Properties Allowed:

Details about external pricing
productId: Type: string

The ID of the product.
quantity: Type: integer

The quantity included.

Nested Schema : commerceItems

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Properties

externalPrice: Type: number

External price of this commerce item
externalPriceQuantity: Type: integer

external quantity of this commerce item

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the item by the configurator system.
catalogRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
commerceItems: Type: array commerceItems

Additional Properties Allowed:
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPriceDetails: Type: object externalPriceDetails

Additional Properties Allowed:

Details about external pricing
productId: Type: string

The ID of the product.
quantity: Type: integer

The quantity included.

Nested Schema : commerceItems

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Properties

externalPrice: Type: number

External price of this commerce item
externalPriceQuantity: Type: integer

external quantity of this commerce item

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the item by the configurator system.
catalogRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
commerceItems: Type: array commerceItems

Additional Properties Allowed:
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPriceDetails: Type: object externalPriceDetails

Additional Properties Allowed:

Details about external pricing
productId: Type: string

The ID of the product.
quantity: Type: integer

The quantity included.

Nested Schema : commerceItems

Type: array

Items

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Properties

externalPrice: Type: number

External price of this commerce item
externalPriceQuantity: Type: integer

external quantity of this commerce item

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the third party system.
name: Type: string

The name to be associated with the externalData item.
values: Type: object values

Additional Properties Allowed:

The map values associated with an externalData item.

Nested Schema : values

Type: object

The map values associated with an externalData item.

Properties

key: Type: string

Map key defined by external system.
value: Type: string

Map value defined by external system.

Nested Schema : currentPriceDetailsSorted

Type: array

The current price details.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

amount: Type: number

The monetary amount.
amountIsFinal: Type: boolean

Whether the amount is final.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
quantity: Type: integer

The number of items covered by this price info
range: Type: object range

Additional Properties Allowed:

Represents which specific items are covered by this price info.
secondaryCurrencyTaxAmount: Type: number

tax amount in secondaryCurrency
tax: Type: number

Monetary tax amount.

Nested Schema : range

Type: object

Represents which specific items are covered by this price info.

Properties

highBound: Type: integer

The upper bound of the range this price info covers.
lowBound: Type: integer

The lower bound of the range this price info covers, inclusive.
size: Type: integer

The number of items in this range, inclusive. (read-only)

Nested Schema : items

Type: object

Properties

amount: Type: number
amountAuthorized: Type: number
authorizationStatus: Type: array authorizationStatus

Additional Properties Allowed:
billingAddress: Type: object billingAddress

Additional Properties Allowed:
creditCardNumber: Type: string
currencyCode: Type: string
expirationMonth: Type: string
expirationYear: Type: string
id: Type: string
IIN: Type: string
paymentGroupClassType: Type: string
paymentMethod: Type: string
PONumber: Type: string
submittedDate: Type: string
token: Type: string

Nested Schema : authorizationStatus

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : billingAddress

Type: object

Properties

address1: Type: string
address2: Type: string
address3: Type: string
city: Type: string
companyName: Type: string
country: Type: string
county: Type: string
email: Type: string
faxNumber: Type: string
firstName: Type: string
jobTitle: Type: string
lastName: Type: string
middleName: Type: string
ownerId: Type: string
phoneNumber: Type: string
postalCode: Type: string
prefix: Type: string
state: Type: string
suffix: Type: string

Nested Schema : items

Type: object

Properties

amount: Type: number
authorizationDecision: Type: string
currency: Type: string
errorMessage: Type: string
reasonCode: Type: string
transactionId: Type: string
transactionSuccess: Type: boolean
transactionUuid: Type: string

Nested Schema : items

Type: object

Properties

amount: Type: number
id: Type: string
paymentGroupId: Type: string
relationshipType: Type: string

Nested Schema : items

Type: object

Properties

actualShipDate: Type: string
commerceItemRelationships: Type: array commerceItemRelationships

Additional Properties Allowed:
description: Type: string
handlingInstructions: Type: array handlingInstructions

Additional Properties Allowed:
id: Type: string
priceInfo: Type: object priceInfo

Additional Properties Allowed:
shipOnDate: Type: string
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:
shippingGroupClassType: Type: string
shippingMethod: Type: string
specialInstructions: Type: array specialInstructions

Additional Properties Allowed:
state: Type: string
stateDetail: Type: string
submittedDate: Type: string
trackingNumber: Type: string

Nested Schema : commerceItemRelationships

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : handlingInstructions

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

Properties

amount: Type: integer
amountIsFinal: Type: boolean
currencyCode: Type: string
discounted: Type: boolean
rawShipping: Type: integer
secondaryCurrencyTaxAmount: Type: number

tax amount in secondaryCurrency

Nested Schema : shippingAddress

Type: object

Properties

address1: Type: string
address2: Type: string
address3: Type: string
city: Type: string
companyName: Type: string
country: Type: string
county: Type: string
email: Type: string
faxNumber: Type: string
firstName: Type: string
jobTitle: Type: string
lastName: Type: string
middleName: Type: string
ownerId: Type: string
phoneNumber: Type: string
postalCode: Type: string
prefix: Type: string
state: Type: string
suffix: Type: string

Nested Schema : specialInstructions

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the item by the third party system.
amount: Type: integer
commerceItemExternalId: Type: string
commerceItemId: Type: string
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a third party system.
id: Type: string
quantity: Type: integer
relationshipType: Type: string
returnedQuantity: Type: integer

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a third party system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the third party system.
name: Type: string

The name to be associated with the externalData item.
values: Type: object values

Additional Properties Allowed:

The map values associated with an externalData item.

Nested Schema : values

Type: object

The map values associated with an externalData item.

Properties

key: Type: string

Map key defined by external system.
value: Type: string

Map value defined by external system.

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Properties

amount: Type: number
class: Type: string
maximumRefundAmount: Type: integer
refundType: Type: string
returnManager: Type: string

Nested Schema : commerceItems

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : paymentGroups

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

Properties

amount: Type: number
amountIsFinal: Type: boolean
currencyCode: Type: string
discountAmount: Type: integer
discounted: Type: boolean
manualAdjustmentTotal: Type: integer
rawSubtotal: Type: number
shipping: Type: integer
tax: Type: number
total: Type: number

Nested Schema : relationships

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingGroups

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : taxPriceInfo

Type: object

Properties

amount: Type: number
amountIsFinal: Type: boolean
cityTax: Type: integer
countryTax: Type: integer
countyTax: Type: number
currencyCode: Type: string
discounted: Type: boolean
districtTax: Type: integer
isTaxIncluded: Type: boolean
miscTax: Type: integer
stateTax: Type: number
valueAddedTax: Type: integer

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the item by the third party system.
catalogId: Type: string

The ID of the catalog which this commerce item references.
catalogKey: Type: string

The key of the catalog this commerce item references.
catalogRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a third party system.
externalId: Type: string

An optional, external ID for this commerce item.
id: Type: string

The internal/native ID for this commerce item.
priceInfo: Type: object priceInfo

Additional Properties Allowed:

Details about pricing.
productDisplayName: Type: string

The product's display name. (read-only, obtained from the referenced product)
productId: Type: string

The ID of the product.
quantity: Type: integer

The quantity included.
returnedQuantity: Type: integer

The quantity returned.
state: Type: string

The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)
stateDetail: Type: string

Details about the state of this commerce item.

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a third party system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

Details about pricing.

Properties

amount: Type: number

The monetary amount of this order.
amountIsFinal: Type: boolean

Whether the amount is final.
currencyCode: Type: string

The currency code for the monetary amounts. A three character currency code such as USD.
currentPriceDetailsSorted: Type: array currentPriceDetailsSorted

Additional Properties Allowed:

The current price details.
discountable: Type: boolean

Whether discountable.
discounted: Type: boolean

Whether the price is discounted.
listPrice: Type: number

The monetary amount of the list price.
onSale: Type: boolean

Whether is on sale.
priceListId: Type: string

The price list ID used for pricing.
quantityDiscounted: Type: integer

The quanity discounted.
rawTotalPrice: Type: number

The raw total price.
salePrice: Type: number

The sale price
shippingSurcharge: Type: number

Extra handling cost for shipping the product.

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the third party system.
name: Type: string

The name to be associated with the externalData item.
values: Type: object values

Additional Properties Allowed:

The map values associated with an externalData item.

Nested Schema : values

Type: object

The map values associated with an externalData item.

Properties

key: Type: string

Map key defined by external system.
value: Type: string

Map value defined by external system.

Nested Schema : currentPriceDetailsSorted

Type: array

The current price details.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

amount: Type: number

The monetary amount.
amountIsFinal: Type: boolean

Whether the amount is final.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
quantity: Type: integer

The number of items covered by this price info
range: Type: object range

Additional Properties Allowed:

Represents which specific items are covered by this price info.
tax: Type: number

Monetary tax amount.

Nested Schema : range

Type: object

Represents which specific items are covered by this price info.

Properties

highBound: Type: integer

The upper bound of the range this price info covers.
lowBound: Type: integer

The lower bound of the range this price info covers, inclusive.
size: Type: integer

The number of items in this range, inclusive. (read-only)

Nested Schema : items

Type: object

Properties

amount: Type: number
amountAuthorized: Type: number
authorizationStatus: Type: array authorizationStatus

Additional Properties Allowed:
billingAddress: Type: object billingAddress

Additional Properties Allowed:
creditCardNumber: Type: string
currencyCode: Type: string
expirationMonth: Type: string
expirationYear: Type: string
id: Type: string
IIN: Type: string
paymentGroupClassType: Type: string
paymentMethod: Type: string
PONumber: Type: string
submittedDate: Type: string
token: Type: string

Nested Schema : authorizationStatus

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : billingAddress

Type: object

Properties

address1: Type: string
address2: Type: string
address3: Type: string
city: Type: string
companyName: Type: string
country: Type: string
county: Type: string
email: Type: string
faxNumber: Type: string
firstName: Type: string
jobTitle: Type: string
lastName: Type: string
middleName: Type: string
ownerId: Type: string
phoneNumber: Type: string
postalCode: Type: string
prefix: Type: string
state: Type: string
suffix: Type: string

Nested Schema : items

Type: object

Properties

amount: Type: number
authorizationDecision: Type: string
currency: Type: string
errorMessage: Type: string
reasonCode: Type: string
transactionId: Type: string
transactionSuccess: Type: boolean
transactionUuid: Type: string

Nested Schema : items

Type: object

Properties

amount: Type: number
id: Type: string
paymentGroupId: Type: string
relationshipType: Type: string

Nested Schema : items

Type: object

Properties

actualShipDate: Type: string
commerceItemRelationships: Type: array commerceItemRelationships

Additional Properties Allowed:
description: Type: string
handlingInstructions: Type: array handlingInstructions

Additional Properties Allowed:
id: Type: string
priceInfo: Type: object priceInfo

Additional Properties Allowed:
shipOnDate: Type: string
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:
shippingGroupClassType: Type: string
shippingMethod: Type: string
specialInstructions: Type: array specialInstructions

Additional Properties Allowed:
state: Type: string
stateDetail: Type: string
submittedDate: Type: string
trackingNumber: Type: string

Nested Schema : commerceItemRelationships

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : handlingInstructions

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

Properties

amount: Type: integer
amountIsFinal: Type: boolean
currencyCode: Type: string
discounted: Type: boolean
rawShipping: Type: integer

Nested Schema : shippingAddress

Type: object

Properties

address1: Type: string
address2: Type: string
address3: Type: string
city: Type: string
companyName: Type: string
country: Type: string
county: Type: string
email: Type: string
faxNumber: Type: string
firstName: Type: string
jobTitle: Type: string
lastName: Type: string
middleName: Type: string
ownerId: Type: string
phoneNumber: Type: string
postalCode: Type: string
prefix: Type: string
state: Type: string
suffix: Type: string

Nested Schema : specialInstructions

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the item by the third party system.
amount: Type: integer
commerceItemExternalId: Type: string
commerceItemId: Type: string
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a third party system.
id: Type: string
quantity: Type: integer
relationshipType: Type: string
returnedQuantity: Type: integer

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a third party system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the third party system.
name: Type: string

The name to be associated with the externalData item.
values: Type: object values

Additional Properties Allowed:

The map values associated with an externalData item.

Nested Schema : values

Type: object

The map values associated with an externalData item.

Properties

key: Type: string

Map key defined by external system.
value: Type: string

Map value defined by external system.

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Properties

actualShippingRefundShare: Type: integer
actualTaxRefundShare: Type: integer
comments: Type: string
commerceItem: Type: object commerceItem

Additional Properties Allowed:
disposition: Type: string
editable: Type: boolean
id: Type: string
itemCostAdjustments: Type: array itemCostAdjustments

Additional Properties Allowed:
manualAdjustmentShare: Type: integer
orderDiscountAdjustment: Type: number
quantityAvailable: Type: integer
quantityReceived: Type: integer
quantityReturned: Type: integer
quantityShipped: Type: integer
quantityToExchange: Type: integer
quantityToProcess: Type: integer
quantityToReturn: Type: integer
refundAmount: Type: integer
returnReason: Type: string
returnShipmentRequired: Type: boolean
shippingGroupId: Type: string
state: Type: string
stateAsUserResource: Type: string
stateDetailAsUserResource: Type: string
suggestedRefundAmount: Type: integer
suggestedShippingRefundShare: Type: integer
suggestedTaxRefundShare: Type: integer
unAdjustedRefundAmount: Type: number

Nested Schema : commerceItem

Type: object

Properties

actionCode: Type: string

The action code that has been set on the item by the third party system.
catalogId: Type: string
catalogKey: Type: string
catalogRefId: Type: string
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a third party system.
externalId: Type: string
id: Type: string
priceInfo: Type: object priceInfo

Additional Properties Allowed:
productDisplayName: Type: string
productId: Type: string
quantity: Type: integer
returnedQuantity: Type: integer

Nested Schema : itemCostAdjustments

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a third party system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

Properties

amount: Type: number
amountIsFinal: Type: boolean
currencyCode: Type: string
currentPriceDetailsSorted: Type: array currentPriceDetailsSorted

Additional Properties Allowed:
discountable: Type: boolean
discounted: Type: boolean
listPrice: Type: number
onSale: Type: boolean
priceListId: Type: string
quantityDiscounted: Type: integer
rawTotalPrice: Type: number
salePrice: Type: integer
shippingSurcharge: Type: integer

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the third party system.
name: Type: string

The name to be associated with the externalData item.
values: Type: object values

Additional Properties Allowed:

The map values associated with an externalData item.