Root Schema : getScheduledOrder_response
Type: object
Show Source
{
"properties":{
"endDate":{
"description":"Scheduled order end date.",
"type":"string"
},
"executionStatusList":{
"description":"The list of executions from this scheduled order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"errorMessages":{
"description":"The list of error messages for this execution.",
"type":"array",
"items":{
"type":"string"
}
},
"scheduledOrderId":{
"description":"Scheuduled Order ID to which the order submitted in this particular execution belongs.",
"type":"string"
},
"orderId":{
"description":"Order ID of the order submitted in that particular execution.",
"type":"string"
},
"repositoryId":{
"description":"The repository id of the execution status.",
"type":"string"
},
"executionDate":{
"description":"The execution date.",
"type":"string"
},
"currency":{
"description":"currency set for the scheduled order.",
"type":"string"
},
"id":{
"description":"ID of the execution status.",
"type":"string"
},
"orderSubmitted":{
"description":"The boolean indicating whether the order has been submitted successfully during the execution.",
"type":"boolean"
},
"orderTotal":{
"description":"Order total.",
"type":"number"
}
}
}
},
"lastScheduledRun":{
"description":"Last scheduled run date of the scheduled order.",
"type":"string"
},
"schedule":{
"description":"Schedule of this scheduled order",
"type":"object",
"properties":{
"daysInMonth":{
"description":"Days in a month this scheduled order has to be placed",
"type":"array",
"items":{
"type":"integer"
}
},
"period":{
"description":"The period of repeating of the Periodic Scheduled order in milliseconds.",
"type":"integer"
},
"delay":{
"description":"The delay of the first scheduled run after start date of the Periodic Scheduled order in milliseconds.",
"type":"integer"
},
"weeksInMonth":{
"description":"Weeks in a month this scheduled order has to be placed",
"type":"array",
"items":{
"type":"integer"
}
},
"monthsInYear":{
"description":"Months in a year this scheduled order has to be placed",
"type":"array",
"items":{
"type":"integer"
}
},
"daysOfWeek":{
"description":"Days in a week this scheduled order has to be placed",
"type":"array",
"items":{
"type":"integer"
}
},
"occurrenceInDay":{
"description":"The number of times this scheduled order is placed in a day",
"type":"integer"
}
}
},
"templateOrderId":{
"description":"The template order id.",
"type":"string"
},
"profileId":{
"description":"Profile ID of the shopper associated with the scheduled order.",
"type":"string"
},
"templateOrder":{
"description":"The template order details",
"type":"object",
"properties":{
"totalAmountAuthorized":{
"description":"total amount authorized for the order.",
"type":"number"
},
"orderComments":{
"description":"The list of all logged comments for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"The repository id of the comment record.",
"type":"string"
},
"comment":{
"description":"The comment string.",
"type":"string"
},
"creationDate":{
"description":"Date on which the comment was created.",
"type":"string"
}
}
}
},
"creationTime":{
"description":"Order creation time.",
"type":"number"
},
"dynamicProperties":{
"description":"Read-only list of dynamic properties for the order along with meta-data.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property.",
"type":"string"
}
}
}
},
"stateString":{
"description":"Order state as key string.",
"type":"string"
},
"submittedDate":{
"description":"Date on which the order was submitted.",
"type":"string"
},
"paymentGroups":{
"description":"List of payment Groups for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"lastName":{
"description":"Last name associated with this Payment Group.",
"type":"string"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"totalDue":{
"description":"The current working total order price including all discounts, tax, and billing costs.",
"type":"number"
},
"cardType":{
"description":"Payment method. e.g. physicalGiftCard/ creditCard",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
},
"paymentGroupId":{
"description":"Id of this payment Group.",
"type":"integer"
},
"paymentStateString":{
"description":"The payment state as a key String.",
"type":"string"
},
"firstName":{
"description":"First name associated with this Payment Group.",
"type":"string"
},
"paymentStateDetailsAsUser":{
"description":"The payment state description as string.",
"type":"string"
},
"balance":{
"description":"The gift card balance available.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
}
}
},
"paymentState":{
"description":"The Payment Group state.",
"type":"string"
},
"paidAmount":{
"description":"The amount that has been debited to-date for this Payment Group.",
"type":"number"
},
"cardNumber":{
"description":"The masked credit card number.",
"type":"string"
},
"refundAmount":{
"description":"The amount that has been credited to-date for this Payment Group.",
"type":"number"
}
}
}
},
"priceInfo":{
"description":"Price information of the order.",
"type":"object",
"properties":{
"amount":{
"description":"The raw number that represents the price.",
"type":"number"
},
"total":{
"description":"The current working total, including all promotions, tax, and billing costs.",
"type":"number"
},
"tax":{
"description":"The tax on the order.",
"type":"number"
},
"subTotal":{
"description":" The subtotal of the order before applying order-level promotions.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
},
"billing":{
"description":"The billing cost of the order.",
"type":"number"
}
}
},
"paymentGroup":{
"description":"Payment Group for the order.",
"type":"object",
"properties":{
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"lastName":{
"description":"Last name associated with this Payment Group.",
"type":"string"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"totalDue":{
"description":"The current working total order price including all discounts, tax, and billing costs.",
"type":"number"
},
"cardType":{
"description":"The credit card type.",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
},
"paymentGroupId":{
"description":"Id of this payment Group.",
"type":"integer"
},
"firstName":{
"description":"First name associated with this Payment Group.",
"type":"string"
},
"paymentStateDetailsAsUser":{
"description":"The payment state description as string.",
"type":"string"
},
"balance":{
"description":"The gift card balance available.",
"type":"string"
},
"paymentStatString":{
"description":"The payment state as a key string.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
}
}
},
"paymentState":{
"description":"The Payment Group state.",
"type":"string"
},
"paidAmount":{
"description":"The amount that has been debited to-date for this Payment Group.",
"type":"number"
},
"cardNumber":{
"description":"The masked credit card number.",
"type":"string"
},
"refundAmount":{
"description":"The amount that has been credited to-date for this Payment Group.",
"type":"number"
}
}
},
"shoppingCart":{
"description":"Shopping cart information.",
"type":"object",
"properties":{
"items":{
"description":"Items in the cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"returnedQuantity":{
"description":"Quantity for which return request has been raised.",
"type":"number"
},
"displayName":{
"description":"Display name of commerce item.",
"type":"string"
},
"priceOverridenBy":{
"description":"Name of the agent who has overridden item price.",
"type":"string"
},
"discountAmount":{
"description":"Total discount applied to commerce item.",
"type":"number"
},
"imageInfo":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"primaryThumbImageURL":{
"description":"ThumbNail Image URL",
"type":"string"
}
}
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"route":{
"description":"Product path",
"type":"string"
},
"productId":{
"description":"Product Id of the child item ",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"selectedOptions":{
"description":"Child Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
}
}
}
},
"subTotal":{
"description":"The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.",
"type":"number"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"externalPrice":{
"description":"The Price of the product as per the external pricing system.",
"type":"number"
},
"overriddenPrice":{
"description":"overridden price of commerce item.",
"type":"number"
},
"commerceItemId":{
"description":"Unique id of the line item",
"type":"string"
},
"price":{
"description":"The raw number that represents the price.",
"type":"number"
},
"isPriceOverridden":{
"description":"Indicates if commerce item price is overridden or not.",
"type":"boolean"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"onSale":{
"description":"indicates if product is on sale or not",
"type":"boolean"
},
"stateDetailsAsUser":{
"description":"State description of the commerce item.",
"type":"string"
},
"unitPrice":{
"description":"Sale price or list price of commerceItem.",
"type":"number"
},
"quantity":{
"description":"Quantity of the items.",
"type":"number"
},
"productId":{
"description":"Product Id of commerce item.",
"type":"string"
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by GWP.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this GWP promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion id.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
},
"tax":{
"description":"The amount of tax paid for this item.",
"type":"number"
},
"externalPriceQuantity":{
"description":"Quantity of the product, the customer is allowed to buy at the external price.",
"type":"integer"
},
"catRefId":{
"description":"Catalog Reference Id of commerce item.",
"type":"string"
},
"discountInfo":{
"description":"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":"Discount given on an order.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"unclaimedCouponsMap":{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
}
}
},
"stateDescription":{
"description":"Item state as a key string.",
"type":"string"
},
"status":{
"description":"State of the commerce item.",
"type":"integer"
},
"priceOverrideReason":{
"description":"Price override reason map.",
"type":"object",
"properties":{
"displayValue":{
"description":"price override reason value.",
"type":"string"
},
"key":{
"description":"price override reason key.",
"type":"string"
}
}
}
}
}
}
}
},
"id":{
"description":"Commerce id for this order.",
"type":"string"
},
"state":{
"description":"The order state.",
"type":"integer"
},
"stateDetailsAsUser":{
"description":"Order State description for this order.Incorporates changes made by merchant from admin UI, if any.",
"type":"string"
},
"taxPriceInfo":{
"description":"The tax pricing details for the order.",
"type":"object",
"properties":{
"cityTax":{
"description":"The monetary amount of city tax.",
"type":"number"
},
"discounted":{
"description":"Whether the price was discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"countyTax":{
"description":"The monetary amount of county tax.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"districtTax":{
"description":"Tax amount for the district.",
"type":"number"
},
"stateTax":{
"description":"Tax amount for the state.",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
},
"countryTax":{
"description":"The monetary amount of country tax.",
"type":"number"
}
}
},
"shippingGroups":{
"description":"Shipping Group Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"trackingInfo":{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier Id for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number",
"type":"string"
}
}
}
},
"shippingMethod":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment.",
"type":"string"
}
}
},
"shippingAddress":{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
}
}
},
"trackingNumber":{
"description":"Shipping tracking number.",
"type":"string"
}
}
}
},
"shippingMethod":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment",
"type":"string"
}
}
},
"isItemPriceOverrideAllowed":{
"description":"Indicates whether an item price can be overridden.",
"type":"boolean"
},
"billingMethod":{
"description":"billing Method information of the order.",
"type":"object",
"properties":{
"cost":{
"description":"billing Cost for this order.",
"type":"number"
},
"displayName":{
"description":"billing method display name for this billing method.",
"type":"string"
},
"value":{
"description":"billing method name for this order.",
"type":"string"
}
}
},
"profile":{
"description":"Profile Information for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name of profile.",
"type":"string"
},
"firstName":{
"description":"First name of profile.",
"type":"string"
},
"isAnonymous":{
"description":"Indicates whether this profile is an anonymous profile. By default, it is false.",
"type":"boolean"
},
"organization":{
"description":"The Organization associated with the B2B customer profile.",
"type":"object",
"properties":{
"name":{
"description":"The name of of the organization.",
"type":"string"
},
"id":{
"description":"The id of the organization.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name of profile.",
"type":"string"
},
"email":{
"description":"Email Address corresponding to the profile.",
"type":"string"
}
}
},
"priceListGroup":{
"description":"PriceList group of the order.",
"type":"object",
"properties":{
"deleted":{
"description":"Pricelist group deleted status.",
"type":"boolean"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"active":{
"description":"Active status of pricelist group.",
"type":"boolean"
},
"currency":{
"description":"Currency of the PriceList group.",
"type":"object",
"properties":{
"symbol":{
"description":"currency Symbol.",
"type":"string"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"fractionalDigits":{
"description":"Fractional Digits.",
"type":"integer"
},
"currencyCode":{
"description":"Currency Code.",
"type":"string"
},
"numericCode":{
"description":"Numeric Code.",
"type":"string"
}
}
},
"id":{
"description":"Id.",
"type":"string"
},
"locale":{
"description":"Locale.",
"type":"string"
}
}
},
"returnRequests":{
"description":"The list of the requests raised for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"returnRequestId":{
"description":"The return request id.",
"type":"string"
},
"createdDate":{
"description":"The creation date of the return request.",
"type":"string"
},
"totalRefund":{
"description":"The total amount to be refunded on return.",
"type":"number"
},
"state":{
"description":"The status of the return request.",
"type":"string"
},
"totalReturnQuantity":{
"description":"The total quantity for which return request has been raised.",
"type":"integer"
},
"stateKey":{
"description":"State key for return request which is not localized",
"type":"string"
}
}
}
},
"creationDate":{
"description":"Date on which the Order was created.",
"type":"string"
},
"discountInfo":{
"description":"Discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"description":"The coupons that were not claimed",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code, corresponding to which some promotions were not applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
},
"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":"Discount given on an order.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"unclaimedCouponsMap":{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
},
"claimedCouponMultiPromotions":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code, corresponding to which promotions were applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
}
}
},
"orderCancelReason":{
"description":"Reason through which the order has been cancelled.",
"type":"string"
},
"profileId":{
"description":"The Repository Id of the profile to which this Order belongs to.",
"type":"string"
},
"giftWithPurchaseInfo":{
"description":"The gift information.",
"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":"integer"
}
}
}
},
"shippingAddress":{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
}
}
},
"giftWithPurchaseOrderMarkers":{
"description":"gwpOrderMarker information",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"The total quantity of sku for this gift selection.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
"type":"integer"
},
"removedQuantity":{
"description":"The amount of free quantity that has since been manually removed by a Shopper.",
"type":"number"
},
"data":{
"description":"Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
},
"autoRemove":{
"description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
"type":"boolean"
},
"giftDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"automaticQuantity":{
"description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
"type":"number"
},
"giftType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"failedQuantity":{
"description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
}
}
},
"repositoryId":{
"description":"Repository ID of the scheduled order.",
"type":"string"
},
"name":{
"description":"Name of the Scheduled Order.",
"type":"string"
},
"nextScheduledRun":{
"description":"Next scheduled run date of the scheduled order.",
"type":"string"
},
"state":{
"description":"The state of the scheduled order.",
"type":"string"
},
"id":{
"description":"ID of the scheduled order.",
"type":"string"
},
"startDate":{
"description":"Scheduled Order start date.",
"type":"string"
},
"createDate":{
"description":"Scheduled Order creation date.",
"type":"string"
}
}
}
Nested Schema : executionStatusList
Type: array
The list of executions from this scheduled order.
Show Source
{
"description":"The list of executions from this scheduled order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"errorMessages":{
"description":"The list of error messages for this execution.",
"type":"array",
"items":{
"type":"string"
}
},
"scheduledOrderId":{
"description":"Scheuduled Order ID to which the order submitted in this particular execution belongs.",
"type":"string"
},
"orderId":{
"description":"Order ID of the order submitted in that particular execution.",
"type":"string"
},
"repositoryId":{
"description":"The repository id of the execution status.",
"type":"string"
},
"executionDate":{
"description":"The execution date.",
"type":"string"
},
"currency":{
"description":"currency set for the scheduled order.",
"type":"string"
},
"id":{
"description":"ID of the execution status.",
"type":"string"
},
"orderSubmitted":{
"description":"The boolean indicating whether the order has been submitted successfully during the execution.",
"type":"boolean"
},
"orderTotal":{
"description":"Order total.",
"type":"number"
}
}
}
}
Nested Schema : schedule
Type: object
Schedule of this scheduled order
Show Source
{
"description":"Schedule of this scheduled order",
"type":"object",
"properties":{
"daysInMonth":{
"description":"Days in a month this scheduled order has to be placed",
"type":"array",
"items":{
"type":"integer"
}
},
"period":{
"description":"The period of repeating of the Periodic Scheduled order in milliseconds.",
"type":"integer"
},
"delay":{
"description":"The delay of the first scheduled run after start date of the Periodic Scheduled order in milliseconds.",
"type":"integer"
},
"weeksInMonth":{
"description":"Weeks in a month this scheduled order has to be placed",
"type":"array",
"items":{
"type":"integer"
}
},
"monthsInYear":{
"description":"Months in a year this scheduled order has to be placed",
"type":"array",
"items":{
"type":"integer"
}
},
"daysOfWeek":{
"description":"Days in a week this scheduled order has to be placed",
"type":"array",
"items":{
"type":"integer"
}
},
"occurrenceInDay":{
"description":"The number of times this scheduled order is placed in a day",
"type":"integer"
}
}
}
Nested Schema : templateOrder
Type: object
The template order details
Show Source
{
"description":"The template order details",
"type":"object",
"properties":{
"totalAmountAuthorized":{
"description":"total amount authorized for the order.",
"type":"number"
},
"orderComments":{
"description":"The list of all logged comments for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"The repository id of the comment record.",
"type":"string"
},
"comment":{
"description":"The comment string.",
"type":"string"
},
"creationDate":{
"description":"Date on which the comment was created.",
"type":"string"
}
}
}
},
"creationTime":{
"description":"Order creation time.",
"type":"number"
},
"dynamicProperties":{
"description":"Read-only list of dynamic properties for the order along with meta-data.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property.",
"type":"string"
}
}
}
},
"stateString":{
"description":"Order state as key string.",
"type":"string"
},
"submittedDate":{
"description":"Date on which the order was submitted.",
"type":"string"
},
"paymentGroups":{
"description":"List of payment Groups for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"lastName":{
"description":"Last name associated with this Payment Group.",
"type":"string"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"totalDue":{
"description":"The current working total order price including all discounts, tax, and billing costs.",
"type":"number"
},
"cardType":{
"description":"Payment method. e.g. physicalGiftCard/ creditCard",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
},
"paymentGroupId":{
"description":"Id of this payment Group.",
"type":"integer"
},
"paymentStateString":{
"description":"The payment state as a key String.",
"type":"string"
},
"firstName":{
"description":"First name associated with this Payment Group.",
"type":"string"
},
"paymentStateDetailsAsUser":{
"description":"The payment state description as string.",
"type":"string"
},
"balance":{
"description":"The gift card balance available.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
}
}
},
"paymentState":{
"description":"The Payment Group state.",
"type":"string"
},
"paidAmount":{
"description":"The amount that has been debited to-date for this Payment Group.",
"type":"number"
},
"cardNumber":{
"description":"The masked credit card number.",
"type":"string"
},
"refundAmount":{
"description":"The amount that has been credited to-date for this Payment Group.",
"type":"number"
}
}
}
},
"priceInfo":{
"description":"Price information of the order.",
"type":"object",
"properties":{
"amount":{
"description":"The raw number that represents the price.",
"type":"number"
},
"total":{
"description":"The current working total, including all promotions, tax, and billing costs.",
"type":"number"
},
"tax":{
"description":"The tax on the order.",
"type":"number"
},
"subTotal":{
"description":" The subtotal of the order before applying order-level promotions.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
},
"billing":{
"description":"The billing cost of the order.",
"type":"number"
}
}
},
"paymentGroup":{
"description":"Payment Group for the order.",
"type":"object",
"properties":{
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"lastName":{
"description":"Last name associated with this Payment Group.",
"type":"string"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"totalDue":{
"description":"The current working total order price including all discounts, tax, and billing costs.",
"type":"number"
},
"cardType":{
"description":"The credit card type.",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
},
"paymentGroupId":{
"description":"Id of this payment Group.",
"type":"integer"
},
"firstName":{
"description":"First name associated with this Payment Group.",
"type":"string"
},
"paymentStateDetailsAsUser":{
"description":"The payment state description as string.",
"type":"string"
},
"balance":{
"description":"The gift card balance available.",
"type":"string"
},
"paymentStatString":{
"description":"The payment state as a key string.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
}
}
},
"paymentState":{
"description":"The Payment Group state.",
"type":"string"
},
"paidAmount":{
"description":"The amount that has been debited to-date for this Payment Group.",
"type":"number"
},
"cardNumber":{
"description":"The masked credit card number.",
"type":"string"
},
"refundAmount":{
"description":"The amount that has been credited to-date for this Payment Group.",
"type":"number"
}
}
},
"shoppingCart":{
"description":"Shopping cart information.",
"type":"object",
"properties":{
"items":{
"description":"Items in the cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"returnedQuantity":{
"description":"Quantity for which return request has been raised.",
"type":"number"
},
"displayName":{
"description":"Display name of commerce item.",
"type":"string"
},
"priceOverridenBy":{
"description":"Name of the agent who has overridden item price.",
"type":"string"
},
"discountAmount":{
"description":"Total discount applied to commerce item.",
"type":"number"
},
"imageInfo":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"primaryThumbImageURL":{
"description":"ThumbNail Image URL",
"type":"string"
}
}
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"route":{
"description":"Product path",
"type":"string"
},
"productId":{
"description":"Product Id of the child item ",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"selectedOptions":{
"description":"Child Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
}
}
}
},
"subTotal":{
"description":"The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.",
"type":"number"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"externalPrice":{
"description":"The Price of the product as per the external pricing system.",
"type":"number"
},
"overriddenPrice":{
"description":"overridden price of commerce item.",
"type":"number"
},
"commerceItemId":{
"description":"Unique id of the line item",
"type":"string"
},
"price":{
"description":"The raw number that represents the price.",
"type":"number"
},
"isPriceOverridden":{
"description":"Indicates if commerce item price is overridden or not.",
"type":"boolean"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"onSale":{
"description":"indicates if product is on sale or not",
"type":"boolean"
},
"stateDetailsAsUser":{
"description":"State description of the commerce item.",
"type":"string"
},
"unitPrice":{
"description":"Sale price or list price of commerceItem.",
"type":"number"
},
"quantity":{
"description":"Quantity of the items.",
"type":"number"
},
"productId":{
"description":"Product Id of commerce item.",
"type":"string"
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by GWP.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this GWP promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion id.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
},
"tax":{
"description":"The amount of tax paid for this item.",
"type":"number"
},
"externalPriceQuantity":{
"description":"Quantity of the product, the customer is allowed to buy at the external price.",
"type":"integer"
},
"catRefId":{
"description":"Catalog Reference Id of commerce item.",
"type":"string"
},
"discountInfo":{
"description":"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":"Discount given on an order.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"unclaimedCouponsMap":{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
}
}
},
"stateDescription":{
"description":"Item state as a key string.",
"type":"string"
},
"status":{
"description":"State of the commerce item.",
"type":"integer"
},
"priceOverrideReason":{
"description":"Price override reason map.",
"type":"object",
"properties":{
"displayValue":{
"description":"price override reason value.",
"type":"string"
},
"key":{
"description":"price override reason key.",
"type":"string"
}
}
}
}
}
}
}
},
"id":{
"description":"Commerce id for this order.",
"type":"string"
},
"state":{
"description":"The order state.",
"type":"integer"
},
"stateDetailsAsUser":{
"description":"Order State description for this order.Incorporates changes made by merchant from admin UI, if any.",
"type":"string"
},
"taxPriceInfo":{
"description":"The tax pricing details for the order.",
"type":"object",
"properties":{
"cityTax":{
"description":"The monetary amount of city tax.",
"type":"number"
},
"discounted":{
"description":"Whether the price was discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"countyTax":{
"description":"The monetary amount of county tax.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"districtTax":{
"description":"Tax amount for the district.",
"type":"number"
},
"stateTax":{
"description":"Tax amount for the state.",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
},
"countryTax":{
"description":"The monetary amount of country tax.",
"type":"number"
}
}
},
"shippingGroups":{
"description":"Shipping Group Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"trackingInfo":{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier Id for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number",
"type":"string"
}
}
}
},
"shippingMethod":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment.",
"type":"string"
}
}
},
"shippingAddress":{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
}
}
},
"trackingNumber":{
"description":"Shipping tracking number.",
"type":"string"
}
}
}
},
"shippingMethod":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment",
"type":"string"
}
}
},
"isItemPriceOverrideAllowed":{
"description":"Indicates whether an item price can be overridden.",
"type":"boolean"
},
"billingMethod":{
"description":"billing Method information of the order.",
"type":"object",
"properties":{
"cost":{
"description":"billing Cost for this order.",
"type":"number"
},
"displayName":{
"description":"billing method display name for this billing method.",
"type":"string"
},
"value":{
"description":"billing method name for this order.",
"type":"string"
}
}
},
"profile":{
"description":"Profile Information for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name of profile.",
"type":"string"
},
"firstName":{
"description":"First name of profile.",
"type":"string"
},
"isAnonymous":{
"description":"Indicates whether this profile is an anonymous profile. By default, it is false.",
"type":"boolean"
},
"organization":{
"description":"The Organization associated with the B2B customer profile.",
"type":"object",
"properties":{
"name":{
"description":"The name of of the organization.",
"type":"string"
},
"id":{
"description":"The id of the organization.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name of profile.",
"type":"string"
},
"email":{
"description":"Email Address corresponding to the profile.",
"type":"string"
}
}
},
"priceListGroup":{
"description":"PriceList group of the order.",
"type":"object",
"properties":{
"deleted":{
"description":"Pricelist group deleted status.",
"type":"boolean"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"active":{
"description":"Active status of pricelist group.",
"type":"boolean"
},
"currency":{
"description":"Currency of the PriceList group.",
"type":"object",
"properties":{
"symbol":{
"description":"currency Symbol.",
"type":"string"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"fractionalDigits":{
"description":"Fractional Digits.",
"type":"integer"
},
"currencyCode":{
"description":"Currency Code.",
"type":"string"
},
"numericCode":{
"description":"Numeric Code.",
"type":"string"
}
}
},
"id":{
"description":"Id.",
"type":"string"
},
"locale":{
"description":"Locale.",
"type":"string"
}
}
},
"returnRequests":{
"description":"The list of the requests raised for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"returnRequestId":{
"description":"The return request id.",
"type":"string"
},
"createdDate":{
"description":"The creation date of the return request.",
"type":"string"
},
"totalRefund":{
"description":"The total amount to be refunded on return.",
"type":"number"
},
"state":{
"description":"The status of the return request.",
"type":"string"
},
"totalReturnQuantity":{
"description":"The total quantity for which return request has been raised.",
"type":"integer"
},
"stateKey":{
"description":"State key for return request which is not localized",
"type":"string"
}
}
}
},
"creationDate":{
"description":"Date on which the Order was created.",
"type":"string"
},
"discountInfo":{
"description":"Discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"description":"The coupons that were not claimed",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code, corresponding to which some promotions were not applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
},
"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":"Discount given on an order.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"unclaimedCouponsMap":{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
},
"claimedCouponMultiPromotions":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code, corresponding to which promotions were applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
}
}
},
"orderCancelReason":{
"description":"Reason through which the order has been cancelled.",
"type":"string"
},
"profileId":{
"description":"The Repository Id of the profile to which this Order belongs to.",
"type":"string"
},
"giftWithPurchaseInfo":{
"description":"The gift information.",
"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":"integer"
}
}
}
},
"shippingAddress":{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
}
}
},
"giftWithPurchaseOrderMarkers":{
"description":"gwpOrderMarker information",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"The total quantity of sku for this gift selection.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
"type":"integer"
},
"removedQuantity":{
"description":"The amount of free quantity that has since been manually removed by a Shopper.",
"type":"number"
},
"data":{
"description":"Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
},
"autoRemove":{
"description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
"type":"boolean"
},
"giftDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"automaticQuantity":{
"description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
"type":"number"
},
"giftType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"failedQuantity":{
"description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"errorMessages":{
"description":"The list of error messages for this execution.",
"type":"array",
"items":{
"type":"string"
}
},
"scheduledOrderId":{
"description":"Scheuduled Order ID to which the order submitted in this particular execution belongs.",
"type":"string"
},
"orderId":{
"description":"Order ID of the order submitted in that particular execution.",
"type":"string"
},
"repositoryId":{
"description":"The repository id of the execution status.",
"type":"string"
},
"executionDate":{
"description":"The execution date.",
"type":"string"
},
"currency":{
"description":"currency set for the scheduled order.",
"type":"string"
},
"id":{
"description":"ID of the execution status.",
"type":"string"
},
"orderSubmitted":{
"description":"The boolean indicating whether the order has been submitted successfully during the execution.",
"type":"boolean"
},
"orderTotal":{
"description":"Order total.",
"type":"number"
}
}
}
Nested Schema : errorMessages
Type: array
The list of error messages for this execution.
Show Source
{
"description":"The list of error messages for this execution.",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : daysInMonth
Type: array
Days in a month this scheduled order has to be placed
Show Source
{
"description":"Days in a month this scheduled order has to be placed",
"type":"array",
"items":{
"type":"integer"
}
}
Nested Schema : daysOfWeek
Type: array
Days in a week this scheduled order has to be placed
Show Source
{
"description":"Days in a week this scheduled order has to be placed",
"type":"array",
"items":{
"type":"integer"
}
}
Nested Schema : monthsInYear
Type: array
Months in a year this scheduled order has to be placed
Show Source
{
"description":"Months in a year this scheduled order has to be placed",
"type":"array",
"items":{
"type":"integer"
}
}
Nested Schema : weeksInMonth
Type: array
Weeks in a month this scheduled order has to be placed
Show Source
{
"description":"Weeks in a month this scheduled order has to be placed",
"type":"array",
"items":{
"type":"integer"
}
}
Nested Schema : billingMethod
Type: object
billing Method information of the order.
Show Source
{
"description":"billing Method information of the order.",
"type":"object",
"properties":{
"cost":{
"description":"billing Cost for this order.",
"type":"number"
},
"displayName":{
"description":"billing method display name for this billing method.",
"type":"string"
},
"value":{
"description":"billing method name for this order.",
"type":"string"
}
}
}
Nested Schema : discountInfo
Type: object
Discount information.
Show Source
{
"description":"Discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"description":"The coupons that were not claimed",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code, corresponding to which some promotions were not applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
},
"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":"Discount given on an order.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"unclaimedCouponsMap":{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
},
"claimedCouponMultiPromotions":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code, corresponding to which promotions were applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
}
}
}
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
{
"description":"Read-only list of dynamic properties for the order along with meta-data.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property.",
"type":"string"
}
}
}
}
Nested Schema : giftWithPurchaseInfo
Type: array
The gift information.
Show Source
{
"description":"The gift information.",
"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":"integer"
}
}
}
}
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
gwpOrderMarker information
Show Source
{
"description":"gwpOrderMarker information",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"The total quantity of sku for this gift selection.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
"type":"integer"
},
"removedQuantity":{
"description":"The amount of free quantity that has since been manually removed by a Shopper.",
"type":"number"
},
"data":{
"description":"Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
},
"autoRemove":{
"description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
"type":"boolean"
},
"giftDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"automaticQuantity":{
"description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
"type":"number"
},
"giftType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"failedQuantity":{
"description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
}
Nested Schema : paymentGroup
Type: object
Payment Group for the order.
Show Source
{
"description":"Payment Group for the order.",
"type":"object",
"properties":{
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"lastName":{
"description":"Last name associated with this Payment Group.",
"type":"string"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"totalDue":{
"description":"The current working total order price including all discounts, tax, and billing costs.",
"type":"number"
},
"cardType":{
"description":"The credit card type.",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
},
"paymentGroupId":{
"description":"Id of this payment Group.",
"type":"integer"
},
"firstName":{
"description":"First name associated with this Payment Group.",
"type":"string"
},
"paymentStateDetailsAsUser":{
"description":"The payment state description as string.",
"type":"string"
},
"balance":{
"description":"The gift card balance available.",
"type":"string"
},
"paymentStatString":{
"description":"The payment state as a key string.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
}
}
},
"paymentState":{
"description":"The Payment Group state.",
"type":"string"
},
"paidAmount":{
"description":"The amount that has been debited to-date for this Payment Group.",
"type":"number"
},
"cardNumber":{
"description":"The masked credit card number.",
"type":"string"
},
"refundAmount":{
"description":"The amount that has been credited to-date for this Payment Group.",
"type":"number"
}
}
}
Nested Schema : paymentGroups
Type: array
List of payment Groups for the order.
Show Source
{
"description":"List of payment Groups for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"lastName":{
"description":"Last name associated with this Payment Group.",
"type":"string"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"totalDue":{
"description":"The current working total order price including all discounts, tax, and billing costs.",
"type":"number"
},
"cardType":{
"description":"Payment method. e.g. physicalGiftCard/ creditCard",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
},
"paymentGroupId":{
"description":"Id of this payment Group.",
"type":"integer"
},
"paymentStateString":{
"description":"The payment state as a key String.",
"type":"string"
},
"firstName":{
"description":"First name associated with this Payment Group.",
"type":"string"
},
"paymentStateDetailsAsUser":{
"description":"The payment state description as string.",
"type":"string"
},
"balance":{
"description":"The gift card balance available.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
}
}
},
"paymentState":{
"description":"The Payment Group state.",
"type":"string"
},
"paidAmount":{
"description":"The amount that has been debited to-date for this Payment Group.",
"type":"number"
},
"cardNumber":{
"description":"The masked credit card number.",
"type":"string"
},
"refundAmount":{
"description":"The amount that has been credited to-date for this Payment Group.",
"type":"number"
}
}
}
}
Nested Schema : priceInfo
Type: object
Price information of the order.
Show Source
{
"description":"Price information of the order.",
"type":"object",
"properties":{
"amount":{
"description":"The raw number that represents the price.",
"type":"number"
},
"total":{
"description":"The current working total, including all promotions, tax, and billing costs.",
"type":"number"
},
"tax":{
"description":"The tax on the order.",
"type":"number"
},
"subTotal":{
"description":" The subtotal of the order before applying order-level promotions.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
},
"billing":{
"description":"The billing cost of the order.",
"type":"number"
}
}
}
Nested Schema : priceListGroup
Type: object
PriceList group of the order.
Show Source
{
"description":"PriceList group of the order.",
"type":"object",
"properties":{
"deleted":{
"description":"Pricelist group deleted status.",
"type":"boolean"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"active":{
"description":"Active status of pricelist group.",
"type":"boolean"
},
"currency":{
"description":"Currency of the PriceList group.",
"type":"object",
"properties":{
"symbol":{
"description":"currency Symbol.",
"type":"string"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"fractionalDigits":{
"description":"Fractional Digits.",
"type":"integer"
},
"currencyCode":{
"description":"Currency Code.",
"type":"string"
},
"numericCode":{
"description":"Numeric Code.",
"type":"string"
}
}
},
"id":{
"description":"Id.",
"type":"string"
},
"locale":{
"description":"Locale.",
"type":"string"
}
}
}
Nested Schema : profile
Type: object
Profile Information for the order.
Show Source
{
"description":"Profile Information for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name of profile.",
"type":"string"
},
"firstName":{
"description":"First name of profile.",
"type":"string"
},
"isAnonymous":{
"description":"Indicates whether this profile is an anonymous profile. By default, it is false.",
"type":"boolean"
},
"organization":{
"description":"The Organization associated with the B2B customer profile.",
"type":"object",
"properties":{
"name":{
"description":"The name of of the organization.",
"type":"string"
},
"id":{
"description":"The id of the organization.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name of profile.",
"type":"string"
},
"email":{
"description":"Email Address corresponding to the profile.",
"type":"string"
}
}
}
Nested Schema : returnRequests
Type: array
The list of the requests raised for the order.
Show Source
{
"description":"The list of the requests raised for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"returnRequestId":{
"description":"The return request id.",
"type":"string"
},
"createdDate":{
"description":"The creation date of the return request.",
"type":"string"
},
"totalRefund":{
"description":"The total amount to be refunded on return.",
"type":"number"
},
"state":{
"description":"The status of the return request.",
"type":"string"
},
"totalReturnQuantity":{
"description":"The total quantity for which return request has been raised.",
"type":"integer"
},
"stateKey":{
"description":"State key for return request which is not localized",
"type":"string"
}
}
}
}
Nested Schema : shippingAddress
Type: object
shipping address for the order.
Show Source
{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
}
}
}
Nested Schema : shippingGroups
Type: array
Shipping Group Information
Show Source
{
"description":"Shipping Group Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"trackingInfo":{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier Id for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number",
"type":"string"
}
}
}
},
"shippingMethod":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment.",
"type":"string"
}
}
},
"shippingAddress":{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
}
}
},
"trackingNumber":{
"description":"Shipping tracking number.",
"type":"string"
}
}
}
}
Nested Schema : shippingMethod
Type: object
Shipping method information.
Show Source
{
"description":"Shipping method information.",
"type":"object",
"properties":{
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment",
"type":"string"
}
}
}
Nested Schema : shoppingCart
Type: object
Shopping cart information.
Show Source
{
"description":"Shopping cart information.",
"type":"object",
"properties":{
"items":{
"description":"Items in the cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"returnedQuantity":{
"description":"Quantity for which return request has been raised.",
"type":"number"
},
"displayName":{
"description":"Display name of commerce item.",
"type":"string"
},
"priceOverridenBy":{
"description":"Name of the agent who has overridden item price.",
"type":"string"
},
"discountAmount":{
"description":"Total discount applied to commerce item.",
"type":"number"
},
"imageInfo":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"primaryThumbImageURL":{
"description":"ThumbNail Image URL",
"type":"string"
}
}
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"route":{
"description":"Product path",
"type":"string"
},
"productId":{
"description":"Product Id of the child item ",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"selectedOptions":{
"description":"Child Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
}
}
}
},
"subTotal":{
"description":"The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.",
"type":"number"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"externalPrice":{
"description":"The Price of the product as per the external pricing system.",
"type":"number"
},
"overriddenPrice":{
"description":"overridden price of commerce item.",
"type":"number"
},
"commerceItemId":{
"description":"Unique id of the line item",
"type":"string"
},
"price":{
"description":"The raw number that represents the price.",
"type":"number"
},
"isPriceOverridden":{
"description":"Indicates if commerce item price is overridden or not.",
"type":"boolean"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"onSale":{
"description":"indicates if product is on sale or not",
"type":"boolean"
},
"stateDetailsAsUser":{
"description":"State description of the commerce item.",
"type":"string"
},
"unitPrice":{
"description":"Sale price or list price of commerceItem.",
"type":"number"
},
"quantity":{
"description":"Quantity of the items.",
"type":"number"
},
"productId":{
"description":"Product Id of commerce item.",
"type":"string"
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by GWP.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this GWP promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion id.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
},
"tax":{
"description":"The amount of tax paid for this item.",
"type":"number"
},
"externalPriceQuantity":{
"description":"Quantity of the product, the customer is allowed to buy at the external price.",
"type":"integer"
},
"catRefId":{
"description":"Catalog Reference Id of commerce item.",
"type":"string"
},
"discountInfo":{
"description":"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":"Discount given on an order.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"unclaimedCouponsMap":{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
}
}
},
"stateDescription":{
"description":"Item state as a key string.",
"type":"string"
},
"status":{
"description":"State of the commerce item.",
"type":"integer"
},
"priceOverrideReason":{
"description":"Price override reason map.",
"type":"object",
"properties":{
"displayValue":{
"description":"price override reason value.",
"type":"string"
},
"key":{
"description":"price override reason key.",
"type":"string"
}
}
}
}
}
}
}
}
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order.
Show Source
{
"description":"The tax pricing details for the order.",
"type":"object",
"properties":{
"cityTax":{
"description":"The monetary amount of city tax.",
"type":"number"
},
"discounted":{
"description":"Whether the price was discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"countyTax":{
"description":"The monetary amount of county tax.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"districtTax":{
"description":"Tax amount for the district.",
"type":"number"
},
"stateTax":{
"description":"Tax amount for the state.",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
},
"countryTax":{
"description":"The monetary amount of country tax.",
"type":"number"
}
}
}
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 : orderImplicitDiscountList
Type: array
List of discounts.
Show Source
{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
}
Nested Schema : unclaimedCouponsMap
Type: array
Map of unclaimed coupons.
Show Source
{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for 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
Show Source
{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
Nested Schema : couponInfo
Type: array
The coupon Info.
Show Source
{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property.",
"type":"string"
}
}
}
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":"integer"
}
}
}
Nested Schema : items
Type: object
Show Source
-
automaticQuantity:
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove:
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data:
integer
Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
failedQuantity:
number
The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
-
giftDetail:
string
String identifying the free gift, usually the repository id of the gift type.
-
giftType:
string
The type of the gift. (sku, product)
-
key:
string
-
quantity:
number
The total quantity of sku for this gift selection.
-
removedQuantity:
number
The amount of free quantity that has since been manually removed by a Shopper.
-
selectedQuantity:
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity:
number
The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
-
value:
string
The gift with purchase promotion id
{
"type":"object",
"properties":{
"quantity":{
"description":"The total quantity of sku for this gift selection.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
"type":"integer"
},
"removedQuantity":{
"description":"The amount of free quantity that has since been manually removed by a Shopper.",
"type":"number"
},
"data":{
"description":"Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
},
"autoRemove":{
"description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
"type":"boolean"
},
"giftDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"automaticQuantity":{
"description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
"type":"number"
},
"giftType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"failedQuantity":{
"description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
Nested Schema : billingAddress
Type: object
Billing address for the order.
Show Source
{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"lastName":{
"description":"Last name associated with this Payment Group.",
"type":"string"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"totalDue":{
"description":"The current working total order price including all discounts, tax, and billing costs.",
"type":"number"
},
"cardType":{
"description":"Payment method. e.g. physicalGiftCard/ creditCard",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
},
"paymentGroupId":{
"description":"Id of this payment Group.",
"type":"integer"
},
"paymentStateString":{
"description":"The payment state as a key String.",
"type":"string"
},
"firstName":{
"description":"First name associated with this Payment Group.",
"type":"string"
},
"paymentStateDetailsAsUser":{
"description":"The payment state description as string.",
"type":"string"
},
"balance":{
"description":"The gift card balance available.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
}
}
},
"paymentState":{
"description":"The Payment Group state.",
"type":"string"
},
"paidAmount":{
"description":"The amount that has been debited to-date for this Payment Group.",
"type":"number"
},
"cardNumber":{
"description":"The masked credit card number.",
"type":"string"
},
"refundAmount":{
"description":"The amount that has been credited to-date for this Payment Group.",
"type":"number"
}
}
}
Nested Schema : billingAddress
Type: object
Billing address for the order.
Show Source
{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
}
}
}
Nested Schema : currency
Type: object
Currency of the PriceList group.
Show Source
{
"description":"Currency of the PriceList group.",
"type":"object",
"properties":{
"symbol":{
"description":"currency Symbol.",
"type":"string"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"fractionalDigits":{
"description":"Fractional Digits.",
"type":"integer"
},
"currencyCode":{
"description":"Currency Code.",
"type":"string"
},
"numericCode":{
"description":"Numeric Code.",
"type":"string"
}
}
}
Nested Schema : organization
Type: object
The Organization associated with the B2B customer profile.
Show Source
{
"description":"The Organization associated with the B2B customer profile.",
"type":"object",
"properties":{
"name":{
"description":"The name of of the organization.",
"type":"string"
},
"id":{
"description":"The id of the organization.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"returnRequestId":{
"description":"The return request id.",
"type":"string"
},
"createdDate":{
"description":"The creation date of the return request.",
"type":"string"
},
"totalRefund":{
"description":"The total amount to be refunded on return.",
"type":"number"
},
"state":{
"description":"The status of the return request.",
"type":"string"
},
"totalReturnQuantity":{
"description":"The total quantity for which return request has been raised.",
"type":"integer"
},
"stateKey":{
"description":"State key for return request which is not localized",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"trackingInfo":{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier Id for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number",
"type":"string"
}
}
}
},
"shippingMethod":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment.",
"type":"string"
}
}
},
"shippingAddress":{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
}
}
},
"trackingNumber":{
"description":"Shipping tracking number.",
"type":"string"
}
}
}
Nested Schema : shippingAddress
Type: object
shipping address for the order.
Show Source
{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
}
}
}
Nested Schema : shippingMethod
Type: object
Shipping method information.
Show Source
{
"description":"Shipping method information.",
"type":"object",
"properties":{
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment.",
"type":"string"
}
}
}
Nested Schema : trackingInfo
Type: array
Tracking Information for the Order.
Show Source
{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier Id for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier Id for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number",
"type":"string"
}
}
}
Nested Schema : items
Type: array
Items in the cart.
Show Source
{
"description":"Items in the cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"returnedQuantity":{
"description":"Quantity for which return request has been raised.",
"type":"number"
},
"displayName":{
"description":"Display name of commerce item.",
"type":"string"
},
"priceOverridenBy":{
"description":"Name of the agent who has overridden item price.",
"type":"string"
},
"discountAmount":{
"description":"Total discount applied to commerce item.",
"type":"number"
},
"imageInfo":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"primaryThumbImageURL":{
"description":"ThumbNail Image URL",
"type":"string"
}
}
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"route":{
"description":"Product path",
"type":"string"
},
"productId":{
"description":"Product Id of the child item ",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"selectedOptions":{
"description":"Child Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
}
}
}
},
"subTotal":{
"description":"The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.",
"type":"number"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"externalPrice":{
"description":"The Price of the product as per the external pricing system.",
"type":"number"
},
"overriddenPrice":{
"description":"overridden price of commerce item.",
"type":"number"
},
"commerceItemId":{
"description":"Unique id of the line item",
"type":"string"
},
"price":{
"description":"The raw number that represents the price.",
"type":"number"
},
"isPriceOverridden":{
"description":"Indicates if commerce item price is overridden or not.",
"type":"boolean"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"onSale":{
"description":"indicates if product is on sale or not",
"type":"boolean"
},
"stateDetailsAsUser":{
"description":"State description of the commerce item.",
"type":"string"
},
"unitPrice":{
"description":"Sale price or list price of commerceItem.",
"type":"number"
},
"quantity":{
"description":"Quantity of the items.",
"type":"number"
},
"productId":{
"description":"Product Id of commerce item.",
"type":"string"
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by GWP.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this GWP promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion id.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
},
"tax":{
"description":"The amount of tax paid for this item.",
"type":"number"
},
"externalPriceQuantity":{
"description":"Quantity of the product, the customer is allowed to buy at the external price.",
"type":"integer"
},
"catRefId":{
"description":"Catalog Reference Id of commerce item.",
"type":"string"
},
"discountInfo":{
"description":"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":"Discount given on an order.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"unclaimedCouponsMap":{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
}
}
},
"stateDescription":{
"description":"Item state as a key string.",
"type":"string"
},
"status":{
"description":"State of the commerce item.",
"type":"integer"
},
"priceOverrideReason":{
"description":"Price override reason map.",
"type":"object",
"properties":{
"displayValue":{
"description":"price override reason value.",
"type":"string"
},
"key":{
"description":"price override reason key.",
"type":"string"
}
}
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"returnedQuantity":{
"description":"Quantity for which return request has been raised.",
"type":"number"
},
"displayName":{
"description":"Display name of commerce item.",
"type":"string"
},
"priceOverridenBy":{
"description":"Name of the agent who has overridden item price.",
"type":"string"
},
"discountAmount":{
"description":"Total discount applied to commerce item.",
"type":"number"
},
"imageInfo":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"primaryThumbImageURL":{
"description":"ThumbNail Image URL",
"type":"string"
}
}
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"route":{
"description":"Product path",
"type":"string"
},
"productId":{
"description":"Product Id of the child item ",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"selectedOptions":{
"description":"Child Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
}
}
}
},
"subTotal":{
"description":"The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.",
"type":"number"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"externalPrice":{
"description":"The Price of the product as per the external pricing system.",
"type":"number"
},
"overriddenPrice":{
"description":"overridden price of commerce item.",
"type":"number"
},
"commerceItemId":{
"description":"Unique id of the line item",
"type":"string"
},
"price":{
"description":"The raw number that represents the price.",
"type":"number"
},
"isPriceOverridden":{
"description":"Indicates if commerce item price is overridden or not.",
"type":"boolean"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"onSale":{
"description":"indicates if product is on sale or not",
"type":"boolean"
},
"stateDetailsAsUser":{
"description":"State description of the commerce item.",
"type":"string"
},
"unitPrice":{
"description":"Sale price or list price of commerceItem.",
"type":"number"
},
"quantity":{
"description":"Quantity of the items.",
"type":"number"
},
"productId":{
"description":"Product Id of commerce item.",
"type":"string"
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by GWP.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this GWP promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion id.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
},
"tax":{
"description":"The amount of tax paid for this item.",
"type":"number"
},
"externalPriceQuantity":{
"description":"Quantity of the product, the customer is allowed to buy at the external price.",
"type":"integer"
},
"catRefId":{
"description":"Catalog Reference Id of commerce item.",
"type":"string"
},
"discountInfo":{
"description":"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":"Discount given on an order.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"unclaimedCouponsMap":{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
}
}
},
"stateDescription":{
"description":"Item state as a key string.",
"type":"string"
},
"status":{
"description":"State of the commerce item.",
"type":"integer"
},
"priceOverrideReason":{
"description":"Price override reason map.",
"type":"object",
"properties":{
"displayValue":{
"description":"price override reason value.",
"type":"string"
},
"key":{
"description":"price override reason key.",
"type":"string"
}
}
}
}
}
Nested Schema : discountInfo
Type: object
Discount information.
Show Source
{
"description":"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":"Discount given on an order.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"unclaimedCouponsMap":{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
}
}
}