REST API for Oracle Commerce Cloud December 2017

submitOrderForNonPCITargets

post

/ccadmin/v1/webhook/submitOrderForNonPCITargets

The details of an order, triggered when an order is submitted in Oracle Commerce Cloud. The body for this webhook does not include payment details.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : non_pci_order_request

Properties

order: Type: object order

Additional Properties Allowed:
site: Type: object site

Additional Properties Allowed:

Nested Schema : order

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

The creation time.
exchangeRate: Type: number

The conversion rate between the order currency and secondary currency.
id: Type: string

The ID
lastModifiedTime: Type: integer

The last modified time.
organizationId: Type: string

The organization ID.
paymentGroupCount: Type: integer

The number of payment groups. (read-only, value is ignored when updating)
priceInfo: Type: object priceInfo

Additional Properties Allowed:

Pricing information, an instance of OrderPriceInfo.
profile: Type: object profile

Additional Properties Allowed:

Basic profile information. (read-only)
profileId: Type: string

The ID of the shopper profile that owns the order.
salesChannel: Type: string

The sales channel of this order. default to "default".
secondaryCurrencyCode: Type: string

The currency code of secondary currency.
shippingGroupCount: Type: integer

The number of shipping groups (read-only, value is ignored when updating).
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:

Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address.
siteId: Type: string

The ID of the site on which the order was placed.
sourceSystem: Type: string

The system where the order originated.
state: Type: string

The state of the order.
submittedDate: Type: string (date-time)

The date when order was submitted.
taxPriceInfo: Type: object taxPriceInfo

Additional Properties Allowed:

The tax pricing details for the order.
totalCommerceItemCount: Type: integer

The total count of commerce items in the order. (read-only)

Nested Schema : site

Type: object

Properties

siteName: Type: string

The name of the site where order is placed
siteURL: Type: string

The production URL of the site where the order is placed

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 : priceInfo

Type: object

Pricing information, an instance of OrderPriceInfo.

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.
discountAmount: Type: number

The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)
discounted: Type: boolean

Whether the price is discounted.
manualAdjustmentTotal: Type: number

The monetary total of manual adjustments.
rawSubtotal: Type: number

The monetary raw subtotal.
shipping: Type: number

The monetary cost of shipping.
tax: Type: number

Monetary tax amount.
total: Type: number

The monetary total: amount + shipping + tax. (read-only)

Nested Schema : profile

Type: object

Basic profile information. (read-only)

Properties

email: Type: string

The email address
firstName: Type: string

First name.
lastName: Type: string

Last name.
loyaltyPrograms: Type: array loyaltyPrograms

Additional Properties Allowed:

Loyalty Programs Information
middleName: Type: string

Middle name.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

Default shipping address

Nested Schema : shippingGroups

Type: array

Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : taxPriceInfo

Type: object

The tax pricing details for the order.

Properties

amount: Type: number

The monetary amount.
amountIsFinal: Type: boolean

Whether the amount is final.
cityTax: Type: number

The monetary amount of city tax.
countryTax: Type: number

The monetary amount of country tax.
countyTax: Type: number

The monetary amount of county tax.
currencyCode: Type: string

The three character currency code.
discounted: Type: boolean

Whether the price was discounted.
districtTax: Type: number

Tax amount for the district.
isTaxIncluded: Type: boolean

If Tax is Included
secondaryCurrencyTaxAmount: Type: number

The tax amount in secondary currency
stateTax: Type: number

Tax amount for the state.
valueAddedTax: Type: number

The value added tax

Nested Schema : items

Type: object

Properties

actionCode: Type: string

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

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
availabilityDate: Type: string (date-time)

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

The back ordered quantity included.
billingAccountId: Type: string

The billing account ID associated to the current item.
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.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
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.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current item.
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.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catalogRefId: Type: string

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

Additional Properties Allowed:
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
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.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current 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 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.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catalogRefId: Type: string

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

Additional Properties Allowed:
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
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.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current 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 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.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catalogRefId: Type: string

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

Additional Properties Allowed:
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
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.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current 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 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.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catalogRefId: Type: string

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

Additional Properties Allowed:
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
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.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current 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 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.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catalogRefId: Type: string

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

Additional Properties Allowed:
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
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.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current 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 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.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catalogRefId: Type: string

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

Additional Properties Allowed:
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
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.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current 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 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.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catalogRefId: Type: string

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

Additional Properties Allowed:
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
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.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current 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 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.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catalogRefId: Type: string

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

Additional Properties Allowed:
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
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.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current 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 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.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catalogRefId: Type: string

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

Additional Properties Allowed:
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
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.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current 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 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.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catalogRefId: Type: string

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

Additional Properties Allowed:
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
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.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current item.

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.
orderDiscountShare: Type: number

The Order Discount Share
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

The tax amount in secondary currency
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 : loyaltyPrograms

Type: array

Loyalty Programs Information

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

Default shipping address

Properties

address1: Type: string

Address Line 1.
address2: Type: string

Address Line 2.
address3: Type: string

Address Line 3.
city: Type: string

City.
country: Type: string

Country.
county: Type: string

Name of the county.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Postal code.
state: Type: string

State.

Nested Schema : items

Type: object

Properties

membershipId: Type: string

membershipId of the profile.
programId: Type: string

programId of Loyalty Program
programName: Type: string

programName of Loyalty Program
repositoryId: Type: string

repository Id
status: Type: string

status of Enrollment.

Nested Schema : items

Type: object

Properties

actualShipDate: Type: string (date-time)

The actual shipped date of this shipping group.
commerceItemRelationships: Type: array commerceItemRelationships

Additional Properties Allowed:

The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.
description: Type: string

The description of this shipping group. Defaults to the ID.
handlingInstructions: Type: array handlingInstructions

Additional Properties Allowed:

Handling instructions. Currently read-only.
id: Type: string

The ID of this shipping group.
priceInfo: Type: object priceInfo

Additional Properties Allowed:

The pricing details about this shipping group.
shipOnDate: Type: string (date-time)

The date this shipping group is expected to ship upon.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address for this shipping group.
shippingGroupClassType: Type: string

The class type for the ShippingGroup. Currently must be "hardgoodShippingGroup".
shippingMethod: Type: string

The shipping method.
specialInstructions: Type: array specialInstructions

Additional Properties Allowed:

Special instructions for the shipping group. Keys and values are strings.
state: Type: string

The state of this shipping group.
stateDetail: Type: string

Details about the state of this shipping group.
submittedDate: Type: string (date-time)

The date the shipping group was submitted.
trackingNumber: Type: string

The tracking number. In case of multiple tracking numbers the format should be carrierId-trackingNumber,carrierId-trackingNumber..., Here carrierId is the Id which has been added through the addCarrier end point.

Nested Schema : commerceItemRelationships

Type: array

The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : handlingInstructions

Type: array

Handling instructions. Currently read-only.

Items

Type: string

Nested Schema : priceInfo

Type: object

The pricing details about this shipping group.

Properties

amount: Type: number

The monetary amount.
amountIsFinal: Type: boolean

Whether the amount is final.
currencyCode: Type: string

The currency code for the monetary amounts.
discounted: Type: boolean

Whether this item is discounted.
rawShipping: Type: number

The monitary amount of the cost of raw shipping.
secondaryCurrencyTaxAmount: Type: number

The tax amount in secondary currency
shippingTax: Type: number

The shipping tax

Nested Schema : shippingAddress

Type: object

The shipping address for this shipping group.

Properties

address1: Type: string

Address Line 1.
address2: Type: string

Address Line 2.
address3: Type: string

Address Line 3.
city: Type: string

City.
companyName: Type: string

Company name.
country: Type: string

Country.
county: Type: string

Name of the county.
email: Type: string

The email address
faxNumber: Type: string

The fax number.
firstName: Type: string

First name.
id: Type: string

ID.
jobTitle: Type: string

Job title.
lastName: Type: string

Last name.
middleName: Type: string

Middle name.
ownerId: Type: string

The ID of the owner of this address.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Postal code.
prefix: Type: string

Prefix.
state: Type: string

State.
suffix: Type: string

Suffix.

Nested Schema : specialInstructions

Type: array

Special instructions for the shipping group. Keys and values are strings.

Items

Type: string

Nested Schema : items

Type: object

Properties

actionCode: Type: string

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

The activation date in ISO format.
amount: Type: number

The monetary value.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
commerceItemExternalId: Type: string

The referenced commerce item's external ID.
commerceItemId: Type: string

The referenced commerce item's internal ID.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
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

The native ID of this item.
quantity: Type: integer

The quantity of items referenced by this relationship.
range: Type: object range

Additional Properties Allowed:

The range covered by these commerce items
relationshipType: Type: string

The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.
returnedQuantity: Type: integer

Number of referenced items that were returned.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current 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 : range

Type: object

The range covered by these commerce items

Properties

highBound: Type: integer

The upper bound of the range.
lowBound: Type: integer

The lower bound of the range, inclusive.
size: Type: integer

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

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.

Response

Supported Media Types

application/json

200 Response

No response is returned as this is an event webhook

Body

Root Schema : emptyResponse

Properties