Jump to

• Request
• Response

cancelOrderUpdate

post

/ccadmin/v1/webhook/cancelOrderUpdate

This operation is triggered to update the cancel order details

Request

Supported Media Types

• application/json

Body ()

This functional webhook is triggered to update the cancel order details

Root Schema : cancelOrderUpdate_request

Type: object

This functional webhook is triggered to update the cancel order details

Show Source

• operation(optional): string
  The operation performed
• order(optional): object order

{
    "description":"This functional webhook is triggered to update the cancel order details",
    "properties":{
        "operation":{
            "description":"The operation performed",
            "type":"string"
        },
        "order":{
            "properties":{
                "gwp":{
                    "description":"Whether gift with purchase is enabled or not.",
                    "type":"boolean"
                },
                "secondaryCurrencyCode":{
                    "description":"Secondary currencyCode",
                    "type":"string"
                },
                "lastModifiedTime":{
                    "description":"The last modified time.",
                    "type":"integer"
                },
                "creationTime":{
                    "description":"The creation time.",
                    "type":"integer"
                },
                "locale":{
                    "description":"Locale",
                    "type":"string"
                },
                "paymentGroups":{
                    "description":"The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of \"tokenizedCreditCard\"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of \"externalPaymentGroup\"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "expirationYear":{
                                "description":"A string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards)",
                                "type":"string"
                            },
                            "PONumber":{
                                "description":"The purchase order number",
                                "type":"string"
                            },
                            "externalType":{
                                "description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
                                "type":"string"
                            },
                            "amountAuthorized":{
                                "description":"The monetary amount authorized.",
                                "type":"number"
                            },
                            "amount":{
                                "description":"The monetary amount of the payment.",
                                "type":"number"
                            },
                            "externalId":{
                                "description":"The ID for the payment group in an external system (like the OMS)",
                                "type":"string"
                            },
                            "expirationMonth":{
                                "description":"A string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards)",
                                "type":"string"
                            },
                            "creditCardType":{
                                "description":"The type of the credit card. (only for TokenizedCreditCards)",
                                "type":"string"
                            },
                            "submittedDate":{
                                "format":"date-time",
                                "description":"The date the payment was submitted.",
                                "type":"string"
                            },
                            "authorizationStatus":{
                                "description":"Aray of authorization status objects.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "amount":{
                                            "description":"The monetary amount.",
                                            "type":"number"
                                        },
                                        "transactionSuccess":{
                                            "description":"Whether the transaction was successful.",
                                            "type":"boolean"
                                        },
                                        "errorMessage":{
                                            "description":"The error message, if any.",
                                            "type":"string"
                                        },
                                        "transactionId":{
                                            "description":"The transaction ID.",
                                            "type":"string"
                                        },
                                        "transactionTimestamp":{
                                            "description":"The timestamp of the transaction.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "token":{
                                "description":"The CyberSource token string. (only for tokenizedCreditCard)",
                                "type":"string"
                            },
                            "paymentGroupClassType":{
                                "description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
                                "type":"string"
                            },
                            "creditCardNumber":{
                                "description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
                                "type":"string"
                            },
                            "externalSubtype":{
                                "description":"The subtype in the external system. Might be \"VISA\" for a PaymentGroup with an external type of \"CreditCard\". (only for ExternalPaymentGroups)",
                                "type":"string"
                            },
                            "paymentMethod":{
                                "description":"The payment method. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
                                "type":"string"
                            },
                            "externalSourceId":{
                                "description":"The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)",
                                "type":"string"
                            },
                            "state":{
                                "description":"The state of this payment group.",
                                "type":"string"
                            },
                            "id":{
                                "description":"The internal ID of the payment group.",
                                "type":"string"
                            },
                            "stateDetail":{
                                "description":"Details about the state of this payment group.",
                                "type":"string"
                            },
                            "currencyCode":{
                                "description":"The three character currency code. For example: USD.",
                                "type":"string"
                            },
                            "expirationDayOfMonth":{
                                "description":"A string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards)",
                                "type":"string"
                            }
                        }
                    }
                },
                "salesChannel":{
                    "description":"The sales channel of this order. default to \"default\".",
                    "type":"string"
                },
                "organizationId":{
                    "description":"The organization ID.",
                    "type":"string"
                },
                "priceInfo":{
                    "description":"Pricing information, an instance of OrderPriceInfo.",
                    "type":"object",
                    "properties":{
                        "secondaryCurrencyTaxAmount":{
                            "description":"The secondary currency tax amount.",
                            "type":"number"
                        },
                        "discounted":{
                            "description":"Whether the price is discounted.",
                            "type":"boolean"
                        },
                        "amount":{
                            "description":"The monetary amount.",
                            "type":"number"
                        },
                        "secondaryCurrencyShippingAmount":{
                            "description":"The secondary currency shipping amount.",
                            "type":"number"
                        },
                        "secondaryCurrencyTotal":{
                            "description":"The secondary currency total amount.",
                            "type":"number"
                        },
                        "manualAdjustmentTotal":{
                            "description":"The monetary total of manual adjustments.",
                            "type":"number"
                        },
                        "discountAmount":{
                            "description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
                            "type":"number"
                        },
                        "tax":{
                            "description":"Monetary tax amount.",
                            "type":"number"
                        },
                        "rawSubtotal":{
                            "description":"The monetary raw subtotal.",
                            "type":"number"
                        },
                        "total":{
                            "description":"The monetary total: amount + shipping + tax. (read-only)",
                            "type":"number"
                        },
                        "shipping":{
                            "description":"The monetary cost of shipping.",
                            "type":"number"
                        },
                        "primaryCurrencyTotal":{
                            "description":"The primary currency total amount.",
                            "type":"number"
                        },
                        "amountIsFinal":{
                            "description":"Whether the amount is final.",
                            "type":"boolean"
                        },
                        "currencyCode":{
                            "description":"The three character currency code for the monetary amounts.",
                            "type":"string"
                        }
                    }
                },
                "exchangeRate":{
                    "description":"exchangeRate",
                    "type":"number"
                },
                "totalCommerceItemCount":{
                    "description":"The total count of commerce items in the order. (read-only)",
                    "type":"integer"
                },
                "state":{
                    "description":"The state of the order.",
                    "type":"string"
                },
                "id":{
                    "description":"The ID",
                    "type":"string"
                },
                "quoteInfo":{
                    "description":"Details about quote info",
                    "type":"object",
                    "properties":{
                        "providerNote":{
                            "description":"Provider note for this quote",
                            "type":"string"
                        },
                        "agentId":{
                            "description":"Agent id",
                            "type":"string"
                        },
                        "rejectionDate":{
                            "format":"date-time",
                            "description":"Rejection date for this quote",
                            "type":"string"
                        },
                        "requestDate":{
                            "format":"date-time",
                            "description":"Request Date for this quote",
                            "type":"string"
                        },
                        "errorInfo":{
                            "description":"Error Info for this quote",
                            "type":"string"
                        },
                        "externalId":{
                            "description":"external id for this quote",
                            "type":"string"
                        },
                        "rejectionNote":{
                            "description":"Rejection note for this quote",
                            "type":"string"
                        },
                        "quoteDate":{
                            "format":"date-time",
                            "description":"Quote Date for this quote",
                            "type":"string"
                        },
                        "expirationDate":{
                            "format":"date-time",
                            "description":"Expiration date for this quote",
                            "type":"string"
                        },
                        "requesterNote":{
                            "description":"Requestor note for this quote",
                            "type":"string"
                        }
                    }
                },
                "taxCalculated":{
                    "description":"Whether tax is calculated or not",
                    "type":"boolean"
                },
                "commerceItems":{
                    "description":"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. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "gwp":{
                                "description":"Flag to indicate whether item exists as a result of a gift with purchase promotion.",
                                "type":"boolean"
                            },
                            "deactivationDate":{
                                "description":"The deactivation date in ISO format.",
                                "type":"string"
                            },
                            "returnedQuantity":{
                                "description":"The quantity returned.",
                                "type":"integer"
                            },
                            "availabilityDate":{
                                "format":"date-time",
                                "description":"The availability date for preOrdered/backOrdered quantity.",
                                "type":"string"
                            },
                            "externalData":{
                                "description":"External data to be associated with a commerce item, provided by a third party system.",
                                "type":"array",
                                "items":{
                                    "properties":{
                                        "values":{
                                            "description":"The map values associated with an externalData item.",
                                            "type":"object",
                                            "properties":{
                                                "value":{
                                                    "description":"Map value defined by external system.",
                                                    "type":"string"
                                                },
                                                "key":{
                                                    "description":"Map key defined by external system.",
                                                    "type":"string"
                                                }
                                            }
                                        },
                                        "name":{
                                            "description":"The name to be associated with the externalData item.",
                                            "type":"string"
                                        },
                                        "actionCode":{
                                            "description":"The action code that has been set on the externalData item by the third party system.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "billingAccountId":{
                                "description":"The billing account ID associated to the current item.",
                                "type":"string"
                            },
                            "preOrderQuantity":{
                                "description":"The pre ordered quantity included.",
                                "type":"integer"
                            },
                            "configuratorId":{
                                "description":"Configuration ID for this commerce item.",
                                "type":"string"
                            },
                            "assetKey":{
                                "description":"The assetKey assigned when the item is a service.",
                                "type":"string"
                            },
                            "priceInfo":{
                                "description":"Details about pricing.",
                                "type":"object",
                                "properties":{
                                    "discounted":{
                                        "description":"Whether the price is discounted.",
                                        "type":"boolean"
                                    },
                                    "amount":{
                                        "description":"The monetary amount of this order.",
                                        "type":"number"
                                    },
                                    "rawTotalPrice":{
                                        "description":"The raw total price.",
                                        "type":"number"
                                    },
                                    "salePrice":{
                                        "description":"The sale price",
                                        "type":"number"
                                    },
                                    "orderDiscountInfos":{
                                        "description":"Array of order promotions affecting this item.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "couponCodes":{
                                                    "description":"One or more coupon codes used to grant the order promotion providing the discount.",
                                                    "type":"array",
                                                    "items":{
                                                        "type":"string"
                                                    }
                                                },
                                                "amount":{
                                                    "description":"The amount of discount this item received from the promotion.",
                                                    "type":"number"
                                                },
                                                "promotionId":{
                                                    "description":"The promotion id that resulted in the discount.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "priceListId":{
                                        "description":"The price list ID used for pricing.",
                                        "type":"string"
                                    },
                                    "itemDiscountInfos":{
                                        "description":"Array of item promotions affecting this item.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "couponCodes":{
                                                    "description":"One or more coupon codes used to grant the item promotion providing the discount.",
                                                    "type":"array",
                                                    "items":{
                                                        "type":"string"
                                                    }
                                                },
                                                "amount":{
                                                    "description":"The amount of discount this item received from the promotion.",
                                                    "type":"number"
                                                },
                                                "promotionId":{
                                                    "description":"The promotion id that resulted in the discount.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "quantityDiscounted":{
                                        "description":"The quantity discounted.",
                                        "type":"integer"
                                    },
                                    "amountIsFinal":{
                                        "description":"Whether the amount is final.",
                                        "type":"boolean"
                                    },
                                    "shippingSurcharge":{
                                        "description":"Extra handling cost for shipping the product.",
                                        "type":"number"
                                    },
                                    "onSale":{
                                        "description":"Whether is on sale.",
                                        "type":"boolean"
                                    },
                                    "discountable":{
                                        "description":"Whether discountable.",
                                        "type":"boolean"
                                    },
                                    "currencyCode":{
                                        "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                                        "type":"string"
                                    },
                                    "currentPriceDetailsSorted":{
                                        "description":"The current price details.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "discounted":{
                                                    "description":"Whether the price is discounted.",
                                                    "type":"boolean"
                                                },
                                                "secondaryCurrencyTaxAmount":{
                                                    "description":" tax amount in secondaryCurrency",
                                                    "type":"number"
                                                },
                                                "amount":{
                                                    "description":"The monetary amount.",
                                                    "type":"number"
                                                },
                                                "quantity":{
                                                    "description":"The number of items covered by this price info",
                                                    "type":"integer"
                                                },
                                                "amountIsFinal":{
                                                    "description":"Whether the amount is final.",
                                                    "type":"boolean"
                                                },
                                                "range":{
                                                    "description":"Represents which specific items are covered by this price info.",
                                                    "type":"object",
                                                    "properties":{
                                                        "lowBound":{
                                                            "description":"The lower bound of the range this price info covers, inclusive.",
                                                            "type":"integer"
                                                        },
                                                        "highBound":{
                                                            "description":"The upper bound of the range this price info covers.",
                                                            "type":"integer"
                                                        },
                                                        "size":{
                                                            "description":"The number of items in this range, inclusive. (read-only)",
                                                            "type":"integer"
                                                        }
                                                    }
                                                },
                                                "tax":{
                                                    "description":"Monetary tax amount.",
                                                    "type":"number"
                                                },
                                                "orderDiscountShare":{
                                                    "description":"Share of the order discount for this item",
                                                    "type":"number"
                                                },
                                                "detailedUnitPrice":{
                                                    "description":"The detailed unit price: amount / quantity. (read-only)",
                                                    "type":"number"
                                                },
                                                "currencyCode":{
                                                    "description":"The three character currency code for the monetary amounts.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "listPrice":{
                                        "description":"The monetary amount of the list price.",
                                        "type":"number"
                                    }
                                }
                            },
                            "catalogId":{
                                "description":"The ID of the catalog which this commerce item references.",
                                "type":"string"
                            },
                            "externalRecurringChargeDetails":{
                                "description":"Details about external recurring pricing.",
                                "type":"object",
                                "properties":{
                                    "externalRecurringCharge":{
                                        "description":"The external recurring price.",
                                        "type":"number"
                                    },
                                    "externalRecurringChargeFrequency":{
                                        "description":"The frequency for the recurring charge e.g. Monthly.",
                                        "type":"string"
                                    },
                                    "externalRecurringChargeDuration":{
                                        "description":"The duration for the recurring charge e.g. 12 months.",
                                        "type":"string"
                                    }
                                }
                            },
                            "externalPriceDetails":{
                                "description":"Details about external pricing",
                                "type":"object",
                                "properties":{
                                    "externalPriceQuantity":{
                                        "description":"external quantity of this commerce item",
                                        "type":"integer"
                                    },
                                    "externalPrice":{
                                        "description":"External price of this commerce item",
                                        "type":"number"
                                    }
                                }
                            },
                            "actionCode":{
                                "description":"The action code that has been set on the item by the third party system.",
                                "type":"string"
                            },
                            "id":{
                                "description":"The internal/native ID for this commerce item.",
                                "type":"string"
                            },
                            "state":{
                                "description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
                                "type":"string"
                            },
                            "stateDetail":{
                                "description":"Details about the state of this commerce item",
                                "type":"string"
                            },
                            "serviceId":{
                                "description":"The service ID associated to the current item.",
                                "type":"string"
                            },
                            "commerceItems":{
                                "description":"The sub commerce items represent the child items of a configurable commerce item. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "$ref":"#/definitions/cancelOrderSubCommerceItems"
                                }
                            },
                            "serviceAccountId":{
                                "description":"The service account ID associated to the current item.",
                                "type":"string"
                            },
                            "commerceItemsIsTruncated":{
                                "description":"This property will be added to the webhook payload only if the corresponding commerceItems property is truncated. The value for this field will be true always if present",
                                "type":"boolean"
                            },
                            "quantity":{
                                "description":"The quantity included.",
                                "type":"integer"
                            },
                            "productId":{
                                "description":"The ID of the product.",
                                "type":"string"
                            },
                            "externalId":{
                                "description":"An optional, external ID for this commerce item.",
                                "type":"string"
                            },
                            "parentAssetKey":{
                                "description":"The parentAssetKey assigned when the item is a service.",
                                "type":"string"
                            },
                            "rootAssetKey":{
                                "description":"The rootAssetKey assigned when the item is a service.",
                                "type":"string"
                            },
                            "catalogRefId":{
                                "description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
                                "type":"string"
                            },
                            "recurringChargePriceInfo":{
                                "description":"Recurring charge price information.",
                                "type":"object",
                                "properties":{
                                    "amount":{
                                        "description":"The monetary amount of this recurring charge.",
                                        "type":"number"
                                    },
                                    "total":{
                                        "description":"The total price of the recurring charge.",
                                        "type":"number"
                                    },
                                    "frequencyAmountTotals":{
                                        "description":"The total for each recurring charge frequency",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "total":{
                                                    "description":"The total amount for the frequency.",
                                                    "type":"string"
                                                },
                                                "frequency":{
                                                    "description":"The frequency for the item's total e.g. Monthly.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "shipping":{
                                        "description":"Cost of shipping the product.",
                                        "type":"number"
                                    },
                                    "tax":{
                                        "description":"Monetary tax amount.",
                                        "type":"number"
                                    },
                                    "subTotal":{
                                        "description":"The sub-total price of the recurring charge.",
                                        "type":"number"
                                    },
                                    "frequencyTaxTotals":{
                                        "description":"The tax for each recurring charge frequency",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "tax":{
                                                    "description":"The tax amount for the frequency.",
                                                    "type":"string"
                                                },
                                                "frequency":{
                                                    "description":"The frequency for the item's tax e.g. Monthly.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "currencyCode":{
                                        "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                                        "type":"string"
                                    },
                                    "totalWithoutTax":{
                                        "description":"Total of recurring amount without tax included.",
                                        "type":"number"
                                    }
                                }
                            },
                            "customerAccountId":{
                                "description":"The customer account ID associated to the current item.",
                                "type":"string"
                            },
                            "productDisplayName":{
                                "description":"The product's display name. (read-only, obtained from the referenced product)",
                                "type":"string"
                            },
                            "catalogKey":{
                                "description":"The key of the catalog this commerce item references.",
                                "type":"string"
                            },
                            "siteId":{
                                "description":"The ID of the site on which the item was added.",
                                "type":"string"
                            },
                            "shopperInput":{
                                "description":"Map of shopper input keys to values",
                                "additionalProperties":{
                                    "type":"string"
                                },
                                "type":"object"
                            },
                            "asset":{
                                "description":"The flag that defines it the item is an asset or not.",
                                "type":"boolean"
                            },
                            "activationDate":{
                                "description":"The activation date in ISO format.",
                                "type":"string"
                            },
                            "backOrderQuantity":{
                                "description":"The back ordered quantity included.",
                                "type":"integer"
                            }
                        }
                    }
                },
                "commerceItemsIsTruncated":{
                    "description":"This property will be added to the webhook payload only if the corresponding commerceItems property is truncated. The value for this field will be true always if present",
                    "type":"boolean"
                },
                "taxPriceInfo":{
                    "description":"The tax pricing details for the order.",
                    "type":"object",
                    "properties":{
                        "discounted":{
                            "description":"Whether the price was discounted.",
                            "type":"boolean"
                        },
                        "secondaryCurrencyTaxAmount":{
                            "description":" tax amount in secondaryCurrency",
                            "type":"number"
                        },
                        "amount":{
                            "description":"The monetary amount.",
                            "type":"number"
                        },
                        "valueAddedTax":{
                            "description":"The amount for valueAddedTax.",
                            "type":"number"
                        },
                        "countyTax":{
                            "description":"The monetary amount of county tax.",
                            "type":"number"
                        },
                        "isTaxIncluded":{
                            "description":"Whether the tax is included or not",
                            "type":"boolean"
                        },
                        "miscTax":{
                            "description":"The amount for miscTax.",
                            "type":"number"
                        },
                        "districtTax":{
                            "description":"Tax amount for the district.",
                            "type":"number"
                        },
                        "stateTax":{
                            "description":"Tax amount for the state.",
                            "type":"number"
                        },
                        "miscTaxInfo":{
                            "description":"Details about the miscTax.",
                            "type":"object",
                            "properties":{
                                "Special":{
                                    "description":"Details of the Special tax",
                                    "type":"number"
                                }
                            }
                        },
                        "countryTax":{
                            "description":"The monetary amount of country tax.",
                            "type":"number"
                        },
                        "cityTax":{
                            "description":"The monetary amount of city tax.",
                            "type":"number"
                        },
                        "amountIsFinal":{
                            "description":"Whether the amount is final.",
                            "type":"boolean"
                        },
                        "currencyCode":{
                            "description":"The three character currency code.",
                            "type":"string"
                        }
                    }
                },
                "shippingGroups":{
                    "description":"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.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "shippingMethod":{
                                "description":"The shipping method.",
                                "type":"string"
                            },
                            "description":{
                                "description":"The description of this shipping group. Defaults to the ID.",
                                "type":"string"
                            },
                            "submittedDate":{
                                "format":"date-time",
                                "description":"The date the shipping group was submitted.",
                                "type":"string"
                            },
                            "priceInfo":{
                                "description":"The pricing details about this shipping group.",
                                "type":"object",
                                "properties":{
                                    "discounted":{
                                        "description":"Whether this item is discounted.",
                                        "type":"boolean"
                                    },
                                    "secondaryCurrencyTaxAmount":{
                                        "description":" The secondary currency tax amount.",
                                        "type":"number"
                                    },
                                    "shippingTax":{
                                        "description":"shippingTax for this shipping group",
                                        "type":"number"
                                    },
                                    "amount":{
                                        "description":"The monetary amount.",
                                        "type":"number"
                                    },
                                    "secondaryCurrencyShippingAmount":{
                                        "description":" The secondary currency shipping amount.",
                                        "type":"number"
                                    },
                                    "rawShipping":{
                                        "description":"The monitary amount of the cost of raw shipping.",
                                        "type":"number"
                                    },
                                    "amountIsFinal":{
                                        "description":"Whether the amount is final.",
                                        "type":"boolean"
                                    },
                                    "currencyCode":{
                                        "description":"The currency code for the monetary amounts.",
                                        "type":"string"
                                    }
                                }
                            },
                            "recurringChargePriceInfo":{
                                "description":"Recurring charge price information.",
                                "type":"object",
                                "properties":{
                                    "amount":{
                                        "description":"The monetary amount of this recurring charge.",
                                        "type":"number"
                                    },
                                    "total":{
                                        "description":"The total price of the recurring charge.",
                                        "type":"number"
                                    },
                                    "frequencyAmountTotals":{
                                        "description":"The total for each recurring charge frequency",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "total":{
                                                    "description":"The total amount for the frequency.",
                                                    "type":"string"
                                                },
                                                "frequency":{
                                                    "description":"The frequency for the item's total e.g. Monthly.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "shipping":{
                                        "description":"Cost of shipping the product.",
                                        "type":"number"
                                    },
                                    "tax":{
                                        "description":"Monetary tax amount.",
                                        "type":"number"
                                    },
                                    "subTotal":{
                                        "description":"The sub-total price of the recurring charge.",
                                        "type":"number"
                                    },
                                    "frequencyTaxTotals":{
                                        "description":"The tax for each recurring charge frequency",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "tax":{
                                                    "description":"The tax amount for the frequency.",
                                                    "type":"string"
                                                },
                                                "frequency":{
                                                    "description":"The frequency for the item's tax e.g. Monthly.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "currencyCode":{
                                        "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                                        "type":"string"
                                    },
                                    "totalWithoutTax":{
                                        "description":"Total of recurring amount without tax included.",
                                        "type":"number"
                                    }
                                }
                            },
                            "shipOnDate":{
                                "format":"date-time",
                                "description":"The date this shipping group is expected to ship upon.",
                                "type":"string"
                            },
                            "actualShipDate":{
                                "format":"date-time",
                                "description":"The actual shipped date of this shipping group.",
                                "type":"string"
                            },
                            "specialInstructions":{
                                "description":"Special instructions for the shipping group. Keys and values are strings.",
                                "type":"object",
                                "properties":{
                                    "additionalProperties":{
                                        "type":"string"
                                    }
                                }
                            },
                            "shippingAddress":{
                                "description":"The shipping address for this shipping group.",
                                "type":"object",
                                "properties":{
                                    "lastName":{
                                        "description":"Last name.",
                                        "type":"string"
                                    },
                                    "country":{
                                        "description":"Country.",
                                        "type":"string"
                                    },
                                    "address3":{
                                        "description":"Address Line 3.",
                                        "type":"string"
                                    },
                                    "address2":{
                                        "description":"Address Line 2.",
                                        "type":"string"
                                    },
                                    "city":{
                                        "description":"City.",
                                        "type":"string"
                                    },
                                    "address1":{
                                        "description":"Address Line 1.",
                                        "type":"string"
                                    },
                                    "prefix":{
                                        "description":"Prefix.",
                                        "type":"string"
                                    },
                                    "companyName":{
                                        "description":"Company name.",
                                        "type":"string"
                                    },
                                    "postalCode":{
                                        "description":"Postal code.",
                                        "type":"string"
                                    },
                                    "jobTitle":{
                                        "description":"Job title.",
                                        "type":"string"
                                    },
                                    "county":{
                                        "description":"Name of the county.",
                                        "type":"string"
                                    },
                                    "ownerId":{
                                        "description":"The ID of the owner of this address.",
                                        "type":"string"
                                    },
                                    "suffix":{
                                        "description":"Suffix.",
                                        "type":"string"
                                    },
                                    "firstName":{
                                        "description":"First name.",
                                        "type":"string"
                                    },
                                    "phoneNumber":{
                                        "description":"Phone number.",
                                        "type":"string"
                                    },
                                    "faxNumber":{
                                        "description":"The fax number.",
                                        "type":"string"
                                    },
                                    "middleName":{
                                        "description":"Middle name.",
                                        "type":"string"
                                    },
                                    "state":{
                                        "description":"State.",
                                        "type":"string"
                                    },
                                    "id":{
                                        "description":"ID.",
                                        "type":"string"
                                    },
                                    "email":{
                                        "description":"The email address",
                                        "type":"string"
                                    }
                                }
                            },
                            "commerceItemRelationships":{
                                "description":"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.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "commerceItemId":{
                                            "description":"The referenced commerce item's internal ID. If it is a new item getting added from webhook response, the item and its commerceItemRelationships' id must have prefix \"new_\".",
                                            "type":"string"
                                        },
                                        "amount":{
                                            "description":"The monetary value.",
                                            "type":"number"
                                        },
                                        "quantity":{
                                            "description":"The quantity of items referenced by this relationship.",
                                            "type":"integer"
                                        },
                                        "relationshipType":{
                                            "description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
                                            "type":"string"
                                        },
                                        "returnedQuantity":{
                                            "description":"Number of referenced items that were returned.",
                                            "type":"integer"
                                        },
                                        "range":{
                                            "description":"Represents which specific items are covered by this commerceItemRelationship.",
                                            "type":"object",
                                            "properties":{
                                                "lowBound":{
                                                    "description":"The lower bound of the range.",
                                                    "type":"integer"
                                                },
                                                "highBound":{
                                                    "description":"The upper bound of the range.",
                                                    "type":"integer"
                                                },
                                                "size":{
                                                    "description":"The no of items this range includes",
                                                    "type":"integer"
                                                }
                                            }
                                        },
                                        "commerceItemExternalId":{
                                            "description":"The referenced commerce item's external ID.",
                                            "type":"string"
                                        },
                                        "state":{
                                            "description":"The state of this commerceItemRelationships item",
                                            "type":"string"
                                        },
                                        "id":{
                                            "description":"The native ID of this item.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "id":{
                                "description":"The ID of this shipping group.",
                                "type":"string"
                            },
                            "state":{
                                "description":"The state of this shipping group.",
                                "type":"string"
                            },
                            "stateDetail":{
                                "description":"Details about the state of this shipping group.",
                                "type":"string"
                            },
                            "trackingNumber":{
                                "description":"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.",
                                "type":"string"
                            },
                            "handlingInstructions":{
                                "description":"Handling instructions. Currently read-only.",
                                "type":"array",
                                "items":{
                                    "type":"string",
                                    "properties":{
                                    }
                                }
                            },
                            "shippingGroupClassType":{
                                "description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
                                "type":"string"
                            }
                        }
                    }
                },
                "taxExempt":{
                    "description":"Whether order is tax-exempt or not.",
                    "type":"boolean"
                },
                "creationSiteId":{
                    "description":"The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.",
                    "type":"string"
                },
                "profile":{
                    "description":"Basic profile information. (read-only)",
                    "type":"object",
                    "properties":{
                        "lastName":{
                            "description":"Last name.",
                            "type":"string"
                        },
                        "firstName":{
                            "description":"First name.",
                            "type":"string"
                        },
                        "shippingAddress":{
                            "description":"Default shipping address",
                            "type":"object",
                            "properties":{
                                "country":{
                                    "description":"Country.",
                                    "type":"string"
                                },
                                "phoneNumber":{
                                    "description":"Phone number.",
                                    "type":"string"
                                },
                                "address3":{
                                    "description":"Address Line 3.",
                                    "type":"string"
                                },
                                "address2":{
                                    "description":"Address Line 2.",
                                    "type":"string"
                                },
                                "city":{
                                    "description":"City.",
                                    "type":"string"
                                },
                                "address1":{
                                    "description":"Address Line 1.",
                                    "type":"string"
                                },
                                "postalCode":{
                                    "description":"Postal code.",
                                    "type":"string"
                                },
                                "county":{
                                    "description":"Name of the county.",
                                    "type":"string"
                                },
                                "state":{
                                    "description":"State.",
                                    "type":"string"
                                }
                            }
                        },
                        "middleName":{
                            "description":"Middle name.",
                            "type":"string"
                        },
                        "email":{
                            "description":"The email address",
                            "type":"string"
                        }
                    }
                },
                "shippingGroupCount":{
                    "description":"The number of shipping groups (read-only, value is ignored when updating).",
                    "type":"integer"
                },
                "paymentGroupCount":{
                    "description":"The number of payment groups. (read-only, value is ignored when updating)",
                    "type":"integer"
                },
                "orderAction":{
                    "description":"The action performed on the order.",
                    "type":"string"
                },
                "PriceGroupId":{
                    "description":"The id of the PriceGroup.",
                    "type":"string"
                },
                "recurringChargePriceInfo":{
                    "description":"Recurring charge price information.",
                    "type":"object",
                    "properties":{
                        "amount":{
                            "description":"The monetary amount of this recurring charge.",
                            "type":"number"
                        },
                        "total":{
                            "description":"The total price of the recurring charge.",
                            "type":"number"
                        },
                        "frequencyAmountTotals":{
                            "description":"The total for each recurring charge frequency",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "total":{
                                        "description":"The total amount for the frequency.",
                                        "type":"string"
                                    },
                                    "frequency":{
                                        "description":"The frequency for the item's total e.g. Monthly.",
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "shipping":{
                            "description":"Cost of shipping the product.",
                            "type":"number"
                        },
                        "tax":{
                            "description":"Monetary tax amount.",
                            "type":"number"
                        },
                        "subTotal":{
                            "description":"The sub-total price of the recurring charge.",
                            "type":"number"
                        },
                        "frequencyTaxTotals":{
                            "description":"The tax for each recurring charge frequency",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "tax":{
                                        "description":"The tax amount for the frequency.",
                                        "type":"string"
                                    },
                                    "frequency":{
                                        "description":"The frequency for the item's tax e.g. Monthly.",
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "currencyCode":{
                            "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                            "type":"string"
                        },
                        "totalWithoutTax":{
                            "description":"Total of recurring amount without tax included.",
                            "type":"number"
                        }
                    }
                },
                "profileId":{
                    "description":"The ID of the shopper profile that owns the order.",
                    "type":"string"
                },
                "siteId":{
                    "description":"The site id associated with this order",
                    "type":"string"
                },
                "activeQuoteOrderId":{
                    "description":"The Id of the parent quoted order",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : order

Type: object

Show Source

• activeQuoteOrderId(optional): string
  The Id of the parent quoted order
• commerceItems(optional): array commerceItems
  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. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
• commerceItemsIsTruncated(optional): boolean
  This property will be added to the webhook payload only if the corresponding commerceItems property is truncated. The value for this field will be true always if present
• creationSiteId(optional): string
  The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.
• creationTime(optional): integer
  The creation time.
• exchangeRate(optional): number
  exchangeRate
• gwp(optional): boolean
  Whether gift with purchase is enabled or not.
• id(optional): string
  The ID
• lastModifiedTime(optional): integer
  The last modified time.
• locale(optional): string
  Locale
• orderAction(optional): string
  The action performed on the order.
• organizationId(optional): string
  The organization ID.
• paymentGroupCount(optional): integer
  The number of payment groups. (read-only, value is ignored when updating)
• paymentGroups(optional): array paymentGroups
  The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of "tokenizedCreditCard"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of "externalPaymentGroup"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.
• PriceGroupId(optional): string
  The id of the PriceGroup.
• priceInfo(optional): object priceInfo
  Pricing information, an instance of OrderPriceInfo.
• profile(optional): object profile
  Basic profile information. (read-only)
• profileId(optional): string
  The ID of the shopper profile that owns the order.
• quoteInfo(optional): object quoteInfo
  Details about quote info
• recurringChargePriceInfo(optional): object recurringChargePriceInfo
  Recurring charge price information.
• salesChannel(optional): string
  The sales channel of this order. default to "default".
• secondaryCurrencyCode(optional): string
  Secondary currencyCode
• shippingGroupCount(optional): integer
  The number of shipping groups (read-only, value is ignored when updating).
• shippingGroups(optional): array shippingGroups
  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(optional): string
  The site id associated with this order
• state(optional): string
  The state of the order.
• taxCalculated(optional): boolean
  Whether tax is calculated or not
• taxExempt(optional): boolean
  Whether order is tax-exempt or not.
• taxPriceInfo(optional): object taxPriceInfo
  The tax pricing details for the order.
• totalCommerceItemCount(optional): integer
  The total count of commerce items in the order. (read-only)

{
    "properties":{
        "gwp":{
            "description":"Whether gift with purchase is enabled or not.",
            "type":"boolean"
        },
        "secondaryCurrencyCode":{
            "description":"Secondary currencyCode",
            "type":"string"
        },
        "lastModifiedTime":{
            "description":"The last modified time.",
            "type":"integer"
        },
        "creationTime":{
            "description":"The creation time.",
            "type":"integer"
        },
        "locale":{
            "description":"Locale",
            "type":"string"
        },
        "paymentGroups":{
            "description":"The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of \"tokenizedCreditCard\"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of \"externalPaymentGroup\"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "expirationYear":{
                        "description":"A string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards)",
                        "type":"string"
                    },
                    "PONumber":{
                        "description":"The purchase order number",
                        "type":"string"
                    },
                    "externalType":{
                        "description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
                        "type":"string"
                    },
                    "amountAuthorized":{
                        "description":"The monetary amount authorized.",
                        "type":"number"
                    },
                    "amount":{
                        "description":"The monetary amount of the payment.",
                        "type":"number"
                    },
                    "externalId":{
                        "description":"The ID for the payment group in an external system (like the OMS)",
                        "type":"string"
                    },
                    "expirationMonth":{
                        "description":"A string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards)",
                        "type":"string"
                    },
                    "creditCardType":{
                        "description":"The type of the credit card. (only for TokenizedCreditCards)",
                        "type":"string"
                    },
                    "submittedDate":{
                        "format":"date-time",
                        "description":"The date the payment was submitted.",
                        "type":"string"
                    },
                    "authorizationStatus":{
                        "description":"Aray of authorization status objects.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "amount":{
                                    "description":"The monetary amount.",
                                    "type":"number"
                                },
                                "transactionSuccess":{
                                    "description":"Whether the transaction was successful.",
                                    "type":"boolean"
                                },
                                "errorMessage":{
                                    "description":"The error message, if any.",
                                    "type":"string"
                                },
                                "transactionId":{
                                    "description":"The transaction ID.",
                                    "type":"string"
                                },
                                "transactionTimestamp":{
                                    "description":"The timestamp of the transaction.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "token":{
                        "description":"The CyberSource token string. (only for tokenizedCreditCard)",
                        "type":"string"
                    },
                    "paymentGroupClassType":{
                        "description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
                        "type":"string"
                    },
                    "creditCardNumber":{
                        "description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
                        "type":"string"
                    },
                    "externalSubtype":{
                        "description":"The subtype in the external system. Might be \"VISA\" for a PaymentGroup with an external type of \"CreditCard\". (only for ExternalPaymentGroups)",
                        "type":"string"
                    },
                    "paymentMethod":{
                        "description":"The payment method. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
                        "type":"string"
                    },
                    "externalSourceId":{
                        "description":"The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)",
                        "type":"string"
                    },
                    "state":{
                        "description":"The state of this payment group.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The internal ID of the payment group.",
                        "type":"string"
                    },
                    "stateDetail":{
                        "description":"Details about the state of this payment group.",
                        "type":"string"
                    },
                    "currencyCode":{
                        "description":"The three character currency code. For example: USD.",
                        "type":"string"
                    },
                    "expirationDayOfMonth":{
                        "description":"A string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards)",
                        "type":"string"
                    }
                }
            }
        },
        "salesChannel":{
            "description":"The sales channel of this order. default to \"default\".",
            "type":"string"
        },
        "organizationId":{
            "description":"The organization ID.",
            "type":"string"
        },
        "priceInfo":{
            "description":"Pricing information, an instance of OrderPriceInfo.",
            "type":"object",
            "properties":{
                "secondaryCurrencyTaxAmount":{
                    "description":"The secondary currency tax amount.",
                    "type":"number"
                },
                "discounted":{
                    "description":"Whether the price is discounted.",
                    "type":"boolean"
                },
                "amount":{
                    "description":"The monetary amount.",
                    "type":"number"
                },
                "secondaryCurrencyShippingAmount":{
                    "description":"The secondary currency shipping amount.",
                    "type":"number"
                },
                "secondaryCurrencyTotal":{
                    "description":"The secondary currency total amount.",
                    "type":"number"
                },
                "manualAdjustmentTotal":{
                    "description":"The monetary total of manual adjustments.",
                    "type":"number"
                },
                "discountAmount":{
                    "description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
                    "type":"number"
                },
                "tax":{
                    "description":"Monetary tax amount.",
                    "type":"number"
                },
                "rawSubtotal":{
                    "description":"The monetary raw subtotal.",
                    "type":"number"
                },
                "total":{
                    "description":"The monetary total: amount + shipping + tax. (read-only)",
                    "type":"number"
                },
                "shipping":{
                    "description":"The monetary cost of shipping.",
                    "type":"number"
                },
                "primaryCurrencyTotal":{
                    "description":"The primary currency total amount.",
                    "type":"number"
                },
                "amountIsFinal":{
                    "description":"Whether the amount is final.",
                    "type":"boolean"
                },
                "currencyCode":{
                    "description":"The three character currency code for the monetary amounts.",
                    "type":"string"
                }
            }
        },
        "exchangeRate":{
            "description":"exchangeRate",
            "type":"number"
        },
        "totalCommerceItemCount":{
            "description":"The total count of commerce items in the order. (read-only)",
            "type":"integer"
        },
        "state":{
            "description":"The state of the order.",
            "type":"string"
        },
        "id":{
            "description":"The ID",
            "type":"string"
        },
        "quoteInfo":{
            "description":"Details about quote info",
            "type":"object",
            "properties":{
                "providerNote":{
                    "description":"Provider note for this quote",
                    "type":"string"
                },
                "agentId":{
                    "description":"Agent id",
                    "type":"string"
                },
                "rejectionDate":{
                    "format":"date-time",
                    "description":"Rejection date for this quote",
                    "type":"string"
                },
                "requestDate":{
                    "format":"date-time",
                    "description":"Request Date for this quote",
                    "type":"string"
                },
                "errorInfo":{
                    "description":"Error Info for this quote",
                    "type":"string"
                },
                "externalId":{
                    "description":"external id for this quote",
                    "type":"string"
                },
                "rejectionNote":{
                    "description":"Rejection note for this quote",
                    "type":"string"
                },
                "quoteDate":{
                    "format":"date-time",
                    "description":"Quote Date for this quote",
                    "type":"string"
                },
                "expirationDate":{
                    "format":"date-time",
                    "description":"Expiration date for this quote",
                    "type":"string"
                },
                "requesterNote":{
                    "description":"Requestor note for this quote",
                    "type":"string"
                }
            }
        },
        "taxCalculated":{
            "description":"Whether tax is calculated or not",
            "type":"boolean"
        },
        "commerceItems":{
            "description":"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. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "gwp":{
                        "description":"Flag to indicate whether item exists as a result of a gift with purchase promotion.",
                        "type":"boolean"
                    },
                    "deactivationDate":{
                        "description":"The deactivation date in ISO format.",
                        "type":"string"
                    },
                    "returnedQuantity":{
                        "description":"The quantity returned.",
                        "type":"integer"
                    },
                    "availabilityDate":{
                        "format":"date-time",
                        "description":"The availability date for preOrdered/backOrdered quantity.",
                        "type":"string"
                    },
                    "externalData":{
                        "description":"External data to be associated with a commerce item, provided by a third party system.",
                        "type":"array",
                        "items":{
                            "properties":{
                                "values":{
                                    "description":"The map values associated with an externalData item.",
                                    "type":"object",
                                    "properties":{
                                        "value":{
                                            "description":"Map value defined by external system.",
                                            "type":"string"
                                        },
                                        "key":{
                                            "description":"Map key defined by external system.",
                                            "type":"string"
                                        }
                                    }
                                },
                                "name":{
                                    "description":"The name to be associated with the externalData item.",
                                    "type":"string"
                                },
                                "actionCode":{
                                    "description":"The action code that has been set on the externalData item by the third party system.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "billingAccountId":{
                        "description":"The billing account ID associated to the current item.",
                        "type":"string"
                    },
                    "preOrderQuantity":{
                        "description":"The pre ordered quantity included.",
                        "type":"integer"
                    },
                    "configuratorId":{
                        "description":"Configuration ID for this commerce item.",
                        "type":"string"
                    },
                    "assetKey":{
                        "description":"The assetKey assigned when the item is a service.",
                        "type":"string"
                    },
                    "priceInfo":{
                        "description":"Details about pricing.",
                        "type":"object",
                        "properties":{
                            "discounted":{
                                "description":"Whether the price is discounted.",
                                "type":"boolean"
                            },
                            "amount":{
                                "description":"The monetary amount of this order.",
                                "type":"number"
                            },
                            "rawTotalPrice":{
                                "description":"The raw total price.",
                                "type":"number"
                            },
                            "salePrice":{
                                "description":"The sale price",
                                "type":"number"
                            },
                            "orderDiscountInfos":{
                                "description":"Array of order promotions affecting this item.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "couponCodes":{
                                            "description":"One or more coupon codes used to grant the order promotion providing the discount.",
                                            "type":"array",
                                            "items":{
                                                "type":"string"
                                            }
                                        },
                                        "amount":{
                                            "description":"The amount of discount this item received from the promotion.",
                                            "type":"number"
                                        },
                                        "promotionId":{
                                            "description":"The promotion id that resulted in the discount.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "priceListId":{
                                "description":"The price list ID used for pricing.",
                                "type":"string"
                            },
                            "itemDiscountInfos":{
                                "description":"Array of item promotions affecting this item.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "couponCodes":{
                                            "description":"One or more coupon codes used to grant the item promotion providing the discount.",
                                            "type":"array",
                                            "items":{
                                                "type":"string"
                                            }
                                        },
                                        "amount":{
                                            "description":"The amount of discount this item received from the promotion.",
                                            "type":"number"
                                        },
                                        "promotionId":{
                                            "description":"The promotion id that resulted in the discount.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "quantityDiscounted":{
                                "description":"The quantity discounted.",
                                "type":"integer"
                            },
                            "amountIsFinal":{
                                "description":"Whether the amount is final.",
                                "type":"boolean"
                            },
                            "shippingSurcharge":{
                                "description":"Extra handling cost for shipping the product.",
                                "type":"number"
                            },
                            "onSale":{
                                "description":"Whether is on sale.",
                                "type":"boolean"
                            },
                            "discountable":{
                                "description":"Whether discountable.",
                                "type":"boolean"
                            },
                            "currencyCode":{
                                "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                                "type":"string"
                            },
                            "currentPriceDetailsSorted":{
                                "description":"The current price details.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "discounted":{
                                            "description":"Whether the price is discounted.",
                                            "type":"boolean"
                                        },
                                        "secondaryCurrencyTaxAmount":{
                                            "description":" tax amount in secondaryCurrency",
                                            "type":"number"
                                        },
                                        "amount":{
                                            "description":"The monetary amount.",
                                            "type":"number"
                                        },
                                        "quantity":{
                                            "description":"The number of items covered by this price info",
                                            "type":"integer"
                                        },
                                        "amountIsFinal":{
                                            "description":"Whether the amount is final.",
                                            "type":"boolean"
                                        },
                                        "range":{
                                            "description":"Represents which specific items are covered by this price info.",
                                            "type":"object",
                                            "properties":{
                                                "lowBound":{
                                                    "description":"The lower bound of the range this price info covers, inclusive.",
                                                    "type":"integer"
                                                },
                                                "highBound":{
                                                    "description":"The upper bound of the range this price info covers.",
                                                    "type":"integer"
                                                },
                                                "size":{
                                                    "description":"The number of items in this range, inclusive. (read-only)",
                                                    "type":"integer"
                                                }
                                            }
                                        },
                                        "tax":{
                                            "description":"Monetary tax amount.",
                                            "type":"number"
                                        },
                                        "orderDiscountShare":{
                                            "description":"Share of the order discount for this item",
                                            "type":"number"
                                        },
                                        "detailedUnitPrice":{
                                            "description":"The detailed unit price: amount / quantity. (read-only)",
                                            "type":"number"
                                        },
                                        "currencyCode":{
                                            "description":"The three character currency code for the monetary amounts.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "listPrice":{
                                "description":"The monetary amount of the list price.",
                                "type":"number"
                            }
                        }
                    },
                    "catalogId":{
                        "description":"The ID of the catalog which this commerce item references.",
                        "type":"string"
                    },
                    "externalRecurringChargeDetails":{
                        "description":"Details about external recurring pricing.",
                        "type":"object",
                        "properties":{
                            "externalRecurringCharge":{
                                "description":"The external recurring price.",
                                "type":"number"
                            },
                            "externalRecurringChargeFrequency":{
                                "description":"The frequency for the recurring charge e.g. Monthly.",
                                "type":"string"
                            },
                            "externalRecurringChargeDuration":{
                                "description":"The duration for the recurring charge e.g. 12 months.",
                                "type":"string"
                            }
                        }
                    },
                    "externalPriceDetails":{
                        "description":"Details about external pricing",
                        "type":"object",
                        "properties":{
                            "externalPriceQuantity":{
                                "description":"external quantity of this commerce item",
                                "type":"integer"
                            },
                            "externalPrice":{
                                "description":"External price of this commerce item",
                                "type":"number"
                            }
                        }
                    },
                    "actionCode":{
                        "description":"The action code that has been set on the item by the third party system.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The internal/native ID for this commerce item.",
                        "type":"string"
                    },
                    "state":{
                        "description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
                        "type":"string"
                    },
                    "stateDetail":{
                        "description":"Details about the state of this commerce item",
                        "type":"string"
                    },
                    "serviceId":{
                        "description":"The service ID associated to the current item.",
                        "type":"string"
                    },
                    "commerceItems":{
                        "description":"The sub commerce items represent the child items of a configurable commerce item. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "$ref":"#/definitions/cancelOrderSubCommerceItems"
                        }
                    },
                    "serviceAccountId":{
                        "description":"The service account ID associated to the current item.",
                        "type":"string"
                    },
                    "commerceItemsIsTruncated":{
                        "description":"This property will be added to the webhook payload only if the corresponding commerceItems property is truncated. The value for this field will be true always if present",
                        "type":"boolean"
                    },
                    "quantity":{
                        "description":"The quantity included.",
                        "type":"integer"
                    },
                    "productId":{
                        "description":"The ID of the product.",
                        "type":"string"
                    },
                    "externalId":{
                        "description":"An optional, external ID for this commerce item.",
                        "type":"string"
                    },
                    "parentAssetKey":{
                        "description":"The parentAssetKey assigned when the item is a service.",
                        "type":"string"
                    },
                    "rootAssetKey":{
                        "description":"The rootAssetKey assigned when the item is a service.",
                        "type":"string"
                    },
                    "catalogRefId":{
                        "description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
                        "type":"string"
                    },
                    "recurringChargePriceInfo":{
                        "description":"Recurring charge price information.",
                        "type":"object",
                        "properties":{
                            "amount":{
                                "description":"The monetary amount of this recurring charge.",
                                "type":"number"
                            },
                            "total":{
                                "description":"The total price of the recurring charge.",
                                "type":"number"
                            },
                            "frequencyAmountTotals":{
                                "description":"The total for each recurring charge frequency",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "total":{
                                            "description":"The total amount for the frequency.",
                                            "type":"string"
                                        },
                                        "frequency":{
                                            "description":"The frequency for the item's total e.g. Monthly.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "shipping":{
                                "description":"Cost of shipping the product.",
                                "type":"number"
                            },
                            "tax":{
                                "description":"Monetary tax amount.",
                                "type":"number"
                            },
                            "subTotal":{
                                "description":"The sub-total price of the recurring charge.",
                                "type":"number"
                            },
                            "frequencyTaxTotals":{
                                "description":"The tax for each recurring charge frequency",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "tax":{
                                            "description":"The tax amount for the frequency.",
                                            "type":"string"
                                        },
                                        "frequency":{
                                            "description":"The frequency for the item's tax e.g. Monthly.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "currencyCode":{
                                "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                                "type":"string"
                            },
                            "totalWithoutTax":{
                                "description":"Total of recurring amount without tax included.",
                                "type":"number"
                            }
                        }
                    },
                    "customerAccountId":{
                        "description":"The customer account ID associated to the current item.",
                        "type":"string"
                    },
                    "productDisplayName":{
                        "description":"The product's display name. (read-only, obtained from the referenced product)",
                        "type":"string"
                    },
                    "catalogKey":{
                        "description":"The key of the catalog this commerce item references.",
                        "type":"string"
                    },
                    "siteId":{
                        "description":"The ID of the site on which the item was added.",
                        "type":"string"
                    },
                    "shopperInput":{
                        "description":"Map of shopper input keys to values",
                        "additionalProperties":{
                            "type":"string"
                        },
                        "type":"object"
                    },
                    "asset":{
                        "description":"The flag that defines it the item is an asset or not.",
                        "type":"boolean"
                    },
                    "activationDate":{
                        "description":"The activation date in ISO format.",
                        "type":"string"
                    },
                    "backOrderQuantity":{
                        "description":"The back ordered quantity included.",
                        "type":"integer"
                    }
                }
            }
        },
        "commerceItemsIsTruncated":{
            "description":"This property will be added to the webhook payload only if the corresponding commerceItems property is truncated. The value for this field will be true always if present",
            "type":"boolean"
        },
        "taxPriceInfo":{
            "description":"The tax pricing details for the order.",
            "type":"object",
            "properties":{
                "discounted":{
                    "description":"Whether the price was discounted.",
                    "type":"boolean"
                },
                "secondaryCurrencyTaxAmount":{
                    "description":" tax amount in secondaryCurrency",
                    "type":"number"
                },
                "amount":{
                    "description":"The monetary amount.",
                    "type":"number"
                },
                "valueAddedTax":{
                    "description":"The amount for valueAddedTax.",
                    "type":"number"
                },
                "countyTax":{
                    "description":"The monetary amount of county tax.",
                    "type":"number"
                },
                "isTaxIncluded":{
                    "description":"Whether the tax is included or not",
                    "type":"boolean"
                },
                "miscTax":{
                    "description":"The amount for miscTax.",
                    "type":"number"
                },
                "districtTax":{
                    "description":"Tax amount for the district.",
                    "type":"number"
                },
                "stateTax":{
                    "description":"Tax amount for the state.",
                    "type":"number"
                },
                "miscTaxInfo":{
                    "description":"Details about the miscTax.",
                    "type":"object",
                    "properties":{
                        "Special":{
                            "description":"Details of the Special tax",
                            "type":"number"
                        }
                    }
                },
                "countryTax":{
                    "description":"The monetary amount of country tax.",
                    "type":"number"
                },
                "cityTax":{
                    "description":"The monetary amount of city tax.",
                    "type":"number"
                },
                "amountIsFinal":{
                    "description":"Whether the amount is final.",
                    "type":"boolean"
                },
                "currencyCode":{
                    "description":"The three character currency code.",
                    "type":"string"
                }
            }
        },
        "shippingGroups":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "shippingMethod":{
                        "description":"The shipping method.",
                        "type":"string"
                    },
                    "description":{
                        "description":"The description of this shipping group. Defaults to the ID.",
                        "type":"string"
                    },
                    "submittedDate":{
                        "format":"date-time",
                        "description":"The date the shipping group was submitted.",
                        "type":"string"
                    },
                    "priceInfo":{
                        "description":"The pricing details about this shipping group.",
                        "type":"object",
                        "properties":{
                            "discounted":{
                                "description":"Whether this item is discounted.",
                                "type":"boolean"
                            },
                            "secondaryCurrencyTaxAmount":{
                                "description":" The secondary currency tax amount.",
                                "type":"number"
                            },
                            "shippingTax":{
                                "description":"shippingTax for this shipping group",
                                "type":"number"
                            },
                            "amount":{
                                "description":"The monetary amount.",
                                "type":"number"
                            },
                            "secondaryCurrencyShippingAmount":{
                                "description":" The secondary currency shipping amount.",
                                "type":"number"
                            },
                            "rawShipping":{
                                "description":"The monitary amount of the cost of raw shipping.",
                                "type":"number"
                            },
                            "amountIsFinal":{
                                "description":"Whether the amount is final.",
                                "type":"boolean"
                            },
                            "currencyCode":{
                                "description":"The currency code for the monetary amounts.",
                                "type":"string"
                            }
                        }
                    },
                    "recurringChargePriceInfo":{
                        "description":"Recurring charge price information.",
                        "type":"object",
                        "properties":{
                            "amount":{
                                "description":"The monetary amount of this recurring charge.",
                                "type":"number"
                            },
                            "total":{
                                "description":"The total price of the recurring charge.",
                                "type":"number"
                            },
                            "frequencyAmountTotals":{
                                "description":"The total for each recurring charge frequency",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "total":{
                                            "description":"The total amount for the frequency.",
                                            "type":"string"
                                        },
                                        "frequency":{
                                            "description":"The frequency for the item's total e.g. Monthly.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "shipping":{
                                "description":"Cost of shipping the product.",
                                "type":"number"
                            },
                            "tax":{
                                "description":"Monetary tax amount.",
                                "type":"number"
                            },
                            "subTotal":{
                                "description":"The sub-total price of the recurring charge.",
                                "type":"number"
                            },
                            "frequencyTaxTotals":{
                                "description":"The tax for each recurring charge frequency",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "tax":{
                                            "description":"The tax amount for the frequency.",
                                            "type":"string"
                                        },
                                        "frequency":{
                                            "description":"The frequency for the item's tax e.g. Monthly.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "currencyCode":{
                                "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                                "type":"string"
                            },
                            "totalWithoutTax":{
                                "description":"Total of recurring amount without tax included.",
                                "type":"number"
                            }
                        }
                    },
                    "shipOnDate":{
                        "format":"date-time",
                        "description":"The date this shipping group is expected to ship upon.",
                        "type":"string"
                    },
                    "actualShipDate":{
                        "format":"date-time",
                        "description":"The actual shipped date of this shipping group.",
                        "type":"string"
                    },
                    "specialInstructions":{
                        "description":"Special instructions for the shipping group. Keys and values are strings.",
                        "type":"object",
                        "properties":{
                            "additionalProperties":{
                                "type":"string"
                            }
                        }
                    },
                    "shippingAddress":{
                        "description":"The shipping address for this shipping group.",
                        "type":"object",
                        "properties":{
                            "lastName":{
                                "description":"Last name.",
                                "type":"string"
                            },
                            "country":{
                                "description":"Country.",
                                "type":"string"
                            },
                            "address3":{
                                "description":"Address Line 3.",
                                "type":"string"
                            },
                            "address2":{
                                "description":"Address Line 2.",
                                "type":"string"
                            },
                            "city":{
                                "description":"City.",
                                "type":"string"
                            },
                            "address1":{
                                "description":"Address Line 1.",
                                "type":"string"
                            },
                            "prefix":{
                                "description":"Prefix.",
                                "type":"string"
                            },
                            "companyName":{
                                "description":"Company name.",
                                "type":"string"
                            },
                            "postalCode":{
                                "description":"Postal code.",
                                "type":"string"
                            },
                            "jobTitle":{
                                "description":"Job title.",
                                "type":"string"
                            },
                            "county":{
                                "description":"Name of the county.",
                                "type":"string"
                            },
                            "ownerId":{
                                "description":"The ID of the owner of this address.",
                                "type":"string"
                            },
                            "suffix":{
                                "description":"Suffix.",
                                "type":"string"
                            },
                            "firstName":{
                                "description":"First name.",
                                "type":"string"
                            },
                            "phoneNumber":{
                                "description":"Phone number.",
                                "type":"string"
                            },
                            "faxNumber":{
                                "description":"The fax number.",
                                "type":"string"
                            },
                            "middleName":{
                                "description":"Middle name.",
                                "type":"string"
                            },
                            "state":{
                                "description":"State.",
                                "type":"string"
                            },
                            "id":{
                                "description":"ID.",
                                "type":"string"
                            },
                            "email":{
                                "description":"The email address",
                                "type":"string"
                            }
                        }
                    },
                    "commerceItemRelationships":{
                        "description":"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.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "commerceItemId":{
                                    "description":"The referenced commerce item's internal ID. If it is a new item getting added from webhook response, the item and its commerceItemRelationships' id must have prefix \"new_\".",
                                    "type":"string"
                                },
                                "amount":{
                                    "description":"The monetary value.",
                                    "type":"number"
                                },
                                "quantity":{
                                    "description":"The quantity of items referenced by this relationship.",
                                    "type":"integer"
                                },
                                "relationshipType":{
                                    "description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
                                    "type":"string"
                                },
                                "returnedQuantity":{
                                    "description":"Number of referenced items that were returned.",
                                    "type":"integer"
                                },
                                "range":{
                                    "description":"Represents which specific items are covered by this commerceItemRelationship.",
                                    "type":"object",
                                    "properties":{
                                        "lowBound":{
                                            "description":"The lower bound of the range.",
                                            "type":"integer"
                                        },
                                        "highBound":{
                                            "description":"The upper bound of the range.",
                                            "type":"integer"
                                        },
                                        "size":{
                                            "description":"The no of items this range includes",
                                            "type":"integer"
                                        }
                                    }
                                },
                                "commerceItemExternalId":{
                                    "description":"The referenced commerce item's external ID.",
                                    "type":"string"
                                },
                                "state":{
                                    "description":"The state of this commerceItemRelationships item",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"The native ID of this item.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "id":{
                        "description":"The ID of this shipping group.",
                        "type":"string"
                    },
                    "state":{
                        "description":"The state of this shipping group.",
                        "type":"string"
                    },
                    "stateDetail":{
                        "description":"Details about the state of this shipping group.",
                        "type":"string"
                    },
                    "trackingNumber":{
                        "description":"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.",
                        "type":"string"
                    },
                    "handlingInstructions":{
                        "description":"Handling instructions. Currently read-only.",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "properties":{
                            }
                        }
                    },
                    "shippingGroupClassType":{
                        "description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
                        "type":"string"
                    }
                }
            }
        },
        "taxExempt":{
            "description":"Whether order is tax-exempt or not.",
            "type":"boolean"
        },
        "creationSiteId":{
            "description":"The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.",
            "type":"string"
        },
        "profile":{
            "description":"Basic profile information. (read-only)",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"Last name.",
                    "type":"string"
                },
                "firstName":{
                    "description":"First name.",
                    "type":"string"
                },
                "shippingAddress":{
                    "description":"Default shipping address",
                    "type":"object",
                    "properties":{
                        "country":{
                            "description":"Country.",
                            "type":"string"
                        },
                        "phoneNumber":{
                            "description":"Phone number.",
                            "type":"string"
                        },
                        "address3":{
                            "description":"Address Line 3.",
                            "type":"string"
                        },
                        "address2":{
                            "description":"Address Line 2.",
                            "type":"string"
                        },
                        "city":{
                            "description":"City.",
                            "type":"string"
                        },
                        "address1":{
                            "description":"Address Line 1.",
                            "type":"string"
                        },
                        "postalCode":{
                            "description":"Postal code.",
                            "type":"string"
                        },
                        "county":{
                            "description":"Name of the county.",
                            "type":"string"
                        },
                        "state":{
                            "description":"State.",
                            "type":"string"
                        }
                    }
                },
                "middleName":{
                    "description":"Middle name.",
                    "type":"string"
                },
                "email":{
                    "description":"The email address",
                    "type":"string"
                }
            }
        },
        "shippingGroupCount":{
            "description":"The number of shipping groups (read-only, value is ignored when updating).",
            "type":"integer"
        },
        "paymentGroupCount":{
            "description":"The number of payment groups. (read-only, value is ignored when updating)",
            "type":"integer"
        },
        "orderAction":{
            "description":"The action performed on the order.",
            "type":"string"
        },
        "PriceGroupId":{
            "description":"The id of the PriceGroup.",
            "type":"string"
        },
        "recurringChargePriceInfo":{
            "description":"Recurring charge price information.",
            "type":"object",
            "properties":{
                "amount":{
                    "description":"The monetary amount of this recurring charge.",
                    "type":"number"
                },
                "total":{
                    "description":"The total price of the recurring charge.",
                    "type":"number"
                },
                "frequencyAmountTotals":{
                    "description":"The total for each recurring charge frequency",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "total":{
                                "description":"The total amount for the frequency.",
                                "type":"string"
                            },
                            "frequency":{
                                "description":"The frequency for the item's total e.g. Monthly.",
                                "type":"string"
                            }
                        }
                    }
                },
                "shipping":{
                    "description":"Cost of shipping the product.",
                    "type":"number"
                },
                "tax":{
                    "description":"Monetary tax amount.",
                    "type":"number"
                },
                "subTotal":{
                    "description":"The sub-total price of the recurring charge.",
                    "type":"number"
                },
                "frequencyTaxTotals":{
                    "description":"The tax for each recurring charge frequency",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "tax":{
                                "description":"The tax amount for the frequency.",
                                "type":"string"
                            },
                            "frequency":{
                                "description":"The frequency for the item's tax e.g. Monthly.",
                                "type":"string"
                            }
                        }
                    }
                },
                "currencyCode":{
                    "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                    "type":"string"
                },
                "totalWithoutTax":{
                    "description":"Total of recurring amount without tax included.",
                    "type":"number"
                }
            }
        },
        "profileId":{
            "description":"The ID of the shopper profile that owns the order.",
            "type":"string"
        },
        "siteId":{
            "description":"The site id associated with this order",
            "type":"string"
        },
        "activeQuoteOrderId":{
            "description":"The Id of the parent quoted order",
            "type":"string"
        }
    }
}

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. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook

Show Source

• Array of: object items

{
    "description":"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. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "gwp":{
                "description":"Flag to indicate whether item exists as a result of a gift with purchase promotion.",
                "type":"boolean"
            },
            "deactivationDate":{
                "description":"The deactivation date in ISO format.",
                "type":"string"
            },
            "returnedQuantity":{
                "description":"The quantity returned.",
                "type":"integer"
            },
            "availabilityDate":{
                "format":"date-time",
                "description":"The availability date for preOrdered/backOrdered quantity.",
                "type":"string"
            },
            "externalData":{
                "description":"External data to be associated with a commerce item, provided by a third party system.",
                "type":"array",
                "items":{
                    "properties":{
                        "values":{
                            "description":"The map values associated with an externalData item.",
                            "type":"object",
                            "properties":{
                                "value":{
                                    "description":"Map value defined by external system.",
                                    "type":"string"
                                },
                                "key":{
                                    "description":"Map key defined by external system.",
                                    "type":"string"
                                }
                            }
                        },
                        "name":{
                            "description":"The name to be associated with the externalData item.",
                            "type":"string"
                        },
                        "actionCode":{
                            "description":"The action code that has been set on the externalData item by the third party system.",
                            "type":"string"
                        }
                    }
                }
            },
            "billingAccountId":{
                "description":"The billing account ID associated to the current item.",
                "type":"string"
            },
            "preOrderQuantity":{
                "description":"The pre ordered quantity included.",
                "type":"integer"
            },
            "configuratorId":{
                "description":"Configuration ID for this commerce item.",
                "type":"string"
            },
            "assetKey":{
                "description":"The assetKey assigned when the item is a service.",
                "type":"string"
            },
            "priceInfo":{
                "description":"Details about pricing.",
                "type":"object",
                "properties":{
                    "discounted":{
                        "description":"Whether the price is discounted.",
                        "type":"boolean"
                    },
                    "amount":{
                        "description":"The monetary amount of this order.",
                        "type":"number"
                    },
                    "rawTotalPrice":{
                        "description":"The raw total price.",
                        "type":"number"
                    },
                    "salePrice":{
                        "description":"The sale price",
                        "type":"number"
                    },
                    "orderDiscountInfos":{
                        "description":"Array of order promotions affecting this item.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "couponCodes":{
                                    "description":"One or more coupon codes used to grant the order promotion providing the discount.",
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                },
                                "amount":{
                                    "description":"The amount of discount this item received from the promotion.",
                                    "type":"number"
                                },
                                "promotionId":{
                                    "description":"The promotion id that resulted in the discount.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "priceListId":{
                        "description":"The price list ID used for pricing.",
                        "type":"string"
                    },
                    "itemDiscountInfos":{
                        "description":"Array of item promotions affecting this item.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "couponCodes":{
                                    "description":"One or more coupon codes used to grant the item promotion providing the discount.",
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                },
                                "amount":{
                                    "description":"The amount of discount this item received from the promotion.",
                                    "type":"number"
                                },
                                "promotionId":{
                                    "description":"The promotion id that resulted in the discount.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "quantityDiscounted":{
                        "description":"The quantity discounted.",
                        "type":"integer"
                    },
                    "amountIsFinal":{
                        "description":"Whether the amount is final.",
                        "type":"boolean"
                    },
                    "shippingSurcharge":{
                        "description":"Extra handling cost for shipping the product.",
                        "type":"number"
                    },
                    "onSale":{
                        "description":"Whether is on sale.",
                        "type":"boolean"
                    },
                    "discountable":{
                        "description":"Whether discountable.",
                        "type":"boolean"
                    },
                    "currencyCode":{
                        "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                        "type":"string"
                    },
                    "currentPriceDetailsSorted":{
                        "description":"The current price details.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "discounted":{
                                    "description":"Whether the price is discounted.",
                                    "type":"boolean"
                                },
                                "secondaryCurrencyTaxAmount":{
                                    "description":" tax amount in secondaryCurrency",
                                    "type":"number"
                                },
                                "amount":{
                                    "description":"The monetary amount.",
                                    "type":"number"
                                },
                                "quantity":{
                                    "description":"The number of items covered by this price info",
                                    "type":"integer"
                                },
                                "amountIsFinal":{
                                    "description":"Whether the amount is final.",
                                    "type":"boolean"
                                },
                                "range":{
                                    "description":"Represents which specific items are covered by this price info.",
                                    "type":"object",
                                    "properties":{
                                        "lowBound":{
                                            "description":"The lower bound of the range this price info covers, inclusive.",
                                            "type":"integer"
                                        },
                                        "highBound":{
                                            "description":"The upper bound of the range this price info covers.",
                                            "type":"integer"
                                        },
                                        "size":{
                                            "description":"The number of items in this range, inclusive. (read-only)",
                                            "type":"integer"
                                        }
                                    }
                                },
                                "tax":{
                                    "description":"Monetary tax amount.",
                                    "type":"number"
                                },
                                "orderDiscountShare":{
                                    "description":"Share of the order discount for this item",
                                    "type":"number"
                                },
                                "detailedUnitPrice":{
                                    "description":"The detailed unit price: amount / quantity. (read-only)",
                                    "type":"number"
                                },
                                "currencyCode":{
                                    "description":"The three character currency code for the monetary amounts.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "listPrice":{
                        "description":"The monetary amount of the list price.",
                        "type":"number"
                    }
                }
            },
            "catalogId":{
                "description":"The ID of the catalog which this commerce item references.",
                "type":"string"
            },
            "externalRecurringChargeDetails":{
                "description":"Details about external recurring pricing.",
                "type":"object",
                "properties":{
                    "externalRecurringCharge":{
                        "description":"The external recurring price.",
                        "type":"number"
                    },
                    "externalRecurringChargeFrequency":{
                        "description":"The frequency for the recurring charge e.g. Monthly.",
                        "type":"string"
                    },
                    "externalRecurringChargeDuration":{
                        "description":"The duration for the recurring charge e.g. 12 months.",
                        "type":"string"
                    }
                }
            },
            "externalPriceDetails":{
                "description":"Details about external pricing",
                "type":"object",
                "properties":{
                    "externalPriceQuantity":{
                        "description":"external quantity of this commerce item",
                        "type":"integer"
                    },
                    "externalPrice":{
                        "description":"External price of this commerce item",
                        "type":"number"
                    }
                }
            },
            "actionCode":{
                "description":"The action code that has been set on the item by the third party system.",
                "type":"string"
            },
            "id":{
                "description":"The internal/native ID for this commerce item.",
                "type":"string"
            },
            "state":{
                "description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
                "type":"string"
            },
            "stateDetail":{
                "description":"Details about the state of this commerce item",
                "type":"string"
            },
            "serviceId":{
                "description":"The service ID associated to the current item.",
                "type":"string"
            },
            "commerceItems":{
                "description":"The sub commerce items represent the child items of a configurable commerce item. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
                "type":"array",
                "items":{
                    "type":"object",
                    "$ref":"#/definitions/cancelOrderSubCommerceItems"
                }
            },
            "serviceAccountId":{
                "description":"The service account ID associated to the current item.",
                "type":"string"
            },
            "commerceItemsIsTruncated":{
                "description":"This property will be added to the webhook payload only if the corresponding commerceItems property is truncated. The value for this field will be true always if present",
                "type":"boolean"
            },
            "quantity":{
                "description":"The quantity included.",
                "type":"integer"
            },
            "productId":{
                "description":"The ID of the product.",
                "type":"string"
            },
            "externalId":{
                "description":"An optional, external ID for this commerce item.",
                "type":"string"
            },
            "parentAssetKey":{
                "description":"The parentAssetKey assigned when the item is a service.",
                "type":"string"
            },
            "rootAssetKey":{
                "description":"The rootAssetKey assigned when the item is a service.",
                "type":"string"
            },
            "catalogRefId":{
                "description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
                "type":"string"
            },
            "recurringChargePriceInfo":{
                "description":"Recurring charge price information.",
                "type":"object",
                "properties":{
                    "amount":{
                        "description":"The monetary amount of this recurring charge.",
                        "type":"number"
                    },
                    "total":{
                        "description":"The total price of the recurring charge.",
                        "type":"number"
                    },
                    "frequencyAmountTotals":{
                        "description":"The total for each recurring charge frequency",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "total":{
                                    "description":"The total amount for the frequency.",
                                    "type":"string"
                                },
                                "frequency":{
                                    "description":"The frequency for the item's total e.g. Monthly.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "shipping":{
                        "description":"Cost of shipping the product.",
                        "type":"number"
                    },
                    "tax":{
                        "description":"Monetary tax amount.",
                        "type":"number"
                    },
                    "subTotal":{
                        "description":"The sub-total price of the recurring charge.",
                        "type":"number"
                    },
                    "frequencyTaxTotals":{
                        "description":"The tax for each recurring charge frequency",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "tax":{
                                    "description":"The tax amount for the frequency.",
                                    "type":"string"
                                },
                                "frequency":{
                                    "description":"The frequency for the item's tax e.g. Monthly.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "currencyCode":{
                        "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                        "type":"string"
                    },
                    "totalWithoutTax":{
                        "description":"Total of recurring amount without tax included.",
                        "type":"number"
                    }
                }
            },
            "customerAccountId":{
                "description":"The customer account ID associated to the current item.",
                "type":"string"
            },
            "productDisplayName":{
                "description":"The product's display name. (read-only, obtained from the referenced product)",
                "type":"string"
            },
            "catalogKey":{
                "description":"The key of the catalog this commerce item references.",
                "type":"string"
            },
            "siteId":{
                "description":"The ID of the site on which the item was added.",
                "type":"string"
            },
            "shopperInput":{
                "description":"Map of shopper input keys to values",
                "additionalProperties":{
                    "type":"string"
                },
                "type":"object"
            },
            "asset":{
                "description":"The flag that defines it the item is an asset or not.",
                "type":"boolean"
            },
            "activationDate":{
                "description":"The activation date in ISO format.",
                "type":"string"
            },
            "backOrderQuantity":{
                "description":"The back ordered quantity included.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : paymentGroups

Type: array

The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of "tokenizedCreditCard"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of "externalPaymentGroup"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.

Show Source

• Array of: object items

{
    "description":"The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of \"tokenizedCreditCard\"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of \"externalPaymentGroup\"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "expirationYear":{
                "description":"A string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards)",
                "type":"string"
            },
            "PONumber":{
                "description":"The purchase order number",
                "type":"string"
            },
            "externalType":{
                "description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
                "type":"string"
            },
            "amountAuthorized":{
                "description":"The monetary amount authorized.",
                "type":"number"
            },
            "amount":{
                "description":"The monetary amount of the payment.",
                "type":"number"
            },
            "externalId":{
                "description":"The ID for the payment group in an external system (like the OMS)",
                "type":"string"
            },
            "expirationMonth":{
                "description":"A string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards)",
                "type":"string"
            },
            "creditCardType":{
                "description":"The type of the credit card. (only for TokenizedCreditCards)",
                "type":"string"
            },
            "submittedDate":{
                "format":"date-time",
                "description":"The date the payment was submitted.",
                "type":"string"
            },
            "authorizationStatus":{
                "description":"Aray of authorization status objects.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "amount":{
                            "description":"The monetary amount.",
                            "type":"number"
                        },
                        "transactionSuccess":{
                            "description":"Whether the transaction was successful.",
                            "type":"boolean"
                        },
                        "errorMessage":{
                            "description":"The error message, if any.",
                            "type":"string"
                        },
                        "transactionId":{
                            "description":"The transaction ID.",
                            "type":"string"
                        },
                        "transactionTimestamp":{
                            "description":"The timestamp of the transaction.",
                            "type":"string"
                        }
                    }
                }
            },
            "token":{
                "description":"The CyberSource token string. (only for tokenizedCreditCard)",
                "type":"string"
            },
            "paymentGroupClassType":{
                "description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
                "type":"string"
            },
            "creditCardNumber":{
                "description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
                "type":"string"
            },
            "externalSubtype":{
                "description":"The subtype in the external system. Might be \"VISA\" for a PaymentGroup with an external type of \"CreditCard\". (only for ExternalPaymentGroups)",
                "type":"string"
            },
            "paymentMethod":{
                "description":"The payment method. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
                "type":"string"
            },
            "externalSourceId":{
                "description":"The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)",
                "type":"string"
            },
            "state":{
                "description":"The state of this payment group.",
                "type":"string"
            },
            "id":{
                "description":"The internal ID of the payment group.",
                "type":"string"
            },
            "stateDetail":{
                "description":"Details about the state of this payment group.",
                "type":"string"
            },
            "currencyCode":{
                "description":"The three character currency code. For example: USD.",
                "type":"string"
            },
            "expirationDayOfMonth":{
                "description":"A string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards)",
                "type":"string"
            }
        }
    }
}

Nested Schema : priceInfo

Type: object

Pricing information, an instance of OrderPriceInfo.

Show Source

• amount(optional): number
  The monetary amount.
• amountIsFinal(optional): boolean
  Whether the amount is final.
• currencyCode(optional): string
  The three character currency code for the monetary amounts.
• discountAmount(optional): number
  The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)
• discounted(optional): boolean
  Whether the price is discounted.
• manualAdjustmentTotal(optional): number
  The monetary total of manual adjustments.
• primaryCurrencyTotal(optional): number
  The primary currency total amount.
• rawSubtotal(optional): number
  The monetary raw subtotal.
• secondaryCurrencyShippingAmount(optional): number
  The secondary currency shipping amount.
• secondaryCurrencyTaxAmount(optional): number
  The secondary currency tax amount.
• secondaryCurrencyTotal(optional): number
  The secondary currency total amount.
• shipping(optional): number
  The monetary cost of shipping.
• tax(optional): number
  Monetary tax amount.
• total(optional): number
  The monetary total: amount + shipping + tax. (read-only)

{
    "description":"Pricing information, an instance of OrderPriceInfo.",
    "type":"object",
    "properties":{
        "secondaryCurrencyTaxAmount":{
            "description":"The secondary currency tax amount.",
            "type":"number"
        },
        "discounted":{
            "description":"Whether the price is discounted.",
            "type":"boolean"
        },
        "amount":{
            "description":"The monetary amount.",
            "type":"number"
        },
        "secondaryCurrencyShippingAmount":{
            "description":"The secondary currency shipping amount.",
            "type":"number"
        },
        "secondaryCurrencyTotal":{
            "description":"The secondary currency total amount.",
            "type":"number"
        },
        "manualAdjustmentTotal":{
            "description":"The monetary total of manual adjustments.",
            "type":"number"
        },
        "discountAmount":{
            "description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
            "type":"number"
        },
        "tax":{
            "description":"Monetary tax amount.",
            "type":"number"
        },
        "rawSubtotal":{
            "description":"The monetary raw subtotal.",
            "type":"number"
        },
        "total":{
            "description":"The monetary total: amount + shipping + tax. (read-only)",
            "type":"number"
        },
        "shipping":{
            "description":"The monetary cost of shipping.",
            "type":"number"
        },
        "primaryCurrencyTotal":{
            "description":"The primary currency total amount.",
            "type":"number"
        },
        "amountIsFinal":{
            "description":"Whether the amount is final.",
            "type":"boolean"
        },
        "currencyCode":{
            "description":"The three character currency code for the monetary amounts.",
            "type":"string"
        }
    }
}

Nested Schema : profile

Type: object

Basic profile information. (read-only)

Show Source

• email(optional): string
  The email address
• firstName(optional): string
  First name.
• lastName(optional): string
  Last name.
• middleName(optional): string
  Middle name.
• shippingAddress(optional): object shippingAddress
  Default shipping address

{
    "description":"Basic profile information. (read-only)",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"Last name.",
            "type":"string"
        },
        "firstName":{
            "description":"First name.",
            "type":"string"
        },
        "shippingAddress":{
            "description":"Default shipping address",
            "type":"object",
            "properties":{
                "country":{
                    "description":"Country.",
                    "type":"string"
                },
                "phoneNumber":{
                    "description":"Phone number.",
                    "type":"string"
                },
                "address3":{
                    "description":"Address Line 3.",
                    "type":"string"
                },
                "address2":{
                    "description":"Address Line 2.",
                    "type":"string"
                },
                "city":{
                    "description":"City.",
                    "type":"string"
                },
                "address1":{
                    "description":"Address Line 1.",
                    "type":"string"
                },
                "postalCode":{
                    "description":"Postal code.",
                    "type":"string"
                },
                "county":{
                    "description":"Name of the county.",
                    "type":"string"
                },
                "state":{
                    "description":"State.",
                    "type":"string"
                }
            }
        },
        "middleName":{
            "description":"Middle name.",
            "type":"string"
        },
        "email":{
            "description":"The email address",
            "type":"string"
        }
    }
}

Nested Schema : quoteInfo

Type: object

Details about quote info

Show Source

• agentId(optional): string
  Agent id
• errorInfo(optional): string
  Error Info for this quote
• expirationDate(optional): string(date-time)
  Expiration date for this quote
• externalId(optional): string
  external id for this quote
• providerNote(optional): string
  Provider note for this quote
• quoteDate(optional): string(date-time)
  Quote Date for this quote
• rejectionDate(optional): string(date-time)
  Rejection date for this quote
• rejectionNote(optional): string
  Rejection note for this quote
• requestDate(optional): string(date-time)
  Request Date for this quote
• requesterNote(optional): string
  Requestor note for this quote

{
    "description":"Details about quote info",
    "type":"object",
    "properties":{
        "providerNote":{
            "description":"Provider note for this quote",
            "type":"string"
        },
        "agentId":{
            "description":"Agent id",
            "type":"string"
        },
        "rejectionDate":{
            "format":"date-time",
            "description":"Rejection date for this quote",
            "type":"string"
        },
        "requestDate":{
            "format":"date-time",
            "description":"Request Date for this quote",
            "type":"string"
        },
        "errorInfo":{
            "description":"Error Info for this quote",
            "type":"string"
        },
        "externalId":{
            "description":"external id for this quote",
            "type":"string"
        },
        "rejectionNote":{
            "description":"Rejection note for this quote",
            "type":"string"
        },
        "quoteDate":{
            "format":"date-time",
            "description":"Quote Date for this quote",
            "type":"string"
        },
        "expirationDate":{
            "format":"date-time",
            "description":"Expiration date for this quote",
            "type":"string"
        },
        "requesterNote":{
            "description":"Requestor note for this quote",
            "type":"string"
        }
    }
}

Nested Schema : recurringChargePriceInfo

Type: object

Recurring charge price information.

Show Source

• amount(optional): number
  The monetary amount of this recurring charge.
• currencyCode(optional): string
  The currency code for the monetary amounts. A three character currency code such as USD.
• frequencyAmountTotals(optional): array frequencyAmountTotals
  The total for each recurring charge frequency
• frequencyTaxTotals(optional): array frequencyTaxTotals
  The tax for each recurring charge frequency
• shipping(optional): number
  Cost of shipping the product.
• subTotal(optional): number
  The sub-total price of the recurring charge.
• tax(optional): number
  Monetary tax amount.
• total(optional): number
  The total price of the recurring charge.
• totalWithoutTax(optional): number
  Total of recurring amount without tax included.

{
    "description":"Recurring charge price information.",
    "type":"object",
    "properties":{
        "amount":{
            "description":"The monetary amount of this recurring charge.",
            "type":"number"
        },
        "total":{
            "description":"The total price of the recurring charge.",
            "type":"number"
        },
        "frequencyAmountTotals":{
            "description":"The total for each recurring charge frequency",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "total":{
                        "description":"The total amount for the frequency.",
                        "type":"string"
                    },
                    "frequency":{
                        "description":"The frequency for the item's total e.g. Monthly.",
                        "type":"string"
                    }
                }
            }
        },
        "shipping":{
            "description":"Cost of shipping the product.",
            "type":"number"
        },
        "tax":{
            "description":"Monetary tax amount.",
            "type":"number"
        },
        "subTotal":{
            "description":"The sub-total price of the recurring charge.",
            "type":"number"
        },
        "frequencyTaxTotals":{
            "description":"The tax for each recurring charge frequency",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "tax":{
                        "description":"The tax amount for the frequency.",
                        "type":"string"
                    },
                    "frequency":{
                        "description":"The frequency for the item's tax e.g. Monthly.",
                        "type":"string"
                    }
                }
            }
        },
        "currencyCode":{
            "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
            "type":"string"
        },
        "totalWithoutTax":{
            "description":"Total of recurring amount without tax included.",
            "type":"number"
        }
    }
}

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.

Show Source

• Array of: object items

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "shippingMethod":{
                "description":"The shipping method.",
                "type":"string"
            },
            "description":{
                "description":"The description of this shipping group. Defaults to the ID.",
                "type":"string"
            },
            "submittedDate":{
                "format":"date-time",
                "description":"The date the shipping group was submitted.",
                "type":"string"
            },
            "priceInfo":{
                "description":"The pricing details about this shipping group.",
                "type":"object",
                "properties":{
                    "discounted":{
                        "description":"Whether this item is discounted.",
                        "type":"boolean"
                    },
                    "secondaryCurrencyTaxAmount":{
                        "description":" The secondary currency tax amount.",
                        "type":"number"
                    },
                    "shippingTax":{
                        "description":"shippingTax for this shipping group",
                        "type":"number"
                    },
                    "amount":{
                        "description":"The monetary amount.",
                        "type":"number"
                    },
                    "secondaryCurrencyShippingAmount":{
                        "description":" The secondary currency shipping amount.",
                        "type":"number"
                    },
                    "rawShipping":{
                        "description":"The monitary amount of the cost of raw shipping.",
                        "type":"number"
                    },
                    "amountIsFinal":{
                        "description":"Whether the amount is final.",
                        "type":"boolean"
                    },
                    "currencyCode":{
                        "description":"The currency code for the monetary amounts.",
                        "type":"string"
                    }
                }
            },
            "recurringChargePriceInfo":{
                "description":"Recurring charge price information.",
                "type":"object",
                "properties":{
                    "amount":{
                        "description":"The monetary amount of this recurring charge.",
                        "type":"number"
                    },
                    "total":{
                        "description":"The total price of the recurring charge.",
                        "type":"number"
                    },
                    "frequencyAmountTotals":{
                        "description":"The total for each recurring charge frequency",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "total":{
                                    "description":"The total amount for the frequency.",
                                    "type":"string"
                                },
                                "frequency":{
                                    "description":"The frequency for the item's total e.g. Monthly.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "shipping":{
                        "description":"Cost of shipping the product.",
                        "type":"number"
                    },
                    "tax":{
                        "description":"Monetary tax amount.",
                        "type":"number"
                    },
                    "subTotal":{
                        "description":"The sub-total price of the recurring charge.",
                        "type":"number"
                    },
                    "frequencyTaxTotals":{
                        "description":"The tax for each recurring charge frequency",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "tax":{
                                    "description":"The tax amount for the frequency.",
                                    "type":"string"
                                },
                                "frequency":{
                                    "description":"The frequency for the item's tax e.g. Monthly.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "currencyCode":{
                        "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                        "type":"string"
                    },
                    "totalWithoutTax":{
                        "description":"Total of recurring amount without tax included.",
                        "type":"number"
                    }
                }
            },
            "shipOnDate":{
                "format":"date-time",
                "description":"The date this shipping group is expected to ship upon.",
                "type":"string"
            },
            "actualShipDate":{
                "format":"date-time",
                "description":"The actual shipped date of this shipping group.",
                "type":"string"
            },
            "specialInstructions":{
                "description":"Special instructions for the shipping group. Keys and values are strings.",
                "type":"object",
                "properties":{
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "shippingAddress":{
                "description":"The shipping address for this shipping group.",
                "type":"object",
                "properties":{
                    "lastName":{
                        "description":"Last name.",
                        "type":"string"
                    },
                    "country":{
                        "description":"Country.",
                        "type":"string"
                    },
                    "address3":{
                        "description":"Address Line 3.",
                        "type":"string"
                    },
                    "address2":{
                        "description":"Address Line 2.",
                        "type":"string"
                    },
                    "city":{
                        "description":"City.",
                        "type":"string"
                    },
                    "address1":{
                        "description":"Address Line 1.",
                        "type":"string"
                    },
                    "prefix":{
                        "description":"Prefix.",
                        "type":"string"
                    },
                    "companyName":{
                        "description":"Company name.",
                        "type":"string"
                    },
                    "postalCode":{
                        "description":"Postal code.",
                        "type":"string"
                    },
                    "jobTitle":{
                        "description":"Job title.",
                        "type":"string"
                    },
                    "county":{
                        "description":"Name of the county.",
                        "type":"string"
                    },
                    "ownerId":{
                        "description":"The ID of the owner of this address.",
                        "type":"string"
                    },
                    "suffix":{
                        "description":"Suffix.",
                        "type":"string"
                    },
                    "firstName":{
                        "description":"First name.",
                        "type":"string"
                    },
                    "phoneNumber":{
                        "description":"Phone number.",
                        "type":"string"
                    },
                    "faxNumber":{
                        "description":"The fax number.",
                        "type":"string"
                    },
                    "middleName":{
                        "description":"Middle name.",
                        "type":"string"
                    },
                    "state":{
                        "description":"State.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID.",
                        "type":"string"
                    },
                    "email":{
                        "description":"The email address",
                        "type":"string"
                    }
                }
            },
            "commerceItemRelationships":{
                "description":"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.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "commerceItemId":{
                            "description":"The referenced commerce item's internal ID. If it is a new item getting added from webhook response, the item and its commerceItemRelationships' id must have prefix \"new_\".",
                            "type":"string"
                        },
                        "amount":{
                            "description":"The monetary value.",
                            "type":"number"
                        },
                        "quantity":{
                            "description":"The quantity of items referenced by this relationship.",
                            "type":"integer"
                        },
                        "relationshipType":{
                            "description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
                            "type":"string"
                        },
                        "returnedQuantity":{
                            "description":"Number of referenced items that were returned.",
                            "type":"integer"
                        },
                        "range":{
                            "description":"Represents which specific items are covered by this commerceItemRelationship.",
                            "type":"object",
                            "properties":{
                                "lowBound":{
                                    "description":"The lower bound of the range.",
                                    "type":"integer"
                                },
                                "highBound":{
                                    "description":"The upper bound of the range.",
                                    "type":"integer"
                                },
                                "size":{
                                    "description":"The no of items this range includes",
                                    "type":"integer"
                                }
                            }
                        },
                        "commerceItemExternalId":{
                            "description":"The referenced commerce item's external ID.",
                            "type":"string"
                        },
                        "state":{
                            "description":"The state of this commerceItemRelationships item",
                            "type":"string"
                        },
                        "id":{
                            "description":"The native ID of this item.",
                            "type":"string"
                        }
                    }
                }
            },
            "id":{
                "description":"The ID of this shipping group.",
                "type":"string"
            },
            "state":{
                "description":"The state of this shipping group.",
                "type":"string"
            },
            "stateDetail":{
                "description":"Details about the state of this shipping group.",
                "type":"string"
            },
            "trackingNumber":{
                "description":"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.",
                "type":"string"
            },
            "handlingInstructions":{
                "description":"Handling instructions. Currently read-only.",
                "type":"array",
                "items":{
                    "type":"string",
                    "properties":{
                    }
                }
            },
            "shippingGroupClassType":{
                "description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
                "type":"string"
            }
        }
    }
}

Nested Schema : taxPriceInfo

Type: object

The tax pricing details for the order.

Show Source

• amount(optional): number
  The monetary amount.
• amountIsFinal(optional): boolean
  Whether the amount is final.
• cityTax(optional): number
  The monetary amount of city tax.
• countryTax(optional): number
  The monetary amount of country tax.
• countyTax(optional): number
  The monetary amount of county tax.
• currencyCode(optional): string
  The three character currency code.
• discounted(optional): boolean
  Whether the price was discounted.
• districtTax(optional): number
  Tax amount for the district.
• isTaxIncluded(optional): boolean
  Whether the tax is included or not
• miscTax(optional): number
  The amount for miscTax.
• miscTaxInfo(optional): object miscTaxInfo
  Details about the miscTax.
• secondaryCurrencyTaxAmount(optional): number
  tax amount in secondaryCurrency
• stateTax(optional): number
  Tax amount for the state.
• valueAddedTax(optional): number
  The amount for valueAddedTax.

{
    "description":"The tax pricing details for the order.",
    "type":"object",
    "properties":{
        "discounted":{
            "description":"Whether the price was discounted.",
            "type":"boolean"
        },
        "secondaryCurrencyTaxAmount":{
            "description":" tax amount in secondaryCurrency",
            "type":"number"
        },
        "amount":{
            "description":"The monetary amount.",
            "type":"number"
        },
        "valueAddedTax":{
            "description":"The amount for valueAddedTax.",
            "type":"number"
        },
        "countyTax":{
            "description":"The monetary amount of county tax.",
            "type":"number"
        },
        "isTaxIncluded":{
            "description":"Whether the tax is included or not",
            "type":"boolean"
        },
        "miscTax":{
            "description":"The amount for miscTax.",
            "type":"number"
        },
        "districtTax":{
            "description":"Tax amount for the district.",
            "type":"number"
        },
        "stateTax":{
            "description":"Tax amount for the state.",
            "type":"number"
        },
        "miscTaxInfo":{
            "description":"Details about the miscTax.",
            "type":"object",
            "properties":{
                "Special":{
                    "description":"Details of the Special tax",
                    "type":"number"
                }
            }
        },
        "countryTax":{
            "description":"The monetary amount of country tax.",
            "type":"number"
        },
        "cityTax":{
            "description":"The monetary amount of city tax.",
            "type":"number"
        },
        "amountIsFinal":{
            "description":"Whether the amount is final.",
            "type":"boolean"
        },
        "currencyCode":{
            "description":"The three character currency code.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• actionCode(optional): string
  The action code that has been set on the item by the third party system.
• activationDate(optional): string
  The activation date in ISO format.
• asset(optional): boolean
  The flag that defines it the item is an asset or not.
• assetKey(optional): string
  The assetKey assigned when the item is a service.
• availabilityDate(optional): string(date-time)
  The availability date for preOrdered/backOrdered quantity.
• backOrderQuantity(optional): integer
  The back ordered quantity included.
• billingAccountId(optional): string
  The billing account ID associated to the current item.
• catalogId(optional): string
  The ID of the catalog which this commerce item references.
• catalogKey(optional): string
  The key of the catalog this commerce item references.
• catalogRefId(optional): string
  The reference ID of the catalog this commerce item references. Typically the SKU id.
• commerceItems(optional): array commerceItems
  The sub commerce items represent the child items of a configurable commerce item. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
• commerceItemsIsTruncated(optional): boolean
  This property will be added to the webhook payload only if the corresponding commerceItems property is truncated. The value for this field will be true always if present
• configuratorId(optional): string
  Configuration ID for this commerce item.
• customerAccountId(optional): string
  The customer account ID associated to the current item.
• deactivationDate(optional): string
  The deactivation date in ISO format.
• externalData(optional): array externalData
  External data to be associated with a commerce item, provided by a third party system.
• externalId(optional): string
  An optional, external ID for this commerce item.
• externalPriceDetails(optional): object externalPriceDetails
  Details about external pricing
• externalRecurringChargeDetails(optional): object externalRecurringChargeDetails
  Details about external recurring pricing.
• gwp(optional): boolean
  Flag to indicate whether item exists as a result of a gift with purchase promotion.
• id(optional): string
  The internal/native ID for this commerce item.
• parentAssetKey(optional): string
  The parentAssetKey assigned when the item is a service.
• preOrderQuantity(optional): integer
  The pre ordered quantity included.
• priceInfo(optional): object priceInfo
  Details about pricing.
• productDisplayName(optional): string
  The product's display name. (read-only, obtained from the referenced product)
• productId(optional): string
  The ID of the product.
• quantity(optional): integer
  The quantity included.
• recurringChargePriceInfo(optional): object recurringChargePriceInfo
  Recurring charge price information.
• returnedQuantity(optional): integer
  The quantity returned.
• rootAssetKey(optional): string
  The rootAssetKey assigned when the item is a service.
• serviceAccountId(optional): string
  The service account ID associated to the current item.
• serviceId(optional): string
  The service ID associated to the current item.
• shopperInput(optional): object shopperInput
  Additional Properties Allowed: additionalProperties

  Map of shopper input keys to values
• siteId(optional): string
  The ID of the site on which the item was added.
• state(optional): string
  The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)
• stateDetail(optional): string
  Details about the state of this commerce item

{
    "type":"object",
    "properties":{
        "gwp":{
            "description":"Flag to indicate whether item exists as a result of a gift with purchase promotion.",
            "type":"boolean"
        },
        "deactivationDate":{
            "description":"The deactivation date in ISO format.",
            "type":"string"
        },
        "returnedQuantity":{
            "description":"The quantity returned.",
            "type":"integer"
        },
        "availabilityDate":{
            "format":"date-time",
            "description":"The availability date for preOrdered/backOrdered quantity.",
            "type":"string"
        },
        "externalData":{
            "description":"External data to be associated with a commerce item, provided by a third party system.",
            "type":"array",
            "items":{
                "properties":{
                    "values":{
                        "description":"The map values associated with an externalData item.",
                        "type":"object",
                        "properties":{
                            "value":{
                                "description":"Map value defined by external system.",
                                "type":"string"
                            },
                            "key":{
                                "description":"Map key defined by external system.",
                                "type":"string"
                            }
                        }
                    },
                    "name":{
                        "description":"The name to be associated with the externalData item.",
                        "type":"string"
                    },
                    "actionCode":{
                        "description":"The action code that has been set on the externalData item by the third party system.",
                        "type":"string"
                    }
                }
            }
        },
        "billingAccountId":{
            "description":"The billing account ID associated to the current item.",
            "type":"string"
        },
        "preOrderQuantity":{
            "description":"The pre ordered quantity included.",
            "type":"integer"
        },
        "configuratorId":{
            "description":"Configuration ID for this commerce item.",
            "type":"string"
        },
        "assetKey":{
            "description":"The assetKey assigned when the item is a service.",
            "type":"string"
        },
        "priceInfo":{
            "description":"Details about pricing.",
            "type":"object",
            "properties":{
                "discounted":{
                    "description":"Whether the price is discounted.",
                    "type":"boolean"
                },
                "amount":{
                    "description":"The monetary amount of this order.",
                    "type":"number"
                },
                "rawTotalPrice":{
                    "description":"The raw total price.",
                    "type":"number"
                },
                "salePrice":{
                    "description":"The sale price",
                    "type":"number"
                },
                "orderDiscountInfos":{
                    "description":"Array of order promotions affecting this item.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "couponCodes":{
                                "description":"One or more coupon codes used to grant the order promotion providing the discount.",
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            },
                            "amount":{
                                "description":"The amount of discount this item received from the promotion.",
                                "type":"number"
                            },
                            "promotionId":{
                                "description":"The promotion id that resulted in the discount.",
                                "type":"string"
                            }
                        }
                    }
                },
                "priceListId":{
                    "description":"The price list ID used for pricing.",
                    "type":"string"
                },
                "itemDiscountInfos":{
                    "description":"Array of item promotions affecting this item.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "couponCodes":{
                                "description":"One or more coupon codes used to grant the item promotion providing the discount.",
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            },
                            "amount":{
                                "description":"The amount of discount this item received from the promotion.",
                                "type":"number"
                            },
                            "promotionId":{
                                "description":"The promotion id that resulted in the discount.",
                                "type":"string"
                            }
                        }
                    }
                },
                "quantityDiscounted":{
                    "description":"The quantity discounted.",
                    "type":"integer"
                },
                "amountIsFinal":{
                    "description":"Whether the amount is final.",
                    "type":"boolean"
                },
                "shippingSurcharge":{
                    "description":"Extra handling cost for shipping the product.",
                    "type":"number"
                },
                "onSale":{
                    "description":"Whether is on sale.",
                    "type":"boolean"
                },
                "discountable":{
                    "description":"Whether discountable.",
                    "type":"boolean"
                },
                "currencyCode":{
                    "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                    "type":"string"
                },
                "currentPriceDetailsSorted":{
                    "description":"The current price details.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "discounted":{
                                "description":"Whether the price is discounted.",
                                "type":"boolean"
                            },
                            "secondaryCurrencyTaxAmount":{
                                "description":" tax amount in secondaryCurrency",
                                "type":"number"
                            },
                            "amount":{
                                "description":"The monetary amount.",
                                "type":"number"
                            },
                            "quantity":{
                                "description":"The number of items covered by this price info",
                                "type":"integer"
                            },
                            "amountIsFinal":{
                                "description":"Whether the amount is final.",
                                "type":"boolean"
                            },
                            "range":{
                                "description":"Represents which specific items are covered by this price info.",
                                "type":"object",
                                "properties":{
                                    "lowBound":{
                                        "description":"The lower bound of the range this price info covers, inclusive.",
                                        "type":"integer"
                                    },
                                    "highBound":{
                                        "description":"The upper bound of the range this price info covers.",
                                        "type":"integer"
                                    },
                                    "size":{
                                        "description":"The number of items in this range, inclusive. (read-only)",
                                        "type":"integer"
                                    }
                                }
                            },
                            "tax":{
                                "description":"Monetary tax amount.",
                                "type":"number"
                            },
                            "orderDiscountShare":{
                                "description":"Share of the order discount for this item",
                                "type":"number"
                            },
                            "detailedUnitPrice":{
                                "description":"The detailed unit price: amount / quantity. (read-only)",
                                "type":"number"
                            },
                            "currencyCode":{
                                "description":"The three character currency code for the monetary amounts.",
                                "type":"string"
                            }
                        }
                    }
                },
                "listPrice":{
                    "description":"The monetary amount of the list price.",
                    "type":"number"
                }
            }
        },
        "catalogId":{
            "description":"The ID of the catalog which this commerce item references.",
            "type":"string"
        },
        "externalRecurringChargeDetails":{
            "description":"Details about external recurring pricing.",
            "type":"object",
            "properties":{
                "externalRecurringCharge":{
                    "description":"The external recurring price.",
                    "type":"number"
                },
                "externalRecurringChargeFrequency":{
                    "description":"The frequency for the recurring charge e.g. Monthly.",
                    "type":"string"
                },
                "externalRecurringChargeDuration":{
                    "description":"The duration for the recurring charge e.g. 12 months.",
                    "type":"string"
                }
            }
        },
        "externalPriceDetails":{
            "description":"Details about external pricing",
            "type":"object",
            "properties":{
                "externalPriceQuantity":{
                    "description":"external quantity of this commerce item",
                    "type":"integer"
                },
                "externalPrice":{
                    "description":"External price of this commerce item",
                    "type":"number"
                }
            }
        },
        "actionCode":{
            "description":"The action code that has been set on the item by the third party system.",
            "type":"string"
        },
        "id":{
            "description":"The internal/native ID for this commerce item.",
            "type":"string"
        },
        "state":{
            "description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
            "type":"string"
        },
        "stateDetail":{
            "description":"Details about the state of this commerce item",
            "type":"string"
        },
        "serviceId":{
            "description":"The service ID associated to the current item.",
            "type":"string"
        },
        "commerceItems":{
            "description":"The sub commerce items represent the child items of a configurable commerce item. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
            "type":"array",
            "items":{
                "type":"object",
                "$ref":"#/definitions/cancelOrderSubCommerceItems"
            }
        },
        "serviceAccountId":{
            "description":"The service account ID associated to the current item.",
            "type":"string"
        },
        "commerceItemsIsTruncated":{
            "description":"This property will be added to the webhook payload only if the corresponding commerceItems property is truncated. The value for this field will be true always if present",
            "type":"boolean"
        },
        "quantity":{
            "description":"The quantity included.",
            "type":"integer"
        },
        "productId":{
            "description":"The ID of the product.",
            "type":"string"
        },
        "externalId":{
            "description":"An optional, external ID for this commerce item.",
            "type":"string"
        },
        "parentAssetKey":{
            "description":"The parentAssetKey assigned when the item is a service.",
            "type":"string"
        },
        "rootAssetKey":{
            "description":"The rootAssetKey assigned when the item is a service.",
            "type":"string"
        },
        "catalogRefId":{
            "description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
            "type":"string"
        },
        "recurringChargePriceInfo":{
            "description":"Recurring charge price information.",
            "type":"object",
            "properties":{
                "amount":{
                    "description":"The monetary amount of this recurring charge.",
                    "type":"number"
                },
                "total":{
                    "description":"The total price of the recurring charge.",
                    "type":"number"
                },
                "frequencyAmountTotals":{
                    "description":"The total for each recurring charge frequency",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "total":{
                                "description":"The total amount for the frequency.",
                                "type":"string"
                            },
                            "frequency":{
                                "description":"The frequency for the item's total e.g. Monthly.",
                                "type":"string"
                            }
                        }
                    }
                },
                "shipping":{
                    "description":"Cost of shipping the product.",
                    "type":"number"
                },
                "tax":{
                    "description":"Monetary tax amount.",
                    "type":"number"
                },
                "subTotal":{
                    "description":"The sub-total price of the recurring charge.",
                    "type":"number"
                },
                "frequencyTaxTotals":{
                    "description":"The tax for each recurring charge frequency",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "tax":{
                                "description":"The tax amount for the frequency.",
                                "type":"string"
                            },
                            "frequency":{
                                "description":"The frequency for the item's tax e.g. Monthly.",
                                "type":"string"
                            }
                        }
                    }
                },
                "currencyCode":{
                    "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                    "type":"string"
                },
                "totalWithoutTax":{
                    "description":"Total of recurring amount without tax included.",
                    "type":"number"
                }
            }
        },
        "customerAccountId":{
            "description":"The customer account ID associated to the current item.",
            "type":"string"
        },
        "productDisplayName":{
            "description":"The product's display name. (read-only, obtained from the referenced product)",
            "type":"string"
        },
        "catalogKey":{
            "description":"The key of the catalog this commerce item references.",
            "type":"string"
        },
        "siteId":{
            "description":"The ID of the site on which the item was added.",
            "type":"string"
        },
        "shopperInput":{
            "description":"Map of shopper input keys to values",
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "asset":{
            "description":"The flag that defines it the item is an asset or not.",
            "type":"boolean"
        },
        "activationDate":{
            "description":"The activation date in ISO format.",
            "type":"string"
        },
        "backOrderQuantity":{
            "description":"The back ordered quantity included.",
            "type":"integer"
        }
    }
}

Nested Schema : commerceItems

Type: array

The sub commerce items represent the child items of a configurable commerce item. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook

Show Source

• Array of: object cancelOrderSubCommerceItems

{
    "description":"The sub commerce items represent the child items of a configurable commerce item. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
    "type":"array",
    "items":{
        "type":"object",
        "$ref":"#/definitions/cancelOrderSubCommerceItems"
    }
}

Nested Schema : externalData

Type: array

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

Show Source

• Array of: object items

{
    "description":"External data to be associated with a commerce item, provided by a third party system.",
    "type":"array",
    "items":{
        "properties":{
            "values":{
                "description":"The map values associated with an externalData item.",
                "type":"object",
                "properties":{
                    "value":{
                        "description":"Map value defined by external system.",
                        "type":"string"
                    },
                    "key":{
                        "description":"Map key defined by external system.",
                        "type":"string"
                    }
                }
            },
            "name":{
                "description":"The name to be associated with the externalData item.",
                "type":"string"
            },
            "actionCode":{
                "description":"The action code that has been set on the externalData item by the third party system.",
                "type":"string"
            }
        }
    }
}

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Show Source

• externalPrice(optional): number
  External price of this commerce item
• externalPriceQuantity(optional): integer
  external quantity of this commerce item

{
    "description":"Details about external pricing",
    "type":"object",
    "properties":{
        "externalPriceQuantity":{
            "description":"external quantity of this commerce item",
            "type":"integer"
        },
        "externalPrice":{
            "description":"External price of this commerce item",
            "type":"number"
        }
    }
}

Nested Schema : externalRecurringChargeDetails

Type: object

Details about external recurring pricing.

Show Source

• externalRecurringCharge(optional): number
  The external recurring price.
• externalRecurringChargeDuration(optional): string
  The duration for the recurring charge e.g. 12 months.
• externalRecurringChargeFrequency(optional): string
  The frequency for the recurring charge e.g. Monthly.

{
    "description":"Details about external recurring pricing.",
    "type":"object",
    "properties":{
        "externalRecurringCharge":{
            "description":"The external recurring price.",
            "type":"number"
        },
        "externalRecurringChargeFrequency":{
            "description":"The frequency for the recurring charge e.g. Monthly.",
            "type":"string"
        },
        "externalRecurringChargeDuration":{
            "description":"The duration for the recurring charge e.g. 12 months.",
            "type":"string"
        }
    }
}

Nested Schema : priceInfo

Type: object

Details about pricing.

Show Source

• amount(optional): number
  The monetary amount of this order.
• amountIsFinal(optional): boolean
  Whether the amount is final.
• currencyCode(optional): string
  The currency code for the monetary amounts. A three character currency code such as USD.
• currentPriceDetailsSorted(optional): array currentPriceDetailsSorted
  The current price details.
• discountable(optional): boolean
  Whether discountable.
• discounted(optional): boolean
  Whether the price is discounted.
• itemDiscountInfos(optional): array itemDiscountInfos
  Array of item promotions affecting this item.
• listPrice(optional): number
  The monetary amount of the list price.
• onSale(optional): boolean
  Whether is on sale.
• orderDiscountInfos(optional): array orderDiscountInfos
  Array of order promotions affecting this item.
• priceListId(optional): string
  The price list ID used for pricing.
• quantityDiscounted(optional): integer
  The quantity discounted.
• rawTotalPrice(optional): number
  The raw total price.
• salePrice(optional): number
  The sale price
• shippingSurcharge(optional): number
  Extra handling cost for shipping the product.

{
    "description":"Details about pricing.",
    "type":"object",
    "properties":{
        "discounted":{
            "description":"Whether the price is discounted.",
            "type":"boolean"
        },
        "amount":{
            "description":"The monetary amount of this order.",
            "type":"number"
        },
        "rawTotalPrice":{
            "description":"The raw total price.",
            "type":"number"
        },
        "salePrice":{
            "description":"The sale price",
            "type":"number"
        },
        "orderDiscountInfos":{
            "description":"Array of order promotions affecting this item.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "couponCodes":{
                        "description":"One or more coupon codes used to grant the order promotion providing the discount.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "amount":{
                        "description":"The amount of discount this item received from the promotion.",
                        "type":"number"
                    },
                    "promotionId":{
                        "description":"The promotion id that resulted in the discount.",
                        "type":"string"
                    }
                }
            }
        },
        "priceListId":{
            "description":"The price list ID used for pricing.",
            "type":"string"
        },
        "itemDiscountInfos":{
            "description":"Array of item promotions affecting this item.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "couponCodes":{
                        "description":"One or more coupon codes used to grant the item promotion providing the discount.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "amount":{
                        "description":"The amount of discount this item received from the promotion.",
                        "type":"number"
                    },
                    "promotionId":{
                        "description":"The promotion id that resulted in the discount.",
                        "type":"string"
                    }
                }
            }
        },
        "quantityDiscounted":{
            "description":"The quantity discounted.",
            "type":"integer"
        },
        "amountIsFinal":{
            "description":"Whether the amount is final.",
            "type":"boolean"
        },
        "shippingSurcharge":{
            "description":"Extra handling cost for shipping the product.",
            "type":"number"
        },
        "onSale":{
            "description":"Whether is on sale.",
            "type":"boolean"
        },
        "discountable":{
            "description":"Whether discountable.",
            "type":"boolean"
        },
        "currencyCode":{
            "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
            "type":"string"
        },
        "currentPriceDetailsSorted":{
            "description":"The current price details.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "discounted":{
                        "description":"Whether the price is discounted.",
                        "type":"boolean"
                    },
                    "secondaryCurrencyTaxAmount":{
                        "description":" tax amount in secondaryCurrency",
                        "type":"number"
                    },
                    "amount":{
                        "description":"The monetary amount.",
                        "type":"number"
                    },
                    "quantity":{
                        "description":"The number of items covered by this price info",
                        "type":"integer"
                    },
                    "amountIsFinal":{
                        "description":"Whether the amount is final.",
                        "type":"boolean"
                    },
                    "range":{
                        "description":"Represents which specific items are covered by this price info.",
                        "type":"object",
                        "properties":{
                            "lowBound":{
                                "description":"The lower bound of the range this price info covers, inclusive.",
                                "type":"integer"
                            },
                            "highBound":{
                                "description":"The upper bound of the range this price info covers.",
                                "type":"integer"
                            },
                            "size":{
                                "description":"The number of items in this range, inclusive. (read-only)",
                                "type":"integer"
                            }
                        }
                    },
                    "tax":{
                        "description":"Monetary tax amount.",
                        "type":"number"
                    },
                    "orderDiscountShare":{
                        "description":"Share of the order discount for this item",
                        "type":"number"
                    },
                    "detailedUnitPrice":{
                        "description":"The detailed unit price: amount / quantity. (read-only)",
                        "type":"number"
                    },
                    "currencyCode":{
                        "description":"The three character currency code for the monetary amounts.",
                        "type":"string"
                    }
                }
            }
        },
        "listPrice":{
            "description":"The monetary amount of the list price.",
            "type":"number"
        }
    }
}

Nested Schema : recurringChargePriceInfo

Type: object

Recurring charge price information.

Show Source

• amount(optional): number
  The monetary amount of this recurring charge.
• currencyCode(optional): string
  The currency code for the monetary amounts. A three character currency code such as USD.
• frequencyAmountTotals(optional): array frequencyAmountTotals
  The total for each recurring charge frequency
• frequencyTaxTotals(optional): array frequencyTaxTotals
  The tax for each recurring charge frequency
• shipping(optional): number
  Cost of shipping the product.
• subTotal(optional): number
  The sub-total price of the recurring charge.
• tax(optional): number
  Monetary tax amount.
• total(optional): number
  The total price of the recurring charge.
• totalWithoutTax(optional): number
  Total of recurring amount without tax included.

{
    "description":"Recurring charge price information.",
    "type":"object",
    "properties":{
        "amount":{
            "description":"The monetary amount of this recurring charge.",
            "type":"number"
        },
        "total":{
            "description":"The total price of the recurring charge.",
            "type":"number"
        },
        "frequencyAmountTotals":{
            "description":"The total for each recurring charge frequency",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "total":{
                        "description":"The total amount for the frequency.",
                        "type":"string"
                    },
                    "frequency":{
                        "description":"The frequency for the item's total e.g. Monthly.",
                        "type":"string"
                    }
                }
            }
        },
        "shipping":{
            "description":"Cost of shipping the product.",
            "type":"number"
        },
        "tax":{
            "description":"Monetary tax amount.",
            "type":"number"
        },
        "subTotal":{
            "description":"The sub-total price of the recurring charge.",
            "type":"number"
        },
        "frequencyTaxTotals":{
            "description":"The tax for each recurring charge frequency",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "tax":{
                        "description":"The tax amount for the frequency.",
                        "type":"string"
                    },
                    "frequency":{
                        "description":"The frequency for the item's tax e.g. Monthly.",
                        "type":"string"
                    }
                }
            }
        },
        "currencyCode":{
            "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
            "type":"string"
        },
        "totalWithoutTax":{
            "description":"Total of recurring amount without tax included.",
            "type":"number"
        }
    }
}

Nested Schema : shopperInput

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Map of shopper input keys to values",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Map of shopper input keys to values

Nested Schema : cancelOrderSubCommerceItems

Type: object

Show Source

• actionCode(optional): string
  The action code that has been set on the item by the configurator system. Updatable through webhook response.
• activationDate(optional): string
  The activation date in ISO format. Updatable through webhook response.
• addOnItem(optional): boolean
  Whether this child item is an add-on (internally configured) or not (externally configured). Updatable through webhook response.
• asset(optional): boolean
  The flag that defines it the item is an asset or not. Updatable through webhook response.
• assetKey(optional): string
  The assetKey assigned when the item is a service. Updatable through webhook response.
• billingAccountId(optional): string
  The billing account ID associated to the current item. Updatable through webhook response.
• billingProfileId(optional): string
  The billing profile ID associated to the current item. Updatable through webhook response.
• catalogRefId(optional): string
  The reference ID of the catalog this commerce item references. Typically the SKU id.
• commerceItems(optional): array commerceItems
• configurablePropertyId(optional): string
  ID of the catalog's configurableProperty associated with this item. Updatable through webhook response.
• configurationOptionId(optional): string
  ID of the catalog's configurationOption associated with this item. Updatable through webhook response.
• customerAccountId(optional): string
  The customer account ID associated to the current item. Updatable through webhook response.
• deactivationDate(optional): string
  The deactivation date in ISO format. Updatable through webhook response.
• externalData(optional): array externalData
  External data to be associated with a commerce item, provided by a configurator system. Updatable through webhook response.
• externalPriceDetails(optional): object externalPriceDetails
  Details about external pricing
• parentAssetKey(optional): string
  The parentAssetKey assigned when the item is a service. Updatable through webhook response.
• productId(optional): string
  The ID of the product.
• quantity(optional): integer
  The quantity included. Updatable through webhook response.
• rootAssetKey(optional): string
  The rootAssetKey assigned when the item is a service. Updatable through webhook response.
• serviceAccountId(optional): string
  The service account ID associated to the current item. Updatable through webhook response.
• serviceId(optional): string
  The service ID associated to the current item. Updatable through webhook response.
• shopperInput(optional): object shopperInput
  Additional Properties Allowed: additionalProperties

  Map of shopper input keys to values
• siteId(optional): string
  The ID of the site on which the item was added.
• transactionDate(optional): string
  ISO formatted Date on which the service action should be triggered.

{
    "properties":{
        "serviceAccountId":{
            "description":"The service account ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "configurationOptionId":{
            "description":"ID of the catalog's configurationOption associated with this item. Updatable through webhook response.",
            "type":"string"
        },
        "deactivationDate":{
            "description":"The deactivation date in ISO format. Updatable through webhook response.",
            "type":"string"
        },
        "addOnItem":{
            "description":"Whether this child item is an add-on (internally configured) or not (externally configured). Updatable through webhook response.",
            "type":"boolean"
        },
        "quantity":{
            "description":"The quantity included. Updatable through webhook response.",
            "type":"integer"
        },
        "productId":{
            "description":"The ID of the product.",
            "type":"string"
        },
        "externalData":{
            "description":"External data to be associated with a commerce item, provided by a configurator system. Updatable through webhook response.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "values":{
                        "description":"The array of values associated with an externalData item.",
                        "type":"object",
                        "properties":{
                            "dynamic_property_key":{
                                "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                                "type":"string"
                            }
                        },
                        "required":[
                            "dynamic_property_key"
                        ]
                    },
                    "name":{
                        "description":"The name to be associated with the externalData item.",
                        "type":"string"
                    },
                    "actionCode":{
                        "description":"The action code that has been set on the externalData item by the configurator system.",
                        "type":"string"
                    }
                },
                "required":[
                    "values",
                    "name"
                ]
            }
        },
        "parentAssetKey":{
            "description":"The parentAssetKey assigned when the item is a service. Updatable through webhook response.",
            "type":"string"
        },
        "billingProfileId":{
            "description":"The billing profile ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "billingAccountId":{
            "description":"The billing account ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "rootAssetKey":{
            "description":"The rootAssetKey assigned when the item is a service. Updatable through webhook response.",
            "type":"string"
        },
        "configurablePropertyId":{
            "description":"ID of the catalog's configurableProperty associated with this item. Updatable through webhook response.",
            "type":"string"
        },
        "transactionDate":{
            "description":"ISO formatted Date on which the service action should be triggered.",
            "type":"string"
        },
        "catalogRefId":{
            "description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
            "type":"string"
        },
        "assetKey":{
            "description":"The assetKey assigned when the item is a service. Updatable through webhook response.",
            "type":"string"
        },
        "customerAccountId":{
            "description":"The customer account ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "externalPriceDetails":{
            "description":"Details about external pricing",
            "type":"object",
            "properties":{
                "externalPriceQuantity":{
                    "description":"external quantity of this commerce item",
                    "type":"integer"
                },
                "externalPrice":{
                    "description":"External price of this commerce item",
                    "type":"number"
                }
            }
        },
        "siteId":{
            "description":"The ID of the site on which the item was added.",
            "type":"string"
        },
        "actionCode":{
            "description":"The action code that has been set on the item by the configurator system. Updatable through webhook response.",
            "type":"string"
        },
        "shopperInput":{
            "description":"Map of shopper input keys to values",
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "asset":{
            "description":"The flag that defines it the item is an asset or not. Updatable through webhook response.",
            "type":"boolean"
        },
        "activationDate":{
            "description":"The activation date in ISO format. Updatable through webhook response.",
            "type":"string"
        },
        "serviceId":{
            "description":"The service ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "commerceItems":{
            "type":"array",
            "items":{
                "type":"object",
                "$ref":"#/definitions/cancelOrderSubCommerceItems"
            }
        }
    }
}

Nested Schema : commerceItems

Type: array

Show Source

• Array of: object cancelOrderSubCommerceItems

{
    "type":"array",
    "items":{
        "type":"object",
        "$ref":"#/definitions/cancelOrderSubCommerceItems"
    }
}

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system. Updatable through webhook response.

Show Source

• Array of: object items

{
    "description":"External data to be associated with a commerce item, provided by a configurator system. Updatable through webhook response.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "values":{
                "description":"The array of values associated with an externalData item.",
                "type":"object",
                "properties":{
                    "dynamic_property_key":{
                        "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                        "type":"string"
                    }
                },
                "required":[
                    "dynamic_property_key"
                ]
            },
            "name":{
                "description":"The name to be associated with the externalData item.",
                "type":"string"
            },
            "actionCode":{
                "description":"The action code that has been set on the externalData item by the configurator system.",
                "type":"string"
            }
        },
        "required":[
            "values",
            "name"
        ]
    }
}

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Show Source

• externalPrice(optional): number
  External price of this commerce item
• externalPriceQuantity(optional): integer
  external quantity of this commerce item

{
    "description":"Details about external pricing",
    "type":"object",
    "properties":{
        "externalPriceQuantity":{
            "description":"external quantity of this commerce item",
            "type":"integer"
        },
        "externalPrice":{
            "description":"External price of this commerce item",
            "type":"number"
        }
    }
}

Nested Schema : shopperInput

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Map of shopper input keys to values",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Map of shopper input keys to values

Nested Schema : items

Type: object

Show Source

• actionCode(optional): string
  The action code that has been set on the externalData item by the configurator system.
• name: string
  The name to be associated with the externalData item.
• values: object values
  The array of values associated with an externalData item.

{
    "type":"object",
    "properties":{
        "values":{
            "description":"The array of values associated with an externalData item.",
            "type":"object",
            "properties":{
                "dynamic_property_key":{
                    "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                    "type":"string"
                }
            },
            "required":[
                "dynamic_property_key"
            ]
        },
        "name":{
            "description":"The name to be associated with the externalData item.",
            "type":"string"
        },
        "actionCode":{
            "description":"The action code that has been set on the externalData item by the configurator system.",
            "type":"string"
        }
    },
    "required":[
        "values",
        "name"
    ]
}

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Show Source

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

{
    "description":"The array of values associated with an externalData item.",
    "type":"object",
    "properties":{
        "dynamic_property_key":{
            "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
            "type":"string"
        }
    },
    "required":[
        "dynamic_property_key"
    ]
}

Nested Schema : items

Type: object

Show Source

• actionCode(optional): string
  The action code that has been set on the externalData item by the third party system.
• name(optional): string
  The name to be associated with the externalData item.
• values(optional): object values
  The map values associated with an externalData item.

{
    "properties":{
        "values":{
            "description":"The map values associated with an externalData item.",
            "type":"object",
            "properties":{
                "value":{
                    "description":"Map value defined by external system.",
                    "type":"string"
                },
                "key":{
                    "description":"Map key defined by external system.",
                    "type":"string"
                }
            }
        },
        "name":{
            "description":"The name to be associated with the externalData item.",
            "type":"string"
        },
        "actionCode":{
            "description":"The action code that has been set on the externalData item by the third party system.",
            "type":"string"
        }
    }
}

Nested Schema : values

Type: object

The map values associated with an externalData item.

Show Source

• key(optional): string
  Map key defined by external system.
• value(optional): string
  Map value defined by external system.

{
    "description":"The map values associated with an externalData item.",
    "type":"object",
    "properties":{
        "value":{
            "description":"Map value defined by external system.",
            "type":"string"
        },
        "key":{
            "description":"Map key defined by external system.",
            "type":"string"
        }
    }
}

Nested Schema : currentPriceDetailsSorted

Type: array

The current price details.

Show Source

• Array of: object items

{
    "description":"The current price details.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "discounted":{
                "description":"Whether the price is discounted.",
                "type":"boolean"
            },
            "secondaryCurrencyTaxAmount":{
                "description":" tax amount in secondaryCurrency",
                "type":"number"
            },
            "amount":{
                "description":"The monetary amount.",
                "type":"number"
            },
            "quantity":{
                "description":"The number of items covered by this price info",
                "type":"integer"
            },
            "amountIsFinal":{
                "description":"Whether the amount is final.",
                "type":"boolean"
            },
            "range":{
                "description":"Represents which specific items are covered by this price info.",
                "type":"object",
                "properties":{
                    "lowBound":{
                        "description":"The lower bound of the range this price info covers, inclusive.",
                        "type":"integer"
                    },
                    "highBound":{
                        "description":"The upper bound of the range this price info covers.",
                        "type":"integer"
                    },
                    "size":{
                        "description":"The number of items in this range, inclusive. (read-only)",
                        "type":"integer"
                    }
                }
            },
            "tax":{
                "description":"Monetary tax amount.",
                "type":"number"
            },
            "orderDiscountShare":{
                "description":"Share of the order discount for this item",
                "type":"number"
            },
            "detailedUnitPrice":{
                "description":"The detailed unit price: amount / quantity. (read-only)",
                "type":"number"
            },
            "currencyCode":{
                "description":"The three character currency code for the monetary amounts.",
                "type":"string"
            }
        }
    }
}

Nested Schema : itemDiscountInfos

Type: array

Array of item promotions affecting this item.

Show Source

• Array of: object items

{
    "description":"Array of item promotions affecting this item.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "couponCodes":{
                "description":"One or more coupon codes used to grant the item promotion providing the discount.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "amount":{
                "description":"The amount of discount this item received from the promotion.",
                "type":"number"
            },
            "promotionId":{
                "description":"The promotion id that resulted in the discount.",
                "type":"string"
            }
        }
    }
}

Nested Schema : orderDiscountInfos

Type: array

Array of order promotions affecting this item.

Show Source

• Array of: object items

{
    "description":"Array of order promotions affecting this item.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "couponCodes":{
                "description":"One or more coupon codes used to grant the order promotion providing the discount.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "amount":{
                "description":"The amount of discount this item received from the promotion.",
                "type":"number"
            },
            "promotionId":{
                "description":"The promotion id that resulted in the discount.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The monetary amount.
• amountIsFinal(optional): boolean
  Whether the amount is final.
• currencyCode(optional): string
  The three character currency code for the monetary amounts.
• detailedUnitPrice(optional): number
  The detailed unit price: amount / quantity. (read-only)
• discounted(optional): boolean
  Whether the price is discounted.
• orderDiscountShare(optional): number
  Share of the order discount for this item
• quantity(optional): integer
  The number of items covered by this price info
• range(optional): object range
  Represents which specific items are covered by this price info.
• secondaryCurrencyTaxAmount(optional): number
  tax amount in secondaryCurrency
• tax(optional): number
  Monetary tax amount.

{
    "type":"object",
    "properties":{
        "discounted":{
            "description":"Whether the price is discounted.",
            "type":"boolean"
        },
        "secondaryCurrencyTaxAmount":{
            "description":" tax amount in secondaryCurrency",
            "type":"number"
        },
        "amount":{
            "description":"The monetary amount.",
            "type":"number"
        },
        "quantity":{
            "description":"The number of items covered by this price info",
            "type":"integer"
        },
        "amountIsFinal":{
            "description":"Whether the amount is final.",
            "type":"boolean"
        },
        "range":{
            "description":"Represents which specific items are covered by this price info.",
            "type":"object",
            "properties":{
                "lowBound":{
                    "description":"The lower bound of the range this price info covers, inclusive.",
                    "type":"integer"
                },
                "highBound":{
                    "description":"The upper bound of the range this price info covers.",
                    "type":"integer"
                },
                "size":{
                    "description":"The number of items in this range, inclusive. (read-only)",
                    "type":"integer"
                }
            }
        },
        "tax":{
            "description":"Monetary tax amount.",
            "type":"number"
        },
        "orderDiscountShare":{
            "description":"Share of the order discount for this item",
            "type":"number"
        },
        "detailedUnitPrice":{
            "description":"The detailed unit price: amount / quantity. (read-only)",
            "type":"number"
        },
        "currencyCode":{
            "description":"The three character currency code for the monetary amounts.",
            "type":"string"
        }
    }
}

Nested Schema : range

Type: object

Represents which specific items are covered by this price info.

Show Source

• highBound(optional): integer
  The upper bound of the range this price info covers.
• lowBound(optional): integer
  The lower bound of the range this price info covers, inclusive.
• size(optional): integer
  The number of items in this range, inclusive. (read-only)

{
    "description":"Represents which specific items are covered by this price info.",
    "type":"object",
    "properties":{
        "lowBound":{
            "description":"The lower bound of the range this price info covers, inclusive.",
            "type":"integer"
        },
        "highBound":{
            "description":"The upper bound of the range this price info covers.",
            "type":"integer"
        },
        "size":{
            "description":"The number of items in this range, inclusive. (read-only)",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The amount of discount this item received from the promotion.
• couponCodes(optional): array couponCodes
  One or more coupon codes used to grant the item promotion providing the discount.
• promotionId(optional): string
  The promotion id that resulted in the discount.

{
    "type":"object",
    "properties":{
        "couponCodes":{
            "description":"One or more coupon codes used to grant the item promotion providing the discount.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "amount":{
            "description":"The amount of discount this item received from the promotion.",
            "type":"number"
        },
        "promotionId":{
            "description":"The promotion id that resulted in the discount.",
            "type":"string"
        }
    }
}

Nested Schema : couponCodes

Type: array

One or more coupon codes used to grant the item promotion providing the discount.

Show Source

• Array of: string

{
    "description":"One or more coupon codes used to grant the item promotion providing the discount.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The amount of discount this item received from the promotion.
• couponCodes(optional): array couponCodes
  One or more coupon codes used to grant the order promotion providing the discount.
• promotionId(optional): string
  The promotion id that resulted in the discount.

{
    "type":"object",
    "properties":{
        "couponCodes":{
            "description":"One or more coupon codes used to grant the order promotion providing the discount.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "amount":{
            "description":"The amount of discount this item received from the promotion.",
            "type":"number"
        },
        "promotionId":{
            "description":"The promotion id that resulted in the discount.",
            "type":"string"
        }
    }
}

Nested Schema : couponCodes

Type: array

One or more coupon codes used to grant the order promotion providing the discount.

Show Source

• Array of: string

{
    "description":"One or more coupon codes used to grant the order promotion providing the discount.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : frequencyAmountTotals

Type: array

The total for each recurring charge frequency

Show Source

• Array of: object items

{
    "description":"The total for each recurring charge frequency",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "total":{
                "description":"The total amount for the frequency.",
                "type":"string"
            },
            "frequency":{
                "description":"The frequency for the item's total e.g. Monthly.",
                "type":"string"
            }
        }
    }
}

Nested Schema : frequencyTaxTotals

Type: array

The tax for each recurring charge frequency

Show Source

• Array of: object items

{
    "description":"The tax for each recurring charge frequency",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "tax":{
                "description":"The tax amount for the frequency.",
                "type":"string"
            },
            "frequency":{
                "description":"The frequency for the item's tax e.g. Monthly.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• frequency(optional): string
  The frequency for the item's total e.g. Monthly.
• total(optional): string
  The total amount for the frequency.

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total amount for the frequency.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency for the item's total e.g. Monthly.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• frequency(optional): string
  The frequency for the item's tax e.g. Monthly.
• tax(optional): string
  The tax amount for the frequency.

{
    "type":"object",
    "properties":{
        "tax":{
            "description":"The tax amount for the frequency.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency for the item's tax e.g. Monthly.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The monetary amount of the payment.
• amountAuthorized(optional): number
  The monetary amount authorized.
• authorizationStatus(optional): array authorizationStatus
  Aray of authorization status objects.
• creditCardNumber(optional): string
  The last four digits of the credit card number. (only for TokenizedCreditCards)
• creditCardType(optional): string
  The type of the credit card. (only for TokenizedCreditCards)
• currencyCode(optional): string
  The three character currency code. For example: USD.
• expirationDayOfMonth(optional): string
  A string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards)
• expirationMonth(optional): string
  A string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards)
• expirationYear(optional): string
  A string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards)
• externalId(optional): string
  The ID for the payment group in an external system (like the OMS)
• externalSourceId(optional): string
  The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)
• externalSubtype(optional): string
  The subtype in the external system. Might be "VISA" for a PaymentGroup with an external type of "CreditCard". (only for ExternalPaymentGroups)
• externalType(optional): string
  The type in the external system. Might be "StoreCredit", "CreditCard", "Check", etc. (only for ExternalPaymentGroups).
• id(optional): string
  The internal ID of the payment group.
• paymentGroupClassType(optional): string
  The class type of the payment group. Currently supported values are "tokenizedCreditCard" and "externalPaymentGroup".
• paymentMethod(optional): string
  The payment method. Currently supported values are "tokenizedCreditCard" and "externalPaymentGroup".
• PONumber(optional): string
  The purchase order number
• state(optional): string
  The state of this payment group.
• stateDetail(optional): string
  Details about the state of this payment group.
• submittedDate(optional): string(date-time)
  The date the payment was submitted.
• token(optional): string
  The CyberSource token string. (only for tokenizedCreditCard)

{
    "type":"object",
    "properties":{
        "expirationYear":{
            "description":"A string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards)",
            "type":"string"
        },
        "PONumber":{
            "description":"The purchase order number",
            "type":"string"
        },
        "externalType":{
            "description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
            "type":"string"
        },
        "amountAuthorized":{
            "description":"The monetary amount authorized.",
            "type":"number"
        },
        "amount":{
            "description":"The monetary amount of the payment.",
            "type":"number"
        },
        "externalId":{
            "description":"The ID for the payment group in an external system (like the OMS)",
            "type":"string"
        },
        "expirationMonth":{
            "description":"A string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards)",
            "type":"string"
        },
        "creditCardType":{
            "description":"The type of the credit card. (only for TokenizedCreditCards)",
            "type":"string"
        },
        "submittedDate":{
            "format":"date-time",
            "description":"The date the payment was submitted.",
            "type":"string"
        },
        "authorizationStatus":{
            "description":"Aray of authorization status objects.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "amount":{
                        "description":"The monetary amount.",
                        "type":"number"
                    },
                    "transactionSuccess":{
                        "description":"Whether the transaction was successful.",
                        "type":"boolean"
                    },
                    "errorMessage":{
                        "description":"The error message, if any.",
                        "type":"string"
                    },
                    "transactionId":{
                        "description":"The transaction ID.",
                        "type":"string"
                    },
                    "transactionTimestamp":{
                        "description":"The timestamp of the transaction.",
                        "type":"string"
                    }
                }
            }
        },
        "token":{
            "description":"The CyberSource token string. (only for tokenizedCreditCard)",
            "type":"string"
        },
        "paymentGroupClassType":{
            "description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
            "type":"string"
        },
        "creditCardNumber":{
            "description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
            "type":"string"
        },
        "externalSubtype":{
            "description":"The subtype in the external system. Might be \"VISA\" for a PaymentGroup with an external type of \"CreditCard\". (only for ExternalPaymentGroups)",
            "type":"string"
        },
        "paymentMethod":{
            "description":"The payment method. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
            "type":"string"
        },
        "externalSourceId":{
            "description":"The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)",
            "type":"string"
        },
        "state":{
            "description":"The state of this payment group.",
            "type":"string"
        },
        "id":{
            "description":"The internal ID of the payment group.",
            "type":"string"
        },
        "stateDetail":{
            "description":"Details about the state of this payment group.",
            "type":"string"
        },
        "currencyCode":{
            "description":"The three character currency code. For example: USD.",
            "type":"string"
        },
        "expirationDayOfMonth":{
            "description":"A string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards)",
            "type":"string"
        }
    }
}

Nested Schema : authorizationStatus

Type: array

Aray of authorization status objects.

Show Source

• Array of: object items

{
    "description":"Aray of authorization status objects.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "amount":{
                "description":"The monetary amount.",
                "type":"number"
            },
            "transactionSuccess":{
                "description":"Whether the transaction was successful.",
                "type":"boolean"
            },
            "errorMessage":{
                "description":"The error message, if any.",
                "type":"string"
            },
            "transactionId":{
                "description":"The transaction ID.",
                "type":"string"
            },
            "transactionTimestamp":{
                "description":"The timestamp of the transaction.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The monetary amount.
• errorMessage(optional): string
  The error message, if any.
• transactionId(optional): string
  The transaction ID.
• transactionSuccess(optional): boolean
  Whether the transaction was successful.
• transactionTimestamp(optional): string
  The timestamp of the transaction.

{
    "type":"object",
    "properties":{
        "amount":{
            "description":"The monetary amount.",
            "type":"number"
        },
        "transactionSuccess":{
            "description":"Whether the transaction was successful.",
            "type":"boolean"
        },
        "errorMessage":{
            "description":"The error message, if any.",
            "type":"string"
        },
        "transactionId":{
            "description":"The transaction ID.",
            "type":"string"
        },
        "transactionTimestamp":{
            "description":"The timestamp of the transaction.",
            "type":"string"
        }
    }
}

Nested Schema : shippingAddress

Type: object

Default shipping address

Show Source

• address1(optional): string
  Address Line 1.
• address2(optional): string
  Address Line 2.
• address3(optional): string
  Address Line 3.
• city(optional): string
  City.
• country(optional): string
  Country.
• county(optional): string
  Name of the county.
• phoneNumber(optional): string
  Phone number.
• postalCode(optional): string
  Postal code.
• state(optional): string
  State.

{
    "description":"Default shipping address",
    "type":"object",
    "properties":{
        "country":{
            "description":"Country.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"Phone number.",
            "type":"string"
        },
        "address3":{
            "description":"Address Line 3.",
            "type":"string"
        },
        "address2":{
            "description":"Address Line 2.",
            "type":"string"
        },
        "city":{
            "description":"City.",
            "type":"string"
        },
        "address1":{
            "description":"Address Line 1.",
            "type":"string"
        },
        "postalCode":{
            "description":"Postal code.",
            "type":"string"
        },
        "county":{
            "description":"Name of the county.",
            "type":"string"
        },
        "state":{
            "description":"State.",
            "type":"string"
        }
    }
}

Nested Schema : frequencyAmountTotals

Type: array

The total for each recurring charge frequency

Show Source

• Array of: object items

{
    "description":"The total for each recurring charge frequency",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "total":{
                "description":"The total amount for the frequency.",
                "type":"string"
            },
            "frequency":{
                "description":"The frequency for the item's total e.g. Monthly.",
                "type":"string"
            }
        }
    }
}

Nested Schema : frequencyTaxTotals

Type: array

The tax for each recurring charge frequency

Show Source

• Array of: object items

{
    "description":"The tax for each recurring charge frequency",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "tax":{
                "description":"The tax amount for the frequency.",
                "type":"string"
            },
            "frequency":{
                "description":"The frequency for the item's tax e.g. Monthly.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• frequency(optional): string
  The frequency for the item's total e.g. Monthly.
• total(optional): string
  The total amount for the frequency.

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total amount for the frequency.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency for the item's total e.g. Monthly.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• frequency(optional): string
  The frequency for the item's tax e.g. Monthly.
• tax(optional): string
  The tax amount for the frequency.

{
    "type":"object",
    "properties":{
        "tax":{
            "description":"The tax amount for the frequency.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency for the item's tax e.g. Monthly.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• actualShipDate(optional): string(date-time)
  The actual shipped date of this shipping group.
• commerceItemRelationships(optional): array commerceItemRelationships
  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(optional): string
  The description of this shipping group. Defaults to the ID.
• handlingInstructions(optional): array handlingInstructions
  Handling instructions. Currently read-only.
• id(optional): string
  The ID of this shipping group.
• priceInfo(optional): object priceInfo
  The pricing details about this shipping group.
• recurringChargePriceInfo(optional): object recurringChargePriceInfo
  Recurring charge price information.
• shipOnDate(optional): string(date-time)
  The date this shipping group is expected to ship upon.
• shippingAddress(optional): object shippingAddress
  The shipping address for this shipping group.
• shippingGroupClassType(optional): string
  The class type for the ShippingGroup. Currently must be "hardgoodShippingGroup".
• shippingMethod(optional): string
  The shipping method.
• specialInstructions(optional): object specialInstructions
  Special instructions for the shipping group. Keys and values are strings.
• state(optional): string
  The state of this shipping group.
• stateDetail(optional): string
  Details about the state of this shipping group.
• submittedDate(optional): string(date-time)
  The date the shipping group was submitted.
• trackingNumber(optional): 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.

{
    "type":"object",
    "properties":{
        "shippingMethod":{
            "description":"The shipping method.",
            "type":"string"
        },
        "description":{
            "description":"The description of this shipping group. Defaults to the ID.",
            "type":"string"
        },
        "submittedDate":{
            "format":"date-time",
            "description":"The date the shipping group was submitted.",
            "type":"string"
        },
        "priceInfo":{
            "description":"The pricing details about this shipping group.",
            "type":"object",
            "properties":{
                "discounted":{
                    "description":"Whether this item is discounted.",
                    "type":"boolean"
                },
                "secondaryCurrencyTaxAmount":{
                    "description":" The secondary currency tax amount.",
                    "type":"number"
                },
                "shippingTax":{
                    "description":"shippingTax for this shipping group",
                    "type":"number"
                },
                "amount":{
                    "description":"The monetary amount.",
                    "type":"number"
                },
                "secondaryCurrencyShippingAmount":{
                    "description":" The secondary currency shipping amount.",
                    "type":"number"
                },
                "rawShipping":{
                    "description":"The monitary amount of the cost of raw shipping.",
                    "type":"number"
                },
                "amountIsFinal":{
                    "description":"Whether the amount is final.",
                    "type":"boolean"
                },
                "currencyCode":{
                    "description":"The currency code for the monetary amounts.",
                    "type":"string"
                }
            }
        },
        "recurringChargePriceInfo":{
            "description":"Recurring charge price information.",
            "type":"object",
            "properties":{
                "amount":{
                    "description":"The monetary amount of this recurring charge.",
                    "type":"number"
                },
                "total":{
                    "description":"The total price of the recurring charge.",
                    "type":"number"
                },
                "frequencyAmountTotals":{
                    "description":"The total for each recurring charge frequency",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "total":{
                                "description":"The total amount for the frequency.",
                                "type":"string"
                            },
                            "frequency":{
                                "description":"The frequency for the item's total e.g. Monthly.",
                                "type":"string"
                            }
                        }
                    }
                },
                "shipping":{
                    "description":"Cost of shipping the product.",
                    "type":"number"
                },
                "tax":{
                    "description":"Monetary tax amount.",
                    "type":"number"
                },
                "subTotal":{
                    "description":"The sub-total price of the recurring charge.",
                    "type":"number"
                },
                "frequencyTaxTotals":{
                    "description":"The tax for each recurring charge frequency",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "tax":{
                                "description":"The tax amount for the frequency.",
                                "type":"string"
                            },
                            "frequency":{
                                "description":"The frequency for the item's tax e.g. Monthly.",
                                "type":"string"
                            }
                        }
                    }
                },
                "currencyCode":{
                    "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                    "type":"string"
                },
                "totalWithoutTax":{
                    "description":"Total of recurring amount without tax included.",
                    "type":"number"
                }
            }
        },
        "shipOnDate":{
            "format":"date-time",
            "description":"The date this shipping group is expected to ship upon.",
            "type":"string"
        },
        "actualShipDate":{
            "format":"date-time",
            "description":"The actual shipped date of this shipping group.",
            "type":"string"
        },
        "specialInstructions":{
            "description":"Special instructions for the shipping group. Keys and values are strings.",
            "type":"object",
            "properties":{
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "shippingAddress":{
            "description":"The shipping address for this shipping group.",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"Last name.",
                    "type":"string"
                },
                "country":{
                    "description":"Country.",
                    "type":"string"
                },
                "address3":{
                    "description":"Address Line 3.",
                    "type":"string"
                },
                "address2":{
                    "description":"Address Line 2.",
                    "type":"string"
                },
                "city":{
                    "description":"City.",
                    "type":"string"
                },
                "address1":{
                    "description":"Address Line 1.",
                    "type":"string"
                },
                "prefix":{
                    "description":"Prefix.",
                    "type":"string"
                },
                "companyName":{
                    "description":"Company name.",
                    "type":"string"
                },
                "postalCode":{
                    "description":"Postal code.",
                    "type":"string"
                },
                "jobTitle":{
                    "description":"Job title.",
                    "type":"string"
                },
                "county":{
                    "description":"Name of the county.",
                    "type":"string"
                },
                "ownerId":{
                    "description":"The ID of the owner of this address.",
                    "type":"string"
                },
                "suffix":{
                    "description":"Suffix.",
                    "type":"string"
                },
                "firstName":{
                    "description":"First name.",
                    "type":"string"
                },
                "phoneNumber":{
                    "description":"Phone number.",
                    "type":"string"
                },
                "faxNumber":{
                    "description":"The fax number.",
                    "type":"string"
                },
                "middleName":{
                    "description":"Middle name.",
                    "type":"string"
                },
                "state":{
                    "description":"State.",
                    "type":"string"
                },
                "id":{
                    "description":"ID.",
                    "type":"string"
                },
                "email":{
                    "description":"The email address",
                    "type":"string"
                }
            }
        },
        "commerceItemRelationships":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "commerceItemId":{
                        "description":"The referenced commerce item's internal ID. If it is a new item getting added from webhook response, the item and its commerceItemRelationships' id must have prefix \"new_\".",
                        "type":"string"
                    },
                    "amount":{
                        "description":"The monetary value.",
                        "type":"number"
                    },
                    "quantity":{
                        "description":"The quantity of items referenced by this relationship.",
                        "type":"integer"
                    },
                    "relationshipType":{
                        "description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
                        "type":"string"
                    },
                    "returnedQuantity":{
                        "description":"Number of referenced items that were returned.",
                        "type":"integer"
                    },
                    "range":{
                        "description":"Represents which specific items are covered by this commerceItemRelationship.",
                        "type":"object",
                        "properties":{
                            "lowBound":{
                                "description":"The lower bound of the range.",
                                "type":"integer"
                            },
                            "highBound":{
                                "description":"The upper bound of the range.",
                                "type":"integer"
                            },
                            "size":{
                                "description":"The no of items this range includes",
                                "type":"integer"
                            }
                        }
                    },
                    "commerceItemExternalId":{
                        "description":"The referenced commerce item's external ID.",
                        "type":"string"
                    },
                    "state":{
                        "description":"The state of this commerceItemRelationships item",
                        "type":"string"
                    },
                    "id":{
                        "description":"The native ID of this item.",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"The ID of this shipping group.",
            "type":"string"
        },
        "state":{
            "description":"The state of this shipping group.",
            "type":"string"
        },
        "stateDetail":{
            "description":"Details about the state of this shipping group.",
            "type":"string"
        },
        "trackingNumber":{
            "description":"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.",
            "type":"string"
        },
        "handlingInstructions":{
            "description":"Handling instructions. Currently read-only.",
            "type":"array",
            "items":{
                "type":"string",
                "properties":{
                }
            }
        },
        "shippingGroupClassType":{
            "description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
            "type":"string"
        }
    }
}

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.

Show Source

• Array of: object items

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "commerceItemId":{
                "description":"The referenced commerce item's internal ID. If it is a new item getting added from webhook response, the item and its commerceItemRelationships' id must have prefix \"new_\".",
                "type":"string"
            },
            "amount":{
                "description":"The monetary value.",
                "type":"number"
            },
            "quantity":{
                "description":"The quantity of items referenced by this relationship.",
                "type":"integer"
            },
            "relationshipType":{
                "description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
                "type":"string"
            },
            "returnedQuantity":{
                "description":"Number of referenced items that were returned.",
                "type":"integer"
            },
            "range":{
                "description":"Represents which specific items are covered by this commerceItemRelationship.",
                "type":"object",
                "properties":{
                    "lowBound":{
                        "description":"The lower bound of the range.",
                        "type":"integer"
                    },
                    "highBound":{
                        "description":"The upper bound of the range.",
                        "type":"integer"
                    },
                    "size":{
                        "description":"The no of items this range includes",
                        "type":"integer"
                    }
                }
            },
            "commerceItemExternalId":{
                "description":"The referenced commerce item's external ID.",
                "type":"string"
            },
            "state":{
                "description":"The state of this commerceItemRelationships item",
                "type":"string"
            },
            "id":{
                "description":"The native ID of this item.",
                "type":"string"
            }
        }
    }
}

Nested Schema : handlingInstructions

Type: array

Handling instructions. Currently read-only.

Show Source

• Array of: string

{
    "description":"Handling instructions. Currently read-only.",
    "type":"array",
    "items":{
        "type":"string",
        "properties":{
        }
    }
}

Nested Schema : priceInfo

Type: object

The pricing details about this shipping group.

Show Source

• amount(optional): number
  The monetary amount.
• amountIsFinal(optional): boolean
  Whether the amount is final.
• currencyCode(optional): string
  The currency code for the monetary amounts.
• discounted(optional): boolean
  Whether this item is discounted.
• rawShipping(optional): number
  The monitary amount of the cost of raw shipping.
• secondaryCurrencyShippingAmount(optional): number
  The secondary currency shipping amount.
• secondaryCurrencyTaxAmount(optional): number
  The secondary currency tax amount.
• shippingTax(optional): number
  shippingTax for this shipping group

{
    "description":"The pricing details about this shipping group.",
    "type":"object",
    "properties":{
        "discounted":{
            "description":"Whether this item is discounted.",
            "type":"boolean"
        },
        "secondaryCurrencyTaxAmount":{
            "description":" The secondary currency tax amount.",
            "type":"number"
        },
        "shippingTax":{
            "description":"shippingTax for this shipping group",
            "type":"number"
        },
        "amount":{
            "description":"The monetary amount.",
            "type":"number"
        },
        "secondaryCurrencyShippingAmount":{
            "description":" The secondary currency shipping amount.",
            "type":"number"
        },
        "rawShipping":{
            "description":"The monitary amount of the cost of raw shipping.",
            "type":"number"
        },
        "amountIsFinal":{
            "description":"Whether the amount is final.",
            "type":"boolean"
        },
        "currencyCode":{
            "description":"The currency code for the monetary amounts.",
            "type":"string"
        }
    }
}

Nested Schema : recurringChargePriceInfo

Type: object

Recurring charge price information.

Show Source

• amount(optional): number
  The monetary amount of this recurring charge.
• currencyCode(optional): string
  The currency code for the monetary amounts. A three character currency code such as USD.
• frequencyAmountTotals(optional): array frequencyAmountTotals
  The total for each recurring charge frequency
• frequencyTaxTotals(optional): array frequencyTaxTotals
  The tax for each recurring charge frequency
• shipping(optional): number
  Cost of shipping the product.
• subTotal(optional): number
  The sub-total price of the recurring charge.
• tax(optional): number
  Monetary tax amount.
• total(optional): number
  The total price of the recurring charge.
• totalWithoutTax(optional): number
  Total of recurring amount without tax included.

{
    "description":"Recurring charge price information.",
    "type":"object",
    "properties":{
        "amount":{
            "description":"The monetary amount of this recurring charge.",
            "type":"number"
        },
        "total":{
            "description":"The total price of the recurring charge.",
            "type":"number"
        },
        "frequencyAmountTotals":{
            "description":"The total for each recurring charge frequency",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "total":{
                        "description":"The total amount for the frequency.",
                        "type":"string"
                    },
                    "frequency":{
                        "description":"The frequency for the item's total e.g. Monthly.",
                        "type":"string"
                    }
                }
            }
        },
        "shipping":{
            "description":"Cost of shipping the product.",
            "type":"number"
        },
        "tax":{
            "description":"Monetary tax amount.",
            "type":"number"
        },
        "subTotal":{
            "description":"The sub-total price of the recurring charge.",
            "type":"number"
        },
        "frequencyTaxTotals":{
            "description":"The tax for each recurring charge frequency",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "tax":{
                        "description":"The tax amount for the frequency.",
                        "type":"string"
                    },
                    "frequency":{
                        "description":"The frequency for the item's tax e.g. Monthly.",
                        "type":"string"
                    }
                }
            }
        },
        "currencyCode":{
            "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
            "type":"string"
        },
        "totalWithoutTax":{
            "description":"Total of recurring amount without tax included.",
            "type":"number"
        }
    }
}

Nested Schema : shippingAddress

Type: object

The shipping address for this shipping group.

Show Source

• address1(optional): string
  Address Line 1.
• address2(optional): string
  Address Line 2.
• address3(optional): string
  Address Line 3.
• city(optional): string
  City.
• companyName(optional): string
  Company name.
• country(optional): string
  Country.
• county(optional): string
  Name of the county.
• email(optional): string
  The email address
• faxNumber(optional): string
  The fax number.
• firstName(optional): string
  First name.
• id(optional): string
  ID.
• jobTitle(optional): string
  Job title.
• lastName(optional): string
  Last name.
• middleName(optional): string
  Middle name.
• ownerId(optional): string
  The ID of the owner of this address.
• phoneNumber(optional): string
  Phone number.
• postalCode(optional): string
  Postal code.
• prefix(optional): string
  Prefix.
• state(optional): string
  State.
• suffix(optional): string
  Suffix.

{
    "description":"The shipping address for this shipping group.",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"Last name.",
            "type":"string"
        },
        "country":{
            "description":"Country.",
            "type":"string"
        },
        "address3":{
            "description":"Address Line 3.",
            "type":"string"
        },
        "address2":{
            "description":"Address Line 2.",
            "type":"string"
        },
        "city":{
            "description":"City.",
            "type":"string"
        },
        "address1":{
            "description":"Address Line 1.",
            "type":"string"
        },
        "prefix":{
            "description":"Prefix.",
            "type":"string"
        },
        "companyName":{
            "description":"Company name.",
            "type":"string"
        },
        "postalCode":{
            "description":"Postal code.",
            "type":"string"
        },
        "jobTitle":{
            "description":"Job title.",
            "type":"string"
        },
        "county":{
            "description":"Name of the county.",
            "type":"string"
        },
        "ownerId":{
            "description":"The ID of the owner of this address.",
            "type":"string"
        },
        "suffix":{
            "description":"Suffix.",
            "type":"string"
        },
        "firstName":{
            "description":"First name.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"Phone number.",
            "type":"string"
        },
        "faxNumber":{
            "description":"The fax number.",
            "type":"string"
        },
        "middleName":{
            "description":"Middle name.",
            "type":"string"
        },
        "state":{
            "description":"State.",
            "type":"string"
        },
        "id":{
            "description":"ID.",
            "type":"string"
        },
        "email":{
            "description":"The email address",
            "type":"string"
        }
    }
}

Nested Schema : specialInstructions

Type: object

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

Show Source

• additionalProperties(optional): string

{
    "description":"Special instructions for the shipping group. Keys and values are strings.",
    "type":"object",
    "properties":{
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The monetary value.
• commerceItemExternalId(optional): string
  The referenced commerce item's external ID.
• commerceItemId(optional): string
  The referenced commerce item's internal ID. If it is a new item getting added from webhook response, the item and its commerceItemRelationships' id must have prefix "new_".
• id(optional): string
  The native ID of this item.
• quantity(optional): integer
  The quantity of items referenced by this relationship.
• range(optional): object range
  Represents which specific items are covered by this commerceItemRelationship.
• relationshipType(optional): string
  The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.
• returnedQuantity(optional): integer
  Number of referenced items that were returned.
• state(optional): string
  The state of this commerceItemRelationships item

{
    "type":"object",
    "properties":{
        "commerceItemId":{
            "description":"The referenced commerce item's internal ID. If it is a new item getting added from webhook response, the item and its commerceItemRelationships' id must have prefix \"new_\".",
            "type":"string"
        },
        "amount":{
            "description":"The monetary value.",
            "type":"number"
        },
        "quantity":{
            "description":"The quantity of items referenced by this relationship.",
            "type":"integer"
        },
        "relationshipType":{
            "description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
            "type":"string"
        },
        "returnedQuantity":{
            "description":"Number of referenced items that were returned.",
            "type":"integer"
        },
        "range":{
            "description":"Represents which specific items are covered by this commerceItemRelationship.",
            "type":"object",
            "properties":{
                "lowBound":{
                    "description":"The lower bound of the range.",
                    "type":"integer"
                },
                "highBound":{
                    "description":"The upper bound of the range.",
                    "type":"integer"
                },
                "size":{
                    "description":"The no of items this range includes",
                    "type":"integer"
                }
            }
        },
        "commerceItemExternalId":{
            "description":"The referenced commerce item's external ID.",
            "type":"string"
        },
        "state":{
            "description":"The state of this commerceItemRelationships item",
            "type":"string"
        },
        "id":{
            "description":"The native ID of this item.",
            "type":"string"
        }
    }
}

Nested Schema : range

Type: object

Represents which specific items are covered by this commerceItemRelationship.

Show Source

• highBound(optional): integer
  The upper bound of the range.
• lowBound(optional): integer
  The lower bound of the range.
• size(optional): integer
  The no of items this range includes

{
    "description":"Represents which specific items are covered by this commerceItemRelationship.",
    "type":"object",
    "properties":{
        "lowBound":{
            "description":"The lower bound of the range.",
            "type":"integer"
        },
        "highBound":{
            "description":"The upper bound of the range.",
            "type":"integer"
        },
        "size":{
            "description":"The no of items this range includes",
            "type":"integer"
        }
    }
}

Nested Schema : frequencyAmountTotals

Type: array

The total for each recurring charge frequency

Show Source

• Array of: object items

{
    "description":"The total for each recurring charge frequency",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "total":{
                "description":"The total amount for the frequency.",
                "type":"string"
            },
            "frequency":{
                "description":"The frequency for the item's total e.g. Monthly.",
                "type":"string"
            }
        }
    }
}

Nested Schema : frequencyTaxTotals

Type: array

The tax for each recurring charge frequency

Show Source

• Array of: object items

{
    "description":"The tax for each recurring charge frequency",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "tax":{
                "description":"The tax amount for the frequency.",
                "type":"string"
            },
            "frequency":{
                "description":"The frequency for the item's tax e.g. Monthly.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• frequency(optional): string
  The frequency for the item's total e.g. Monthly.
• total(optional): string
  The total amount for the frequency.

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total amount for the frequency.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency for the item's total e.g. Monthly.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• frequency(optional): string
  The frequency for the item's tax e.g. Monthly.
• tax(optional): string
  The tax amount for the frequency.

{
    "type":"object",
    "properties":{
        "tax":{
            "description":"The tax amount for the frequency.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency for the item's tax e.g. Monthly.",
            "type":"string"
        }
    }
}

Nested Schema : miscTaxInfo

Type: object

Details about the miscTax.

Show Source

• Special(optional): number
  Details of the Special tax

{
    "description":"Details about the miscTax.",
    "type":"object",
    "properties":{
        "Special":{
            "description":"Details of the Special tax",
            "type":"number"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : cancelOrderUpdate_response

Type: object

Show Source

• order(optional): object order

{
    "properties":{
        "order":{
            "properties":{
                "gwp":{
                    "description":"Whether gift with purchase is enabled or not.",
                    "type":"boolean"
                },
                "secondaryCurrencyCode":{
                    "description":"Secondary currencyCode",
                    "type":"string"
                },
                "lastModifiedTime":{
                    "description":"The last modified time.",
                    "type":"integer"
                },
                "creationTime":{
                    "description":"The creation time.",
                    "type":"integer"
                },
                "locale":{
                    "description":"Locale",
                    "type":"string"
                },
                "paymentGroups":{
                    "description":"The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of \"tokenizedCreditCard\"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of \"externalPaymentGroup\"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "expirationYear":{
                                "description":"A string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards)",
                                "type":"string"
                            },
                            "PONumber":{
                                "description":"The purchase order number",
                                "type":"string"
                            },
                            "externalType":{
                                "description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
                                "type":"string"
                            },
                            "amountAuthorized":{
                                "description":"The monetary amount authorized.",
                                "type":"number"
                            },
                            "amount":{
                                "description":"The monetary amount of the payment.",
                                "type":"number"
                            },
                            "externalId":{
                                "description":"The ID for the payment group in an external system (like the OMS)",
                                "type":"string"
                            },
                            "expirationMonth":{
                                "description":"A string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards)",
                                "type":"string"
                            },
                            "creditCardType":{
                                "description":"The type of the credit card. (only for TokenizedCreditCards)",
                                "type":"string"
                            },
                            "submittedDate":{
                                "format":"date-time",
                                "description":"The date the payment was submitted.",
                                "type":"string"
                            },
                            "authorizationStatus":{
                                "description":"Aray of authorization status objects.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "amount":{
                                            "description":"The monetary amount.",
                                            "type":"number"
                                        },
                                        "transactionSuccess":{
                                            "description":"Whether the transaction was successful.",
                                            "type":"boolean"
                                        },
                                        "errorMessage":{
                                            "description":"The error message, if any.",
                                            "type":"string"
                                        },
                                        "transactionId":{
                                            "description":"The transaction ID.",
                                            "type":"string"
                                        },
                                        "transactionTimestamp":{
                                            "description":"The timestamp of the transaction.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "token":{
                                "description":"The CyberSource token string. (only for tokenizedCreditCard)",
                                "type":"string"
                            },
                            "paymentGroupClassType":{
                                "description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
                                "type":"string"
                            },
                            "creditCardNumber":{
                                "description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
                                "type":"string"
                            },
                            "externalSubtype":{
                                "description":"The subtype in the external system. Might be \"VISA\" for a PaymentGroup with an external type of \"CreditCard\". (only for ExternalPaymentGroups)",
                                "type":"string"
                            },
                            "paymentMethod":{
                                "description":"The payment method. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
                                "type":"string"
                            },
                            "externalSourceId":{
                                "description":"The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)",
                                "type":"string"
                            },
                            "state":{
                                "description":"The state of this payment group.",
                                "type":"string"
                            },
                            "id":{
                                "description":"The internal ID of the payment group.",
                                "type":"string"
                            },
                            "stateDetail":{
                                "description":"Details about the state of this payment group.",
                                "type":"string"
                            },
                            "currencyCode":{
                                "description":"The three character currency code. For example: USD.",
                                "type":"string"
                            },
                            "expirationDayOfMonth":{
                                "description":"A string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards)",
                                "type":"string"
                            }
                        }
                    }
                },
                "salesChannel":{
                    "description":"The sales channel of this order. default to \"default\".",
                    "type":"string"
                },
                "organizationId":{
                    "description":"The organization ID.",
                    "type":"string"
                },
                "priceInfo":{
                    "description":"Pricing information, an instance of OrderPriceInfo.",
                    "type":"object",
                    "properties":{
                        "secondaryCurrencyTaxAmount":{
                            "description":"The secondary currency tax amount.",
                            "type":"number"
                        },
                        "discounted":{
                            "description":"Whether the price is discounted.",
                            "type":"boolean"
                        },
                        "amount":{
                            "description":"The monetary amount.",
                            "type":"number"
                        },
                        "secondaryCurrencyShippingAmount":{
                            "description":"The secondary currency shipping amount.",
                            "type":"number"
                        },
                        "secondaryCurrencyTotal":{
                            "description":"The secondary currency total amount.",
                            "type":"number"
                        },
                        "manualAdjustmentTotal":{
                            "description":"The monetary total of manual adjustments.",
                            "type":"number"
                        },
                        "discountAmount":{
                            "description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
                            "type":"number"
                        },
                        "tax":{
                            "description":"Monetary tax amount.",
                            "type":"number"
                        },
                        "rawSubtotal":{
                            "description":"The monetary raw subtotal.",
                            "type":"number"
                        },
                        "total":{
                            "description":"The monetary total: amount + shipping + tax. (read-only)",
                            "type":"number"
                        },
                        "shipping":{
                            "description":"The monetary cost of shipping.",
                            "type":"number"
                        },
                        "primaryCurrencyTotal":{
                            "description":"The primary currency total amount.",
                            "type":"number"
                        },
                        "amountIsFinal":{
                            "description":"Whether the amount is final.",
                            "type":"boolean"
                        },
                        "currencyCode":{
                            "description":"The three character currency code for the monetary amounts.",
                            "type":"string"
                        }
                    }
                },
                "exchangeRate":{
                    "description":"exchangeRate",
                    "type":"number"
                },
                "totalCommerceItemCount":{
                    "description":"The total count of commerce items in the order. (read-only)",
                    "type":"integer"
                },
                "state":{
                    "description":"The state of the order.",
                    "type":"string"
                },
                "id":{
                    "description":"The ID. OrderId in response should match that of the request.",
                    "type":"string"
                },
                "quoteInfo":{
                    "description":"Details about quote info",
                    "type":"object",
                    "properties":{
                        "providerNote":{
                            "description":"Provider note for this quote",
                            "type":"string"
                        },
                        "agentId":{
                            "description":"Agent id",
                            "type":"string"
                        },
                        "rejectionDate":{
                            "format":"date-time",
                            "description":"Rejection date for this quote",
                            "type":"string"
                        },
                        "requestDate":{
                            "format":"date-time",
                            "description":"Request Date for this quote",
                            "type":"string"
                        },
                        "errorInfo":{
                            "description":"Error Info for this quote",
                            "type":"string"
                        },
                        "externalId":{
                            "description":"external id for this quote",
                            "type":"string"
                        },
                        "rejectionNote":{
                            "description":"Rejection note for this quote",
                            "type":"string"
                        },
                        "quoteDate":{
                            "format":"date-time",
                            "description":"Quote Date for this quote",
                            "type":"string"
                        },
                        "expirationDate":{
                            "format":"date-time",
                            "description":"Expiration date for this quote",
                            "type":"string"
                        },
                        "requesterNote":{
                            "description":"Requestor note for this quote",
                            "type":"string"
                        }
                    }
                },
                "taxCalculated":{
                    "description":"Whether tax is calculated or not",
                    "type":"boolean"
                },
                "commerceItems":{
                    "description":"The commerce items (sometimes referred to as \"line items\") represent which actual skus are included in thef order in what quantity, and related information. Existing commerce items are matched to input data by id. If it is an existing item in order, its properties will be updated. If it is a new item, the item and its commerceItemRelationships' id must have prefix \"new_\". If you want to delete some item from the order, remove it from the webhook response. This is only applicable for root level items and not child items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "gwp":{
                                "description":"Flag to indicate whether item exists as a result of a gift with purchase promotion.",
                                "type":"boolean"
                            },
                            "deactivationDate":{
                                "description":"The deactivation date in ISO format. Updatable through webhook response.",
                                "type":"string"
                            },
                            "returnedQuantity":{
                                "description":"The quantity returned.",
                                "type":"integer"
                            },
                            "availabilityDate":{
                                "format":"date-time",
                                "description":"The availability date for preOrdered/backOrdered quantity.",
                                "type":"string"
                            },
                            "externalData":{
                                "description":"External data to be associated with a commerce item, provided by a third party system. Updatable through webhook response.",
                                "type":"array",
                                "items":{
                                    "properties":{
                                        "values":{
                                            "description":"The map values associated with an externalData item.",
                                            "type":"object",
                                            "properties":{
                                                "value":{
                                                    "description":"Map value defined by external system.",
                                                    "type":"string"
                                                },
                                                "key":{
                                                    "description":"Map key defined by external system.",
                                                    "type":"string"
                                                }
                                            }
                                        },
                                        "name":{
                                            "description":"The name to be associated with the externalData item.",
                                            "type":"string"
                                        },
                                        "actionCode":{
                                            "description":"The action code that has been set on the externalData item by the third party system.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "billingProfileId":{
                                "description":"The billing profile ID associated to the current item. Updatable through webhook response.",
                                "type":"string"
                            },
                            "billingAccountId":{
                                "description":"The billing account ID associated to the current item. Updatable through webhook response.",
                                "type":"string"
                            },
                            "preOrderQuantity":{
                                "description":"The pre ordered quantity included.",
                                "type":"integer"
                            },
                            "configuratorId":{
                                "description":"Configuration ID for this commerce item. Updatable through webhook response.",
                                "type":"string"
                            },
                            "assetKey":{
                                "description":"The assetKey assigned when the item is a service. Updatable through webhook response.",
                                "type":"string"
                            },
                            "priceInfo":{
                                "description":"Details about pricing.",
                                "type":"object",
                                "properties":{
                                    "discounted":{
                                        "description":"Whether the price is discounted.",
                                        "type":"boolean"
                                    },
                                    "amount":{
                                        "description":"The monetary amount of this order.",
                                        "type":"number"
                                    },
                                    "rawTotalPrice":{
                                        "description":"The raw total price.",
                                        "type":"number"
                                    },
                                    "salePrice":{
                                        "description":"The sale price",
                                        "type":"number"
                                    },
                                    "orderDiscountInfos":{
                                        "description":"Array of order promotions affecting this item.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "couponCodes":{
                                                    "description":"One or more coupon codes used to grant the order promotion providing the discount.",
                                                    "type":"array",
                                                    "items":{
                                                        "type":"string"
                                                    }
                                                },
                                                "amount":{
                                                    "description":"The amount of discount this item received from the promotion.",
                                                    "type":"number"
                                                },
                                                "promotionId":{
                                                    "description":"The promotion id that resulted in the discount.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "priceListId":{
                                        "description":"The price list ID used for pricing.",
                                        "type":"string"
                                    },
                                    "itemDiscountInfos":{
                                        "description":"Array of item promotions affecting this item.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "couponCodes":{
                                                    "description":"One or more coupon codes used to grant the item promotion providing the discount.",
                                                    "type":"array",
                                                    "items":{
                                                        "type":"string"
                                                    }
                                                },
                                                "amount":{
                                                    "description":"The amount of discount this item received from the promotion.",
                                                    "type":"number"
                                                },
                                                "promotionId":{
                                                    "description":"The promotion id that resulted in the discount.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "quantityDiscounted":{
                                        "description":"The quantity discounted.",
                                        "type":"integer"
                                    },
                                    "amountIsFinal":{
                                        "description":"Whether the amount is final.",
                                        "type":"boolean"
                                    },
                                    "shippingSurcharge":{
                                        "description":"Extra handling cost for shipping the product.",
                                        "type":"number"
                                    },
                                    "onSale":{
                                        "description":"Whether is on sale.",
                                        "type":"boolean"
                                    },
                                    "discountable":{
                                        "description":"Whether discountable.",
                                        "type":"boolean"
                                    },
                                    "currencyCode":{
                                        "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                                        "type":"string"
                                    },
                                    "currentPriceDetailsSorted":{
                                        "description":"The current price details.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "discounted":{
                                                    "description":"Whether the price is discounted.",
                                                    "type":"boolean"
                                                },
                                                "secondaryCurrencyTaxAmount":{
                                                    "description":" tax amount in secondaryCurrency",
                                                    "type":"number"
                                                },
                                                "amount":{
                                                    "description":"The monetary amount.",
                                                    "type":"number"
                                                },
                                                "quantity":{
                                                    "description":"The number of items covered by this price info",
                                                    "type":"integer"
                                                },
                                                "amountIsFinal":{
                                                    "description":"Whether the amount is final.",
                                                    "type":"boolean"
                                                },
                                                "range":{
                                                    "description":"Represents which specific items are covered by this price info.",
                                                    "type":"object",
                                                    "properties":{
                                                        "lowBound":{
                                                            "description":"The lower bound of the range this price info covers, inclusive.",
                                                            "type":"integer"
                                                        },
                                                        "highBound":{
                                                            "description":"The upper bound of the range this price info covers.",
                                                            "type":"integer"
                                                        },
                                                        "size":{
                                                            "description":"The number of items in this range, inclusive. (read-only)",
                                                            "type":"integer"
                                                        }
                                                    }
                                                },
                                                "tax":{
                                                    "description":"Monetary tax amount.",
                                                    "type":"number"
                                                },
                                                "orderDiscountShare":{
                                                    "description":"Share of the order discount for this item",
                                                    "type":"number"
                                                },
                                                "detailedUnitPrice":{
                                                    "description":"The detailed unit price: amount / quantity. (read-only)",
                                                    "type":"number"
                                                },
                                                "currencyCode":{
                                                    "description":"The three character currency code for the monetary amounts.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "listPrice":{
                                        "description":"The monetary amount of the list price.",
                                        "type":"number"
                                    }
                                }
                            },
                            "catalogId":{
                                "description":"The ID of the catalog which this commerce item references.",
                                "type":"string"
                            },
                            "externalRecurringChargeDetails":{
                                "description":"Details about external recurring pricing.",
                                "type":"object",
                                "properties":{
                                    "externalRecurringCharge":{
                                        "description":"The external recurring price.",
                                        "type":"number"
                                    },
                                    "externalRecurringChargeFrequency":{
                                        "description":"The frequency for the recurring charge e.g. Monthly.",
                                        "type":"string"
                                    },
                                    "externalRecurringChargeDuration":{
                                        "description":"The duration for the recurring charge e.g. 12 months.",
                                        "type":"string"
                                    }
                                }
                            },
                            "externalPriceDetails":{
                                "description":"Details about external pricing",
                                "type":"object",
                                "properties":{
                                    "externalPriceQuantity":{
                                        "description":"external quantity of this commerce item",
                                        "type":"integer"
                                    },
                                    "externalPrice":{
                                        "description":"External price of this commerce item",
                                        "type":"number"
                                    }
                                }
                            },
                            "actionCode":{
                                "description":"The action code that has been set on the item by the third party system. Updatable through webhook response.",
                                "type":"string"
                            },
                            "id":{
                                "description":"The internal/native ID for this commerce item. If it is a new item, the id must have prefix \"new_\".",
                                "type":"string"
                            },
                            "state":{
                                "description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
                                "type":"string"
                            },
                            "stateDetail":{
                                "description":"Details about the state of this commerce item",
                                "type":"string"
                            },
                            "serviceId":{
                                "description":"The service ID associated to the current item. Updatable through webhook response.",
                                "type":"string"
                            },
                            "commerceItems":{
                                "description":"The childItems of a commerceItem. The properties of child item can also be updated through webhook response. Unlike the root level items, if any of the childItem is not present in the webhook response, we will assume that no operation has to be performed on it and it will not get deleted. Id of child items of a new root level item should also have the prefix \"new_\".",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "$ref":"#/definitions/cancelOrderSubCommerceItems"
                                }
                            },
                            "serviceAccountId":{
                                "description":"The service account ID associated to the current item. Updatable through webhook response.",
                                "type":"string"
                            },
                            "quantity":{
                                "description":"The quantity included. Updatable through webhook response.",
                                "type":"integer"
                            },
                            "productId":{
                                "description":"The ID of the product.",
                                "type":"string"
                            },
                            "externalId":{
                                "description":"An optional, external ID for this commerce item.",
                                "type":"string"
                            },
                            "parentAssetKey":{
                                "description":"The parentAssetKey assigned when the item is a service. Updatable through webhook response.",
                                "type":"string"
                            },
                            "rootAssetKey":{
                                "description":"The rootAssetKey assigned when the item is a service. Updatable through webhook response.",
                                "type":"string"
                            },
                            "catalogRefId":{
                                "description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
                                "type":"string"
                            },
                            "recurringChargePriceInfo":{
                                "description":"Recurring charge price information.",
                                "type":"object",
                                "properties":{
                                    "amount":{
                                        "description":"The monetary amount of this recurring charge.",
                                        "type":"number"
                                    },
                                    "total":{
                                        "description":"The total price of the recurring charge.",
                                        "type":"number"
                                    },
                                    "frequencyAmountTotals":{
                                        "description":"The total for each recurring charge frequency",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "total":{
                                                    "description":"The total amount for the frequency.",
                                                    "type":"string"
                                                },
                                                "frequency":{
                                                    "description":"The frequency for the item's total e.g. Monthly.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "shipping":{
                                        "description":"Cost of shipping the product.",
                                        "type":"number"
                                    },
                                    "tax":{
                                        "description":"Monetary tax amount.",
                                        "type":"number"
                                    },
                                    "subTotal":{
                                        "description":"The sub-total price of the recurring charge.",
                                        "type":"number"
                                    },
                                    "frequencyTaxTotals":{
                                        "description":"The tax for each recurring charge frequency",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "tax":{
                                                    "description":"The tax amount for the frequency.",
                                                    "type":"string"
                                                },
                                                "frequency":{
                                                    "description":"The frequency for the item's tax e.g. Monthly.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "currencyCode":{
                                        "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                                        "type":"string"
                                    },
                                    "totalWithoutTax":{
                                        "description":"Total of recurring amount without tax included.",
                                        "type":"number"
                                    }
                                }
                            },
                            "customerAccountId":{
                                "description":"The customer account ID associated to the current item. Updatable through webhook response.",
                                "type":"string"
                            },
                            "productDisplayName":{
                                "description":"The product's display name. (read-only, obtained from the referenced product)",
                                "type":"string"
                            },
                            "catalogKey":{
                                "description":"The key of the catalog this commerce item references.",
                                "type":"string"
                            },
                            "siteId":{
                                "description":"The ID of the site on which the item was added.",
                                "type":"string"
                            },
                            "shopperInput":{
                                "description":"Map of shopper input keys to values",
                                "additionalProperties":{
                                    "type":"string"
                                },
                                "type":"object"
                            },
                            "asset":{
                                "description":"The flag that defines it the item is an asset or not. Updatable through webhook response.",
                                "type":"boolean"
                            },
                            "activationDate":{
                                "description":"The activation date in ISO format. Updatable through webhook response.",
                                "type":"string"
                            },
                            "backOrderQuantity":{
                                "description":"The back ordered quantity included.",
                                "type":"integer"
                            }
                        },
                        "required":[
                            "id",
                            "catalogRefId",
                            "quantity"
                        ]
                    }
                },
                "commerceItemsIsTruncated":{
                    "description":"This property will be added to the webhook payload only if the corresponding commerceItems property is truncated. The value for this field will be true always if present",
                    "type":"boolean"
                },
                "taxPriceInfo":{
                    "description":"The tax pricing details for the order.",
                    "type":"object",
                    "properties":{
                        "discounted":{
                            "description":"Whether the price was discounted.",
                            "type":"boolean"
                        },
                        "secondaryCurrencyTaxAmount":{
                            "description":" tax amount in secondaryCurrency",
                            "type":"number"
                        },
                        "amount":{
                            "description":"The monetary amount.",
                            "type":"number"
                        },
                        "valueAddedTax":{
                            "description":"The amount for valueAddedTax.",
                            "type":"number"
                        },
                        "countyTax":{
                            "description":"The monetary amount of county tax.",
                            "type":"number"
                        },
                        "isTaxIncluded":{
                            "description":"Whether the tax is included or not",
                            "type":"boolean"
                        },
                        "miscTax":{
                            "description":"The amount for miscTax.",
                            "type":"number"
                        },
                        "districtTax":{
                            "description":"Tax amount for the district.",
                            "type":"number"
                        },
                        "stateTax":{
                            "description":"Tax amount for the state.",
                            "type":"number"
                        },
                        "miscTaxInfo":{
                            "description":"Details about the miscTax.",
                            "type":"object",
                            "properties":{
                                "Special":{
                                    "description":"Details of the Special tax",
                                    "type":"number"
                                }
                            }
                        },
                        "countryTax":{
                            "description":"The monetary amount of country tax.",
                            "type":"number"
                        },
                        "cityTax":{
                            "description":"The monetary amount of city tax.",
                            "type":"number"
                        },
                        "amountIsFinal":{
                            "description":"Whether the amount is final.",
                            "type":"boolean"
                        },
                        "currencyCode":{
                            "description":"The three character currency code.",
                            "type":"string"
                        }
                    }
                },
                "shippingGroups":{
                    "description":"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.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "shippingMethod":{
                                "description":"The shipping method.",
                                "type":"string"
                            },
                            "description":{
                                "description":"The description of this shipping group. Defaults to the ID.",
                                "type":"string"
                            },
                            "submittedDate":{
                                "format":"date-time",
                                "description":"The date the shipping group was submitted.",
                                "type":"string"
                            },
                            "priceInfo":{
                                "description":"The pricing details about this shipping group.",
                                "type":"object",
                                "properties":{
                                    "discounted":{
                                        "description":"Whether this item is discounted.",
                                        "type":"boolean"
                                    },
                                    "secondaryCurrencyTaxAmount":{
                                        "description":" The secondary currency tax amount.",
                                        "type":"number"
                                    },
                                    "shippingTax":{
                                        "description":"shippingTax for this shipping group",
                                        "type":"number"
                                    },
                                    "amount":{
                                        "description":"The monetary amount.",
                                        "type":"number"
                                    },
                                    "secondaryCurrencyShippingAmount":{
                                        "description":" The secondary currency shipping amount.",
                                        "type":"number"
                                    },
                                    "rawShipping":{
                                        "description":"The monitary amount of the cost of raw shipping.",
                                        "type":"number"
                                    },
                                    "amountIsFinal":{
                                        "description":"Whether the amount is final.",
                                        "type":"boolean"
                                    },
                                    "currencyCode":{
                                        "description":"The currency code for the monetary amounts.",
                                        "type":"string"
                                    }
                                }
                            },
                            "recurringChargePriceInfo":{
                                "description":"Recurring charge price information.",
                                "type":"object",
                                "properties":{
                                    "amount":{
                                        "description":"The monetary amount of this recurring charge.",
                                        "type":"number"
                                    },
                                    "total":{
                                        "description":"The total price of the recurring charge.",
                                        "type":"number"
                                    },
                                    "frequencyAmountTotals":{
                                        "description":"The total for each recurring charge frequency",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "total":{
                                                    "description":"The total amount for the frequency.",
                                                    "type":"string"
                                                },
                                                "frequency":{
                                                    "description":"The frequency for the item's total e.g. Monthly.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "shipping":{
                                        "description":"Cost of shipping the product.",
                                        "type":"number"
                                    },
                                    "tax":{
                                        "description":"Monetary tax amount.",
                                        "type":"number"
                                    },
                                    "subTotal":{
                                        "description":"The sub-total price of the recurring charge.",
                                        "type":"number"
                                    },
                                    "frequencyTaxTotals":{
                                        "description":"The tax for each recurring charge frequency",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "tax":{
                                                    "description":"The tax amount for the frequency.",
                                                    "type":"string"
                                                },
                                                "frequency":{
                                                    "description":"The frequency for the item's tax e.g. Monthly.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "currencyCode":{
                                        "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                                        "type":"string"
                                    },
                                    "totalWithoutTax":{
                                        "description":"Total of recurring amount without tax included.",
                                        "type":"number"
                                    }
                                }
                            },
                            "shipOnDate":{
                                "format":"date-time",
                                "description":"The date this shipping group is expected to ship upon.",
                                "type":"string"
                            },
                            "actualShipDate":{
                                "format":"date-time",
                                "description":"The actual shipped date of this shipping group.",
                                "type":"string"
                            },
                            "specialInstructions":{
                                "description":"Special instructions for the shipping group. Keys and values are strings.",
                                "type":"object",
                                "properties":{
                                    "additionalProperties":{
                                        "type":"string"
                                    }
                                }
                            },
                            "shippingAddress":{
                                "description":"The shipping address for this shipping group.",
                                "type":"object",
                                "properties":{
                                    "lastName":{
                                        "description":"Last name.",
                                        "type":"string"
                                    },
                                    "country":{
                                        "description":"Country.",
                                        "type":"string"
                                    },
                                    "address3":{
                                        "description":"Address Line 3.",
                                        "type":"string"
                                    },
                                    "address2":{
                                        "description":"Address Line 2.",
                                        "type":"string"
                                    },
                                    "city":{
                                        "description":"City.",
                                        "type":"string"
                                    },
                                    "address1":{
                                        "description":"Address Line 1.",
                                        "type":"string"
                                    },
                                    "prefix":{
                                        "description":"Prefix.",
                                        "type":"string"
                                    },
                                    "companyName":{
                                        "description":"Company name.",
                                        "type":"string"
                                    },
                                    "postalCode":{
                                        "description":"Postal code.",
                                        "type":"string"
                                    },
                                    "jobTitle":{
                                        "description":"Job title.",
                                        "type":"string"
                                    },
                                    "county":{
                                        "description":"Name of the county.",
                                        "type":"string"
                                    },
                                    "ownerId":{
                                        "description":"The ID of the owner of this address.",
                                        "type":"string"
                                    },
                                    "suffix":{
                                        "description":"Suffix.",
                                        "type":"string"
                                    },
                                    "firstName":{
                                        "description":"First name.",
                                        "type":"string"
                                    },
                                    "phoneNumber":{
                                        "description":"Phone number.",
                                        "type":"string"
                                    },
                                    "faxNumber":{
                                        "description":"The fax number.",
                                        "type":"string"
                                    },
                                    "middleName":{
                                        "description":"Middle name.",
                                        "type":"string"
                                    },
                                    "state":{
                                        "description":"State.",
                                        "type":"string"
                                    },
                                    "id":{
                                        "description":"ID.",
                                        "type":"string"
                                    },
                                    "email":{
                                        "description":"The email address",
                                        "type":"string"
                                    }
                                }
                            },
                            "commerceItemRelationships":{
                                "description":"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.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "commerceItemId":{
                                            "description":"The referenced commerce item's internal ID.",
                                            "type":"string"
                                        },
                                        "amount":{
                                            "description":"The monetary value.",
                                            "type":"number"
                                        },
                                        "quantity":{
                                            "description":"The quantity of items referenced by this relationship. Updatable through webhook response. If quantity of relationship is updated, the sum of quantity for a commerceItem across all its relationships should match with commerceItem's quantity.",
                                            "type":"integer"
                                        },
                                        "relationshipType":{
                                            "description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
                                            "type":"string"
                                        },
                                        "returnedQuantity":{
                                            "description":"Number of referenced items that were returned.",
                                            "type":"integer"
                                        },
                                        "range":{
                                            "description":"Represents which specific items are covered by this commerceItemRelationship.",
                                            "type":"object",
                                            "properties":{
                                                "lowBound":{
                                                    "description":"The lower bound of the range.",
                                                    "type":"integer"
                                                },
                                                "highBound":{
                                                    "description":"The upper bound of the range.",
                                                    "type":"integer"
                                                },
                                                "size":{
                                                    "description":"The no of items this range includes",
                                                    "type":"integer"
                                                }
                                            }
                                        },
                                        "commerceItemExternalId":{
                                            "description":"The referenced commerce item's external ID.",
                                            "type":"string"
                                        },
                                        "state":{
                                            "description":"The state of this commerceItemRelationships item. Updatable through webhook response. Updatable states are CANCEL_REQUESTED, RETURN_REQUESTED and NO_ACTION.",
                                            "type":"string"
                                        },
                                        "id":{
                                            "description":"The native ID of this item.",
                                            "type":"string"
                                        }
                                    },
                                    "required":[
                                        "id",
                                        "commerceItemId",
                                        "quantity"
                                    ]
                                }
                            },
                            "id":{
                                "description":"The ID of this shipping group.",
                                "type":"string"
                            },
                            "state":{
                                "description":"The state of this shipping group.",
                                "type":"string"
                            },
                            "stateDetail":{
                                "description":"Details about the state of this shipping group.",
                                "type":"string"
                            },
                            "trackingNumber":{
                                "description":"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.",
                                "type":"string"
                            },
                            "handlingInstructions":{
                                "description":"Handling instructions. Currently read-only.",
                                "type":"array",
                                "items":{
                                    "type":"string",
                                    "properties":{
                                    }
                                }
                            },
                            "shippingGroupClassType":{
                                "description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
                                "type":"string"
                            }
                        },
                        "required":[
                            "id",
                            "shippingMethod",
                            "commerceItemRelationships"
                        ]
                    }
                },
                "taxExempt":{
                    "description":"Whether order is tax-exempt or not.",
                    "type":"boolean"
                },
                "creationSiteId":{
                    "description":"The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.",
                    "type":"string"
                },
                "profile":{
                    "description":"Basic profile information. (read-only)",
                    "type":"object",
                    "properties":{
                        "lastName":{
                            "description":"Last name.",
                            "type":"string"
                        },
                        "firstName":{
                            "description":"First name.",
                            "type":"string"
                        },
                        "shippingAddress":{
                            "description":"Default shipping address",
                            "type":"object",
                            "properties":{
                                "country":{
                                    "description":"Country.",
                                    "type":"string"
                                },
                                "phoneNumber":{
                                    "description":"Phone number.",
                                    "type":"string"
                                },
                                "address3":{
                                    "description":"Address Line 3.",
                                    "type":"string"
                                },
                                "address2":{
                                    "description":"Address Line 2.",
                                    "type":"string"
                                },
                                "city":{
                                    "description":"City.",
                                    "type":"string"
                                },
                                "address1":{
                                    "description":"Address Line 1.",
                                    "type":"string"
                                },
                                "postalCode":{
                                    "description":"Postal code.",
                                    "type":"string"
                                },
                                "county":{
                                    "description":"Name of the county.",
                                    "type":"string"
                                },
                                "state":{
                                    "description":"State.",
                                    "type":"string"
                                }
                            }
                        },
                        "middleName":{
                            "description":"Middle name.",
                            "type":"string"
                        },
                        "email":{
                            "description":"The email address",
                            "type":"string"
                        }
                    }
                },
                "shippingGroupCount":{
                    "description":"The number of shipping groups (read-only, value is ignored when updating).",
                    "type":"integer"
                },
                "paymentGroupCount":{
                    "description":"The number of payment groups. (read-only, value is ignored when updating)",
                    "type":"integer"
                },
                "orderAction":{
                    "description":"The action performed on the order.",
                    "type":"string"
                },
                "PriceGroupId":{
                    "description":"The id of the PriceGroup.",
                    "type":"string"
                },
                "recurringChargePriceInfo":{
                    "description":"Recurring charge price information.",
                    "type":"object",
                    "properties":{
                        "amount":{
                            "description":"The monetary amount of this recurring charge.",
                            "type":"number"
                        },
                        "total":{
                            "description":"The total price of the recurring charge.",
                            "type":"number"
                        },
                        "frequencyAmountTotals":{
                            "description":"The total for each recurring charge frequency",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "total":{
                                        "description":"The total amount for the frequency.",
                                        "type":"string"
                                    },
                                    "frequency":{
                                        "description":"The frequency for the item's total e.g. Monthly.",
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "shipping":{
                            "description":"Cost of shipping the product.",
                            "type":"number"
                        },
                        "tax":{
                            "description":"Monetary tax amount.",
                            "type":"number"
                        },
                        "subTotal":{
                            "description":"The sub-total price of the recurring charge.",
                            "type":"number"
                        },
                        "frequencyTaxTotals":{
                            "description":"The tax for each recurring charge frequency",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "tax":{
                                        "description":"The tax amount for the frequency.",
                                        "type":"string"
                                    },
                                    "frequency":{
                                        "description":"The frequency for the item's tax e.g. Monthly.",
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "currencyCode":{
                            "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                            "type":"string"
                        },
                        "totalWithoutTax":{
                            "description":"Total of recurring amount without tax included.",
                            "type":"number"
                        }
                    }
                },
                "profileId":{
                    "description":"The ID of the shopper profile that owns the order.",
                    "type":"string"
                },
                "siteId":{
                    "description":"The site id associated with this order",
                    "type":"string"
                },
                "activeQuoteOrderId":{
                    "description":"The Id of the parent quoted order",
                    "type":"string"
                }
            },
            "required":[
                "id",
                "commerceItems",
                "shippingGroups"
            ]
        }
    },
    "example":{
    }
}

Example:

{
}

Nested Schema : order

Type: object

Show Source

• activeQuoteOrderId(optional): string
  The Id of the parent quoted order
• commerceItems: array commerceItems
  The commerce items (sometimes referred to as "line items") represent which actual skus are included in thef order in what quantity, and related information. Existing commerce items are matched to input data by id. If it is an existing item in order, its properties will be updated. If it is a new item, the item and its commerceItemRelationships' id must have prefix "new_". If you want to delete some item from the order, remove it from the webhook response. This is only applicable for root level items and not child items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
• commerceItemsIsTruncated(optional): boolean
  This property will be added to the webhook payload only if the corresponding commerceItems property is truncated. The value for this field will be true always if present
• creationSiteId(optional): string
  The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.
• creationTime(optional): integer
  The creation time.
• exchangeRate(optional): number
  exchangeRate
• gwp(optional): boolean
  Whether gift with purchase is enabled or not.
• id: string
  The ID. OrderId in response should match that of the request.
• lastModifiedTime(optional): integer
  The last modified time.
• locale(optional): string
  Locale
• orderAction(optional): string
  The action performed on the order.
• organizationId(optional): string
  The organization ID.
• paymentGroupCount(optional): integer
  The number of payment groups. (read-only, value is ignored when updating)
• paymentGroups(optional): array paymentGroups
  The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of "tokenizedCreditCard"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of "externalPaymentGroup"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.
• PriceGroupId(optional): string
  The id of the PriceGroup.
• priceInfo(optional): object priceInfo
  Pricing information, an instance of OrderPriceInfo.
• profile(optional): object profile
  Basic profile information. (read-only)
• profileId(optional): string
  The ID of the shopper profile that owns the order.
• quoteInfo(optional): object quoteInfo
  Details about quote info
• recurringChargePriceInfo(optional): object recurringChargePriceInfo
  Recurring charge price information.
• salesChannel(optional): string
  The sales channel of this order. default to "default".
• secondaryCurrencyCode(optional): string
  Secondary currencyCode
• shippingGroupCount(optional): integer
  The number of shipping groups (read-only, value is ignored when updating).
• shippingGroups: array shippingGroups
  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(optional): string
  The site id associated with this order
• state(optional): string
  The state of the order.
• taxCalculated(optional): boolean
  Whether tax is calculated or not
• taxExempt(optional): boolean
  Whether order is tax-exempt or not.
• taxPriceInfo(optional): object taxPriceInfo
  The tax pricing details for the order.
• totalCommerceItemCount(optional): integer
  The total count of commerce items in the order. (read-only)

{
    "properties":{
        "gwp":{
            "description":"Whether gift with purchase is enabled or not.",
            "type":"boolean"
        },
        "secondaryCurrencyCode":{
            "description":"Secondary currencyCode",
            "type":"string"
        },
        "lastModifiedTime":{
            "description":"The last modified time.",
            "type":"integer"
        },
        "creationTime":{
            "description":"The creation time.",
            "type":"integer"
        },
        "locale":{
            "description":"Locale",
            "type":"string"
        },
        "paymentGroups":{
            "description":"The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of \"tokenizedCreditCard\"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of \"externalPaymentGroup\"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "expirationYear":{
                        "description":"A string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards)",
                        "type":"string"
                    },
                    "PONumber":{
                        "description":"The purchase order number",
                        "type":"string"
                    },
                    "externalType":{
                        "description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
                        "type":"string"
                    },
                    "amountAuthorized":{
                        "description":"The monetary amount authorized.",
                        "type":"number"
                    },
                    "amount":{
                        "description":"The monetary amount of the payment.",
                        "type":"number"
                    },
                    "externalId":{
                        "description":"The ID for the payment group in an external system (like the OMS)",
                        "type":"string"
                    },
                    "expirationMonth":{
                        "description":"A string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards)",
                        "type":"string"
                    },
                    "creditCardType":{
                        "description":"The type of the credit card. (only for TokenizedCreditCards)",
                        "type":"string"
                    },
                    "submittedDate":{
                        "format":"date-time",
                        "description":"The date the payment was submitted.",
                        "type":"string"
                    },
                    "authorizationStatus":{
                        "description":"Aray of authorization status objects.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "amount":{
                                    "description":"The monetary amount.",
                                    "type":"number"
                                },
                                "transactionSuccess":{
                                    "description":"Whether the transaction was successful.",
                                    "type":"boolean"
                                },
                                "errorMessage":{
                                    "description":"The error message, if any.",
                                    "type":"string"
                                },
                                "transactionId":{
                                    "description":"The transaction ID.",
                                    "type":"string"
                                },
                                "transactionTimestamp":{
                                    "description":"The timestamp of the transaction.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "token":{
                        "description":"The CyberSource token string. (only for tokenizedCreditCard)",
                        "type":"string"
                    },
                    "paymentGroupClassType":{
                        "description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
                        "type":"string"
                    },
                    "creditCardNumber":{
                        "description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
                        "type":"string"
                    },
                    "externalSubtype":{
                        "description":"The subtype in the external system. Might be \"VISA\" for a PaymentGroup with an external type of \"CreditCard\". (only for ExternalPaymentGroups)",
                        "type":"string"
                    },
                    "paymentMethod":{
                        "description":"The payment method. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
                        "type":"string"
                    },
                    "externalSourceId":{
                        "description":"The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)",
                        "type":"string"
                    },
                    "state":{
                        "description":"The state of this payment group.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The internal ID of the payment group.",
                        "type":"string"
                    },
                    "stateDetail":{
                        "description":"Details about the state of this payment group.",
                        "type":"string"
                    },
                    "currencyCode":{
                        "description":"The three character currency code. For example: USD.",
                        "type":"string"
                    },
                    "expirationDayOfMonth":{
                        "description":"A string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards)",
                        "type":"string"
                    }
                }
            }
        },
        "salesChannel":{
            "description":"The sales channel of this order. default to \"default\".",
            "type":"string"
        },
        "organizationId":{
            "description":"The organization ID.",
            "type":"string"
        },
        "priceInfo":{
            "description":"Pricing information, an instance of OrderPriceInfo.",
            "type":"object",
            "properties":{
                "secondaryCurrencyTaxAmount":{
                    "description":"The secondary currency tax amount.",
                    "type":"number"
                },
                "discounted":{
                    "description":"Whether the price is discounted.",
                    "type":"boolean"
                },
                "amount":{
                    "description":"The monetary amount.",
                    "type":"number"
                },
                "secondaryCurrencyShippingAmount":{
                    "description":"The secondary currency shipping amount.",
                    "type":"number"
                },
                "secondaryCurrencyTotal":{
                    "description":"The secondary currency total amount.",
                    "type":"number"
                },
                "manualAdjustmentTotal":{
                    "description":"The monetary total of manual adjustments.",
                    "type":"number"
                },
                "discountAmount":{
                    "description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
                    "type":"number"
                },
                "tax":{
                    "description":"Monetary tax amount.",
                    "type":"number"
                },
                "rawSubtotal":{
                    "description":"The monetary raw subtotal.",
                    "type":"number"
                },
                "total":{
                    "description":"The monetary total: amount + shipping + tax. (read-only)",
                    "type":"number"
                },
                "shipping":{
                    "description":"The monetary cost of shipping.",
                    "type":"number"
                },
                "primaryCurrencyTotal":{
                    "description":"The primary currency total amount.",
                    "type":"number"
                },
                "amountIsFinal":{
                    "description":"Whether the amount is final.",
                    "type":"boolean"
                },
                "currencyCode":{
                    "description":"The three character currency code for the monetary amounts.",
                    "type":"string"
                }
            }
        },
        "exchangeRate":{
            "description":"exchangeRate",
            "type":"number"
        },
        "totalCommerceItemCount":{
            "description":"The total count of commerce items in the order. (read-only)",
            "type":"integer"
        },
        "state":{
            "description":"The state of the order.",
            "type":"string"
        },
        "id":{
            "description":"The ID. OrderId in response should match that of the request.",
            "type":"string"
        },
        "quoteInfo":{
            "description":"Details about quote info",
            "type":"object",
            "properties":{
                "providerNote":{
                    "description":"Provider note for this quote",
                    "type":"string"
                },
                "agentId":{
                    "description":"Agent id",
                    "type":"string"
                },
                "rejectionDate":{
                    "format":"date-time",
                    "description":"Rejection date for this quote",
                    "type":"string"
                },
                "requestDate":{
                    "format":"date-time",
                    "description":"Request Date for this quote",
                    "type":"string"
                },
                "errorInfo":{
                    "description":"Error Info for this quote",
                    "type":"string"
                },
                "externalId":{
                    "description":"external id for this quote",
                    "type":"string"
                },
                "rejectionNote":{
                    "description":"Rejection note for this quote",
                    "type":"string"
                },
                "quoteDate":{
                    "format":"date-time",
                    "description":"Quote Date for this quote",
                    "type":"string"
                },
                "expirationDate":{
                    "format":"date-time",
                    "description":"Expiration date for this quote",
                    "type":"string"
                },
                "requesterNote":{
                    "description":"Requestor note for this quote",
                    "type":"string"
                }
            }
        },
        "taxCalculated":{
            "description":"Whether tax is calculated or not",
            "type":"boolean"
        },
        "commerceItems":{
            "description":"The commerce items (sometimes referred to as \"line items\") represent which actual skus are included in thef order in what quantity, and related information. Existing commerce items are matched to input data by id. If it is an existing item in order, its properties will be updated. If it is a new item, the item and its commerceItemRelationships' id must have prefix \"new_\". If you want to delete some item from the order, remove it from the webhook response. This is only applicable for root level items and not child items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "gwp":{
                        "description":"Flag to indicate whether item exists as a result of a gift with purchase promotion.",
                        "type":"boolean"
                    },
                    "deactivationDate":{
                        "description":"The deactivation date in ISO format. Updatable through webhook response.",
                        "type":"string"
                    },
                    "returnedQuantity":{
                        "description":"The quantity returned.",
                        "type":"integer"
                    },
                    "availabilityDate":{
                        "format":"date-time",
                        "description":"The availability date for preOrdered/backOrdered quantity.",
                        "type":"string"
                    },
                    "externalData":{
                        "description":"External data to be associated with a commerce item, provided by a third party system. Updatable through webhook response.",
                        "type":"array",
                        "items":{
                            "properties":{
                                "values":{
                                    "description":"The map values associated with an externalData item.",
                                    "type":"object",
                                    "properties":{
                                        "value":{
                                            "description":"Map value defined by external system.",
                                            "type":"string"
                                        },
                                        "key":{
                                            "description":"Map key defined by external system.",
                                            "type":"string"
                                        }
                                    }
                                },
                                "name":{
                                    "description":"The name to be associated with the externalData item.",
                                    "type":"string"
                                },
                                "actionCode":{
                                    "description":"The action code that has been set on the externalData item by the third party system.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "billingProfileId":{
                        "description":"The billing profile ID associated to the current item. Updatable through webhook response.",
                        "type":"string"
                    },
                    "billingAccountId":{
                        "description":"The billing account ID associated to the current item. Updatable through webhook response.",
                        "type":"string"
                    },
                    "preOrderQuantity":{
                        "description":"The pre ordered quantity included.",
                        "type":"integer"
                    },
                    "configuratorId":{
                        "description":"Configuration ID for this commerce item. Updatable through webhook response.",
                        "type":"string"
                    },
                    "assetKey":{
                        "description":"The assetKey assigned when the item is a service. Updatable through webhook response.",
                        "type":"string"
                    },
                    "priceInfo":{
                        "description":"Details about pricing.",
                        "type":"object",
                        "properties":{
                            "discounted":{
                                "description":"Whether the price is discounted.",
                                "type":"boolean"
                            },
                            "amount":{
                                "description":"The monetary amount of this order.",
                                "type":"number"
                            },
                            "rawTotalPrice":{
                                "description":"The raw total price.",
                                "type":"number"
                            },
                            "salePrice":{
                                "description":"The sale price",
                                "type":"number"
                            },
                            "orderDiscountInfos":{
                                "description":"Array of order promotions affecting this item.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "couponCodes":{
                                            "description":"One or more coupon codes used to grant the order promotion providing the discount.",
                                            "type":"array",
                                            "items":{
                                                "type":"string"
                                            }
                                        },
                                        "amount":{
                                            "description":"The amount of discount this item received from the promotion.",
                                            "type":"number"
                                        },
                                        "promotionId":{
                                            "description":"The promotion id that resulted in the discount.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "priceListId":{
                                "description":"The price list ID used for pricing.",
                                "type":"string"
                            },
                            "itemDiscountInfos":{
                                "description":"Array of item promotions affecting this item.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "couponCodes":{
                                            "description":"One or more coupon codes used to grant the item promotion providing the discount.",
                                            "type":"array",
                                            "items":{
                                                "type":"string"
                                            }
                                        },
                                        "amount":{
                                            "description":"The amount of discount this item received from the promotion.",
                                            "type":"number"
                                        },
                                        "promotionId":{
                                            "description":"The promotion id that resulted in the discount.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "quantityDiscounted":{
                                "description":"The quantity discounted.",
                                "type":"integer"
                            },
                            "amountIsFinal":{
                                "description":"Whether the amount is final.",
                                "type":"boolean"
                            },
                            "shippingSurcharge":{
                                "description":"Extra handling cost for shipping the product.",
                                "type":"number"
                            },
                            "onSale":{
                                "description":"Whether is on sale.",
                                "type":"boolean"
                            },
                            "discountable":{
                                "description":"Whether discountable.",
                                "type":"boolean"
                            },
                            "currencyCode":{
                                "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                                "type":"string"
                            },
                            "currentPriceDetailsSorted":{
                                "description":"The current price details.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "discounted":{
                                            "description":"Whether the price is discounted.",
                                            "type":"boolean"
                                        },
                                        "secondaryCurrencyTaxAmount":{
                                            "description":" tax amount in secondaryCurrency",
                                            "type":"number"
                                        },
                                        "amount":{
                                            "description":"The monetary amount.",
                                            "type":"number"
                                        },
                                        "quantity":{
                                            "description":"The number of items covered by this price info",
                                            "type":"integer"
                                        },
                                        "amountIsFinal":{
                                            "description":"Whether the amount is final.",
                                            "type":"boolean"
                                        },
                                        "range":{
                                            "description":"Represents which specific items are covered by this price info.",
                                            "type":"object",
                                            "properties":{
                                                "lowBound":{
                                                    "description":"The lower bound of the range this price info covers, inclusive.",
                                                    "type":"integer"
                                                },
                                                "highBound":{
                                                    "description":"The upper bound of the range this price info covers.",
                                                    "type":"integer"
                                                },
                                                "size":{
                                                    "description":"The number of items in this range, inclusive. (read-only)",
                                                    "type":"integer"
                                                }
                                            }
                                        },
                                        "tax":{
                                            "description":"Monetary tax amount.",
                                            "type":"number"
                                        },
                                        "orderDiscountShare":{
                                            "description":"Share of the order discount for this item",
                                            "type":"number"
                                        },
                                        "detailedUnitPrice":{
                                            "description":"The detailed unit price: amount / quantity. (read-only)",
                                            "type":"number"
                                        },
                                        "currencyCode":{
                                            "description":"The three character currency code for the monetary amounts.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "listPrice":{
                                "description":"The monetary amount of the list price.",
                                "type":"number"
                            }
                        }
                    },
                    "catalogId":{
                        "description":"The ID of the catalog which this commerce item references.",
                        "type":"string"
                    },
                    "externalRecurringChargeDetails":{
                        "description":"Details about external recurring pricing.",
                        "type":"object",
                        "properties":{
                            "externalRecurringCharge":{
                                "description":"The external recurring price.",
                                "type":"number"
                            },
                            "externalRecurringChargeFrequency":{
                                "description":"The frequency for the recurring charge e.g. Monthly.",
                                "type":"string"
                            },
                            "externalRecurringChargeDuration":{
                                "description":"The duration for the recurring charge e.g. 12 months.",
                                "type":"string"
                            }
                        }
                    },
                    "externalPriceDetails":{
                        "description":"Details about external pricing",
                        "type":"object",
                        "properties":{
                            "externalPriceQuantity":{
                                "description":"external quantity of this commerce item",
                                "type":"integer"
                            },
                            "externalPrice":{
                                "description":"External price of this commerce item",
                                "type":"number"
                            }
                        }
                    },
                    "actionCode":{
                        "description":"The action code that has been set on the item by the third party system. Updatable through webhook response.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The internal/native ID for this commerce item. If it is a new item, the id must have prefix \"new_\".",
                        "type":"string"
                    },
                    "state":{
                        "description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
                        "type":"string"
                    },
                    "stateDetail":{
                        "description":"Details about the state of this commerce item",
                        "type":"string"
                    },
                    "serviceId":{
                        "description":"The service ID associated to the current item. Updatable through webhook response.",
                        "type":"string"
                    },
                    "commerceItems":{
                        "description":"The childItems of a commerceItem. The properties of child item can also be updated through webhook response. Unlike the root level items, if any of the childItem is not present in the webhook response, we will assume that no operation has to be performed on it and it will not get deleted. Id of child items of a new root level item should also have the prefix \"new_\".",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "$ref":"#/definitions/cancelOrderSubCommerceItems"
                        }
                    },
                    "serviceAccountId":{
                        "description":"The service account ID associated to the current item. Updatable through webhook response.",
                        "type":"string"
                    },
                    "quantity":{
                        "description":"The quantity included. Updatable through webhook response.",
                        "type":"integer"
                    },
                    "productId":{
                        "description":"The ID of the product.",
                        "type":"string"
                    },
                    "externalId":{
                        "description":"An optional, external ID for this commerce item.",
                        "type":"string"
                    },
                    "parentAssetKey":{
                        "description":"The parentAssetKey assigned when the item is a service. Updatable through webhook response.",
                        "type":"string"
                    },
                    "rootAssetKey":{
                        "description":"The rootAssetKey assigned when the item is a service. Updatable through webhook response.",
                        "type":"string"
                    },
                    "catalogRefId":{
                        "description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
                        "type":"string"
                    },
                    "recurringChargePriceInfo":{
                        "description":"Recurring charge price information.",
                        "type":"object",
                        "properties":{
                            "amount":{
                                "description":"The monetary amount of this recurring charge.",
                                "type":"number"
                            },
                            "total":{
                                "description":"The total price of the recurring charge.",
                                "type":"number"
                            },
                            "frequencyAmountTotals":{
                                "description":"The total for each recurring charge frequency",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "total":{
                                            "description":"The total amount for the frequency.",
                                            "type":"string"
                                        },
                                        "frequency":{
                                            "description":"The frequency for the item's total e.g. Monthly.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "shipping":{
                                "description":"Cost of shipping the product.",
                                "type":"number"
                            },
                            "tax":{
                                "description":"Monetary tax amount.",
                                "type":"number"
                            },
                            "subTotal":{
                                "description":"The sub-total price of the recurring charge.",
                                "type":"number"
                            },
                            "frequencyTaxTotals":{
                                "description":"The tax for each recurring charge frequency",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "tax":{
                                            "description":"The tax amount for the frequency.",
                                            "type":"string"
                                        },
                                        "frequency":{
                                            "description":"The frequency for the item's tax e.g. Monthly.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "currencyCode":{
                                "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                                "type":"string"
                            },
                            "totalWithoutTax":{
                                "description":"Total of recurring amount without tax included.",
                                "type":"number"
                            }
                        }
                    },
                    "customerAccountId":{
                        "description":"The customer account ID associated to the current item. Updatable through webhook response.",
                        "type":"string"
                    },
                    "productDisplayName":{
                        "description":"The product's display name. (read-only, obtained from the referenced product)",
                        "type":"string"
                    },
                    "catalogKey":{
                        "description":"The key of the catalog this commerce item references.",
                        "type":"string"
                    },
                    "siteId":{
                        "description":"The ID of the site on which the item was added.",
                        "type":"string"
                    },
                    "shopperInput":{
                        "description":"Map of shopper input keys to values",
                        "additionalProperties":{
                            "type":"string"
                        },
                        "type":"object"
                    },
                    "asset":{
                        "description":"The flag that defines it the item is an asset or not. Updatable through webhook response.",
                        "type":"boolean"
                    },
                    "activationDate":{
                        "description":"The activation date in ISO format. Updatable through webhook response.",
                        "type":"string"
                    },
                    "backOrderQuantity":{
                        "description":"The back ordered quantity included.",
                        "type":"integer"
                    }
                },
                "required":[
                    "id",
                    "catalogRefId",
                    "quantity"
                ]
            }
        },
        "commerceItemsIsTruncated":{
            "description":"This property will be added to the webhook payload only if the corresponding commerceItems property is truncated. The value for this field will be true always if present",
            "type":"boolean"
        },
        "taxPriceInfo":{
            "description":"The tax pricing details for the order.",
            "type":"object",
            "properties":{
                "discounted":{
                    "description":"Whether the price was discounted.",
                    "type":"boolean"
                },
                "secondaryCurrencyTaxAmount":{
                    "description":" tax amount in secondaryCurrency",
                    "type":"number"
                },
                "amount":{
                    "description":"The monetary amount.",
                    "type":"number"
                },
                "valueAddedTax":{
                    "description":"The amount for valueAddedTax.",
                    "type":"number"
                },
                "countyTax":{
                    "description":"The monetary amount of county tax.",
                    "type":"number"
                },
                "isTaxIncluded":{
                    "description":"Whether the tax is included or not",
                    "type":"boolean"
                },
                "miscTax":{
                    "description":"The amount for miscTax.",
                    "type":"number"
                },
                "districtTax":{
                    "description":"Tax amount for the district.",
                    "type":"number"
                },
                "stateTax":{
                    "description":"Tax amount for the state.",
                    "type":"number"
                },
                "miscTaxInfo":{
                    "description":"Details about the miscTax.",
                    "type":"object",
                    "properties":{
                        "Special":{
                            "description":"Details of the Special tax",
                            "type":"number"
                        }
                    }
                },
                "countryTax":{
                    "description":"The monetary amount of country tax.",
                    "type":"number"
                },
                "cityTax":{
                    "description":"The monetary amount of city tax.",
                    "type":"number"
                },
                "amountIsFinal":{
                    "description":"Whether the amount is final.",
                    "type":"boolean"
                },
                "currencyCode":{
                    "description":"The three character currency code.",
                    "type":"string"
                }
            }
        },
        "shippingGroups":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "shippingMethod":{
                        "description":"The shipping method.",
                        "type":"string"
                    },
                    "description":{
                        "description":"The description of this shipping group. Defaults to the ID.",
                        "type":"string"
                    },
                    "submittedDate":{
                        "format":"date-time",
                        "description":"The date the shipping group was submitted.",
                        "type":"string"
                    },
                    "priceInfo":{
                        "description":"The pricing details about this shipping group.",
                        "type":"object",
                        "properties":{
                            "discounted":{
                                "description":"Whether this item is discounted.",
                                "type":"boolean"
                            },
                            "secondaryCurrencyTaxAmount":{
                                "description":" The secondary currency tax amount.",
                                "type":"number"
                            },
                            "shippingTax":{
                                "description":"shippingTax for this shipping group",
                                "type":"number"
                            },
                            "amount":{
                                "description":"The monetary amount.",
                                "type":"number"
                            },
                            "secondaryCurrencyShippingAmount":{
                                "description":" The secondary currency shipping amount.",
                                "type":"number"
                            },
                            "rawShipping":{
                                "description":"The monitary amount of the cost of raw shipping.",
                                "type":"number"
                            },
                            "amountIsFinal":{
                                "description":"Whether the amount is final.",
                                "type":"boolean"
                            },
                            "currencyCode":{
                                "description":"The currency code for the monetary amounts.",
                                "type":"string"
                            }
                        }
                    },
                    "recurringChargePriceInfo":{
                        "description":"Recurring charge price information.",
                        "type":"object",
                        "properties":{
                            "amount":{
                                "description":"The monetary amount of this recurring charge.",
                                "type":"number"
                            },
                            "total":{
                                "description":"The total price of the recurring charge.",
                                "type":"number"
                            },
                            "frequencyAmountTotals":{
                                "description":"The total for each recurring charge frequency",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "total":{
                                            "description":"The total amount for the frequency.",
                                            "type":"string"
                                        },
                                        "frequency":{
                                            "description":"The frequency for the item's total e.g. Monthly.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "shipping":{
                                "description":"Cost of shipping the product.",
                                "type":"number"
                            },
                            "tax":{
                                "description":"Monetary tax amount.",
                                "type":"number"
                            },
                            "subTotal":{
                                "description":"The sub-total price of the recurring charge.",
                                "type":"number"
                            },
                            "frequencyTaxTotals":{
                                "description":"The tax for each recurring charge frequency",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "tax":{
                                            "description":"The tax amount for the frequency.",
                                            "type":"string"
                                        },
                                        "frequency":{
                                            "description":"The frequency for the item's tax e.g. Monthly.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "currencyCode":{
                                "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                                "type":"string"
                            },
                            "totalWithoutTax":{
                                "description":"Total of recurring amount without tax included.",
                                "type":"number"
                            }
                        }
                    },
                    "shipOnDate":{
                        "format":"date-time",
                        "description":"The date this shipping group is expected to ship upon.",
                        "type":"string"
                    },
                    "actualShipDate":{
                        "format":"date-time",
                        "description":"The actual shipped date of this shipping group.",
                        "type":"string"
                    },
                    "specialInstructions":{
                        "description":"Special instructions for the shipping group. Keys and values are strings.",
                        "type":"object",
                        "properties":{
                            "additionalProperties":{
                                "type":"string"
                            }
                        }
                    },
                    "shippingAddress":{
                        "description":"The shipping address for this shipping group.",
                        "type":"object",
                        "properties":{
                            "lastName":{
                                "description":"Last name.",
                                "type":"string"
                            },
                            "country":{
                                "description":"Country.",
                                "type":"string"
                            },
                            "address3":{
                                "description":"Address Line 3.",
                                "type":"string"
                            },
                            "address2":{
                                "description":"Address Line 2.",
                                "type":"string"
                            },
                            "city":{
                                "description":"City.",
                                "type":"string"
                            },
                            "address1":{
                                "description":"Address Line 1.",
                                "type":"string"
                            },
                            "prefix":{
                                "description":"Prefix.",
                                "type":"string"
                            },
                            "companyName":{
                                "description":"Company name.",
                                "type":"string"
                            },
                            "postalCode":{
                                "description":"Postal code.",
                                "type":"string"
                            },
                            "jobTitle":{
                                "description":"Job title.",
                                "type":"string"
                            },
                            "county":{
                                "description":"Name of the county.",
                                "type":"string"
                            },
                            "ownerId":{
                                "description":"The ID of the owner of this address.",
                                "type":"string"
                            },
                            "suffix":{
                                "description":"Suffix.",
                                "type":"string"
                            },
                            "firstName":{
                                "description":"First name.",
                                "type":"string"
                            },
                            "phoneNumber":{
                                "description":"Phone number.",
                                "type":"string"
                            },
                            "faxNumber":{
                                "description":"The fax number.",
                                "type":"string"
                            },
                            "middleName":{
                                "description":"Middle name.",
                                "type":"string"
                            },
                            "state":{
                                "description":"State.",
                                "type":"string"
                            },
                            "id":{
                                "description":"ID.",
                                "type":"string"
                            },
                            "email":{
                                "description":"The email address",
                                "type":"string"
                            }
                        }
                    },
                    "commerceItemRelationships":{
                        "description":"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.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "commerceItemId":{
                                    "description":"The referenced commerce item's internal ID.",
                                    "type":"string"
                                },
                                "amount":{
                                    "description":"The monetary value.",
                                    "type":"number"
                                },
                                "quantity":{
                                    "description":"The quantity of items referenced by this relationship. Updatable through webhook response. If quantity of relationship is updated, the sum of quantity for a commerceItem across all its relationships should match with commerceItem's quantity.",
                                    "type":"integer"
                                },
                                "relationshipType":{
                                    "description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
                                    "type":"string"
                                },
                                "returnedQuantity":{
                                    "description":"Number of referenced items that were returned.",
                                    "type":"integer"
                                },
                                "range":{
                                    "description":"Represents which specific items are covered by this commerceItemRelationship.",
                                    "type":"object",
                                    "properties":{
                                        "lowBound":{
                                            "description":"The lower bound of the range.",
                                            "type":"integer"
                                        },
                                        "highBound":{
                                            "description":"The upper bound of the range.",
                                            "type":"integer"
                                        },
                                        "size":{
                                            "description":"The no of items this range includes",
                                            "type":"integer"
                                        }
                                    }
                                },
                                "commerceItemExternalId":{
                                    "description":"The referenced commerce item's external ID.",
                                    "type":"string"
                                },
                                "state":{
                                    "description":"The state of this commerceItemRelationships item. Updatable through webhook response. Updatable states are CANCEL_REQUESTED, RETURN_REQUESTED and NO_ACTION.",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"The native ID of this item.",
                                    "type":"string"
                                }
                            },
                            "required":[
                                "id",
                                "commerceItemId",
                                "quantity"
                            ]
                        }
                    },
                    "id":{
                        "description":"The ID of this shipping group.",
                        "type":"string"
                    },
                    "state":{
                        "description":"The state of this shipping group.",
                        "type":"string"
                    },
                    "stateDetail":{
                        "description":"Details about the state of this shipping group.",
                        "type":"string"
                    },
                    "trackingNumber":{
                        "description":"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.",
                        "type":"string"
                    },
                    "handlingInstructions":{
                        "description":"Handling instructions. Currently read-only.",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "properties":{
                            }
                        }
                    },
                    "shippingGroupClassType":{
                        "description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
                        "type":"string"
                    }
                },
                "required":[
                    "id",
                    "shippingMethod",
                    "commerceItemRelationships"
                ]
            }
        },
        "taxExempt":{
            "description":"Whether order is tax-exempt or not.",
            "type":"boolean"
        },
        "creationSiteId":{
            "description":"The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.",
            "type":"string"
        },
        "profile":{
            "description":"Basic profile information. (read-only)",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"Last name.",
                    "type":"string"
                },
                "firstName":{
                    "description":"First name.",
                    "type":"string"
                },
                "shippingAddress":{
                    "description":"Default shipping address",
                    "type":"object",
                    "properties":{
                        "country":{
                            "description":"Country.",
                            "type":"string"
                        },
                        "phoneNumber":{
                            "description":"Phone number.",
                            "type":"string"
                        },
                        "address3":{
                            "description":"Address Line 3.",
                            "type":"string"
                        },
                        "address2":{
                            "description":"Address Line 2.",
                            "type":"string"
                        },
                        "city":{
                            "description":"City.",
                            "type":"string"
                        },
                        "address1":{
                            "description":"Address Line 1.",
                            "type":"string"
                        },
                        "postalCode":{
                            "description":"Postal code.",
                            "type":"string"
                        },
                        "county":{
                            "description":"Name of the county.",
                            "type":"string"
                        },
                        "state":{
                            "description":"State.",
                            "type":"string"
                        }
                    }
                },
                "middleName":{
                    "description":"Middle name.",
                    "type":"string"
                },
                "email":{
                    "description":"The email address",
                    "type":"string"
                }
            }
        },
        "shippingGroupCount":{
            "description":"The number of shipping groups (read-only, value is ignored when updating).",
            "type":"integer"
        },
        "paymentGroupCount":{
            "description":"The number of payment groups. (read-only, value is ignored when updating)",
            "type":"integer"
        },
        "orderAction":{
            "description":"The action performed on the order.",
            "type":"string"
        },
        "PriceGroupId":{
            "description":"The id of the PriceGroup.",
            "type":"string"
        },
        "recurringChargePriceInfo":{
            "description":"Recurring charge price information.",
            "type":"object",
            "properties":{
                "amount":{
                    "description":"The monetary amount of this recurring charge.",
                    "type":"number"
                },
                "total":{
                    "description":"The total price of the recurring charge.",
                    "type":"number"
                },
                "frequencyAmountTotals":{
                    "description":"The total for each recurring charge frequency",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "total":{
                                "description":"The total amount for the frequency.",
                                "type":"string"
                            },
                            "frequency":{
                                "description":"The frequency for the item's total e.g. Monthly.",
                                "type":"string"
                            }
                        }
                    }
                },
                "shipping":{
                    "description":"Cost of shipping the product.",
                    "type":"number"
                },
                "tax":{
                    "description":"Monetary tax amount.",
                    "type":"number"
                },
                "subTotal":{
                    "description":"The sub-total price of the recurring charge.",
                    "type":"number"
                },
                "frequencyTaxTotals":{
                    "description":"The tax for each recurring charge frequency",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "tax":{
                                "description":"The tax amount for the frequency.",
                                "type":"string"
                            },
                            "frequency":{
                                "description":"The frequency for the item's tax e.g. Monthly.",
                                "type":"string"
                            }
                        }
                    }
                },
                "currencyCode":{
                    "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                    "type":"string"
                },
                "totalWithoutTax":{
                    "description":"Total of recurring amount without tax included.",
                    "type":"number"
                }
            }
        },
        "profileId":{
            "description":"The ID of the shopper profile that owns the order.",
            "type":"string"
        },
        "siteId":{
            "description":"The site id associated with this order",
            "type":"string"
        },
        "activeQuoteOrderId":{
            "description":"The Id of the parent quoted order",
            "type":"string"
        }
    },
    "required":[
        "id",
        "commerceItems",
        "shippingGroups"
    ]
}

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. Existing commerce items are matched to input data by id. If it is an existing item in order, its properties will be updated. If it is a new item, the item and its commerceItemRelationships' id must have prefix "new_". If you want to delete some item from the order, remove it from the webhook response. This is only applicable for root level items and not child items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook

Show Source

• Array of: object items

{
    "description":"The commerce items (sometimes referred to as \"line items\") represent which actual skus are included in thef order in what quantity, and related information. Existing commerce items are matched to input data by id. If it is an existing item in order, its properties will be updated. If it is a new item, the item and its commerceItemRelationships' id must have prefix \"new_\". If you want to delete some item from the order, remove it from the webhook response. This is only applicable for root level items and not child items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "gwp":{
                "description":"Flag to indicate whether item exists as a result of a gift with purchase promotion.",
                "type":"boolean"
            },
            "deactivationDate":{
                "description":"The deactivation date in ISO format. Updatable through webhook response.",
                "type":"string"
            },
            "returnedQuantity":{
                "description":"The quantity returned.",
                "type":"integer"
            },
            "availabilityDate":{
                "format":"date-time",
                "description":"The availability date for preOrdered/backOrdered quantity.",
                "type":"string"
            },
            "externalData":{
                "description":"External data to be associated with a commerce item, provided by a third party system. Updatable through webhook response.",
                "type":"array",
                "items":{
                    "properties":{
                        "values":{
                            "description":"The map values associated with an externalData item.",
                            "type":"object",
                            "properties":{
                                "value":{
                                    "description":"Map value defined by external system.",
                                    "type":"string"
                                },
                                "key":{
                                    "description":"Map key defined by external system.",
                                    "type":"string"
                                }
                            }
                        },
                        "name":{
                            "description":"The name to be associated with the externalData item.",
                            "type":"string"
                        },
                        "actionCode":{
                            "description":"The action code that has been set on the externalData item by the third party system.",
                            "type":"string"
                        }
                    }
                }
            },
            "billingProfileId":{
                "description":"The billing profile ID associated to the current item. Updatable through webhook response.",
                "type":"string"
            },
            "billingAccountId":{
                "description":"The billing account ID associated to the current item. Updatable through webhook response.",
                "type":"string"
            },
            "preOrderQuantity":{
                "description":"The pre ordered quantity included.",
                "type":"integer"
            },
            "configuratorId":{
                "description":"Configuration ID for this commerce item. Updatable through webhook response.",
                "type":"string"
            },
            "assetKey":{
                "description":"The assetKey assigned when the item is a service. Updatable through webhook response.",
                "type":"string"
            },
            "priceInfo":{
                "description":"Details about pricing.",
                "type":"object",
                "properties":{
                    "discounted":{
                        "description":"Whether the price is discounted.",
                        "type":"boolean"
                    },
                    "amount":{
                        "description":"The monetary amount of this order.",
                        "type":"number"
                    },
                    "rawTotalPrice":{
                        "description":"The raw total price.",
                        "type":"number"
                    },
                    "salePrice":{
                        "description":"The sale price",
                        "type":"number"
                    },
                    "orderDiscountInfos":{
                        "description":"Array of order promotions affecting this item.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "couponCodes":{
                                    "description":"One or more coupon codes used to grant the order promotion providing the discount.",
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                },
                                "amount":{
                                    "description":"The amount of discount this item received from the promotion.",
                                    "type":"number"
                                },
                                "promotionId":{
                                    "description":"The promotion id that resulted in the discount.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "priceListId":{
                        "description":"The price list ID used for pricing.",
                        "type":"string"
                    },
                    "itemDiscountInfos":{
                        "description":"Array of item promotions affecting this item.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "couponCodes":{
                                    "description":"One or more coupon codes used to grant the item promotion providing the discount.",
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                },
                                "amount":{
                                    "description":"The amount of discount this item received from the promotion.",
                                    "type":"number"
                                },
                                "promotionId":{
                                    "description":"The promotion id that resulted in the discount.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "quantityDiscounted":{
                        "description":"The quantity discounted.",
                        "type":"integer"
                    },
                    "amountIsFinal":{
                        "description":"Whether the amount is final.",
                        "type":"boolean"
                    },
                    "shippingSurcharge":{
                        "description":"Extra handling cost for shipping the product.",
                        "type":"number"
                    },
                    "onSale":{
                        "description":"Whether is on sale.",
                        "type":"boolean"
                    },
                    "discountable":{
                        "description":"Whether discountable.",
                        "type":"boolean"
                    },
                    "currencyCode":{
                        "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                        "type":"string"
                    },
                    "currentPriceDetailsSorted":{
                        "description":"The current price details.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "discounted":{
                                    "description":"Whether the price is discounted.",
                                    "type":"boolean"
                                },
                                "secondaryCurrencyTaxAmount":{
                                    "description":" tax amount in secondaryCurrency",
                                    "type":"number"
                                },
                                "amount":{
                                    "description":"The monetary amount.",
                                    "type":"number"
                                },
                                "quantity":{
                                    "description":"The number of items covered by this price info",
                                    "type":"integer"
                                },
                                "amountIsFinal":{
                                    "description":"Whether the amount is final.",
                                    "type":"boolean"
                                },
                                "range":{
                                    "description":"Represents which specific items are covered by this price info.",
                                    "type":"object",
                                    "properties":{
                                        "lowBound":{
                                            "description":"The lower bound of the range this price info covers, inclusive.",
                                            "type":"integer"
                                        },
                                        "highBound":{
                                            "description":"The upper bound of the range this price info covers.",
                                            "type":"integer"
                                        },
                                        "size":{
                                            "description":"The number of items in this range, inclusive. (read-only)",
                                            "type":"integer"
                                        }
                                    }
                                },
                                "tax":{
                                    "description":"Monetary tax amount.",
                                    "type":"number"
                                },
                                "orderDiscountShare":{
                                    "description":"Share of the order discount for this item",
                                    "type":"number"
                                },
                                "detailedUnitPrice":{
                                    "description":"The detailed unit price: amount / quantity. (read-only)",
                                    "type":"number"
                                },
                                "currencyCode":{
                                    "description":"The three character currency code for the monetary amounts.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "listPrice":{
                        "description":"The monetary amount of the list price.",
                        "type":"number"
                    }
                }
            },
            "catalogId":{
                "description":"The ID of the catalog which this commerce item references.",
                "type":"string"
            },
            "externalRecurringChargeDetails":{
                "description":"Details about external recurring pricing.",
                "type":"object",
                "properties":{
                    "externalRecurringCharge":{
                        "description":"The external recurring price.",
                        "type":"number"
                    },
                    "externalRecurringChargeFrequency":{
                        "description":"The frequency for the recurring charge e.g. Monthly.",
                        "type":"string"
                    },
                    "externalRecurringChargeDuration":{
                        "description":"The duration for the recurring charge e.g. 12 months.",
                        "type":"string"
                    }
                }
            },
            "externalPriceDetails":{
                "description":"Details about external pricing",
                "type":"object",
                "properties":{
                    "externalPriceQuantity":{
                        "description":"external quantity of this commerce item",
                        "type":"integer"
                    },
                    "externalPrice":{
                        "description":"External price of this commerce item",
                        "type":"number"
                    }
                }
            },
            "actionCode":{
                "description":"The action code that has been set on the item by the third party system. Updatable through webhook response.",
                "type":"string"
            },
            "id":{
                "description":"The internal/native ID for this commerce item. If it is a new item, the id must have prefix \"new_\".",
                "type":"string"
            },
            "state":{
                "description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
                "type":"string"
            },
            "stateDetail":{
                "description":"Details about the state of this commerce item",
                "type":"string"
            },
            "serviceId":{
                "description":"The service ID associated to the current item. Updatable through webhook response.",
                "type":"string"
            },
            "commerceItems":{
                "description":"The childItems of a commerceItem. The properties of child item can also be updated through webhook response. Unlike the root level items, if any of the childItem is not present in the webhook response, we will assume that no operation has to be performed on it and it will not get deleted. Id of child items of a new root level item should also have the prefix \"new_\".",
                "type":"array",
                "items":{
                    "type":"object",
                    "$ref":"#/definitions/cancelOrderSubCommerceItems"
                }
            },
            "serviceAccountId":{
                "description":"The service account ID associated to the current item. Updatable through webhook response.",
                "type":"string"
            },
            "quantity":{
                "description":"The quantity included. Updatable through webhook response.",
                "type":"integer"
            },
            "productId":{
                "description":"The ID of the product.",
                "type":"string"
            },
            "externalId":{
                "description":"An optional, external ID for this commerce item.",
                "type":"string"
            },
            "parentAssetKey":{
                "description":"The parentAssetKey assigned when the item is a service. Updatable through webhook response.",
                "type":"string"
            },
            "rootAssetKey":{
                "description":"The rootAssetKey assigned when the item is a service. Updatable through webhook response.",
                "type":"string"
            },
            "catalogRefId":{
                "description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
                "type":"string"
            },
            "recurringChargePriceInfo":{
                "description":"Recurring charge price information.",
                "type":"object",
                "properties":{
                    "amount":{
                        "description":"The monetary amount of this recurring charge.",
                        "type":"number"
                    },
                    "total":{
                        "description":"The total price of the recurring charge.",
                        "type":"number"
                    },
                    "frequencyAmountTotals":{
                        "description":"The total for each recurring charge frequency",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "total":{
                                    "description":"The total amount for the frequency.",
                                    "type":"string"
                                },
                                "frequency":{
                                    "description":"The frequency for the item's total e.g. Monthly.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "shipping":{
                        "description":"Cost of shipping the product.",
                        "type":"number"
                    },
                    "tax":{
                        "description":"Monetary tax amount.",
                        "type":"number"
                    },
                    "subTotal":{
                        "description":"The sub-total price of the recurring charge.",
                        "type":"number"
                    },
                    "frequencyTaxTotals":{
                        "description":"The tax for each recurring charge frequency",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "tax":{
                                    "description":"The tax amount for the frequency.",
                                    "type":"string"
                                },
                                "frequency":{
                                    "description":"The frequency for the item's tax e.g. Monthly.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "currencyCode":{
                        "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                        "type":"string"
                    },
                    "totalWithoutTax":{
                        "description":"Total of recurring amount without tax included.",
                        "type":"number"
                    }
                }
            },
            "customerAccountId":{
                "description":"The customer account ID associated to the current item. Updatable through webhook response.",
                "type":"string"
            },
            "productDisplayName":{
                "description":"The product's display name. (read-only, obtained from the referenced product)",
                "type":"string"
            },
            "catalogKey":{
                "description":"The key of the catalog this commerce item references.",
                "type":"string"
            },
            "siteId":{
                "description":"The ID of the site on which the item was added.",
                "type":"string"
            },
            "shopperInput":{
                "description":"Map of shopper input keys to values",
                "additionalProperties":{
                    "type":"string"
                },
                "type":"object"
            },
            "asset":{
                "description":"The flag that defines it the item is an asset or not. Updatable through webhook response.",
                "type":"boolean"
            },
            "activationDate":{
                "description":"The activation date in ISO format. Updatable through webhook response.",
                "type":"string"
            },
            "backOrderQuantity":{
                "description":"The back ordered quantity included.",
                "type":"integer"
            }
        },
        "required":[
            "id",
            "catalogRefId",
            "quantity"
        ]
    }
}

Nested Schema : paymentGroups

Type: array

The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of "tokenizedCreditCard"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of "externalPaymentGroup"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.

Show Source

• Array of: object items

{
    "description":"The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of \"tokenizedCreditCard\"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of \"externalPaymentGroup\"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "expirationYear":{
                "description":"A string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards)",
                "type":"string"
            },
            "PONumber":{
                "description":"The purchase order number",
                "type":"string"
            },
            "externalType":{
                "description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
                "type":"string"
            },
            "amountAuthorized":{
                "description":"The monetary amount authorized.",
                "type":"number"
            },
            "amount":{
                "description":"The monetary amount of the payment.",
                "type":"number"
            },
            "externalId":{
                "description":"The ID for the payment group in an external system (like the OMS)",
                "type":"string"
            },
            "expirationMonth":{
                "description":"A string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards)",
                "type":"string"
            },
            "creditCardType":{
                "description":"The type of the credit card. (only for TokenizedCreditCards)",
                "type":"string"
            },
            "submittedDate":{
                "format":"date-time",
                "description":"The date the payment was submitted.",
                "type":"string"
            },
            "authorizationStatus":{
                "description":"Aray of authorization status objects.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "amount":{
                            "description":"The monetary amount.",
                            "type":"number"
                        },
                        "transactionSuccess":{
                            "description":"Whether the transaction was successful.",
                            "type":"boolean"
                        },
                        "errorMessage":{
                            "description":"The error message, if any.",
                            "type":"string"
                        },
                        "transactionId":{
                            "description":"The transaction ID.",
                            "type":"string"
                        },
                        "transactionTimestamp":{
                            "description":"The timestamp of the transaction.",
                            "type":"string"
                        }
                    }
                }
            },
            "token":{
                "description":"The CyberSource token string. (only for tokenizedCreditCard)",
                "type":"string"
            },
            "paymentGroupClassType":{
                "description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
                "type":"string"
            },
            "creditCardNumber":{
                "description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
                "type":"string"
            },
            "externalSubtype":{
                "description":"The subtype in the external system. Might be \"VISA\" for a PaymentGroup with an external type of \"CreditCard\". (only for ExternalPaymentGroups)",
                "type":"string"
            },
            "paymentMethod":{
                "description":"The payment method. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
                "type":"string"
            },
            "externalSourceId":{
                "description":"The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)",
                "type":"string"
            },
            "state":{
                "description":"The state of this payment group.",
                "type":"string"
            },
            "id":{
                "description":"The internal ID of the payment group.",
                "type":"string"
            },
            "stateDetail":{
                "description":"Details about the state of this payment group.",
                "type":"string"
            },
            "currencyCode":{
                "description":"The three character currency code. For example: USD.",
                "type":"string"
            },
            "expirationDayOfMonth":{
                "description":"A string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards)",
                "type":"string"
            }
        }
    }
}

Nested Schema : priceInfo

Type: object

Pricing information, an instance of OrderPriceInfo.

Show Source

• amount(optional): number
  The monetary amount.
• amountIsFinal(optional): boolean
  Whether the amount is final.
• currencyCode(optional): string
  The three character currency code for the monetary amounts.
• discountAmount(optional): number
  The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)
• discounted(optional): boolean
  Whether the price is discounted.
• manualAdjustmentTotal(optional): number
  The monetary total of manual adjustments.
• primaryCurrencyTotal(optional): number
  The primary currency total amount.
• rawSubtotal(optional): number
  The monetary raw subtotal.
• secondaryCurrencyShippingAmount(optional): number
  The secondary currency shipping amount.
• secondaryCurrencyTaxAmount(optional): number
  The secondary currency tax amount.
• secondaryCurrencyTotal(optional): number
  The secondary currency total amount.
• shipping(optional): number
  The monetary cost of shipping.
• tax(optional): number
  Monetary tax amount.
• total(optional): number
  The monetary total: amount + shipping + tax. (read-only)

{
    "description":"Pricing information, an instance of OrderPriceInfo.",
    "type":"object",
    "properties":{
        "secondaryCurrencyTaxAmount":{
            "description":"The secondary currency tax amount.",
            "type":"number"
        },
        "discounted":{
            "description":"Whether the price is discounted.",
            "type":"boolean"
        },
        "amount":{
            "description":"The monetary amount.",
            "type":"number"
        },
        "secondaryCurrencyShippingAmount":{
            "description":"The secondary currency shipping amount.",
            "type":"number"
        },
        "secondaryCurrencyTotal":{
            "description":"The secondary currency total amount.",
            "type":"number"
        },
        "manualAdjustmentTotal":{
            "description":"The monetary total of manual adjustments.",
            "type":"number"
        },
        "discountAmount":{
            "description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
            "type":"number"
        },
        "tax":{
            "description":"Monetary tax amount.",
            "type":"number"
        },
        "rawSubtotal":{
            "description":"The monetary raw subtotal.",
            "type":"number"
        },
        "total":{
            "description":"The monetary total: amount + shipping + tax. (read-only)",
            "type":"number"
        },
        "shipping":{
            "description":"The monetary cost of shipping.",
            "type":"number"
        },
        "primaryCurrencyTotal":{
            "description":"The primary currency total amount.",
            "type":"number"
        },
        "amountIsFinal":{
            "description":"Whether the amount is final.",
            "type":"boolean"
        },
        "currencyCode":{
            "description":"The three character currency code for the monetary amounts.",
            "type":"string"
        }
    }
}

Nested Schema : profile

Type: object

Basic profile information. (read-only)

Show Source

• email(optional): string
  The email address
• firstName(optional): string
  First name.
• lastName(optional): string
  Last name.
• middleName(optional): string
  Middle name.
• shippingAddress(optional): object shippingAddress
  Default shipping address

{
    "description":"Basic profile information. (read-only)",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"Last name.",
            "type":"string"
        },
        "firstName":{
            "description":"First name.",
            "type":"string"
        },
        "shippingAddress":{
            "description":"Default shipping address",
            "type":"object",
            "properties":{
                "country":{
                    "description":"Country.",
                    "type":"string"
                },
                "phoneNumber":{
                    "description":"Phone number.",
                    "type":"string"
                },
                "address3":{
                    "description":"Address Line 3.",
                    "type":"string"
                },
                "address2":{
                    "description":"Address Line 2.",
                    "type":"string"
                },
                "city":{
                    "description":"City.",
                    "type":"string"
                },
                "address1":{
                    "description":"Address Line 1.",
                    "type":"string"
                },
                "postalCode":{
                    "description":"Postal code.",
                    "type":"string"
                },
                "county":{
                    "description":"Name of the county.",
                    "type":"string"
                },
                "state":{
                    "description":"State.",
                    "type":"string"
                }
            }
        },
        "middleName":{
            "description":"Middle name.",
            "type":"string"
        },
        "email":{
            "description":"The email address",
            "type":"string"
        }
    }
}

Nested Schema : quoteInfo

Type: object

Details about quote info

Show Source

• agentId(optional): string
  Agent id
• errorInfo(optional): string
  Error Info for this quote
• expirationDate(optional): string(date-time)
  Expiration date for this quote
• externalId(optional): string
  external id for this quote
• providerNote(optional): string
  Provider note for this quote
• quoteDate(optional): string(date-time)
  Quote Date for this quote
• rejectionDate(optional): string(date-time)
  Rejection date for this quote
• rejectionNote(optional): string
  Rejection note for this quote
• requestDate(optional): string(date-time)
  Request Date for this quote
• requesterNote(optional): string
  Requestor note for this quote

{
    "description":"Details about quote info",
    "type":"object",
    "properties":{
        "providerNote":{
            "description":"Provider note for this quote",
            "type":"string"
        },
        "agentId":{
            "description":"Agent id",
            "type":"string"
        },
        "rejectionDate":{
            "format":"date-time",
            "description":"Rejection date for this quote",
            "type":"string"
        },
        "requestDate":{
            "format":"date-time",
            "description":"Request Date for this quote",
            "type":"string"
        },
        "errorInfo":{
            "description":"Error Info for this quote",
            "type":"string"
        },
        "externalId":{
            "description":"external id for this quote",
            "type":"string"
        },
        "rejectionNote":{
            "description":"Rejection note for this quote",
            "type":"string"
        },
        "quoteDate":{
            "format":"date-time",
            "description":"Quote Date for this quote",
            "type":"string"
        },
        "expirationDate":{
            "format":"date-time",
            "description":"Expiration date for this quote",
            "type":"string"
        },
        "requesterNote":{
            "description":"Requestor note for this quote",
            "type":"string"
        }
    }
}

Nested Schema : recurringChargePriceInfo

Type: object

Recurring charge price information.

Show Source

• amount(optional): number
  The monetary amount of this recurring charge.
• currencyCode(optional): string
  The currency code for the monetary amounts. A three character currency code such as USD.
• frequencyAmountTotals(optional): array frequencyAmountTotals
  The total for each recurring charge frequency
• frequencyTaxTotals(optional): array frequencyTaxTotals
  The tax for each recurring charge frequency
• shipping(optional): number
  Cost of shipping the product.
• subTotal(optional): number
  The sub-total price of the recurring charge.
• tax(optional): number
  Monetary tax amount.
• total(optional): number
  The total price of the recurring charge.
• totalWithoutTax(optional): number
  Total of recurring amount without tax included.

{
    "description":"Recurring charge price information.",
    "type":"object",
    "properties":{
        "amount":{
            "description":"The monetary amount of this recurring charge.",
            "type":"number"
        },
        "total":{
            "description":"The total price of the recurring charge.",
            "type":"number"
        },
        "frequencyAmountTotals":{
            "description":"The total for each recurring charge frequency",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "total":{
                        "description":"The total amount for the frequency.",
                        "type":"string"
                    },
                    "frequency":{
                        "description":"The frequency for the item's total e.g. Monthly.",
                        "type":"string"
                    }
                }
            }
        },
        "shipping":{
            "description":"Cost of shipping the product.",
            "type":"number"
        },
        "tax":{
            "description":"Monetary tax amount.",
            "type":"number"
        },
        "subTotal":{
            "description":"The sub-total price of the recurring charge.",
            "type":"number"
        },
        "frequencyTaxTotals":{
            "description":"The tax for each recurring charge frequency",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "tax":{
                        "description":"The tax amount for the frequency.",
                        "type":"string"
                    },
                    "frequency":{
                        "description":"The frequency for the item's tax e.g. Monthly.",
                        "type":"string"
                    }
                }
            }
        },
        "currencyCode":{
            "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
            "type":"string"
        },
        "totalWithoutTax":{
            "description":"Total of recurring amount without tax included.",
            "type":"number"
        }
    }
}

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.

Show Source

• Array of: object items

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "shippingMethod":{
                "description":"The shipping method.",
                "type":"string"
            },
            "description":{
                "description":"The description of this shipping group. Defaults to the ID.",
                "type":"string"
            },
            "submittedDate":{
                "format":"date-time",
                "description":"The date the shipping group was submitted.",
                "type":"string"
            },
            "priceInfo":{
                "description":"The pricing details about this shipping group.",
                "type":"object",
                "properties":{
                    "discounted":{
                        "description":"Whether this item is discounted.",
                        "type":"boolean"
                    },
                    "secondaryCurrencyTaxAmount":{
                        "description":" The secondary currency tax amount.",
                        "type":"number"
                    },
                    "shippingTax":{
                        "description":"shippingTax for this shipping group",
                        "type":"number"
                    },
                    "amount":{
                        "description":"The monetary amount.",
                        "type":"number"
                    },
                    "secondaryCurrencyShippingAmount":{
                        "description":" The secondary currency shipping amount.",
                        "type":"number"
                    },
                    "rawShipping":{
                        "description":"The monitary amount of the cost of raw shipping.",
                        "type":"number"
                    },
                    "amountIsFinal":{
                        "description":"Whether the amount is final.",
                        "type":"boolean"
                    },
                    "currencyCode":{
                        "description":"The currency code for the monetary amounts.",
                        "type":"string"
                    }
                }
            },
            "recurringChargePriceInfo":{
                "description":"Recurring charge price information.",
                "type":"object",
                "properties":{
                    "amount":{
                        "description":"The monetary amount of this recurring charge.",
                        "type":"number"
                    },
                    "total":{
                        "description":"The total price of the recurring charge.",
                        "type":"number"
                    },
                    "frequencyAmountTotals":{
                        "description":"The total for each recurring charge frequency",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "total":{
                                    "description":"The total amount for the frequency.",
                                    "type":"string"
                                },
                                "frequency":{
                                    "description":"The frequency for the item's total e.g. Monthly.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "shipping":{
                        "description":"Cost of shipping the product.",
                        "type":"number"
                    },
                    "tax":{
                        "description":"Monetary tax amount.",
                        "type":"number"
                    },
                    "subTotal":{
                        "description":"The sub-total price of the recurring charge.",
                        "type":"number"
                    },
                    "frequencyTaxTotals":{
                        "description":"The tax for each recurring charge frequency",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "tax":{
                                    "description":"The tax amount for the frequency.",
                                    "type":"string"
                                },
                                "frequency":{
                                    "description":"The frequency for the item's tax e.g. Monthly.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "currencyCode":{
                        "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                        "type":"string"
                    },
                    "totalWithoutTax":{
                        "description":"Total of recurring amount without tax included.",
                        "type":"number"
                    }
                }
            },
            "shipOnDate":{
                "format":"date-time",
                "description":"The date this shipping group is expected to ship upon.",
                "type":"string"
            },
            "actualShipDate":{
                "format":"date-time",
                "description":"The actual shipped date of this shipping group.",
                "type":"string"
            },
            "specialInstructions":{
                "description":"Special instructions for the shipping group. Keys and values are strings.",
                "type":"object",
                "properties":{
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "shippingAddress":{
                "description":"The shipping address for this shipping group.",
                "type":"object",
                "properties":{
                    "lastName":{
                        "description":"Last name.",
                        "type":"string"
                    },
                    "country":{
                        "description":"Country.",
                        "type":"string"
                    },
                    "address3":{
                        "description":"Address Line 3.",
                        "type":"string"
                    },
                    "address2":{
                        "description":"Address Line 2.",
                        "type":"string"
                    },
                    "city":{
                        "description":"City.",
                        "type":"string"
                    },
                    "address1":{
                        "description":"Address Line 1.",
                        "type":"string"
                    },
                    "prefix":{
                        "description":"Prefix.",
                        "type":"string"
                    },
                    "companyName":{
                        "description":"Company name.",
                        "type":"string"
                    },
                    "postalCode":{
                        "description":"Postal code.",
                        "type":"string"
                    },
                    "jobTitle":{
                        "description":"Job title.",
                        "type":"string"
                    },
                    "county":{
                        "description":"Name of the county.",
                        "type":"string"
                    },
                    "ownerId":{
                        "description":"The ID of the owner of this address.",
                        "type":"string"
                    },
                    "suffix":{
                        "description":"Suffix.",
                        "type":"string"
                    },
                    "firstName":{
                        "description":"First name.",
                        "type":"string"
                    },
                    "phoneNumber":{
                        "description":"Phone number.",
                        "type":"string"
                    },
                    "faxNumber":{
                        "description":"The fax number.",
                        "type":"string"
                    },
                    "middleName":{
                        "description":"Middle name.",
                        "type":"string"
                    },
                    "state":{
                        "description":"State.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID.",
                        "type":"string"
                    },
                    "email":{
                        "description":"The email address",
                        "type":"string"
                    }
                }
            },
            "commerceItemRelationships":{
                "description":"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.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "commerceItemId":{
                            "description":"The referenced commerce item's internal ID.",
                            "type":"string"
                        },
                        "amount":{
                            "description":"The monetary value.",
                            "type":"number"
                        },
                        "quantity":{
                            "description":"The quantity of items referenced by this relationship. Updatable through webhook response. If quantity of relationship is updated, the sum of quantity for a commerceItem across all its relationships should match with commerceItem's quantity.",
                            "type":"integer"
                        },
                        "relationshipType":{
                            "description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
                            "type":"string"
                        },
                        "returnedQuantity":{
                            "description":"Number of referenced items that were returned.",
                            "type":"integer"
                        },
                        "range":{
                            "description":"Represents which specific items are covered by this commerceItemRelationship.",
                            "type":"object",
                            "properties":{
                                "lowBound":{
                                    "description":"The lower bound of the range.",
                                    "type":"integer"
                                },
                                "highBound":{
                                    "description":"The upper bound of the range.",
                                    "type":"integer"
                                },
                                "size":{
                                    "description":"The no of items this range includes",
                                    "type":"integer"
                                }
                            }
                        },
                        "commerceItemExternalId":{
                            "description":"The referenced commerce item's external ID.",
                            "type":"string"
                        },
                        "state":{
                            "description":"The state of this commerceItemRelationships item. Updatable through webhook response. Updatable states are CANCEL_REQUESTED, RETURN_REQUESTED and NO_ACTION.",
                            "type":"string"
                        },
                        "id":{
                            "description":"The native ID of this item.",
                            "type":"string"
                        }
                    },
                    "required":[
                        "id",
                        "commerceItemId",
                        "quantity"
                    ]
                }
            },
            "id":{
                "description":"The ID of this shipping group.",
                "type":"string"
            },
            "state":{
                "description":"The state of this shipping group.",
                "type":"string"
            },
            "stateDetail":{
                "description":"Details about the state of this shipping group.",
                "type":"string"
            },
            "trackingNumber":{
                "description":"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.",
                "type":"string"
            },
            "handlingInstructions":{
                "description":"Handling instructions. Currently read-only.",
                "type":"array",
                "items":{
                    "type":"string",
                    "properties":{
                    }
                }
            },
            "shippingGroupClassType":{
                "description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
                "type":"string"
            }
        },
        "required":[
            "id",
            "shippingMethod",
            "commerceItemRelationships"
        ]
    }
}

Nested Schema : taxPriceInfo

Type: object

The tax pricing details for the order.

Show Source

• amount(optional): number
  The monetary amount.
• amountIsFinal(optional): boolean
  Whether the amount is final.
• cityTax(optional): number
  The monetary amount of city tax.
• countryTax(optional): number
  The monetary amount of country tax.
• countyTax(optional): number
  The monetary amount of county tax.
• currencyCode(optional): string
  The three character currency code.
• discounted(optional): boolean
  Whether the price was discounted.
• districtTax(optional): number
  Tax amount for the district.
• isTaxIncluded(optional): boolean
  Whether the tax is included or not
• miscTax(optional): number
  The amount for miscTax.
• miscTaxInfo(optional): object miscTaxInfo
  Details about the miscTax.
• secondaryCurrencyTaxAmount(optional): number
  tax amount in secondaryCurrency
• stateTax(optional): number
  Tax amount for the state.
• valueAddedTax(optional): number
  The amount for valueAddedTax.

{
    "description":"The tax pricing details for the order.",
    "type":"object",
    "properties":{
        "discounted":{
            "description":"Whether the price was discounted.",
            "type":"boolean"
        },
        "secondaryCurrencyTaxAmount":{
            "description":" tax amount in secondaryCurrency",
            "type":"number"
        },
        "amount":{
            "description":"The monetary amount.",
            "type":"number"
        },
        "valueAddedTax":{
            "description":"The amount for valueAddedTax.",
            "type":"number"
        },
        "countyTax":{
            "description":"The monetary amount of county tax.",
            "type":"number"
        },
        "isTaxIncluded":{
            "description":"Whether the tax is included or not",
            "type":"boolean"
        },
        "miscTax":{
            "description":"The amount for miscTax.",
            "type":"number"
        },
        "districtTax":{
            "description":"Tax amount for the district.",
            "type":"number"
        },
        "stateTax":{
            "description":"Tax amount for the state.",
            "type":"number"
        },
        "miscTaxInfo":{
            "description":"Details about the miscTax.",
            "type":"object",
            "properties":{
                "Special":{
                    "description":"Details of the Special tax",
                    "type":"number"
                }
            }
        },
        "countryTax":{
            "description":"The monetary amount of country tax.",
            "type":"number"
        },
        "cityTax":{
            "description":"The monetary amount of city tax.",
            "type":"number"
        },
        "amountIsFinal":{
            "description":"Whether the amount is final.",
            "type":"boolean"
        },
        "currencyCode":{
            "description":"The three character currency code.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• actionCode(optional): string
  The action code that has been set on the item by the third party system. Updatable through webhook response.
• activationDate(optional): string
  The activation date in ISO format. Updatable through webhook response.
• asset(optional): boolean
  The flag that defines it the item is an asset or not. Updatable through webhook response.
• assetKey(optional): string
  The assetKey assigned when the item is a service. Updatable through webhook response.
• availabilityDate(optional): string(date-time)
  The availability date for preOrdered/backOrdered quantity.
• backOrderQuantity(optional): integer
  The back ordered quantity included.
• billingAccountId(optional): string
  The billing account ID associated to the current item. Updatable through webhook response.
• billingProfileId(optional): string
  The billing profile ID associated to the current item. Updatable through webhook response.
• catalogId(optional): string
  The ID of the catalog which this commerce item references.
• catalogKey(optional): string
  The key of the catalog this commerce item references.
• catalogRefId: string
  The reference ID of the catalog this commerce item references. Typically the SKU id.
• commerceItems(optional): array commerceItems
  The childItems of a commerceItem. The properties of child item can also be updated through webhook response. Unlike the root level items, if any of the childItem is not present in the webhook response, we will assume that no operation has to be performed on it and it will not get deleted. Id of child items of a new root level item should also have the prefix "new_".
• configuratorId(optional): string
  Configuration ID for this commerce item. Updatable through webhook response.
• customerAccountId(optional): string
  The customer account ID associated to the current item. Updatable through webhook response.
• deactivationDate(optional): string
  The deactivation date in ISO format. Updatable through webhook response.
• externalData(optional): array externalData
  External data to be associated with a commerce item, provided by a third party system. Updatable through webhook response.
• externalId(optional): string
  An optional, external ID for this commerce item.
• externalPriceDetails(optional): object externalPriceDetails
  Details about external pricing
• externalRecurringChargeDetails(optional): object externalRecurringChargeDetails
  Details about external recurring pricing.
• gwp(optional): boolean
  Flag to indicate whether item exists as a result of a gift with purchase promotion.
• id: string
  The internal/native ID for this commerce item. If it is a new item, the id must have prefix "new_".
• parentAssetKey(optional): string
  The parentAssetKey assigned when the item is a service. Updatable through webhook response.
• preOrderQuantity(optional): integer
  The pre ordered quantity included.
• priceInfo(optional): object priceInfo
  Details about pricing.
• productDisplayName(optional): string
  The product's display name. (read-only, obtained from the referenced product)
• productId(optional): string
  The ID of the product.
• quantity: integer
  The quantity included. Updatable through webhook response.
• recurringChargePriceInfo(optional): object recurringChargePriceInfo
  Recurring charge price information.
• returnedQuantity(optional): integer
  The quantity returned.
• rootAssetKey(optional): string
  The rootAssetKey assigned when the item is a service. Updatable through webhook response.
• serviceAccountId(optional): string
  The service account ID associated to the current item. Updatable through webhook response.
• serviceId(optional): string
  The service ID associated to the current item. Updatable through webhook response.
• shopperInput(optional): object shopperInput
  Additional Properties Allowed: additionalProperties

  Map of shopper input keys to values
• siteId(optional): string
  The ID of the site on which the item was added.
• state(optional): string
  The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)
• stateDetail(optional): string
  Details about the state of this commerce item

{
    "type":"object",
    "properties":{
        "gwp":{
            "description":"Flag to indicate whether item exists as a result of a gift with purchase promotion.",
            "type":"boolean"
        },
        "deactivationDate":{
            "description":"The deactivation date in ISO format. Updatable through webhook response.",
            "type":"string"
        },
        "returnedQuantity":{
            "description":"The quantity returned.",
            "type":"integer"
        },
        "availabilityDate":{
            "format":"date-time",
            "description":"The availability date for preOrdered/backOrdered quantity.",
            "type":"string"
        },
        "externalData":{
            "description":"External data to be associated with a commerce item, provided by a third party system. Updatable through webhook response.",
            "type":"array",
            "items":{
                "properties":{
                    "values":{
                        "description":"The map values associated with an externalData item.",
                        "type":"object",
                        "properties":{
                            "value":{
                                "description":"Map value defined by external system.",
                                "type":"string"
                            },
                            "key":{
                                "description":"Map key defined by external system.",
                                "type":"string"
                            }
                        }
                    },
                    "name":{
                        "description":"The name to be associated with the externalData item.",
                        "type":"string"
                    },
                    "actionCode":{
                        "description":"The action code that has been set on the externalData item by the third party system.",
                        "type":"string"
                    }
                }
            }
        },
        "billingProfileId":{
            "description":"The billing profile ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "billingAccountId":{
            "description":"The billing account ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "preOrderQuantity":{
            "description":"The pre ordered quantity included.",
            "type":"integer"
        },
        "configuratorId":{
            "description":"Configuration ID for this commerce item. Updatable through webhook response.",
            "type":"string"
        },
        "assetKey":{
            "description":"The assetKey assigned when the item is a service. Updatable through webhook response.",
            "type":"string"
        },
        "priceInfo":{
            "description":"Details about pricing.",
            "type":"object",
            "properties":{
                "discounted":{
                    "description":"Whether the price is discounted.",
                    "type":"boolean"
                },
                "amount":{
                    "description":"The monetary amount of this order.",
                    "type":"number"
                },
                "rawTotalPrice":{
                    "description":"The raw total price.",
                    "type":"number"
                },
                "salePrice":{
                    "description":"The sale price",
                    "type":"number"
                },
                "orderDiscountInfos":{
                    "description":"Array of order promotions affecting this item.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "couponCodes":{
                                "description":"One or more coupon codes used to grant the order promotion providing the discount.",
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            },
                            "amount":{
                                "description":"The amount of discount this item received from the promotion.",
                                "type":"number"
                            },
                            "promotionId":{
                                "description":"The promotion id that resulted in the discount.",
                                "type":"string"
                            }
                        }
                    }
                },
                "priceListId":{
                    "description":"The price list ID used for pricing.",
                    "type":"string"
                },
                "itemDiscountInfos":{
                    "description":"Array of item promotions affecting this item.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "couponCodes":{
                                "description":"One or more coupon codes used to grant the item promotion providing the discount.",
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            },
                            "amount":{
                                "description":"The amount of discount this item received from the promotion.",
                                "type":"number"
                            },
                            "promotionId":{
                                "description":"The promotion id that resulted in the discount.",
                                "type":"string"
                            }
                        }
                    }
                },
                "quantityDiscounted":{
                    "description":"The quantity discounted.",
                    "type":"integer"
                },
                "amountIsFinal":{
                    "description":"Whether the amount is final.",
                    "type":"boolean"
                },
                "shippingSurcharge":{
                    "description":"Extra handling cost for shipping the product.",
                    "type":"number"
                },
                "onSale":{
                    "description":"Whether is on sale.",
                    "type":"boolean"
                },
                "discountable":{
                    "description":"Whether discountable.",
                    "type":"boolean"
                },
                "currencyCode":{
                    "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                    "type":"string"
                },
                "currentPriceDetailsSorted":{
                    "description":"The current price details.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "discounted":{
                                "description":"Whether the price is discounted.",
                                "type":"boolean"
                            },
                            "secondaryCurrencyTaxAmount":{
                                "description":" tax amount in secondaryCurrency",
                                "type":"number"
                            },
                            "amount":{
                                "description":"The monetary amount.",
                                "type":"number"
                            },
                            "quantity":{
                                "description":"The number of items covered by this price info",
                                "type":"integer"
                            },
                            "amountIsFinal":{
                                "description":"Whether the amount is final.",
                                "type":"boolean"
                            },
                            "range":{
                                "description":"Represents which specific items are covered by this price info.",
                                "type":"object",
                                "properties":{
                                    "lowBound":{
                                        "description":"The lower bound of the range this price info covers, inclusive.",
                                        "type":"integer"
                                    },
                                    "highBound":{
                                        "description":"The upper bound of the range this price info covers.",
                                        "type":"integer"
                                    },
                                    "size":{
                                        "description":"The number of items in this range, inclusive. (read-only)",
                                        "type":"integer"
                                    }
                                }
                            },
                            "tax":{
                                "description":"Monetary tax amount.",
                                "type":"number"
                            },
                            "orderDiscountShare":{
                                "description":"Share of the order discount for this item",
                                "type":"number"
                            },
                            "detailedUnitPrice":{
                                "description":"The detailed unit price: amount / quantity. (read-only)",
                                "type":"number"
                            },
                            "currencyCode":{
                                "description":"The three character currency code for the monetary amounts.",
                                "type":"string"
                            }
                        }
                    }
                },
                "listPrice":{
                    "description":"The monetary amount of the list price.",
                    "type":"number"
                }
            }
        },
        "catalogId":{
            "description":"The ID of the catalog which this commerce item references.",
            "type":"string"
        },
        "externalRecurringChargeDetails":{
            "description":"Details about external recurring pricing.",
            "type":"object",
            "properties":{
                "externalRecurringCharge":{
                    "description":"The external recurring price.",
                    "type":"number"
                },
                "externalRecurringChargeFrequency":{
                    "description":"The frequency for the recurring charge e.g. Monthly.",
                    "type":"string"
                },
                "externalRecurringChargeDuration":{
                    "description":"The duration for the recurring charge e.g. 12 months.",
                    "type":"string"
                }
            }
        },
        "externalPriceDetails":{
            "description":"Details about external pricing",
            "type":"object",
            "properties":{
                "externalPriceQuantity":{
                    "description":"external quantity of this commerce item",
                    "type":"integer"
                },
                "externalPrice":{
                    "description":"External price of this commerce item",
                    "type":"number"
                }
            }
        },
        "actionCode":{
            "description":"The action code that has been set on the item by the third party system. Updatable through webhook response.",
            "type":"string"
        },
        "id":{
            "description":"The internal/native ID for this commerce item. If it is a new item, the id must have prefix \"new_\".",
            "type":"string"
        },
        "state":{
            "description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
            "type":"string"
        },
        "stateDetail":{
            "description":"Details about the state of this commerce item",
            "type":"string"
        },
        "serviceId":{
            "description":"The service ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "commerceItems":{
            "description":"The childItems of a commerceItem. The properties of child item can also be updated through webhook response. Unlike the root level items, if any of the childItem is not present in the webhook response, we will assume that no operation has to be performed on it and it will not get deleted. Id of child items of a new root level item should also have the prefix \"new_\".",
            "type":"array",
            "items":{
                "type":"object",
                "$ref":"#/definitions/cancelOrderSubCommerceItems"
            }
        },
        "serviceAccountId":{
            "description":"The service account ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "quantity":{
            "description":"The quantity included. Updatable through webhook response.",
            "type":"integer"
        },
        "productId":{
            "description":"The ID of the product.",
            "type":"string"
        },
        "externalId":{
            "description":"An optional, external ID for this commerce item.",
            "type":"string"
        },
        "parentAssetKey":{
            "description":"The parentAssetKey assigned when the item is a service. Updatable through webhook response.",
            "type":"string"
        },
        "rootAssetKey":{
            "description":"The rootAssetKey assigned when the item is a service. Updatable through webhook response.",
            "type":"string"
        },
        "catalogRefId":{
            "description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
            "type":"string"
        },
        "recurringChargePriceInfo":{
            "description":"Recurring charge price information.",
            "type":"object",
            "properties":{
                "amount":{
                    "description":"The monetary amount of this recurring charge.",
                    "type":"number"
                },
                "total":{
                    "description":"The total price of the recurring charge.",
                    "type":"number"
                },
                "frequencyAmountTotals":{
                    "description":"The total for each recurring charge frequency",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "total":{
                                "description":"The total amount for the frequency.",
                                "type":"string"
                            },
                            "frequency":{
                                "description":"The frequency for the item's total e.g. Monthly.",
                                "type":"string"
                            }
                        }
                    }
                },
                "shipping":{
                    "description":"Cost of shipping the product.",
                    "type":"number"
                },
                "tax":{
                    "description":"Monetary tax amount.",
                    "type":"number"
                },
                "subTotal":{
                    "description":"The sub-total price of the recurring charge.",
                    "type":"number"
                },
                "frequencyTaxTotals":{
                    "description":"The tax for each recurring charge frequency",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "tax":{
                                "description":"The tax amount for the frequency.",
                                "type":"string"
                            },
                            "frequency":{
                                "description":"The frequency for the item's tax e.g. Monthly.",
                                "type":"string"
                            }
                        }
                    }
                },
                "currencyCode":{
                    "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                    "type":"string"
                },
                "totalWithoutTax":{
                    "description":"Total of recurring amount without tax included.",
                    "type":"number"
                }
            }
        },
        "customerAccountId":{
            "description":"The customer account ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "productDisplayName":{
            "description":"The product's display name. (read-only, obtained from the referenced product)",
            "type":"string"
        },
        "catalogKey":{
            "description":"The key of the catalog this commerce item references.",
            "type":"string"
        },
        "siteId":{
            "description":"The ID of the site on which the item was added.",
            "type":"string"
        },
        "shopperInput":{
            "description":"Map of shopper input keys to values",
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "asset":{
            "description":"The flag that defines it the item is an asset or not. Updatable through webhook response.",
            "type":"boolean"
        },
        "activationDate":{
            "description":"The activation date in ISO format. Updatable through webhook response.",
            "type":"string"
        },
        "backOrderQuantity":{
            "description":"The back ordered quantity included.",
            "type":"integer"
        }
    },
    "required":[
        "id",
        "catalogRefId",
        "quantity"
    ]
}

Nested Schema : commerceItems

Type: array

The childItems of a commerceItem. The properties of child item can also be updated through webhook response. Unlike the root level items, if any of the childItem is not present in the webhook response, we will assume that no operation has to be performed on it and it will not get deleted. Id of child items of a new root level item should also have the prefix "new_".

Show Source

• Array of: object cancelOrderSubCommerceItems

{
    "description":"The childItems of a commerceItem. The properties of child item can also be updated through webhook response. Unlike the root level items, if any of the childItem is not present in the webhook response, we will assume that no operation has to be performed on it and it will not get deleted. Id of child items of a new root level item should also have the prefix \"new_\".",
    "type":"array",
    "items":{
        "type":"object",
        "$ref":"#/definitions/cancelOrderSubCommerceItems"
    }
}

Nested Schema : externalData

Type: array

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

Show Source

• Array of: object items

{
    "description":"External data to be associated with a commerce item, provided by a third party system. Updatable through webhook response.",
    "type":"array",
    "items":{
        "properties":{
            "values":{
                "description":"The map values associated with an externalData item.",
                "type":"object",
                "properties":{
                    "value":{
                        "description":"Map value defined by external system.",
                        "type":"string"
                    },
                    "key":{
                        "description":"Map key defined by external system.",
                        "type":"string"
                    }
                }
            },
            "name":{
                "description":"The name to be associated with the externalData item.",
                "type":"string"
            },
            "actionCode":{
                "description":"The action code that has been set on the externalData item by the third party system.",
                "type":"string"
            }
        }
    }
}

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Show Source

• externalPrice(optional): number
  External price of this commerce item
• externalPriceQuantity(optional): integer
  external quantity of this commerce item

{
    "description":"Details about external pricing",
    "type":"object",
    "properties":{
        "externalPriceQuantity":{
            "description":"external quantity of this commerce item",
            "type":"integer"
        },
        "externalPrice":{
            "description":"External price of this commerce item",
            "type":"number"
        }
    }
}

Nested Schema : externalRecurringChargeDetails

Type: object

Details about external recurring pricing.

Show Source

• externalRecurringCharge(optional): number
  The external recurring price.
• externalRecurringChargeDuration(optional): string
  The duration for the recurring charge e.g. 12 months.
• externalRecurringChargeFrequency(optional): string
  The frequency for the recurring charge e.g. Monthly.

{
    "description":"Details about external recurring pricing.",
    "type":"object",
    "properties":{
        "externalRecurringCharge":{
            "description":"The external recurring price.",
            "type":"number"
        },
        "externalRecurringChargeFrequency":{
            "description":"The frequency for the recurring charge e.g. Monthly.",
            "type":"string"
        },
        "externalRecurringChargeDuration":{
            "description":"The duration for the recurring charge e.g. 12 months.",
            "type":"string"
        }
    }
}

Nested Schema : priceInfo

Type: object

Details about pricing.

Show Source

• amount(optional): number
  The monetary amount of this order.
• amountIsFinal(optional): boolean
  Whether the amount is final.
• currencyCode(optional): string
  The currency code for the monetary amounts. A three character currency code such as USD.
• currentPriceDetailsSorted(optional): array currentPriceDetailsSorted
  The current price details.
• discountable(optional): boolean
  Whether discountable.
• discounted(optional): boolean
  Whether the price is discounted.
• itemDiscountInfos(optional): array itemDiscountInfos
  Array of item promotions affecting this item.
• listPrice(optional): number
  The monetary amount of the list price.
• onSale(optional): boolean
  Whether is on sale.
• orderDiscountInfos(optional): array orderDiscountInfos
  Array of order promotions affecting this item.
• priceListId(optional): string
  The price list ID used for pricing.
• quantityDiscounted(optional): integer
  The quantity discounted.
• rawTotalPrice(optional): number
  The raw total price.
• salePrice(optional): number
  The sale price
• shippingSurcharge(optional): number
  Extra handling cost for shipping the product.

{
    "description":"Details about pricing.",
    "type":"object",
    "properties":{
        "discounted":{
            "description":"Whether the price is discounted.",
            "type":"boolean"
        },
        "amount":{
            "description":"The monetary amount of this order.",
            "type":"number"
        },
        "rawTotalPrice":{
            "description":"The raw total price.",
            "type":"number"
        },
        "salePrice":{
            "description":"The sale price",
            "type":"number"
        },
        "orderDiscountInfos":{
            "description":"Array of order promotions affecting this item.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "couponCodes":{
                        "description":"One or more coupon codes used to grant the order promotion providing the discount.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "amount":{
                        "description":"The amount of discount this item received from the promotion.",
                        "type":"number"
                    },
                    "promotionId":{
                        "description":"The promotion id that resulted in the discount.",
                        "type":"string"
                    }
                }
            }
        },
        "priceListId":{
            "description":"The price list ID used for pricing.",
            "type":"string"
        },
        "itemDiscountInfos":{
            "description":"Array of item promotions affecting this item.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "couponCodes":{
                        "description":"One or more coupon codes used to grant the item promotion providing the discount.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "amount":{
                        "description":"The amount of discount this item received from the promotion.",
                        "type":"number"
                    },
                    "promotionId":{
                        "description":"The promotion id that resulted in the discount.",
                        "type":"string"
                    }
                }
            }
        },
        "quantityDiscounted":{
            "description":"The quantity discounted.",
            "type":"integer"
        },
        "amountIsFinal":{
            "description":"Whether the amount is final.",
            "type":"boolean"
        },
        "shippingSurcharge":{
            "description":"Extra handling cost for shipping the product.",
            "type":"number"
        },
        "onSale":{
            "description":"Whether is on sale.",
            "type":"boolean"
        },
        "discountable":{
            "description":"Whether discountable.",
            "type":"boolean"
        },
        "currencyCode":{
            "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
            "type":"string"
        },
        "currentPriceDetailsSorted":{
            "description":"The current price details.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "discounted":{
                        "description":"Whether the price is discounted.",
                        "type":"boolean"
                    },
                    "secondaryCurrencyTaxAmount":{
                        "description":" tax amount in secondaryCurrency",
                        "type":"number"
                    },
                    "amount":{
                        "description":"The monetary amount.",
                        "type":"number"
                    },
                    "quantity":{
                        "description":"The number of items covered by this price info",
                        "type":"integer"
                    },
                    "amountIsFinal":{
                        "description":"Whether the amount is final.",
                        "type":"boolean"
                    },
                    "range":{
                        "description":"Represents which specific items are covered by this price info.",
                        "type":"object",
                        "properties":{
                            "lowBound":{
                                "description":"The lower bound of the range this price info covers, inclusive.",
                                "type":"integer"
                            },
                            "highBound":{
                                "description":"The upper bound of the range this price info covers.",
                                "type":"integer"
                            },
                            "size":{
                                "description":"The number of items in this range, inclusive. (read-only)",
                                "type":"integer"
                            }
                        }
                    },
                    "tax":{
                        "description":"Monetary tax amount.",
                        "type":"number"
                    },
                    "orderDiscountShare":{
                        "description":"Share of the order discount for this item",
                        "type":"number"
                    },
                    "detailedUnitPrice":{
                        "description":"The detailed unit price: amount / quantity. (read-only)",
                        "type":"number"
                    },
                    "currencyCode":{
                        "description":"The three character currency code for the monetary amounts.",
                        "type":"string"
                    }
                }
            }
        },
        "listPrice":{
            "description":"The monetary amount of the list price.",
            "type":"number"
        }
    }
}

Nested Schema : recurringChargePriceInfo

Type: object

Recurring charge price information.

Show Source

• amount(optional): number
  The monetary amount of this recurring charge.
• currencyCode(optional): string
  The currency code for the monetary amounts. A three character currency code such as USD.
• frequencyAmountTotals(optional): array frequencyAmountTotals
  The total for each recurring charge frequency
• frequencyTaxTotals(optional): array frequencyTaxTotals
  The tax for each recurring charge frequency
• shipping(optional): number
  Cost of shipping the product.
• subTotal(optional): number
  The sub-total price of the recurring charge.
• tax(optional): number
  Monetary tax amount.
• total(optional): number
  The total price of the recurring charge.
• totalWithoutTax(optional): number
  Total of recurring amount without tax included.

{
    "description":"Recurring charge price information.",
    "type":"object",
    "properties":{
        "amount":{
            "description":"The monetary amount of this recurring charge.",
            "type":"number"
        },
        "total":{
            "description":"The total price of the recurring charge.",
            "type":"number"
        },
        "frequencyAmountTotals":{
            "description":"The total for each recurring charge frequency",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "total":{
                        "description":"The total amount for the frequency.",
                        "type":"string"
                    },
                    "frequency":{
                        "description":"The frequency for the item's total e.g. Monthly.",
                        "type":"string"
                    }
                }
            }
        },
        "shipping":{
            "description":"Cost of shipping the product.",
            "type":"number"
        },
        "tax":{
            "description":"Monetary tax amount.",
            "type":"number"
        },
        "subTotal":{
            "description":"The sub-total price of the recurring charge.",
            "type":"number"
        },
        "frequencyTaxTotals":{
            "description":"The tax for each recurring charge frequency",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "tax":{
                        "description":"The tax amount for the frequency.",
                        "type":"string"
                    },
                    "frequency":{
                        "description":"The frequency for the item's tax e.g. Monthly.",
                        "type":"string"
                    }
                }
            }
        },
        "currencyCode":{
            "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
            "type":"string"
        },
        "totalWithoutTax":{
            "description":"Total of recurring amount without tax included.",
            "type":"number"
        }
    }
}

Nested Schema : shopperInput

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Map of shopper input keys to values",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Map of shopper input keys to values

Nested Schema : cancelOrderSubCommerceItems

Type: object

Show Source

• actionCode(optional): string
  The action code that has been set on the item by the configurator system. Updatable through webhook response.
• activationDate(optional): string
  The activation date in ISO format. Updatable through webhook response.
• addOnItem(optional): boolean
  Whether this child item is an add-on (internally configured) or not (externally configured). Updatable through webhook response.
• asset(optional): boolean
  The flag that defines it the item is an asset or not. Updatable through webhook response.
• assetKey(optional): string
  The assetKey assigned when the item is a service. Updatable through webhook response.
• billingAccountId(optional): string
  The billing account ID associated to the current item. Updatable through webhook response.
• billingProfileId(optional): string
  The billing profile ID associated to the current item. Updatable through webhook response.
• catalogRefId(optional): string
  The reference ID of the catalog this commerce item references. Typically the SKU id.
• commerceItems(optional): array commerceItems
• configurablePropertyId(optional): string
  ID of the catalog's configurableProperty associated with this item. Updatable through webhook response.
• configurationOptionId(optional): string
  ID of the catalog's configurationOption associated with this item. Updatable through webhook response.
• customerAccountId(optional): string
  The customer account ID associated to the current item. Updatable through webhook response.
• deactivationDate(optional): string
  The deactivation date in ISO format. Updatable through webhook response.
• externalData(optional): array externalData
  External data to be associated with a commerce item, provided by a configurator system. Updatable through webhook response.
• externalPriceDetails(optional): object externalPriceDetails
  Details about external pricing
• parentAssetKey(optional): string
  The parentAssetKey assigned when the item is a service. Updatable through webhook response.
• productId(optional): string
  The ID of the product.
• quantity(optional): integer
  The quantity included. Updatable through webhook response.
• rootAssetKey(optional): string
  The rootAssetKey assigned when the item is a service. Updatable through webhook response.
• serviceAccountId(optional): string
  The service account ID associated to the current item. Updatable through webhook response.
• serviceId(optional): string
  The service ID associated to the current item. Updatable through webhook response.
• shopperInput(optional): object shopperInput
  Additional Properties Allowed: additionalProperties

  Map of shopper input keys to values
• siteId(optional): string
  The ID of the site on which the item was added.
• transactionDate(optional): string
  ISO formatted Date on which the service action should be triggered.

{
    "properties":{
        "serviceAccountId":{
            "description":"The service account ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "configurationOptionId":{
            "description":"ID of the catalog's configurationOption associated with this item. Updatable through webhook response.",
            "type":"string"
        },
        "deactivationDate":{
            "description":"The deactivation date in ISO format. Updatable through webhook response.",
            "type":"string"
        },
        "addOnItem":{
            "description":"Whether this child item is an add-on (internally configured) or not (externally configured). Updatable through webhook response.",
            "type":"boolean"
        },
        "quantity":{
            "description":"The quantity included. Updatable through webhook response.",
            "type":"integer"
        },
        "productId":{
            "description":"The ID of the product.",
            "type":"string"
        },
        "externalData":{
            "description":"External data to be associated with a commerce item, provided by a configurator system. Updatable through webhook response.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "values":{
                        "description":"The array of values associated with an externalData item.",
                        "type":"object",
                        "properties":{
                            "dynamic_property_key":{
                                "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                                "type":"string"
                            }
                        },
                        "required":[
                            "dynamic_property_key"
                        ]
                    },
                    "name":{
                        "description":"The name to be associated with the externalData item.",
                        "type":"string"
                    },
                    "actionCode":{
                        "description":"The action code that has been set on the externalData item by the configurator system.",
                        "type":"string"
                    }
                },
                "required":[
                    "values",
                    "name"
                ]
            }
        },
        "parentAssetKey":{
            "description":"The parentAssetKey assigned when the item is a service. Updatable through webhook response.",
            "type":"string"
        },
        "billingProfileId":{
            "description":"The billing profile ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "billingAccountId":{
            "description":"The billing account ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "rootAssetKey":{
            "description":"The rootAssetKey assigned when the item is a service. Updatable through webhook response.",
            "type":"string"
        },
        "configurablePropertyId":{
            "description":"ID of the catalog's configurableProperty associated with this item. Updatable through webhook response.",
            "type":"string"
        },
        "transactionDate":{
            "description":"ISO formatted Date on which the service action should be triggered.",
            "type":"string"
        },
        "catalogRefId":{
            "description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
            "type":"string"
        },
        "assetKey":{
            "description":"The assetKey assigned when the item is a service. Updatable through webhook response.",
            "type":"string"
        },
        "customerAccountId":{
            "description":"The customer account ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "externalPriceDetails":{
            "description":"Details about external pricing",
            "type":"object",
            "properties":{
                "externalPriceQuantity":{
                    "description":"external quantity of this commerce item",
                    "type":"integer"
                },
                "externalPrice":{
                    "description":"External price of this commerce item",
                    "type":"number"
                }
            }
        },
        "siteId":{
            "description":"The ID of the site on which the item was added.",
            "type":"string"
        },
        "actionCode":{
            "description":"The action code that has been set on the item by the configurator system. Updatable through webhook response.",
            "type":"string"
        },
        "shopperInput":{
            "description":"Map of shopper input keys to values",
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "asset":{
            "description":"The flag that defines it the item is an asset or not. Updatable through webhook response.",
            "type":"boolean"
        },
        "activationDate":{
            "description":"The activation date in ISO format. Updatable through webhook response.",
            "type":"string"
        },
        "serviceId":{
            "description":"The service ID associated to the current item. Updatable through webhook response.",
            "type":"string"
        },
        "commerceItems":{
            "type":"array",
            "items":{
                "type":"object",
                "$ref":"#/definitions/cancelOrderSubCommerceItems"
            }
        }
    }
}

Nested Schema : commerceItems

Type: array

Show Source

• Array of: object cancelOrderSubCommerceItems

{
    "type":"array",
    "items":{
        "type":"object",
        "$ref":"#/definitions/cancelOrderSubCommerceItems"
    }
}

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system. Updatable through webhook response.

Show Source

• Array of: object items

{
    "description":"External data to be associated with a commerce item, provided by a configurator system. Updatable through webhook response.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "values":{
                "description":"The array of values associated with an externalData item.",
                "type":"object",
                "properties":{
                    "dynamic_property_key":{
                        "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                        "type":"string"
                    }
                },
                "required":[
                    "dynamic_property_key"
                ]
            },
            "name":{
                "description":"The name to be associated with the externalData item.",
                "type":"string"
            },
            "actionCode":{
                "description":"The action code that has been set on the externalData item by the configurator system.",
                "type":"string"
            }
        },
        "required":[
            "values",
            "name"
        ]
    }
}

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Show Source

• externalPrice(optional): number
  External price of this commerce item
• externalPriceQuantity(optional): integer
  external quantity of this commerce item

{
    "description":"Details about external pricing",
    "type":"object",
    "properties":{
        "externalPriceQuantity":{
            "description":"external quantity of this commerce item",
            "type":"integer"
        },
        "externalPrice":{
            "description":"External price of this commerce item",
            "type":"number"
        }
    }
}

Nested Schema : shopperInput

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Map of shopper input keys to values",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Map of shopper input keys to values

Nested Schema : items

Type: object

Show Source

• actionCode(optional): string
  The action code that has been set on the externalData item by the configurator system.
• name: string
  The name to be associated with the externalData item.
• values: object values
  The array of values associated with an externalData item.

{
    "type":"object",
    "properties":{
        "values":{
            "description":"The array of values associated with an externalData item.",
            "type":"object",
            "properties":{
                "dynamic_property_key":{
                    "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                    "type":"string"
                }
            },
            "required":[
                "dynamic_property_key"
            ]
        },
        "name":{
            "description":"The name to be associated with the externalData item.",
            "type":"string"
        },
        "actionCode":{
            "description":"The action code that has been set on the externalData item by the configurator system.",
            "type":"string"
        }
    },
    "required":[
        "values",
        "name"
    ]
}

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Show Source

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

{
    "description":"The array of values associated with an externalData item.",
    "type":"object",
    "properties":{
        "dynamic_property_key":{
            "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
            "type":"string"
        }
    },
    "required":[
        "dynamic_property_key"
    ]
}

Nested Schema : items

Type: object

Show Source

• actionCode(optional): string
  The action code that has been set on the externalData item by the third party system.
• name(optional): string
  The name to be associated with the externalData item.
• values(optional): object values
  The map values associated with an externalData item.

{
    "properties":{
        "values":{
            "description":"The map values associated with an externalData item.",
            "type":"object",
            "properties":{
                "value":{
                    "description":"Map value defined by external system.",
                    "type":"string"
                },
                "key":{
                    "description":"Map key defined by external system.",
                    "type":"string"
                }
            }
        },
        "name":{
            "description":"The name to be associated with the externalData item.",
            "type":"string"
        },
        "actionCode":{
            "description":"The action code that has been set on the externalData item by the third party system.",
            "type":"string"
        }
    }
}

Nested Schema : values

Type: object

The map values associated with an externalData item.

Show Source

• key(optional): string
  Map key defined by external system.
• value(optional): string
  Map value defined by external system.

{
    "description":"The map values associated with an externalData item.",
    "type":"object",
    "properties":{
        "value":{
            "description":"Map value defined by external system.",
            "type":"string"
        },
        "key":{
            "description":"Map key defined by external system.",
            "type":"string"
        }
    }
}

Nested Schema : currentPriceDetailsSorted

Type: array

The current price details.

Show Source

• Array of: object items

{
    "description":"The current price details.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "discounted":{
                "description":"Whether the price is discounted.",
                "type":"boolean"
            },
            "secondaryCurrencyTaxAmount":{
                "description":" tax amount in secondaryCurrency",
                "type":"number"
            },
            "amount":{
                "description":"The monetary amount.",
                "type":"number"
            },
            "quantity":{
                "description":"The number of items covered by this price info",
                "type":"integer"
            },
            "amountIsFinal":{
                "description":"Whether the amount is final.",
                "type":"boolean"
            },
            "range":{
                "description":"Represents which specific items are covered by this price info.",
                "type":"object",
                "properties":{
                    "lowBound":{
                        "description":"The lower bound of the range this price info covers, inclusive.",
                        "type":"integer"
                    },
                    "highBound":{
                        "description":"The upper bound of the range this price info covers.",
                        "type":"integer"
                    },
                    "size":{
                        "description":"The number of items in this range, inclusive. (read-only)",
                        "type":"integer"
                    }
                }
            },
            "tax":{
                "description":"Monetary tax amount.",
                "type":"number"
            },
            "orderDiscountShare":{
                "description":"Share of the order discount for this item",
                "type":"number"
            },
            "detailedUnitPrice":{
                "description":"The detailed unit price: amount / quantity. (read-only)",
                "type":"number"
            },
            "currencyCode":{
                "description":"The three character currency code for the monetary amounts.",
                "type":"string"
            }
        }
    }
}

Nested Schema : itemDiscountInfos

Type: array

Array of item promotions affecting this item.

Show Source

• Array of: object items

{
    "description":"Array of item promotions affecting this item.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "couponCodes":{
                "description":"One or more coupon codes used to grant the item promotion providing the discount.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "amount":{
                "description":"The amount of discount this item received from the promotion.",
                "type":"number"
            },
            "promotionId":{
                "description":"The promotion id that resulted in the discount.",
                "type":"string"
            }
        }
    }
}

Nested Schema : orderDiscountInfos

Type: array

Array of order promotions affecting this item.

Show Source

• Array of: object items

{
    "description":"Array of order promotions affecting this item.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "couponCodes":{
                "description":"One or more coupon codes used to grant the order promotion providing the discount.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "amount":{
                "description":"The amount of discount this item received from the promotion.",
                "type":"number"
            },
            "promotionId":{
                "description":"The promotion id that resulted in the discount.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The monetary amount.
• amountIsFinal(optional): boolean
  Whether the amount is final.
• currencyCode(optional): string
  The three character currency code for the monetary amounts.
• detailedUnitPrice(optional): number
  The detailed unit price: amount / quantity. (read-only)
• discounted(optional): boolean
  Whether the price is discounted.
• orderDiscountShare(optional): number
  Share of the order discount for this item
• quantity(optional): integer
  The number of items covered by this price info
• range(optional): object range
  Represents which specific items are covered by this price info.
• secondaryCurrencyTaxAmount(optional): number
  tax amount in secondaryCurrency
• tax(optional): number
  Monetary tax amount.

{
    "type":"object",
    "properties":{
        "discounted":{
            "description":"Whether the price is discounted.",
            "type":"boolean"
        },
        "secondaryCurrencyTaxAmount":{
            "description":" tax amount in secondaryCurrency",
            "type":"number"
        },
        "amount":{
            "description":"The monetary amount.",
            "type":"number"
        },
        "quantity":{
            "description":"The number of items covered by this price info",
            "type":"integer"
        },
        "amountIsFinal":{
            "description":"Whether the amount is final.",
            "type":"boolean"
        },
        "range":{
            "description":"Represents which specific items are covered by this price info.",
            "type":"object",
            "properties":{
                "lowBound":{
                    "description":"The lower bound of the range this price info covers, inclusive.",
                    "type":"integer"
                },
                "highBound":{
                    "description":"The upper bound of the range this price info covers.",
                    "type":"integer"
                },
                "size":{
                    "description":"The number of items in this range, inclusive. (read-only)",
                    "type":"integer"
                }
            }
        },
        "tax":{
            "description":"Monetary tax amount.",
            "type":"number"
        },
        "orderDiscountShare":{
            "description":"Share of the order discount for this item",
            "type":"number"
        },
        "detailedUnitPrice":{
            "description":"The detailed unit price: amount / quantity. (read-only)",
            "type":"number"
        },
        "currencyCode":{
            "description":"The three character currency code for the monetary amounts.",
            "type":"string"
        }
    }
}

Nested Schema : range

Type: object

Represents which specific items are covered by this price info.

Show Source

• highBound(optional): integer
  The upper bound of the range this price info covers.
• lowBound(optional): integer
  The lower bound of the range this price info covers, inclusive.
• size(optional): integer
  The number of items in this range, inclusive. (read-only)

{
    "description":"Represents which specific items are covered by this price info.",
    "type":"object",
    "properties":{
        "lowBound":{
            "description":"The lower bound of the range this price info covers, inclusive.",
            "type":"integer"
        },
        "highBound":{
            "description":"The upper bound of the range this price info covers.",
            "type":"integer"
        },
        "size":{
            "description":"The number of items in this range, inclusive. (read-only)",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The amount of discount this item received from the promotion.
• couponCodes(optional): array couponCodes
  One or more coupon codes used to grant the item promotion providing the discount.
• promotionId(optional): string
  The promotion id that resulted in the discount.

{
    "type":"object",
    "properties":{
        "couponCodes":{
            "description":"One or more coupon codes used to grant the item promotion providing the discount.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "amount":{
            "description":"The amount of discount this item received from the promotion.",
            "type":"number"
        },
        "promotionId":{
            "description":"The promotion id that resulted in the discount.",
            "type":"string"
        }
    }
}

Nested Schema : couponCodes

Type: array

One or more coupon codes used to grant the item promotion providing the discount.

Show Source

• Array of: string

{
    "description":"One or more coupon codes used to grant the item promotion providing the discount.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The amount of discount this item received from the promotion.
• couponCodes(optional): array couponCodes
  One or more coupon codes used to grant the order promotion providing the discount.
• promotionId(optional): string
  The promotion id that resulted in the discount.

{
    "type":"object",
    "properties":{
        "couponCodes":{
            "description":"One or more coupon codes used to grant the order promotion providing the discount.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "amount":{
            "description":"The amount of discount this item received from the promotion.",
            "type":"number"
        },
        "promotionId":{
            "description":"The promotion id that resulted in the discount.",
            "type":"string"
        }
    }
}

Nested Schema : couponCodes

Type: array

One or more coupon codes used to grant the order promotion providing the discount.

Show Source

• Array of: string

{
    "description":"One or more coupon codes used to grant the order promotion providing the discount.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : frequencyAmountTotals

Type: array

The total for each recurring charge frequency

Show Source

• Array of: object items

{
    "description":"The total for each recurring charge frequency",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "total":{
                "description":"The total amount for the frequency.",
                "type":"string"
            },
            "frequency":{
                "description":"The frequency for the item's total e.g. Monthly.",
                "type":"string"
            }
        }
    }
}

Nested Schema : frequencyTaxTotals

Type: array

The tax for each recurring charge frequency

Show Source

• Array of: object items

{
    "description":"The tax for each recurring charge frequency",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "tax":{
                "description":"The tax amount for the frequency.",
                "type":"string"
            },
            "frequency":{
                "description":"The frequency for the item's tax e.g. Monthly.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• frequency(optional): string
  The frequency for the item's total e.g. Monthly.
• total(optional): string
  The total amount for the frequency.

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total amount for the frequency.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency for the item's total e.g. Monthly.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• frequency(optional): string
  The frequency for the item's tax e.g. Monthly.
• tax(optional): string
  The tax amount for the frequency.

{
    "type":"object",
    "properties":{
        "tax":{
            "description":"The tax amount for the frequency.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency for the item's tax e.g. Monthly.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The monetary amount of the payment.
• amountAuthorized(optional): number
  The monetary amount authorized.
• authorizationStatus(optional): array authorizationStatus
  Aray of authorization status objects.
• creditCardNumber(optional): string
  The last four digits of the credit card number. (only for TokenizedCreditCards)
• creditCardType(optional): string
  The type of the credit card. (only for TokenizedCreditCards)
• currencyCode(optional): string
  The three character currency code. For example: USD.
• expirationDayOfMonth(optional): string
  A string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards)
• expirationMonth(optional): string
  A string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards)
• expirationYear(optional): string
  A string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards)
• externalId(optional): string
  The ID for the payment group in an external system (like the OMS)
• externalSourceId(optional): string
  The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)
• externalSubtype(optional): string
  The subtype in the external system. Might be "VISA" for a PaymentGroup with an external type of "CreditCard". (only for ExternalPaymentGroups)
• externalType(optional): string
  The type in the external system. Might be "StoreCredit", "CreditCard", "Check", etc. (only for ExternalPaymentGroups).
• id(optional): string
  The internal ID of the payment group.
• paymentGroupClassType(optional): string
  The class type of the payment group. Currently supported values are "tokenizedCreditCard" and "externalPaymentGroup".
• paymentMethod(optional): string
  The payment method. Currently supported values are "tokenizedCreditCard" and "externalPaymentGroup".
• PONumber(optional): string
  The purchase order number
• state(optional): string
  The state of this payment group.
• stateDetail(optional): string
  Details about the state of this payment group.
• submittedDate(optional): string(date-time)
  The date the payment was submitted.
• token(optional): string
  The CyberSource token string. (only for tokenizedCreditCard)

{
    "type":"object",
    "properties":{
        "expirationYear":{
            "description":"A string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards)",
            "type":"string"
        },
        "PONumber":{
            "description":"The purchase order number",
            "type":"string"
        },
        "externalType":{
            "description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
            "type":"string"
        },
        "amountAuthorized":{
            "description":"The monetary amount authorized.",
            "type":"number"
        },
        "amount":{
            "description":"The monetary amount of the payment.",
            "type":"number"
        },
        "externalId":{
            "description":"The ID for the payment group in an external system (like the OMS)",
            "type":"string"
        },
        "expirationMonth":{
            "description":"A string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards)",
            "type":"string"
        },
        "creditCardType":{
            "description":"The type of the credit card. (only for TokenizedCreditCards)",
            "type":"string"
        },
        "submittedDate":{
            "format":"date-time",
            "description":"The date the payment was submitted.",
            "type":"string"
        },
        "authorizationStatus":{
            "description":"Aray of authorization status objects.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "amount":{
                        "description":"The monetary amount.",
                        "type":"number"
                    },
                    "transactionSuccess":{
                        "description":"Whether the transaction was successful.",
                        "type":"boolean"
                    },
                    "errorMessage":{
                        "description":"The error message, if any.",
                        "type":"string"
                    },
                    "transactionId":{
                        "description":"The transaction ID.",
                        "type":"string"
                    },
                    "transactionTimestamp":{
                        "description":"The timestamp of the transaction.",
                        "type":"string"
                    }
                }
            }
        },
        "token":{
            "description":"The CyberSource token string. (only for tokenizedCreditCard)",
            "type":"string"
        },
        "paymentGroupClassType":{
            "description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
            "type":"string"
        },
        "creditCardNumber":{
            "description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
            "type":"string"
        },
        "externalSubtype":{
            "description":"The subtype in the external system. Might be \"VISA\" for a PaymentGroup with an external type of \"CreditCard\". (only for ExternalPaymentGroups)",
            "type":"string"
        },
        "paymentMethod":{
            "description":"The payment method. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
            "type":"string"
        },
        "externalSourceId":{
            "description":"The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)",
            "type":"string"
        },
        "state":{
            "description":"The state of this payment group.",
            "type":"string"
        },
        "id":{
            "description":"The internal ID of the payment group.",
            "type":"string"
        },
        "stateDetail":{
            "description":"Details about the state of this payment group.",
            "type":"string"
        },
        "currencyCode":{
            "description":"The three character currency code. For example: USD.",
            "type":"string"
        },
        "expirationDayOfMonth":{
            "description":"A string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards)",
            "type":"string"
        }
    }
}

Nested Schema : authorizationStatus

Type: array

Aray of authorization status objects.

Show Source

• Array of: object items

{
    "description":"Aray of authorization status objects.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "amount":{
                "description":"The monetary amount.",
                "type":"number"
            },
            "transactionSuccess":{
                "description":"Whether the transaction was successful.",
                "type":"boolean"
            },
            "errorMessage":{
                "description":"The error message, if any.",
                "type":"string"
            },
            "transactionId":{
                "description":"The transaction ID.",
                "type":"string"
            },
            "transactionTimestamp":{
                "description":"The timestamp of the transaction.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The monetary amount.
• errorMessage(optional): string
  The error message, if any.
• transactionId(optional): string
  The transaction ID.
• transactionSuccess(optional): boolean
  Whether the transaction was successful.
• transactionTimestamp(optional): string
  The timestamp of the transaction.

{
    "type":"object",
    "properties":{
        "amount":{
            "description":"The monetary amount.",
            "type":"number"
        },
        "transactionSuccess":{
            "description":"Whether the transaction was successful.",
            "type":"boolean"
        },
        "errorMessage":{
            "description":"The error message, if any.",
            "type":"string"
        },
        "transactionId":{
            "description":"The transaction ID.",
            "type":"string"
        },
        "transactionTimestamp":{
            "description":"The timestamp of the transaction.",
            "type":"string"
        }
    }
}

Nested Schema : shippingAddress

Type: object

Default shipping address

Show Source

• address1(optional): string
  Address Line 1.
• address2(optional): string
  Address Line 2.
• address3(optional): string
  Address Line 3.
• city(optional): string
  City.
• country(optional): string
  Country.
• county(optional): string
  Name of the county.
• phoneNumber(optional): string
  Phone number.
• postalCode(optional): string
  Postal code.
• state(optional): string
  State.

{
    "description":"Default shipping address",
    "type":"object",
    "properties":{
        "country":{
            "description":"Country.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"Phone number.",
            "type":"string"
        },
        "address3":{
            "description":"Address Line 3.",
            "type":"string"
        },
        "address2":{
            "description":"Address Line 2.",
            "type":"string"
        },
        "city":{
            "description":"City.",
            "type":"string"
        },
        "address1":{
            "description":"Address Line 1.",
            "type":"string"
        },
        "postalCode":{
            "description":"Postal code.",
            "type":"string"
        },
        "county":{
            "description":"Name of the county.",
            "type":"string"
        },
        "state":{
            "description":"State.",
            "type":"string"
        }
    }
}

Nested Schema : frequencyAmountTotals

Type: array

The total for each recurring charge frequency

Show Source

• Array of: object items

{
    "description":"The total for each recurring charge frequency",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "total":{
                "description":"The total amount for the frequency.",
                "type":"string"
            },
            "frequency":{
                "description":"The frequency for the item's total e.g. Monthly.",
                "type":"string"
            }
        }
    }
}

Nested Schema : frequencyTaxTotals

Type: array

The tax for each recurring charge frequency

Show Source

• Array of: object items

{
    "description":"The tax for each recurring charge frequency",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "tax":{
                "description":"The tax amount for the frequency.",
                "type":"string"
            },
            "frequency":{
                "description":"The frequency for the item's tax e.g. Monthly.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• frequency(optional): string
  The frequency for the item's total e.g. Monthly.
• total(optional): string
  The total amount for the frequency.

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total amount for the frequency.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency for the item's total e.g. Monthly.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• frequency(optional): string
  The frequency for the item's tax e.g. Monthly.
• tax(optional): string
  The tax amount for the frequency.

{
    "type":"object",
    "properties":{
        "tax":{
            "description":"The tax amount for the frequency.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency for the item's tax e.g. Monthly.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• actualShipDate(optional): string(date-time)
  The actual shipped date of this shipping group.
• commerceItemRelationships: array commerceItemRelationships
  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.
• description(optional): string
  The description of this shipping group. Defaults to the ID.
• handlingInstructions(optional): array handlingInstructions
  Handling instructions. Currently read-only.
• id: string
  The ID of this shipping group.
• priceInfo(optional): object priceInfo
  The pricing details about this shipping group.
• recurringChargePriceInfo(optional): object recurringChargePriceInfo
  Recurring charge price information.
• shipOnDate(optional): string(date-time)
  The date this shipping group is expected to ship upon.
• shippingAddress(optional): object shippingAddress
  The shipping address for this shipping group.
• shippingGroupClassType(optional): string
  The class type for the ShippingGroup. Currently must be "hardgoodShippingGroup".
• shippingMethod: string
  The shipping method.
• specialInstructions(optional): object specialInstructions
  Special instructions for the shipping group. Keys and values are strings.
• state(optional): string
  The state of this shipping group.
• stateDetail(optional): string
  Details about the state of this shipping group.
• submittedDate(optional): string(date-time)
  The date the shipping group was submitted.
• trackingNumber(optional): 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.

{
    "type":"object",
    "properties":{
        "shippingMethod":{
            "description":"The shipping method.",
            "type":"string"
        },
        "description":{
            "description":"The description of this shipping group. Defaults to the ID.",
            "type":"string"
        },
        "submittedDate":{
            "format":"date-time",
            "description":"The date the shipping group was submitted.",
            "type":"string"
        },
        "priceInfo":{
            "description":"The pricing details about this shipping group.",
            "type":"object",
            "properties":{
                "discounted":{
                    "description":"Whether this item is discounted.",
                    "type":"boolean"
                },
                "secondaryCurrencyTaxAmount":{
                    "description":" The secondary currency tax amount.",
                    "type":"number"
                },
                "shippingTax":{
                    "description":"shippingTax for this shipping group",
                    "type":"number"
                },
                "amount":{
                    "description":"The monetary amount.",
                    "type":"number"
                },
                "secondaryCurrencyShippingAmount":{
                    "description":" The secondary currency shipping amount.",
                    "type":"number"
                },
                "rawShipping":{
                    "description":"The monitary amount of the cost of raw shipping.",
                    "type":"number"
                },
                "amountIsFinal":{
                    "description":"Whether the amount is final.",
                    "type":"boolean"
                },
                "currencyCode":{
                    "description":"The currency code for the monetary amounts.",
                    "type":"string"
                }
            }
        },
        "recurringChargePriceInfo":{
            "description":"Recurring charge price information.",
            "type":"object",
            "properties":{
                "amount":{
                    "description":"The monetary amount of this recurring charge.",
                    "type":"number"
                },
                "total":{
                    "description":"The total price of the recurring charge.",
                    "type":"number"
                },
                "frequencyAmountTotals":{
                    "description":"The total for each recurring charge frequency",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "total":{
                                "description":"The total amount for the frequency.",
                                "type":"string"
                            },
                            "frequency":{
                                "description":"The frequency for the item's total e.g. Monthly.",
                                "type":"string"
                            }
                        }
                    }
                },
                "shipping":{
                    "description":"Cost of shipping the product.",
                    "type":"number"
                },
                "tax":{
                    "description":"Monetary tax amount.",
                    "type":"number"
                },
                "subTotal":{
                    "description":"The sub-total price of the recurring charge.",
                    "type":"number"
                },
                "frequencyTaxTotals":{
                    "description":"The tax for each recurring charge frequency",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "tax":{
                                "description":"The tax amount for the frequency.",
                                "type":"string"
                            },
                            "frequency":{
                                "description":"The frequency for the item's tax e.g. Monthly.",
                                "type":"string"
                            }
                        }
                    }
                },
                "currencyCode":{
                    "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
                    "type":"string"
                },
                "totalWithoutTax":{
                    "description":"Total of recurring amount without tax included.",
                    "type":"number"
                }
            }
        },
        "shipOnDate":{
            "format":"date-time",
            "description":"The date this shipping group is expected to ship upon.",
            "type":"string"
        },
        "actualShipDate":{
            "format":"date-time",
            "description":"The actual shipped date of this shipping group.",
            "type":"string"
        },
        "specialInstructions":{
            "description":"Special instructions for the shipping group. Keys and values are strings.",
            "type":"object",
            "properties":{
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "shippingAddress":{
            "description":"The shipping address for this shipping group.",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"Last name.",
                    "type":"string"
                },
                "country":{
                    "description":"Country.",
                    "type":"string"
                },
                "address3":{
                    "description":"Address Line 3.",
                    "type":"string"
                },
                "address2":{
                    "description":"Address Line 2.",
                    "type":"string"
                },
                "city":{
                    "description":"City.",
                    "type":"string"
                },
                "address1":{
                    "description":"Address Line 1.",
                    "type":"string"
                },
                "prefix":{
                    "description":"Prefix.",
                    "type":"string"
                },
                "companyName":{
                    "description":"Company name.",
                    "type":"string"
                },
                "postalCode":{
                    "description":"Postal code.",
                    "type":"string"
                },
                "jobTitle":{
                    "description":"Job title.",
                    "type":"string"
                },
                "county":{
                    "description":"Name of the county.",
                    "type":"string"
                },
                "ownerId":{
                    "description":"The ID of the owner of this address.",
                    "type":"string"
                },
                "suffix":{
                    "description":"Suffix.",
                    "type":"string"
                },
                "firstName":{
                    "description":"First name.",
                    "type":"string"
                },
                "phoneNumber":{
                    "description":"Phone number.",
                    "type":"string"
                },
                "faxNumber":{
                    "description":"The fax number.",
                    "type":"string"
                },
                "middleName":{
                    "description":"Middle name.",
                    "type":"string"
                },
                "state":{
                    "description":"State.",
                    "type":"string"
                },
                "id":{
                    "description":"ID.",
                    "type":"string"
                },
                "email":{
                    "description":"The email address",
                    "type":"string"
                }
            }
        },
        "commerceItemRelationships":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "commerceItemId":{
                        "description":"The referenced commerce item's internal ID.",
                        "type":"string"
                    },
                    "amount":{
                        "description":"The monetary value.",
                        "type":"number"
                    },
                    "quantity":{
                        "description":"The quantity of items referenced by this relationship. Updatable through webhook response. If quantity of relationship is updated, the sum of quantity for a commerceItem across all its relationships should match with commerceItem's quantity.",
                        "type":"integer"
                    },
                    "relationshipType":{
                        "description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
                        "type":"string"
                    },
                    "returnedQuantity":{
                        "description":"Number of referenced items that were returned.",
                        "type":"integer"
                    },
                    "range":{
                        "description":"Represents which specific items are covered by this commerceItemRelationship.",
                        "type":"object",
                        "properties":{
                            "lowBound":{
                                "description":"The lower bound of the range.",
                                "type":"integer"
                            },
                            "highBound":{
                                "description":"The upper bound of the range.",
                                "type":"integer"
                            },
                            "size":{
                                "description":"The no of items this range includes",
                                "type":"integer"
                            }
                        }
                    },
                    "commerceItemExternalId":{
                        "description":"The referenced commerce item's external ID.",
                        "type":"string"
                    },
                    "state":{
                        "description":"The state of this commerceItemRelationships item. Updatable through webhook response. Updatable states are CANCEL_REQUESTED, RETURN_REQUESTED and NO_ACTION.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The native ID of this item.",
                        "type":"string"
                    }
                },
                "required":[
                    "id",
                    "commerceItemId",
                    "quantity"
                ]
            }
        },
        "id":{
            "description":"The ID of this shipping group.",
            "type":"string"
        },
        "state":{
            "description":"The state of this shipping group.",
            "type":"string"
        },
        "stateDetail":{
            "description":"Details about the state of this shipping group.",
            "type":"string"
        },
        "trackingNumber":{
            "description":"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.",
            "type":"string"
        },
        "handlingInstructions":{
            "description":"Handling instructions. Currently read-only.",
            "type":"array",
            "items":{
                "type":"string",
                "properties":{
                }
            }
        },
        "shippingGroupClassType":{
            "description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
            "type":"string"
        }
    },
    "required":[
        "id",
        "shippingMethod",
        "commerceItemRelationships"
    ]
}

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.

Show Source

• Array of: object items

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "commerceItemId":{
                "description":"The referenced commerce item's internal ID.",
                "type":"string"
            },
            "amount":{
                "description":"The monetary value.",
                "type":"number"
            },
            "quantity":{
                "description":"The quantity of items referenced by this relationship. Updatable through webhook response. If quantity of relationship is updated, the sum of quantity for a commerceItem across all its relationships should match with commerceItem's quantity.",
                "type":"integer"
            },
            "relationshipType":{
                "description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
                "type":"string"
            },
            "returnedQuantity":{
                "description":"Number of referenced items that were returned.",
                "type":"integer"
            },
            "range":{
                "description":"Represents which specific items are covered by this commerceItemRelationship.",
                "type":"object",
                "properties":{
                    "lowBound":{
                        "description":"The lower bound of the range.",
                        "type":"integer"
                    },
                    "highBound":{
                        "description":"The upper bound of the range.",
                        "type":"integer"
                    },
                    "size":{
                        "description":"The no of items this range includes",
                        "type":"integer"
                    }
                }
            },
            "commerceItemExternalId":{
                "description":"The referenced commerce item's external ID.",
                "type":"string"
            },
            "state":{
                "description":"The state of this commerceItemRelationships item. Updatable through webhook response. Updatable states are CANCEL_REQUESTED, RETURN_REQUESTED and NO_ACTION.",
                "type":"string"
            },
            "id":{
                "description":"The native ID of this item.",
                "type":"string"
            }
        },
        "required":[
            "id",
            "commerceItemId",
            "quantity"
        ]
    }
}

Nested Schema : handlingInstructions

Type: array

Handling instructions. Currently read-only.

Show Source

• Array of: string

{
    "description":"Handling instructions. Currently read-only.",
    "type":"array",
    "items":{
        "type":"string",
        "properties":{
        }
    }
}

Nested Schema : priceInfo

Type: object

The pricing details about this shipping group.

Show Source

• amount(optional): number
  The monetary amount.
• amountIsFinal(optional): boolean
  Whether the amount is final.
• currencyCode(optional): string
  The currency code for the monetary amounts.
• discounted(optional): boolean
  Whether this item is discounted.
• rawShipping(optional): number
  The monitary amount of the cost of raw shipping.
• secondaryCurrencyShippingAmount(optional): number
  The secondary currency shipping amount.
• secondaryCurrencyTaxAmount(optional): number
  The secondary currency tax amount.
• shippingTax(optional): number
  shippingTax for this shipping group

{
    "description":"The pricing details about this shipping group.",
    "type":"object",
    "properties":{
        "discounted":{
            "description":"Whether this item is discounted.",
            "type":"boolean"
        },
        "secondaryCurrencyTaxAmount":{
            "description":" The secondary currency tax amount.",
            "type":"number"
        },
        "shippingTax":{
            "description":"shippingTax for this shipping group",
            "type":"number"
        },
        "amount":{
            "description":"The monetary amount.",
            "type":"number"
        },
        "secondaryCurrencyShippingAmount":{
            "description":" The secondary currency shipping amount.",
            "type":"number"
        },
        "rawShipping":{
            "description":"The monitary amount of the cost of raw shipping.",
            "type":"number"
        },
        "amountIsFinal":{
            "description":"Whether the amount is final.",
            "type":"boolean"
        },
        "currencyCode":{
            "description":"The currency code for the monetary amounts.",
            "type":"string"
        }
    }
}

Nested Schema : recurringChargePriceInfo

Type: object

Recurring charge price information.

Show Source

• amount(optional): number
  The monetary amount of this recurring charge.
• currencyCode(optional): string
  The currency code for the monetary amounts. A three character currency code such as USD.
• frequencyAmountTotals(optional): array frequencyAmountTotals
  The total for each recurring charge frequency
• frequencyTaxTotals(optional): array frequencyTaxTotals
  The tax for each recurring charge frequency
• shipping(optional): number
  Cost of shipping the product.
• subTotal(optional): number
  The sub-total price of the recurring charge.
• tax(optional): number
  Monetary tax amount.
• total(optional): number
  The total price of the recurring charge.
• totalWithoutTax(optional): number
  Total of recurring amount without tax included.

{
    "description":"Recurring charge price information.",
    "type":"object",
    "properties":{
        "amount":{
            "description":"The monetary amount of this recurring charge.",
            "type":"number"
        },
        "total":{
            "description":"The total price of the recurring charge.",
            "type":"number"
        },
        "frequencyAmountTotals":{
            "description":"The total for each recurring charge frequency",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "total":{
                        "description":"The total amount for the frequency.",
                        "type":"string"
                    },
                    "frequency":{
                        "description":"The frequency for the item's total e.g. Monthly.",
                        "type":"string"
                    }
                }
            }
        },
        "shipping":{
            "description":"Cost of shipping the product.",
            "type":"number"
        },
        "tax":{
            "description":"Monetary tax amount.",
            "type":"number"
        },
        "subTotal":{
            "description":"The sub-total price of the recurring charge.",
            "type":"number"
        },
        "frequencyTaxTotals":{
            "description":"The tax for each recurring charge frequency",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "tax":{
                        "description":"The tax amount for the frequency.",
                        "type":"string"
                    },
                    "frequency":{
                        "description":"The frequency for the item's tax e.g. Monthly.",
                        "type":"string"
                    }
                }
            }
        },
        "currencyCode":{
            "description":"The currency code for the monetary amounts. A three character currency code such as USD.",
            "type":"string"
        },
        "totalWithoutTax":{
            "description":"Total of recurring amount without tax included.",
            "type":"number"
        }
    }
}

Nested Schema : shippingAddress

Type: object

The shipping address for this shipping group.

Show Source

• address1(optional): string
  Address Line 1.
• address2(optional): string
  Address Line 2.
• address3(optional): string
  Address Line 3.
• city(optional): string
  City.
• companyName(optional): string
  Company name.
• country(optional): string
  Country.
• county(optional): string
  Name of the county.
• email(optional): string
  The email address
• faxNumber(optional): string
  The fax number.
• firstName(optional): string
  First name.
• id(optional): string
  ID.
• jobTitle(optional): string
  Job title.
• lastName(optional): string
  Last name.
• middleName(optional): string
  Middle name.
• ownerId(optional): string
  The ID of the owner of this address.
• phoneNumber(optional): string
  Phone number.
• postalCode(optional): string
  Postal code.
• prefix(optional): string
  Prefix.
• state(optional): string
  State.
• suffix(optional): string
  Suffix.

{
    "description":"The shipping address for this shipping group.",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"Last name.",
            "type":"string"
        },
        "country":{
            "description":"Country.",
            "type":"string"
        },
        "address3":{
            "description":"Address Line 3.",
            "type":"string"
        },
        "address2":{
            "description":"Address Line 2.",
            "type":"string"
        },
        "city":{
            "description":"City.",
            "type":"string"
        },
        "address1":{
            "description":"Address Line 1.",
            "type":"string"
        },
        "prefix":{
            "description":"Prefix.",
            "type":"string"
        },
        "companyName":{
            "description":"Company name.",
            "type":"string"
        },
        "postalCode":{
            "description":"Postal code.",
            "type":"string"
        },
        "jobTitle":{
            "description":"Job title.",
            "type":"string"
        },
        "county":{
            "description":"Name of the county.",
            "type":"string"
        },
        "ownerId":{
            "description":"The ID of the owner of this address.",
            "type":"string"
        },
        "suffix":{
            "description":"Suffix.",
            "type":"string"
        },
        "firstName":{
            "description":"First name.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"Phone number.",
            "type":"string"
        },
        "faxNumber":{
            "description":"The fax number.",
            "type":"string"
        },
        "middleName":{
            "description":"Middle name.",
            "type":"string"
        },
        "state":{
            "description":"State.",
            "type":"string"
        },
        "id":{
            "description":"ID.",
            "type":"string"
        },
        "email":{
            "description":"The email address",
            "type":"string"
        }
    }
}

Nested Schema : specialInstructions

Type: object

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

Show Source

• additionalProperties(optional): string

{
    "description":"Special instructions for the shipping group. Keys and values are strings.",
    "type":"object",
    "properties":{
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The monetary value.
• commerceItemExternalId(optional): string
  The referenced commerce item's external ID.
• commerceItemId: string
  The referenced commerce item's internal ID.
• id: string
  The native ID of this item.
• quantity: integer
  The quantity of items referenced by this relationship. Updatable through webhook response. If quantity of relationship is updated, the sum of quantity for a commerceItem across all its relationships should match with commerceItem's quantity.
• range(optional): object range
  Represents which specific items are covered by this commerceItemRelationship.
• relationshipType(optional): string
  The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.
• returnedQuantity(optional): integer
  Number of referenced items that were returned.
• state(optional): string
  The state of this commerceItemRelationships item. Updatable through webhook response. Updatable states are CANCEL_REQUESTED, RETURN_REQUESTED and NO_ACTION.

{
    "type":"object",
    "properties":{
        "commerceItemId":{
            "description":"The referenced commerce item's internal ID.",
            "type":"string"
        },
        "amount":{
            "description":"The monetary value.",
            "type":"number"
        },
        "quantity":{
            "description":"The quantity of items referenced by this relationship. Updatable through webhook response. If quantity of relationship is updated, the sum of quantity for a commerceItem across all its relationships should match with commerceItem's quantity.",
            "type":"integer"
        },
        "relationshipType":{
            "description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
            "type":"string"
        },
        "returnedQuantity":{
            "description":"Number of referenced items that were returned.",
            "type":"integer"
        },
        "range":{
            "description":"Represents which specific items are covered by this commerceItemRelationship.",
            "type":"object",
            "properties":{
                "lowBound":{
                    "description":"The lower bound of the range.",
                    "type":"integer"
                },
                "highBound":{
                    "description":"The upper bound of the range.",
                    "type":"integer"
                },
                "size":{
                    "description":"The no of items this range includes",
                    "type":"integer"
                }
            }
        },
        "commerceItemExternalId":{
            "description":"The referenced commerce item's external ID.",
            "type":"string"
        },
        "state":{
            "description":"The state of this commerceItemRelationships item. Updatable through webhook response. Updatable states are CANCEL_REQUESTED, RETURN_REQUESTED and NO_ACTION.",
            "type":"string"
        },
        "id":{
            "description":"The native ID of this item.",
            "type":"string"
        }
    },
    "required":[
        "id",
        "commerceItemId",
        "quantity"
    ]
}

Nested Schema : range

Type: object

Represents which specific items are covered by this commerceItemRelationship.

Show Source

• highBound(optional): integer
  The upper bound of the range.
• lowBound(optional): integer
  The lower bound of the range.
• size(optional): integer
  The no of items this range includes

{
    "description":"Represents which specific items are covered by this commerceItemRelationship.",
    "type":"object",
    "properties":{
        "lowBound":{
            "description":"The lower bound of the range.",
            "type":"integer"
        },
        "highBound":{
            "description":"The upper bound of the range.",
            "type":"integer"
        },
        "size":{
            "description":"The no of items this range includes",
            "type":"integer"
        }
    }
}

Nested Schema : frequencyAmountTotals

Type: array

The total for each recurring charge frequency

Show Source

• Array of: object items

{
    "description":"The total for each recurring charge frequency",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "total":{
                "description":"The total amount for the frequency.",
                "type":"string"
            },
            "frequency":{
                "description":"The frequency for the item's total e.g. Monthly.",
                "type":"string"
            }
        }
    }
}

Nested Schema : frequencyTaxTotals

Type: array

The tax for each recurring charge frequency

Show Source

• Array of: object items

{
    "description":"The tax for each recurring charge frequency",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "tax":{
                "description":"The tax amount for the frequency.",
                "type":"string"
            },
            "frequency":{
                "description":"The frequency for the item's tax e.g. Monthly.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• frequency(optional): string
  The frequency for the item's total e.g. Monthly.
• total(optional): string
  The total amount for the frequency.

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total amount for the frequency.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency for the item's total e.g. Monthly.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• frequency(optional): string
  The frequency for the item's tax e.g. Monthly.
• tax(optional): string
  The tax amount for the frequency.

{
    "type":"object",
    "properties":{
        "tax":{
            "description":"The tax amount for the frequency.",
            "type":"string"
        },
        "frequency":{
            "description":"The frequency for the item's tax e.g. Monthly.",
            "type":"string"
        }
    }
}

Nested Schema : miscTaxInfo

Type: object

Details about the miscTax.

Show Source

• Special(optional): number
  Details of the Special tax

{
    "description":"Details about the miscTax.",
    "type":"object",
    "properties":{
        "Special":{
            "description":"Details of the Special tax",
            "type":"number"
        }
    }
}

Back to Top