This webhook is triggered to external systems wherever we need to test whether an order is valid for return. The payload does not include payment details.
Root Schema : returnRequestValidationForNonPCITargets_request
Type: object
This webhook is triggered to external systems wherever we need to test whether an order is valid for return. The payload does not include payment details.
Show Source
{
"description":"This webhook is triggered to external systems wherever we need to test whether an order is valid for return. The payload does not include payment details.",
"properties":{
"agentProfile":{
"type":"object",
"properties":{
"firstName":{
"description":"First Name of agent profile",
"type":"string"
},
"lastName":{
"description":"Last Name of agent profile",
"type":"string"
},
"id":{
"description":"Id of agent profile",
"type":"string"
},
"login":{
"description":"Login of agent profile",
"type":"string"
}
}
},
"context":{
"description":"In which context webhook is getting triggered. Either for initiate or calculaterefund or submit return request or cancelOrder e.t.c.,",
"type":"string"
},
"returnRequests":{
"type":"array",
"items":{
"type":"object",
"properties":{
"returnItemListIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding returnItemList property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"returnItemList":{
"description":"List of returnable 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":{
"quantityToReturn":{
"description":"Quantity shopper wants to return",
"type":"integer"
},
"quantityAvailable":{
"description":"Quantity available to return in cloud commerce",
"type":"integer"
},
"productId":{
"description":"Product Id",
"type":"string"
},
"nonreturnable":{
"description":"Non returnable flag as per CC",
"type":"boolean"
},
"shippingGroupId":{
"description":"Shipping Group Id",
"type":"string"
},
"childReturnItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childReturnItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"catalogRefId":{
"description":"Catalog Ref Id",
"type":"string"
},
"returnRequired":{
"description":"If return is required for the item",
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item Id",
"type":"string"
},
"quantityShipped":{
"description":"Total Quantity shipped in this order",
"type":"integer"
},
"shippable":{
"description":"Shippable flag if item is shippable",
"type":"string"
},
"returnReason":{
"description":"Return Reason shopper selected",
"type":"string"
},
"nonReturnableReason":{
"description":"Non Returnable Reason if it is nonreturnable in cc",
"type":"string"
}
}
}
},
"order":{
"type":"object",
"properties":{
"secondaryCurrencyCode":{
"description":"Secondary currencyCode",
"type":"string"
},
"priceGroupId":{
"description":"The PriceListGroup ID of the current order.",
"type":"string"
},
"lastModifiedTime":{
"description":"Last modified time of order",
"type":"number"
},
"creationTime":{
"description":"The creation time of the order.",
"type":"number"
},
"sourceSystem":{
"description":"The name of the source system",
"type":"string"
},
"dynamicProperties":{
"description":"the value of the dynamic Properties",
"type":"array",
"items":{
"type":"object"
}
},
"orderStatus":{
"description":"The order status.",
"type":"string"
},
"submittedDate":{
"description":"The order submitted date",
"type":"string"
},
"locale":{
"description":"the locale of the request/response",
"type":"string"
},
"paymentGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"PONumber":{
"type":"string"
},
"amountAuthorized":{
"type":"number"
},
"amount":{
"type":"number"
},
"paymentMethod":{
"type":"string"
},
"id":{
"type":"string"
},
"billingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string"
},
"country":{
"type":"string"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string"
},
"address1":{
"type":"string"
},
"prefix":{
"type":"string"
},
"companyName":{
"type":"string"
},
"postalCode":{
"type":"string"
},
"jobTitle":{
"type":"string"
},
"county":{
"type":"string"
},
"ownerId":{
"type":"string"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string"
},
"phoneNumber":{
"type":"string"
},
"faxNumber":{
"type":"string"
},
"middleName":{
"type":"string"
},
"state":{
"type":"string"
},
"email":{
"type":"string"
}
}
},
"currencyCode":{
"type":"string"
}
}
}
},
"salesChannel":{
"type":"string"
},
"priceInfo":{
"type":"object",
"properties":{
"amount":{
"type":"number"
},
"total":{
"type":"number"
},
"shipping":{
"type":"number"
},
"shippingSurchargeValue":{
"type":"number"
},
"tax":{
"type":"number"
},
"subTotal":{
"type":"number"
},
"currencyCode":{
"type":"string"
},
"totalWithoutTax":{
"type":"number"
}
}
},
"relationships":{
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string"
},
"amount":{
"type":"number"
},
"relationshipType":{
"type":"string"
},
"id":{
"type":"string"
}
}
}
},
"catalogId":{
"description":"The Catalog ID of the current order.",
"type":"string"
},
"pricingMessages":{
"type":"object"
},
"exchangeRate":{
"description":"exchangeRate",
"type":"number"
},
"shoppingCart":{
"type":"object",
"properties":{
"numberOfItems":{
"type":"integer"
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"type":"number"
},
"displayName":{
"type":"string"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"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":{
"type":"number"
}
}
}
}
}
},
"totalCommerceItemCount":{
"description":"The total commerce item count",
"type":"integer"
},
"id":{
"description":"The ID of the order.",
"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"
},
"taxPriceInfo":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"discounted":{
"type":"boolean"
},
"amount":{
"type":"number"
},
"valueAddedTax":{
"type":"integer"
},
"countyTax":{
"type":"number"
},
"isTaxIncluded":{
"type":"boolean"
},
"miscTax":{
"type":"integer"
},
"districtTax":{
"type":"integer"
},
"stateTax":{
"type":"number"
},
"countryTax":{
"type":"integer"
},
"cityTax":{
"type":"integer"
},
"amountIsFinal":{
"type":"boolean"
},
"currencyCode":{
"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. Depending on the shippingMethod i.e. hardgoodShippingGroups, inStorePickupShippingGroup different proporties will be defined with shippingGroups.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string"
},
"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"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"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":"The shipping tax",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"rawShipping":{
"description":"The monetary 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"
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"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":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"range":{
"description":"The range covered by these commerce items",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
}
}
}
},
"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"
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"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"
}
}
}
},
"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"
},
"isItemPriceOverrideAllowed":{
"type":"boolean"
},
"profile":{
"description":"Basic profile information.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
},
"shippingAddress":{
"description":"Default shipping address",
"type":"object",
"properties":{
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"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"
},
"repositoryId":{
"description":"Id of shipping address",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"id":{
"type":"string"
},
"parentOrganization":{
"description":"Parent Organization.",
"type":"object",
"properties":{
"name":{
"description":"Name.",
"type":"string"
},
"id":{
"description":"ID",
"type":"string"
}
}
},
"email":{
"description":"The email address",
"type":"string"
}
}
},
"creationDate":{
"description":"The order creation date.",
"type":"string"
},
"orderProfileId":{
"description":"The profile id on the order.",
"type":"string"
},
"site":{
"description":"Site information",
"type":"object",
"properties":{
"productionURL":{
"description":"Url of the site",
"type":"string"
},
"name":{
"description":"Site name",
"type":"string"
},
"id":{
"description":"Site 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"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
}
}
},
"profileId":{
"type":"string"
},
"giftWithPurchaseInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"number"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the order was placed.",
"type":"string"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"giftWithPurchaseOrderMarkers":{
"type":"array",
"items":{
"type":"object"
}
}
}
}
}
}
}
},
"example":{
"context":"Initiate_Return",
"returnRequests":[
{
"returnItemList":[
{
"quantityToReturn":0,
"commerceItemId":"ci3000416",
"quantityAvailable":20,
"quantityShipped":20,
"productId":"Product_27Fxyzii",
"nonreturnable":true,
"returnReason":null,
"shippingGroupId":"sg40414",
"catalogRefId":"Sku_27Gxyzii",
"nonReturnableReason":"This is a non-returnable item."
},
{
"quantityToReturn":0,
"commerceItemId":"ci3000417",
"quantityAvailable":15,
"quantityShipped":20,
"productId":"Product_36Exy",
"nonreturnable":false,
"returnReason":null,
"shippingGroupId":"sg40414",
"catalogRefId":"Sku_36Fxy",
"nonReturnableReason":null
}
],
"order":{
"approverIds":[
],
"gwp":false,
"secondaryCurrencyCode":null,
"lastModifiedTime":1.513930292E12,
"priceGroupId":"defaultPriceGroup",
"creationTime":1.50390023E12,
"sourceSystem":"Cloud Commerce",
"gwpMarkers":[
],
"salesChannel":"default",
"submittedDate":"2017-08-28T06:03:51.000Z",
"locale":"en",
"paymentGroups":[
{
"PONumber":"857",
"amountAuthorized":1052.56,
"amount":1052.56,
"paymentMethod":"invoiceRequest",
"billingAddress":{
"lastName":"Anderson",
"country":"US",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"address2":null,
"city":"Syracuse",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"state":"NY",
"email":"kim@example.com"
},
"state":10,
"id":"pg30416",
"currencyCode":"USD"
}
],
"configuratorId":null,
"organizationId":null,
"relationships":[
{
"paymentGroupId":"pg30416",
"amount":1052.56,
"relationshipType":"ORDERAMOUNTREMAINING",
"id":"r40399"
}
],
"priceInfo":{
"amount":939.6,
"total":1052.56,
"shipping":35,
"discountAmount":0,
"tax":77.96,
"rawSubtotal":939.6,
"currencyCode":"USD"
},
"catalogId":null,
"exchangeRate":null,
"totalCommerceItemCount":35,
"id":"o30411",
"state":"NO_PENDING_ACTION",
"externalContext":false,
"quoteInfo":null,
"taxCalculated":true,
"commerceItems":[
{
"priceInfo":{
"amount":499.8,
"orderDiscountInfos":[
],
"currencyCode":"USD",
"itemDiscountInfos":[
]
},
"gwp":false,
"quantity":20,
"productId":"Product_27Fxyzii",
"productDisplayName":"Sky Blue",
"id":"ci3000416",
"catalogRefId":"Sku_27Gxyzii"
},
{
"priceInfo":{
"amount":439.8,
"orderDiscountInfos":[
],
"currencyCode":"USD",
"itemDiscountInfos":[
]
},
"gwp":false,
"quantity":15,
"productId":"Product_36Exy",
"productDisplayName":"The Girl with the Dragon Tattoo",
"id":"ci3000417",
"catalogRefId":"Sku_36Fxy"
}
],
"taxPriceInfo":{
"secondaryCurrencyTaxAmount":0,
"cityTax":0,
"valueAddedTax":0,
"amount":77.96,
"countyTax":38.98,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":38.98,
"miscTaxInfo":{
},
"currencyCode":"USD",
"countryTax":0
},
"freezeDate":null,
"shippingGroups":[
{
"lastName":"Anderson",
"shippingMethod":"inStorePickupShippingGroup",
"description":"sg40492",
"submittedDate":null,
"firstName":"Kim",
"priceInfo":{
"secondaryCurrencyTaxAmount":0.68,
"discounted":false,
"shippingTax":1.7,
"secondaryCurrencyShippingAmount":8.4,
"amount":21,
"rawShipping":11,
"amountIsFinal":false,
"currencyCode":"L10174"
},
"phoneNumber":"212-555-1977",
"shipOnDate":null,
"actualShipDate":null,
"specialInstructions":{
},
"commerceItemRelationships":[
{
"availablePickupDate":"2018-05-19T13:00:00.000Z",
"commerceItemId":"ci3000500",
"inventoryLocationId":"SiteUS-GlenAllen186",
"amount":0,
"quantity":1,
"relationshipType":"SHIPPINGQUANTITY",
"returnedQuantity":0,
"preferredPickupDate":"2018-05-19T13:00:00.000Z",
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"commerceItemExternalId":null,
"state":"INITIAL",
"id":"r40526"
}
],
"state":"INITIAL",
"id":"sg40492",
"stateDetail":null,
"trackingNumber":null,
"email":"kim@example.com",
"handlingInstructions":[
],
"shippingGroupClassType":"inStorePickupShippingGroup"
}
],
"taxExempt":false,
"profile":{
"lastName":"Anderson",
"firstName":"Kim",
"customerContactId":"newExternalId",
"loyaltyPrograms":[
],
"shippingAddress":{
"country":"US",
"externalAddressId":"test",
"phoneNumber":"212-555-1977",
"address3":null,
"address2":null,
"city":"Syracuse",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"county":null,
"id":"se-100001",
"state":"NY"
},
"middleName":null,
"id":"newId",
"parentOrganization":null,
"email":"kim@example.com"
},
"approverMessages":[
],
"paymentInitiatedEmailSent":false,
"shippingGroupCount":1,
"taxExemptionCode":null,
"paymentGroupCount":1,
"site":{
"productionURL":null,
"name":"Commerce Cloud Site",
"id":"siteUS"
},
"recurringChargePriceInfo":null,
"profileId":"se-570031",
"organization":null,
"siteId":"siteUS",
"activeQuoteOrderId":null
}
}
]
}
}
Example:
{
"context":"Initiate_Return",
"returnRequests":[
{
"returnItemList":[
{
"quantityToReturn":0,
"commerceItemId":"ci3000416",
"quantityAvailable":20,
"quantityShipped":20,
"productId":"Product_27Fxyzii",
"nonreturnable":true,
"returnReason":null,
"shippingGroupId":"sg40414",
"catalogRefId":"Sku_27Gxyzii",
"nonReturnableReason":"This is a non-returnable item."
},
{
"quantityToReturn":0,
"commerceItemId":"ci3000417",
"quantityAvailable":15,
"quantityShipped":20,
"productId":"Product_36Exy",
"nonreturnable":false,
"returnReason":null,
"shippingGroupId":"sg40414",
"catalogRefId":"Sku_36Fxy",
"nonReturnableReason":null
}
],
"order":{
"approverIds":[
],
"gwp":false,
"secondaryCurrencyCode":null,
"lastModifiedTime":1.513930292E12,
"priceGroupId":"defaultPriceGroup",
"creationTime":1.50390023E12,
"sourceSystem":"Cloud Commerce",
"gwpMarkers":[
],
"salesChannel":"default",
"submittedDate":"2017-08-28T06:03:51.000Z",
"locale":"en",
"paymentGroups":[
{
"PONumber":"857",
"amountAuthorized":1052.56,
"amount":1052.56,
"paymentMethod":"invoiceRequest",
"billingAddress":{
"lastName":"Anderson",
"country":"US",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"address2":null,
"city":"Syracuse",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"state":"NY",
"email":"kim@example.com"
},
"state":10,
"id":"pg30416",
"currencyCode":"USD"
}
],
"configuratorId":null,
"organizationId":null,
"relationships":[
{
"paymentGroupId":"pg30416",
"amount":1052.56,
"relationshipType":"ORDERAMOUNTREMAINING",
"id":"r40399"
}
],
"priceInfo":{
"amount":939.6,
"total":1052.56,
"shipping":35,
"discountAmount":0,
"tax":77.96,
"rawSubtotal":939.6,
"currencyCode":"USD"
},
"catalogId":null,
"exchangeRate":null,
"totalCommerceItemCount":35,
"id":"o30411",
"state":"NO_PENDING_ACTION",
"externalContext":false,
"quoteInfo":null,
"taxCalculated":true,
"commerceItems":[
{
"priceInfo":{
"amount":499.8,
"orderDiscountInfos":[
],
"currencyCode":"USD",
"itemDiscountInfos":[
]
},
"gwp":false,
"quantity":20,
"productId":"Product_27Fxyzii",
"productDisplayName":"Sky Blue",
"id":"ci3000416",
"catalogRefId":"Sku_27Gxyzii"
},
{
"priceInfo":{
"amount":439.8,
"orderDiscountInfos":[
],
"currencyCode":"USD",
"itemDiscountInfos":[
]
},
"gwp":false,
"quantity":15,
"productId":"Product_36Exy",
"productDisplayName":"The Girl with the Dragon Tattoo",
"id":"ci3000417",
"catalogRefId":"Sku_36Fxy"
}
],
"taxPriceInfo":{
"secondaryCurrencyTaxAmount":0,
"cityTax":0,
"valueAddedTax":0,
"amount":77.96,
"countyTax":38.98,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":38.98,
"miscTaxInfo":{
},
"currencyCode":"USD",
"countryTax":0
},
"freezeDate":null,
"shippingGroups":[
{
"lastName":"Anderson",
"shippingMethod":"inStorePickupShippingGroup",
"description":"sg40492",
"submittedDate":null,
"firstName":"Kim",
"priceInfo":{
"secondaryCurrencyTaxAmount":0.68,
"discounted":false,
"shippingTax":1.7,
"secondaryCurrencyShippingAmount":8.4,
"amount":21,
"rawShipping":11,
"amountIsFinal":false,
"currencyCode":"L10174"
},
"phoneNumber":"212-555-1977",
"shipOnDate":null,
"actualShipDate":null,
"specialInstructions":{
},
"commerceItemRelationships":[
{
"availablePickupDate":"2018-05-19T13:00:00.000Z",
"commerceItemId":"ci3000500",
"inventoryLocationId":"SiteUS-GlenAllen186",
"amount":0,
"quantity":1,
"relationshipType":"SHIPPINGQUANTITY",
"returnedQuantity":0,
"preferredPickupDate":"2018-05-19T13:00:00.000Z",
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"commerceItemExternalId":null,
"state":"INITIAL",
"id":"r40526"
}
],
"state":"INITIAL",
"id":"sg40492",
"stateDetail":null,
"trackingNumber":null,
"email":"kim@example.com",
"handlingInstructions":[
],
"shippingGroupClassType":"inStorePickupShippingGroup"
}
],
"taxExempt":false,
"profile":{
"lastName":"Anderson",
"firstName":"Kim",
"customerContactId":"newExternalId",
"loyaltyPrograms":[
],
"shippingAddress":{
"country":"US",
"externalAddressId":"test",
"phoneNumber":"212-555-1977",
"address3":null,
"address2":null,
"city":"Syracuse",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"county":null,
"id":"se-100001",
"state":"NY"
},
"middleName":null,
"id":"newId",
"parentOrganization":null,
"email":"kim@example.com"
},
"approverMessages":[
],
"paymentInitiatedEmailSent":false,
"shippingGroupCount":1,
"taxExemptionCode":null,
"paymentGroupCount":1,
"site":{
"productionURL":null,
"name":"Commerce Cloud Site",
"id":"siteUS"
},
"recurringChargePriceInfo":null,
"profileId":"se-570031",
"organization":null,
"siteId":"siteUS",
"activeQuoteOrderId":null
}
}
]
}
Nested Schema : agentProfile
Type: object
Show Source
{
"type":"object",
"properties":{
"firstName":{
"description":"First Name of agent profile",
"type":"string"
},
"lastName":{
"description":"Last Name of agent profile",
"type":"string"
},
"id":{
"description":"Id of agent profile",
"type":"string"
},
"login":{
"description":"Login of agent profile",
"type":"string"
}
}
}
Nested Schema : returnRequests
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"returnItemListIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding returnItemList property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"returnItemList":{
"description":"List of returnable 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":{
"quantityToReturn":{
"description":"Quantity shopper wants to return",
"type":"integer"
},
"quantityAvailable":{
"description":"Quantity available to return in cloud commerce",
"type":"integer"
},
"productId":{
"description":"Product Id",
"type":"string"
},
"nonreturnable":{
"description":"Non returnable flag as per CC",
"type":"boolean"
},
"shippingGroupId":{
"description":"Shipping Group Id",
"type":"string"
},
"childReturnItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childReturnItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"catalogRefId":{
"description":"Catalog Ref Id",
"type":"string"
},
"returnRequired":{
"description":"If return is required for the item",
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item Id",
"type":"string"
},
"quantityShipped":{
"description":"Total Quantity shipped in this order",
"type":"integer"
},
"shippable":{
"description":"Shippable flag if item is shippable",
"type":"string"
},
"returnReason":{
"description":"Return Reason shopper selected",
"type":"string"
},
"nonReturnableReason":{
"description":"Non Returnable Reason if it is nonreturnable in cc",
"type":"string"
}
}
}
},
"order":{
"type":"object",
"properties":{
"secondaryCurrencyCode":{
"description":"Secondary currencyCode",
"type":"string"
},
"priceGroupId":{
"description":"The PriceListGroup ID of the current order.",
"type":"string"
},
"lastModifiedTime":{
"description":"Last modified time of order",
"type":"number"
},
"creationTime":{
"description":"The creation time of the order.",
"type":"number"
},
"sourceSystem":{
"description":"The name of the source system",
"type":"string"
},
"dynamicProperties":{
"description":"the value of the dynamic Properties",
"type":"array",
"items":{
"type":"object"
}
},
"orderStatus":{
"description":"The order status.",
"type":"string"
},
"submittedDate":{
"description":"The order submitted date",
"type":"string"
},
"locale":{
"description":"the locale of the request/response",
"type":"string"
},
"paymentGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"PONumber":{
"type":"string"
},
"amountAuthorized":{
"type":"number"
},
"amount":{
"type":"number"
},
"paymentMethod":{
"type":"string"
},
"id":{
"type":"string"
},
"billingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string"
},
"country":{
"type":"string"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string"
},
"address1":{
"type":"string"
},
"prefix":{
"type":"string"
},
"companyName":{
"type":"string"
},
"postalCode":{
"type":"string"
},
"jobTitle":{
"type":"string"
},
"county":{
"type":"string"
},
"ownerId":{
"type":"string"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string"
},
"phoneNumber":{
"type":"string"
},
"faxNumber":{
"type":"string"
},
"middleName":{
"type":"string"
},
"state":{
"type":"string"
},
"email":{
"type":"string"
}
}
},
"currencyCode":{
"type":"string"
}
}
}
},
"salesChannel":{
"type":"string"
},
"priceInfo":{
"type":"object",
"properties":{
"amount":{
"type":"number"
},
"total":{
"type":"number"
},
"shipping":{
"type":"number"
},
"shippingSurchargeValue":{
"type":"number"
},
"tax":{
"type":"number"
},
"subTotal":{
"type":"number"
},
"currencyCode":{
"type":"string"
},
"totalWithoutTax":{
"type":"number"
}
}
},
"relationships":{
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string"
},
"amount":{
"type":"number"
},
"relationshipType":{
"type":"string"
},
"id":{
"type":"string"
}
}
}
},
"catalogId":{
"description":"The Catalog ID of the current order.",
"type":"string"
},
"pricingMessages":{
"type":"object"
},
"exchangeRate":{
"description":"exchangeRate",
"type":"number"
},
"shoppingCart":{
"type":"object",
"properties":{
"numberOfItems":{
"type":"integer"
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"type":"number"
},
"displayName":{
"type":"string"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"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":{
"type":"number"
}
}
}
}
}
},
"totalCommerceItemCount":{
"description":"The total commerce item count",
"type":"integer"
},
"id":{
"description":"The ID of the order.",
"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"
},
"taxPriceInfo":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"discounted":{
"type":"boolean"
},
"amount":{
"type":"number"
},
"valueAddedTax":{
"type":"integer"
},
"countyTax":{
"type":"number"
},
"isTaxIncluded":{
"type":"boolean"
},
"miscTax":{
"type":"integer"
},
"districtTax":{
"type":"integer"
},
"stateTax":{
"type":"number"
},
"countryTax":{
"type":"integer"
},
"cityTax":{
"type":"integer"
},
"amountIsFinal":{
"type":"boolean"
},
"currencyCode":{
"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. Depending on the shippingMethod i.e. hardgoodShippingGroups, inStorePickupShippingGroup different proporties will be defined with shippingGroups.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string"
},
"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"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"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":"The shipping tax",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"rawShipping":{
"description":"The monetary 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"
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"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":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"range":{
"description":"The range covered by these commerce items",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
}
}
}
},
"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"
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"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"
}
}
}
},
"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"
},
"isItemPriceOverrideAllowed":{
"type":"boolean"
},
"profile":{
"description":"Basic profile information.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
},
"shippingAddress":{
"description":"Default shipping address",
"type":"object",
"properties":{
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"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"
},
"repositoryId":{
"description":"Id of shipping address",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"id":{
"type":"string"
},
"parentOrganization":{
"description":"Parent Organization.",
"type":"object",
"properties":{
"name":{
"description":"Name.",
"type":"string"
},
"id":{
"description":"ID",
"type":"string"
}
}
},
"email":{
"description":"The email address",
"type":"string"
}
}
},
"creationDate":{
"description":"The order creation date.",
"type":"string"
},
"orderProfileId":{
"description":"The profile id on the order.",
"type":"string"
},
"site":{
"description":"Site information",
"type":"object",
"properties":{
"productionURL":{
"description":"Url of the site",
"type":"string"
},
"name":{
"description":"Site name",
"type":"string"
},
"id":{
"description":"Site 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"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
}
}
},
"profileId":{
"type":"string"
},
"giftWithPurchaseInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"number"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the order was placed.",
"type":"string"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"giftWithPurchaseOrderMarkers":{
"type":"array",
"items":{
"type":"object"
}
}
}
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"returnItemListIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding returnItemList property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"returnItemList":{
"description":"List of returnable 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":{
"quantityToReturn":{
"description":"Quantity shopper wants to return",
"type":"integer"
},
"quantityAvailable":{
"description":"Quantity available to return in cloud commerce",
"type":"integer"
},
"productId":{
"description":"Product Id",
"type":"string"
},
"nonreturnable":{
"description":"Non returnable flag as per CC",
"type":"boolean"
},
"shippingGroupId":{
"description":"Shipping Group Id",
"type":"string"
},
"childReturnItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childReturnItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"catalogRefId":{
"description":"Catalog Ref Id",
"type":"string"
},
"returnRequired":{
"description":"If return is required for the item",
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item Id",
"type":"string"
},
"quantityShipped":{
"description":"Total Quantity shipped in this order",
"type":"integer"
},
"shippable":{
"description":"Shippable flag if item is shippable",
"type":"string"
},
"returnReason":{
"description":"Return Reason shopper selected",
"type":"string"
},
"nonReturnableReason":{
"description":"Non Returnable Reason if it is nonreturnable in cc",
"type":"string"
}
}
}
},
"order":{
"type":"object",
"properties":{
"secondaryCurrencyCode":{
"description":"Secondary currencyCode",
"type":"string"
},
"priceGroupId":{
"description":"The PriceListGroup ID of the current order.",
"type":"string"
},
"lastModifiedTime":{
"description":"Last modified time of order",
"type":"number"
},
"creationTime":{
"description":"The creation time of the order.",
"type":"number"
},
"sourceSystem":{
"description":"The name of the source system",
"type":"string"
},
"dynamicProperties":{
"description":"the value of the dynamic Properties",
"type":"array",
"items":{
"type":"object"
}
},
"orderStatus":{
"description":"The order status.",
"type":"string"
},
"submittedDate":{
"description":"The order submitted date",
"type":"string"
},
"locale":{
"description":"the locale of the request/response",
"type":"string"
},
"paymentGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"PONumber":{
"type":"string"
},
"amountAuthorized":{
"type":"number"
},
"amount":{
"type":"number"
},
"paymentMethod":{
"type":"string"
},
"id":{
"type":"string"
},
"billingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string"
},
"country":{
"type":"string"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string"
},
"address1":{
"type":"string"
},
"prefix":{
"type":"string"
},
"companyName":{
"type":"string"
},
"postalCode":{
"type":"string"
},
"jobTitle":{
"type":"string"
},
"county":{
"type":"string"
},
"ownerId":{
"type":"string"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string"
},
"phoneNumber":{
"type":"string"
},
"faxNumber":{
"type":"string"
},
"middleName":{
"type":"string"
},
"state":{
"type":"string"
},
"email":{
"type":"string"
}
}
},
"currencyCode":{
"type":"string"
}
}
}
},
"salesChannel":{
"type":"string"
},
"priceInfo":{
"type":"object",
"properties":{
"amount":{
"type":"number"
},
"total":{
"type":"number"
},
"shipping":{
"type":"number"
},
"shippingSurchargeValue":{
"type":"number"
},
"tax":{
"type":"number"
},
"subTotal":{
"type":"number"
},
"currencyCode":{
"type":"string"
},
"totalWithoutTax":{
"type":"number"
}
}
},
"relationships":{
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string"
},
"amount":{
"type":"number"
},
"relationshipType":{
"type":"string"
},
"id":{
"type":"string"
}
}
}
},
"catalogId":{
"description":"The Catalog ID of the current order.",
"type":"string"
},
"pricingMessages":{
"type":"object"
},
"exchangeRate":{
"description":"exchangeRate",
"type":"number"
},
"shoppingCart":{
"type":"object",
"properties":{
"numberOfItems":{
"type":"integer"
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"type":"number"
},
"displayName":{
"type":"string"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"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":{
"type":"number"
}
}
}
}
}
},
"totalCommerceItemCount":{
"description":"The total commerce item count",
"type":"integer"
},
"id":{
"description":"The ID of the order.",
"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"
},
"taxPriceInfo":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"discounted":{
"type":"boolean"
},
"amount":{
"type":"number"
},
"valueAddedTax":{
"type":"integer"
},
"countyTax":{
"type":"number"
},
"isTaxIncluded":{
"type":"boolean"
},
"miscTax":{
"type":"integer"
},
"districtTax":{
"type":"integer"
},
"stateTax":{
"type":"number"
},
"countryTax":{
"type":"integer"
},
"cityTax":{
"type":"integer"
},
"amountIsFinal":{
"type":"boolean"
},
"currencyCode":{
"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. Depending on the shippingMethod i.e. hardgoodShippingGroups, inStorePickupShippingGroup different proporties will be defined with shippingGroups.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string"
},
"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"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"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":"The shipping tax",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"rawShipping":{
"description":"The monetary 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"
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"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":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"range":{
"description":"The range covered by these commerce items",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
}
}
}
},
"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"
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"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"
}
}
}
},
"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"
},
"isItemPriceOverrideAllowed":{
"type":"boolean"
},
"profile":{
"description":"Basic profile information.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
},
"shippingAddress":{
"description":"Default shipping address",
"type":"object",
"properties":{
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"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"
},
"repositoryId":{
"description":"Id of shipping address",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"id":{
"type":"string"
},
"parentOrganization":{
"description":"Parent Organization.",
"type":"object",
"properties":{
"name":{
"description":"Name.",
"type":"string"
},
"id":{
"description":"ID",
"type":"string"
}
}
},
"email":{
"description":"The email address",
"type":"string"
}
}
},
"creationDate":{
"description":"The order creation date.",
"type":"string"
},
"orderProfileId":{
"description":"The profile id on the order.",
"type":"string"
},
"site":{
"description":"Site information",
"type":"object",
"properties":{
"productionURL":{
"description":"Url of the site",
"type":"string"
},
"name":{
"description":"Site name",
"type":"string"
},
"id":{
"description":"Site 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"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
}
}
},
"profileId":{
"type":"string"
},
"giftWithPurchaseInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"number"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the order was placed.",
"type":"string"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"giftWithPurchaseOrderMarkers":{
"type":"array",
"items":{
"type":"object"
}
}
}
}
}
}
Nested Schema : order
Type: object
Show Source
{
"type":"object",
"properties":{
"secondaryCurrencyCode":{
"description":"Secondary currencyCode",
"type":"string"
},
"priceGroupId":{
"description":"The PriceListGroup ID of the current order.",
"type":"string"
},
"lastModifiedTime":{
"description":"Last modified time of order",
"type":"number"
},
"creationTime":{
"description":"The creation time of the order.",
"type":"number"
},
"sourceSystem":{
"description":"The name of the source system",
"type":"string"
},
"dynamicProperties":{
"description":"the value of the dynamic Properties",
"type":"array",
"items":{
"type":"object"
}
},
"orderStatus":{
"description":"The order status.",
"type":"string"
},
"submittedDate":{
"description":"The order submitted date",
"type":"string"
},
"locale":{
"description":"the locale of the request/response",
"type":"string"
},
"paymentGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"PONumber":{
"type":"string"
},
"amountAuthorized":{
"type":"number"
},
"amount":{
"type":"number"
},
"paymentMethod":{
"type":"string"
},
"id":{
"type":"string"
},
"billingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string"
},
"country":{
"type":"string"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string"
},
"address1":{
"type":"string"
},
"prefix":{
"type":"string"
},
"companyName":{
"type":"string"
},
"postalCode":{
"type":"string"
},
"jobTitle":{
"type":"string"
},
"county":{
"type":"string"
},
"ownerId":{
"type":"string"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string"
},
"phoneNumber":{
"type":"string"
},
"faxNumber":{
"type":"string"
},
"middleName":{
"type":"string"
},
"state":{
"type":"string"
},
"email":{
"type":"string"
}
}
},
"currencyCode":{
"type":"string"
}
}
}
},
"salesChannel":{
"type":"string"
},
"priceInfo":{
"type":"object",
"properties":{
"amount":{
"type":"number"
},
"total":{
"type":"number"
},
"shipping":{
"type":"number"
},
"shippingSurchargeValue":{
"type":"number"
},
"tax":{
"type":"number"
},
"subTotal":{
"type":"number"
},
"currencyCode":{
"type":"string"
},
"totalWithoutTax":{
"type":"number"
}
}
},
"relationships":{
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string"
},
"amount":{
"type":"number"
},
"relationshipType":{
"type":"string"
},
"id":{
"type":"string"
}
}
}
},
"catalogId":{
"description":"The Catalog ID of the current order.",
"type":"string"
},
"pricingMessages":{
"type":"object"
},
"exchangeRate":{
"description":"exchangeRate",
"type":"number"
},
"shoppingCart":{
"type":"object",
"properties":{
"numberOfItems":{
"type":"integer"
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"type":"number"
},
"displayName":{
"type":"string"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"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":{
"type":"number"
}
}
}
}
}
},
"totalCommerceItemCount":{
"description":"The total commerce item count",
"type":"integer"
},
"id":{
"description":"The ID of the order.",
"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"
},
"taxPriceInfo":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"discounted":{
"type":"boolean"
},
"amount":{
"type":"number"
},
"valueAddedTax":{
"type":"integer"
},
"countyTax":{
"type":"number"
},
"isTaxIncluded":{
"type":"boolean"
},
"miscTax":{
"type":"integer"
},
"districtTax":{
"type":"integer"
},
"stateTax":{
"type":"number"
},
"countryTax":{
"type":"integer"
},
"cityTax":{
"type":"integer"
},
"amountIsFinal":{
"type":"boolean"
},
"currencyCode":{
"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. Depending on the shippingMethod i.e. hardgoodShippingGroups, inStorePickupShippingGroup different proporties will be defined with shippingGroups.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string"
},
"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"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"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":"The shipping tax",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"rawShipping":{
"description":"The monetary 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"
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"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":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"range":{
"description":"The range covered by these commerce items",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
}
}
}
},
"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"
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"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"
}
}
}
},
"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"
},
"isItemPriceOverrideAllowed":{
"type":"boolean"
},
"profile":{
"description":"Basic profile information.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
},
"shippingAddress":{
"description":"Default shipping address",
"type":"object",
"properties":{
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"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"
},
"repositoryId":{
"description":"Id of shipping address",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"id":{
"type":"string"
},
"parentOrganization":{
"description":"Parent Organization.",
"type":"object",
"properties":{
"name":{
"description":"Name.",
"type":"string"
},
"id":{
"description":"ID",
"type":"string"
}
}
},
"email":{
"description":"The email address",
"type":"string"
}
}
},
"creationDate":{
"description":"The order creation date.",
"type":"string"
},
"orderProfileId":{
"description":"The profile id on the order.",
"type":"string"
},
"site":{
"description":"Site information",
"type":"object",
"properties":{
"productionURL":{
"description":"Url of the site",
"type":"string"
},
"name":{
"description":"Site name",
"type":"string"
},
"id":{
"description":"Site 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"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
}
}
},
"profileId":{
"type":"string"
},
"giftWithPurchaseInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"number"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the order was placed.",
"type":"string"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"giftWithPurchaseOrderMarkers":{
"type":"array",
"items":{
"type":"object"
}
}
}
}
Nested Schema : returnItemList
Type: array
List of returnable 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
{
"description":"List of returnable 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":{
"quantityToReturn":{
"description":"Quantity shopper wants to return",
"type":"integer"
},
"quantityAvailable":{
"description":"Quantity available to return in cloud commerce",
"type":"integer"
},
"productId":{
"description":"Product Id",
"type":"string"
},
"nonreturnable":{
"description":"Non returnable flag as per CC",
"type":"boolean"
},
"shippingGroupId":{
"description":"Shipping Group Id",
"type":"string"
},
"childReturnItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childReturnItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"catalogRefId":{
"description":"Catalog Ref Id",
"type":"string"
},
"returnRequired":{
"description":"If return is required for the item",
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item Id",
"type":"string"
},
"quantityShipped":{
"description":"Total Quantity shipped in this order",
"type":"integer"
},
"shippable":{
"description":"Shippable flag if item is shippable",
"type":"string"
},
"returnReason":{
"description":"Return Reason shopper selected",
"type":"string"
},
"nonReturnableReason":{
"description":"Non Returnable Reason if it is nonreturnable in cc",
"type":"string"
}
}
}
}
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
}
}
}
Nested Schema : dynamicProperties
Type: array
the value of the dynamic Properties
Show Source
{
"description":"the value of the dynamic Properties",
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : giftWithPurchaseInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"number"
}
}
}
}
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : paymentGroups
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"PONumber":{
"type":"string"
},
"amountAuthorized":{
"type":"number"
},
"amount":{
"type":"number"
},
"paymentMethod":{
"type":"string"
},
"id":{
"type":"string"
},
"billingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string"
},
"country":{
"type":"string"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string"
},
"address1":{
"type":"string"
},
"prefix":{
"type":"string"
},
"companyName":{
"type":"string"
},
"postalCode":{
"type":"string"
},
"jobTitle":{
"type":"string"
},
"county":{
"type":"string"
},
"ownerId":{
"type":"string"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string"
},
"phoneNumber":{
"type":"string"
},
"faxNumber":{
"type":"string"
},
"middleName":{
"type":"string"
},
"state":{
"type":"string"
},
"email":{
"type":"string"
}
}
},
"currencyCode":{
"type":"string"
}
}
}
}
Nested Schema : priceInfo
Type: object
Show Source
{
"type":"object",
"properties":{
"amount":{
"type":"number"
},
"total":{
"type":"number"
},
"shipping":{
"type":"number"
},
"shippingSurchargeValue":{
"type":"number"
},
"tax":{
"type":"number"
},
"subTotal":{
"type":"number"
},
"currencyCode":{
"type":"string"
},
"totalWithoutTax":{
"type":"number"
}
}
}
Nested Schema : pricingMessages
Type: object
Nested Schema : profile
Type: object
Basic profile information.
Show Source
{
"description":"Basic profile information.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
},
"shippingAddress":{
"description":"Default shipping address",
"type":"object",
"properties":{
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"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"
},
"repositoryId":{
"description":"Id of shipping address",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"id":{
"type":"string"
},
"parentOrganization":{
"description":"Parent Organization.",
"type":"object",
"properties":{
"name":{
"description":"Name.",
"type":"string"
},
"id":{
"description":"ID",
"type":"string"
}
}
},
"email":{
"description":"The email address",
"type":"string"
}
}
}
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
{
"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 : relationships
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string"
},
"amount":{
"type":"number"
},
"relationshipType":{
"type":"string"
},
"id":{
"type":"string"
}
}
}
}
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile
Show Source
{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
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. Depending on the shippingMethod i.e. hardgoodShippingGroups, inStorePickupShippingGroup different proporties will be defined with shippingGroups.
Show Source
{
"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. Depending on the shippingMethod i.e. hardgoodShippingGroups, inStorePickupShippingGroup different proporties will be defined with shippingGroups.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string"
},
"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"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"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":"The shipping tax",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"rawShipping":{
"description":"The monetary 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"
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"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":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"range":{
"description":"The range covered by these commerce items",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
}
}
}
},
"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"
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"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 : shoppingCart
Type: object
Show Source
{
"type":"object",
"properties":{
"numberOfItems":{
"type":"integer"
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"type":"number"
},
"displayName":{
"type":"string"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"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":{
"type":"number"
}
}
}
}
}
}
Nested Schema : site
Type: object
Site information
Show Source
{
"description":"Site information",
"type":"object",
"properties":{
"productionURL":{
"description":"Url of the site",
"type":"string"
},
"name":{
"description":"Site name",
"type":"string"
},
"id":{
"description":"Site Id",
"type":"string"
}
}
}
Nested Schema : taxPriceInfo
Type: object
Show Source
{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"discounted":{
"type":"boolean"
},
"amount":{
"type":"number"
},
"valueAddedTax":{
"type":"integer"
},
"countyTax":{
"type":"number"
},
"isTaxIncluded":{
"type":"boolean"
},
"miscTax":{
"type":"integer"
},
"districtTax":{
"type":"integer"
},
"stateTax":{
"type":"number"
},
"countryTax":{
"type":"integer"
},
"cityTax":{
"type":"integer"
},
"amountIsFinal":{
"type":"boolean"
},
"currencyCode":{
"type":"string"
}
}
}
Nested Schema : orderCouponsMap
Type: object
The coupons that were claimed.
Show Source
{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
Nested Schema : couponCode
Type: object
Coupon Code.
Show Source
{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"number"
}
}
}
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"PONumber":{
"type":"string"
},
"amountAuthorized":{
"type":"number"
},
"amount":{
"type":"number"
},
"paymentMethod":{
"type":"string"
},
"id":{
"type":"string"
},
"billingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string"
},
"country":{
"type":"string"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string"
},
"address1":{
"type":"string"
},
"prefix":{
"type":"string"
},
"companyName":{
"type":"string"
},
"postalCode":{
"type":"string"
},
"jobTitle":{
"type":"string"
},
"county":{
"type":"string"
},
"ownerId":{
"type":"string"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string"
},
"phoneNumber":{
"type":"string"
},
"faxNumber":{
"type":"string"
},
"middleName":{
"type":"string"
},
"state":{
"type":"string"
},
"email":{
"type":"string"
}
}
},
"currencyCode":{
"type":"string"
}
}
}
Nested Schema : billingAddress
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"type":"string"
},
"country":{
"type":"string"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string"
},
"address1":{
"type":"string"
},
"prefix":{
"type":"string"
},
"companyName":{
"type":"string"
},
"postalCode":{
"type":"string"
},
"jobTitle":{
"type":"string"
},
"county":{
"type":"string"
},
"ownerId":{
"type":"string"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string"
},
"phoneNumber":{
"type":"string"
},
"faxNumber":{
"type":"string"
},
"middleName":{
"type":"string"
},
"state":{
"type":"string"
},
"email":{
"type":"string"
}
}
}
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
}
Nested Schema : parentOrganization
Type: object
Parent Organization.
Show Source
{
"description":"Parent Organization.",
"type":"object",
"properties":{
"name":{
"description":"Name.",
"type":"string"
},
"id":{
"description":"ID",
"type":"string"
}
}
}
Nested Schema : shippingAddress
Type: object
Default shipping address
Show Source
{
"description":"Default shipping address",
"type":"object",
"properties":{
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"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"
},
"repositoryId":{
"description":"Id of shipping address",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
{
"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
{
"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
{
"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
{
"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
{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string"
},
"amount":{
"type":"number"
},
"relationshipType":{
"type":"string"
},
"id":{
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string"
},
"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"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"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":"The shipping tax",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"rawShipping":{
"description":"The monetary 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"
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"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":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"range":{
"description":"The range covered by these commerce items",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
}
}
}
},
"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"
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"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
{
"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":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"range":{
"description":"The range covered by these commerce items",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
}
}
}
}
Nested Schema : handlingInstructions
Type: array
Handling instructions. Currently read-only.
Show Source
{
"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
{
"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":"The shipping tax",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"rawShipping":{
"description":"The monetary 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
{
"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
{
"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
{
"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
{
"type":"object",
"properties":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"range":{
"description":"The range covered by these commerce items",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
}
}
}
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a third party system.
Show Source
{
"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 : range
Type: object
The range covered by these commerce items
Show Source
{
"description":"The range covered by these commerce items",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"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
{
"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 : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
{
"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
{
"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
{
"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
{
"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: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"type":"number"
},
"displayName":{
"type":"string"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"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":{
"type":"number"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"type":"number"
},
"displayName":{
"type":"string"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"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":{
"type":"number"
}
}
}
Nested Schema : detailedItemPriceInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
}
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"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 : discountInfo
Type: array
The discount information.
Show Source
{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
}
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
}
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"quantityToReturn":{
"description":"Quantity shopper wants to return",
"type":"integer"
},
"quantityAvailable":{
"description":"Quantity available to return in cloud commerce",
"type":"integer"
},
"productId":{
"description":"Product Id",
"type":"string"
},
"nonreturnable":{
"description":"Non returnable flag as per CC",
"type":"boolean"
},
"shippingGroupId":{
"description":"Shipping Group Id",
"type":"string"
},
"childReturnItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childReturnItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"catalogRefId":{
"description":"Catalog Ref Id",
"type":"string"
},
"returnRequired":{
"description":"If return is required for the item",
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item Id",
"type":"string"
},
"quantityShipped":{
"description":"Total Quantity shipped in this order",
"type":"integer"
},
"shippable":{
"description":"Shippable flag if item is shippable",
"type":"string"
},
"returnReason":{
"description":"Return Reason shopper selected",
"type":"string"
},
"nonReturnableReason":{
"description":"Non Returnable Reason if it is nonreturnable in cc",
"type":"string"
}
}
}