getOrder
get
                    /ccagent/v1/orders/{id}
Get Order. Loads an order details from the repository. Maps all required fields for order details.  Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.
                Request
Supported Media Types
                - application/json
Path Parameters
                - 
                    id: string
                    
                    Commerce id of order.
Query Parameters
                - 
                        includeResult(optional): string
                        
                        It is "full" if full result is to be included.
Header Parameters
                - 
                        X-CCOrganization(optional): string
                        
                        the organization Id in which order should be created
Response
Supported Media Types
                - application/json
200 Response
Following model is returned when operation succeeds.
                
                
                    Root Schema : getOrder_response
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            allowAlternateCurrency(optional): 
            boolean
            A site level setting which enables the shopper to split the payment amount in points and monetary currency, irrespective of the order level price list group.
- 
            approvalSystemMessages(optional): 
            array  approvalSystemMessages
            
            An array of approval messages when order going in pending approval state
- 
            approverMessages(optional): 
            array  approverMessages
            
            An array of approval messages when approver approving order
- 
            approvers(optional): 
            array  approvers
            
            List of approvers of the organization.
- 
            billingAddress(optional): 
            object  billingAddress
            
            The billing address details.
- 
            cartName(optional): 
            string
            Cart name for this order.
- 
            creationDate(optional): 
            string
            The creation date in ISO format.
- 
            creationSiteId(optional): 
            string
            The ID of the site on which the order was created. This may differ to siteId value if the site is part of a cart sharing group.
- 
            creationTime(optional): 
            number
            The creation time in long seconds.
- 
            discountInfo(optional): 
            object  discountInfo
            
            The discount information.
- 
            dynamicProperties(optional): 
            array  dynamicProperties
            
            Read-only list of dynamic properties for the order along with meta-data.
- 
            exchangeRate(optional): 
            number
            The coversion rate used to convert values from primary currency to secondary currency. Primary currency refers to to currency code associated with the order level price list group.
- 
            giftWithPurchaseInfo(optional): 
            array  giftWithPurchaseInfo
            
            The gift information.
- 
            giftWithPurchaseOrderMarkers(optional): 
            array  giftWithPurchaseOrderMarkers
            
            gift with purchase order marker information
- 
            id(optional): 
            string
            The order ID.
- 
            lastModifiedDate(optional): 
            string
            The order recent modified date in ISO format.
- 
            orderAction(optional): 
            string
            The action performed on the order.
- 
            orderLocale(optional): 
            string
            The locale in which order submitted.
- 
            orderProfileId(optional): 
            string
            The profile-id of the order.
- 
            orderStatus(optional): 
            string
            Status of the order.
- 
            paymentGroupId(optional): 
            string
            The payment group ID used for the order.
- 
            payments(optional): 
            array  payments
            
            Payment details for the order, including additional properties specific to the payment type.
- 
            payShippingInSecondaryCurrency(optional): 
            boolean
            A site level setting, when enabled, makes it mandatory for the shopper to pay Shipping in monetary currency. Additionally, if the allowAlternateCurrency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.
- 
            payTaxInSecondaryCurrency(optional): 
            boolean
            A site level setting, when enabled, makes it mandatory for the shopper to pay tax in monetary currency. Additionally, if the allowAlternateCurrency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.
- 
            priceInfo(optional): 
            object  priceInfo
            
            The price information.
- 
            priceListGroup(optional): 
            object  priceListGroup
            
            The price list group object.
- 
            quoteInfo(optional): 
            object  quoteInfo
            
            the quote information of the order
- 
            recurringChargePriceInfo(optional): 
            object  recurringChargePriceInfo
            
            Recurring charge price information.
- 
            scheduledOrder(optional): 
            array  scheduledOrder
            
            schedule order information
- 
            secondaryCurrencyCode(optional): 
            string
            The currency code of secondary currency associated with the site.
- 
            shippingAddress(optional): 
            object  shippingAddress
            
            The shipping address details.
- 
            shippingGroups(optional): 
            array  shippingGroups
            
            The shipping groups for the order.
- 
            shippingMethod(optional): 
            object  shippingMethod
            
            The shipping method details for the order.
- 
            shoppingCart/order(optional): 
            object  shoppingCart/order
            
            The shopping-cart or order contents of the current order.
- 
            siteId(optional): 
            string
            The ID of the site on which the order was placed.
- 
            sourceSystem(optional): 
            string
            The system where the order originated.
- 
            submittedDate(optional): 
            string
            The order submitted date in ISO format.
- 
            trackingInfo(optional): 
            array  trackingInfo
            
            Tracking Information for the Order.
- 
            uuid(optional): 
            string
            The unique ID for the order.
Nested Schema : approvalSystemMessages
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayAn array of approval messages when order going in pending approval state
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : approverMessages
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayAn array of approval messages when approver approving order
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : billingAddress
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe billing address details.
    
    
    
    
        Show Source
        - 
            address1(optional): 
            string
            Address snippet.
- 
            address2(optional): 
            string
            Address snippet.
- 
            address3(optional): 
            string
            Address snippet.
- 
            alias(optional): 
            string
            Address alias.
- 
            city(optional): 
            string
            City.
- 
            companyName(optional): 
            string
            Company name.
- 
            country(optional): 
            string
            Country.
- 
            county(optional): 
            string
            County.
- 
            email(optional): 
            string
            Email address.
- 
            faxNumber(optional): 
            string
            Fax number.
- 
            firstName(optional): 
            string
            First name.
- 
            jobTitle(optional): 
            string
            Job title.
- 
            lastName(optional): 
            string
            Last name.
- 
            middleName(optional): 
            string
            Middle name.
- 
            phoneNumber(optional): 
            string
            Phone number.
- 
            postalCode(optional): 
            string
            Postal code.
- 
            prefix(optional): 
            string
            Name prefix.
- 
            selectedCountry(optional): 
            string
            Country code.
- 
            selectedState(optional): 
            string
            State code.
- 
            state(optional): 
            string
            State.
- 
            state_ISOCode(optional): 
            string
            State ISO code.
- 
            suffix(optional): 
            string
            Name suffix.
Nested Schema : discountInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe discount information.
    
    
    
    
        Show Source
        - 
            claimedCouponMultiPromotions(optional): 
            object  claimedCouponMultiPromotions
            
            The coupons that were claimed.
- 
            orderCouponsMap(optional): 
            object  orderCouponsMap
            
            The coupons that were claimed.
- 
            orderDiscount(optional): 
            number
            The order discount.
- 
            orderImplicitDiscountList(optional): 
            array  orderImplicitDiscountList
            
            The implicit order discounts with the order.
- 
            shippingDiscount(optional): 
            number
            The shipping discount.
- 
            unclaimedCouponMultiPromotions(optional): 
            object  unclaimedCouponMultiPromotions
            
            The coupons that were not claimed
- 
            unclaimedCouponsMap(optional): 
            object  unclaimedCouponsMap
            
            The unclaimed coupons with the order.
Nested Schema : dynamicProperties
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayRead-only list of dynamic properties for the order along with meta-data.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : giftWithPurchaseOrderMarkers
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arraygift with purchase order marker information
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : payments
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayPayment details for the order, including additional properties specific to the payment type.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : priceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe price information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The total order amount.
- 
            currencyCode(optional): 
            string
            The currency code.
- 
            orderTotalBySite(optional): 
            object  orderTotalBySite
            
            The map containing order totals by site for all sites in a given order.
- 
            primaryCurrencyTotal(optional): 
            number
            The current total in loyalty points in case of multi currency
- 
            secondaryCurrencyShippingAmount(optional): 
            number
            The current total shipping amount in monetry currency
- 
            secondaryCurrencyShippingSurchargeValue(optional): 
            number
            Extra handling costs for shipping the products in monetry currency.
- 
            secondaryCurrencyTaxAmount(optional): 
            number
            This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency.Prerequisites for the value in this Attribute: 
 1. PriceList configured for the site is in Monetary Currency.2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled 3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary currency. 
- 
            secondaryCurrencyTotal(optional): 
            number
            The current total (sum ofshipping and tax)amount in monetry currency
- 
            shipping(optional): 
            number
            The total shipping cost.
- 
            shippingSurchargeValue(optional): 
            number
            Extra handling costs for shipping the products.
- 
            subTotal(optional): 
            number
            Sub-total.
- 
            tax(optional): 
            number
            The total tax amount.
- 
            taxExclusiveAmount(optional): 
            number
            Total excluding shipping and tax in monetary currency
- 
            total(optional): 
            number
            The order total.
Nested Schema : priceListGroup
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe price list group object.
    
    
    
    
        Show Source
        - 
            repositoryId(optional): 
            string
            Repository ID of the price list group.
Nested Schema : quoteInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectthe quote information of the order
    
    
    
    
        Show Source
        - 
            errorInfo(optional): 
            array  errorInfo
            
            the array of errors, if any
- 
            expirationDate(optional): 
            string
            the expiration date of the quoted order, if any
- 
            externalId(optional): 
            string
            the external ID for the quote
- 
            notes(optional): 
            array  notes
            
            the notes (history) for the order
- 
            providerNote(optional): 
            string
            the provider note for the quoted order
- 
            quoteDate(optional): 
            number
            the date the order was quoted in milliseconds
- 
            rejectionDate(optional): 
            string
            rejection date of the quoted order
- 
            rejectionNote(optional): 
            string
            the rejection note for an order whose quote has been rejected by user
- 
            requestDate(optional): 
            string
            the date when the quote was requested in ISO format
Nested Schema : recurringChargePriceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectRecurring charge price information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The monetary amount of this recurring charge.
- 
            currencyCode(optional): 
            string
            The currency code for the monetary amounts. A three character currency code such as USD.
- 
            frequencyAmountTotals(optional): 
            array  frequencyAmountTotals
            
            The total for each recurring charge frequency
- 
            frequencyTaxTotals(optional): 
            array  frequencyTaxTotals
            
            The tax for each recurring charge frequency
- 
            shipping(optional): 
            number
            Cost of shipping the product.
- 
            subTotal(optional): 
            number
            The sub-total price of the recurring charge.
- 
            tax(optional): 
            number
            Monetary tax amount.
- 
            total(optional): 
            number
            The total price of the recurring charge.
- 
            totalWithoutTax(optional): 
            number
            Total of recurring amount without tax included.
Nested Schema : shippingAddress
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe shipping address details.
    
    
    
    
        Show Source
        - 
            address1(optional): 
            string
            Address snippet.
- 
            address2(optional): 
            string
            Address snippet.
- 
            address3(optional): 
            string
            Address snippet.
- 
            alias(optional): 
            string
            Address alias.
- 
            city(optional): 
            string
            City.
- 
            companyName(optional): 
            string
            Company name.
- 
            country(optional): 
            string
            Country.
- 
            county(optional): 
            string
            County.
- 
            email(optional): 
            string
            Email address.
- 
            faxNumber(optional): 
            string
            Fax number.
- 
            firstName(optional): 
            string
            First name.
- 
            jobTitle(optional): 
            string
            Job title.
- 
            lastName(optional): 
            string
            Last name.
- 
            middleName(optional): 
            string
            Middle name.
- 
            phoneNumber(optional): 
            string
            Phone number.
- 
            postalCode(optional): 
            string
            Postal code.
- 
            prefix(optional): 
            string
            Name prefix.
- 
            selectedCountry(optional): 
            string
            Country code.
- 
            selectedState(optional): 
            string
            State code.
- 
            state(optional): 
            string
            State.
- 
            state_ISOCode(optional): 
            string
            State ISO code.
- 
            suffix(optional): 
            string
            Name suffix.
Nested Schema : shippingMethod
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe shipping method details for the order.
    
    
    
    
        Show Source
        - 
            cost(optional): 
            number
            The total cost of shipping.
- 
            value(optional): 
            string
            The shipping method applied to the order.
Nested Schema : shoppingCart/order
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe shopping-cart or order contents of the current order.
    
    
    
    
        Show Source
        - 
            items(optional): 
            array  items
            
            The array of products in the shopping cart.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            approverId(optional): 
            string
            ID of approver.
- 
            firstName(optional): 
            string
            First name of approver.
- 
            lastName(optional): 
            string
            Last name of approver.
Nested Schema : claimedCouponMultiPromotions
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe coupons that were claimed.
    
    
    
    
        Show Source
        - 
            couponCode(optional): 
            array  couponCode
            
            Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe coupons that were claimed.
    
    
    
    
        Show Source
        - 
            couponCode(optional): 
            object  couponCode
            
            Coupon Code.
Nested Schema : orderImplicitDiscountList
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe implicit order discounts with the order.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : unclaimedCouponMultiPromotions
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe coupons that were not claimed
    
    
    
    
        Show Source
        - 
            couponCode(optional): 
            array  couponCode
            
            Coupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe unclaimed coupons with the order.
    
    
    
    
        Show Source
        - 
            couponCode(optional): 
            array  couponCode
            
            Coupon Code, corresponding to which some promotions were not applied
Nested Schema : couponCode
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayCoupon Code, corresponding to which promotions were applied
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            external(optional): 
            boolean
            States whether this promotion was applied by an external system (only present on external promotions).
- 
            promotionDesc(optional): 
            string
            Description of the promotion. Retained for backward compatibility.
- 
            promotionId(optional): 
            string
            The Id of the promotion.
- 
            promotionLevel(optional): 
            string
            The promotion level.
- 
            promotionLongDesc(optional): 
            string
            The description of the promotion.
- 
            promotionName(optional): 
            string
            The display name of the promotion.
- 
            secondaryCurrencyTotalAdjustment(optional): 
            number
            The total adjustment in monetary currency.
- 
            totalAdjustment(optional): 
            number
            Total adjustment caused by the promotion.
Nested Schema : couponCode
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectCoupon Code.
    
    
    
    
        Show Source
        - 
            external(optional): 
            boolean
            States whether this promotion was applied by an external system (only present on external promotions).
- 
            promotionDesc(optional): 
            string
            Description of the promotion. Retained for backward compatibility.
- 
            promotionId(optional): 
            string
            The Id of the promotion.
- 
            promotionLevel(optional): 
            string
            The promotion level.
- 
            promotionLongDesc(optional): 
            string
            The description of the promotion.
- 
            promotionName(optional): 
            string
            The display name of the promotion.
- 
            secondaryCurrencyTotalAdjustment(optional): 
            number
            The total adjustment in monetary currency.
- 
            totalAdjustment(optional): 
            number
            Total adjustment caused by the promotion.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            external(optional): 
            boolean
            States whether this promotion was applied by an external system (only present on external promotions).
- 
            promotionDesc(optional): 
            string
            Description of the promotion. Retained for backward compatibility.
- 
            promotionId(optional): 
            string
            The promotion ID.
- 
            promotionLevel(optional): 
            string
            The promotion level.
- 
            promotionLongDesc(optional): 
            string
            The description of the promotion.
- 
            promotionName(optional): 
            string
            The display name of the promotion.
- 
            secondaryCurrencyTotalAdjustment(optional): 
            number
            The total adjustment in monetary currency.
- 
            totalAdjustment(optional): 
            string
            The total adjustment.
Nested Schema : couponCode
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayCoupon Code, corresponding to which some promotions were not applied
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            external(optional): 
            boolean
            States whether this promotion was applied by an external system (only present on external promotions).
- 
            promotionDesc(optional): 
            string
            Description of the promotion. Retained for backward compatibility.
- 
            promotionId(optional): 
            string
            The Id of the promotion.
- 
            promotionLevel(optional): 
            string
            The promotion level.
- 
            promotionLongDesc(optional): 
            string
            The description of the promotion.
- 
            promotionName(optional): 
            string
            The display name of the promotion.
Nested Schema : couponCode
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayCoupon Code, corresponding to which some promotions were not applied
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            external(optional): 
            boolean
            States whether this promotion was applied by an external system (only present on external promotions).
- 
            promotionDesc(optional): 
            string
            Description of the promotion. Retained for backward compatibility.
- 
            promotionId(optional): 
            string
            The Id of the promotion.
- 
            promotionLevel(optional): 
            string
            The promotion level.
- 
            promotionLongDesc(optional): 
            string
            The description of the promotion.
- 
            promotionName(optional): 
            string
            The display name of the promotion.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            id(optional): 
            string
            The ID of the dynamic property.
- 
            label(optional): 
            string
            The label of the dynamic property.
- 
            value(optional): 
            string
            The value of the dynamic property.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            giftWithPurchaseDetail(optional): 
            string
            String identifying the free gift, usually the repository ID of the gift type.
- 
            giftWithPurchaseIdentifier(optional): 
            integer
            An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
- 
            giftWithPurchaseQuantityAvailableForSelection(optional): 
            number
            gift quantity available for selection
- 
            giftWithPurchaseType(optional): 
            string
            The type of the gift. (sku, product)
- 
            promotionId(optional): 
            string
            The gift with purchase promotion ID
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            automaticQuantity(optional): 
            number
            The quantity of free sku for this gift selection that has already been auto added to the order.
- 
            autoRemove(optional): 
            boolean
            Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
- 
            data(optional): 
            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(optional): 
            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(optional): 
            string
            String identifying the free gift, usually the repository ID of the gift type.
- 
            giftType(optional): 
            string
            The type of the gift. (sku, product)
- 
            key(optional): 
            string
            atg.gwp
- 
            quantity(optional): 
            number
            The total quantity of sku for this gift selection.
- 
            removedQuantity(optional): 
            number
            The amount of free quantity that has since been manually removed by a Shopper.
- 
            selectedQuantity(optional): 
            integer
            The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
- 
            targetedQuantity(optional): 
            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(optional): 
            string
            The gift with purchase promotion ID
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            amount(optional): 
            number
            Amount authorized from the payment group.
- 
            balance(optional): 
            number
            Total available balance on the gift card.
- 
            gatewayName(optional): 
            string
            Payment gateway name. e.g. chaseCreditCard.
- 
            giftCardNumber(optional): 
            string
            Gift card number.
- 
            isAmountRemaining(optional): 
            boolean
            A boolean to decide if more payment can be made from this payment group.
- 
            maskedCardNumber(optional): 
            string
            Masked gift card number.
- 
            paymentGroupId(optional): 
            string
            Payment group ID.
- 
            paymentMethod(optional): 
            string
            Payment method. e.g. physicalGiftCard/ creditCard.
- 
            paymentState(optional): 
            string
            The state of the payment group. e.g. AUTHORIZED.
- 
            PONumber(optional): 
            string
            Purchase order number for invoice payment. Payment type:invoice
- 
            savedCardId(optional): 
            string
            ID of the saved card associated with the payment group.
- 
            uiIntervention(optional): 
            string
            This decides whether the client has to do some intervention for payment. e.g. SOP.
Nested Schema : orderTotalBySite
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map containing order totals by site for all sites in a given order.
    
    
    
    
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            profileId(optional): 
            string
            the profile ID of the user
- 
            profileType(optional): 
            string
            the profile type of the user that requested the quote
- 
            requestDate/quoteDate/rejectionDate(optional): 
            number
            the request/quote/rejection date for the note
- 
            requesterNote/providerNote/rejectionNote(optional): 
            string
            the requester/provider/rejection note
Nested Schema : frequencyAmountTotals
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe total for each recurring charge frequency
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : frequencyTaxTotals
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe tax for each recurring charge frequency
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            frequency(optional): 
            string
            The frequency for the item's total e.g. Monthly.
- 
            total(optional): 
            string
            The total amount for the frequency.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            frequency(optional): 
            string
            The frequency for the item's tax e.g. Monthly.
- 
            tax(optional): 
            string
            The tax amount for the frequency.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            clonedOrders(optional): 
            array  clonedOrders
            
            list of orders that is created using this as template.
- 
            createDate(optional): 
            string
            The submitted date in ISO format.
- 
            endDate(optional): 
            string
            The submitted date in ISO format.
- 
            executionStatusList(optional): 
            array  executionStatusList
            
            list of orders with status that are placed with this schedule.
- 
            id(optional): 
            string
            The scheduled order ID.
- 
            lastError(optional): 
            object  lastError
            
            last error of this scheduled order.
- 
            lastScheduledRun(optional): 
            string
            last date of order placed.
- 
            name(optional): 
            string
            name of scheduled order.
- 
            nextScheduledRun(optional): 
            string
            next date of order to be placed.
- 
            profileId(optional): 
            string
            the profile ID of the user.
- 
            repositoryId(optional): 
            string
            repository ID of scheduled order.
- 
            schedule: 
            object  schedule
            
            schedule details for the schedule.
- 
            siteId(optional): 
            string
            ID of site.
- 
            startDate(optional): 
            string
            The submitted date in ISO format.
- 
            status(optional): 
            string
            status of schedule order active or inactive.
- 
            templateOrderId(optional): 
            string
            template order ID.
- 
            type(optional): 
            string
            type of order.
- 
            version(optional): 
            integer
            version scheduled order.
Nested Schema : clonedOrders
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arraylist of orders that is created using this as template.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : executionStatusList
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arraylist of orders with status that are placed with this schedule.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : lastError
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectlast error of this scheduled order.
    
    
    
    
        Show Source
        - 
            errorDate(optional): 
            string
            The date when error occurred
- 
            errorMessages(optional): 
            array  errorMessages
            
            An array of error messages
- 
            scheduleErrorId(optional): 
            string
            error ID of the last failed schedule order
Nested Schema : schedule
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectschedule details for the schedule.
    
    
    
    
        Show Source
        - 
            daysInMonth(optional): 
            array  daysInMonth
            
            mention which days of Month schedule should run. values can be 1 to 31.
- 
            daysOfWeek(optional): 
            array  daysOfWeek
            
            mention which days of week schedule should run. values can be 1 to 7.
- 
            monthsInYear(optional): 
            array  monthsInYear
            
            The months in year of the Scheduled order. Values can be 0 to 11.
- 
            occurenceInDay(optional): 
            integer
            The occurence in day on the Scheduled order. Values can be 1 or 2.
- 
            weeksInMonth(optional): 
            array  weeksInMonth
            
            The weeks in month of the Scheduled order.Values can be 1 to 5
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            orderId(optional): 
            string
            The ID of the template order.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            errorMessages(optional): 
            array  errorMessages
            
            The error messages list.
- 
            executionDate(optional): 
            string
            The date for previous scheduled run
- 
            id(optional): 
            string
            The ID of the Scheduled order.
- 
            orderId(optional): 
            string
            The ID of the template order.
- 
            orderSubmitted(optional): 
            boolean
            The status of order.
- 
            orderTotal(optional): 
            number
            Total order value.
- 
            repositoryId(optional): 
            string
            The ID of the Scheduled order.
- 
            scheduledOrderId(optional): 
            string
            The ID of the Scheduled order.
Nested Schema : daysInMonth
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arraymention which days of Month schedule should run. values can be 1 to 31.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : daysOfWeek
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arraymention which days of week schedule should run. values can be 1 to 7.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : monthsInYear
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe months in year of the Scheduled order. Values can be 0 to 11.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : weeksInMonth
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    array The weeks in month of the Scheduled order.Values can be 1 to 5
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actualShipDate(optional): 
            string
            The actual ship date in ISO format.
- 
            discountInfo(optional): 
            object  discountInfo
            
            The shipping group price information.
- 
            items(optional): 
            array  items
            
            The array of products in the shipping group.
- 
            priceInfo(optional): 
            object  priceInfo
            
            The shipping group price information.
- 
            recurringChargePriceInfo(optional): 
            object  recurringChargePriceInfo
            
            Recurring charge price information.
- 
            shipOnDate(optional): 
            string
            The ship on date in ISO format.
- 
            shippingAddress(optional): 
            object  shippingAddress
            
            The shipping address details.
- 
            shippingGroupId(optional): 
            string
            The shipping group ID.
- 
            shippingMethod(optional): 
            object  shippingMethod
            
            The shipping method details.
- 
            status(optional): 
            string
            The shipping group status.
- 
            submittedDate(optional): 
            string
            The submitted date in ISO format.
- 
            taxPriceInfo(optional): 
            object  taxPriceInfo
            
            The shipping tax price info details.
- 
            trackingInfo(optional): 
            array  trackingInfo
            
            Tracking Information for the Order.
- 
            trackingNumber(optional): 
            string
            The tracking number.
Nested Schema : discountInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe shipping group price information.
    
    
    
    
        Show Source
        - 
            discountDescList(optional): 
            array  discountDescList
            
            The list of all the order discounts.
- 
            orderDiscount(optional): 
            number
            The orderDiscount.
- 
            shippingDiscount(optional): 
            number
            The shipping discount.
Nested Schema : priceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe shipping group price information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The shipping method amount.
- 
            currencyCode(optional): 
            string
            The shipping method amount.
- 
            shipping(optional): 
            number
            The shipping amount.
- 
            shippingSurchargeValue(optional): 
            number
            The shipping surcharge value amount.
- 
            subTotal(optional): 
            number
            The shipping group subtotal.
- 
            tax(optional): 
            number
            The shipping method tax amount.
- 
            total(optional): 
            number
            The total cost of shipping.
- 
            totalWithoutTax(optional): 
            number
            The shipping items total.
Nested Schema : recurringChargePriceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectRecurring charge price information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The monetary amount of this recurring charge.
- 
            currencyCode(optional): 
            string
            The currency code for the monetary amounts. A three character currency code such as USD.
- 
            frequencyAmountTotals(optional): 
            array  frequencyAmountTotals
            
            The total for each recurring charge frequency
- 
            frequencyTaxTotals(optional): 
            array  frequencyTaxTotals
            
            The tax for each recurring charge frequency
- 
            shipping(optional): 
            number
            Cost of shipping the product.
- 
            subTotal(optional): 
            number
            The sub-total price of the recurring charge.
- 
            tax(optional): 
            number
            Monetary tax amount.
- 
            total(optional): 
            number
            The total price of the recurring charge.
- 
            totalWithoutTax(optional): 
            number
            Total of recurring amount without tax included.
Nested Schema : shippingAddress
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe shipping address details.
    
    
    
    
        Show Source
        - 
            address1(optional): 
            string
            Address snippet.
- 
            address2(optional): 
            string
            Address snippet.
- 
            address3(optional): 
            string
            Address snippet.
- 
            alias(optional): 
            string
            Address alias.
- 
            city(optional): 
            string
            City.
- 
            companyName(optional): 
            string
            Company name.
- 
            country(optional): 
            string
            Country.
- 
            county(optional): 
            string
            County.
- 
            email(optional): 
            string
            Email address.
- 
            faxNumber(optional): 
            string
            Fax number.
- 
            firstName(optional): 
            string
            First name.
- 
            jobTitle(optional): 
            string
            Job title.
- 
            lastName(optional): 
            string
            Last name.
- 
            middleName(optional): 
            string
            Middle name.
- 
            phoneNumber(optional): 
            string
            Phone number.
- 
            postalCode(optional): 
            string
            Postal code.
- 
            prefix(optional): 
            string
            Name prefix.
- 
            selectedCountry(optional): 
            string
            Country code.
- 
            selectedState(optional): 
            string
            State code.
- 
            state(optional): 
            string
            State.
- 
            state_ISOCode(optional): 
            string
            State ISO code.
- 
            suffix(optional): 
            string
            Name suffix.
Nested Schema : shippingMethod
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe shipping method details.
    
    
    
    
        Show Source
        - 
            cost(optional): 
            number
            The total cost of shipping.
- 
            secondaryCurrencyShipingAmount(optional): 
            number
            shipping amount in monetry currency
- 
            secondaryCurrencyTaxAmount(optional): 
            number
            Shipping tax amount in monetry currency
- 
            shippingMethodDescription(optional): 
            string
            The description of the shipping method.
- 
            shippingTax(optional): 
            number
            The shipping tax.
- 
            value(optional): 
            string
            The shipping method applied to the order.
Nested Schema : taxPriceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe shipping tax price info details.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The shipping method amount.
- 
            cityTax(optional): 
            number
            The shipping group subtotal.
- 
            countryTax(optional): 
            number
            The country tax total.
- 
            countyTax(optional): 
            number
            The county tax amount.
- 
            districtTax(optional): 
            string
            The shipping method applied to the order.
- 
            isTaxIncluded(optional): 
            boolean
            Flag that states whether is tax included.
- 
            miscTax(optional): 
            string
            The miscellaneous tax amount.
- 
            secondaryCurrencyTaxAmount(optional): 
            number
            Shipping tax amount in monetry currency
- 
            stateTax(optional): 
            number
            The shipping method tax amount.
- 
            valueAddedTax(optional): 
            number
            The value added tax .
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            coupon(optional): 
            string
            The coupon code.
- 
            external(optional): 
            boolean
            States whether this promotion was applied by an external system (only present on external promotions).
- 
            promotionDesc(optional): 
            string
            Description of the promotion. Retained for backward compatibility.
- 
            promotionId(optional): 
            string
            The promotion ID.
- 
            promotionLevel(optional): 
            string
            The promotion level.
- 
            promotionLongDesc(optional): 
            string
            The description of the promotion.
- 
            promotionName(optional): 
            string
            The display name of the promotion.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            activationDate(optional): 
            string
            The activation date in ISO format.
- 
            active(optional): 
            boolean
            UIs this product active.
- 
            asset(optional): 
            boolean
            The flag that determines if the current item is an asset or not.
- 
            assetKey(optional): 
            string
            The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
- 
            availabilityDate(optional): 
            string
            The Availability date of commerce Item.
- 
            backOrderQuantity(optional): 
            number
            Back Order Quantity of the Items.
- 
            billingAccountId(optional): 
            string
            The billing account ID associated to the current item.
- 
            billingProfileId(optional): 
            string
            The billing profile ID associated to the current item.
- 
            catRefId(optional): 
            string
            The product variant ID.
- 
            commerceId(optional): 
            string
            Repository ID
- 
            commerceItemId(optional): 
            string
            The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.
- 
            customerAccountId(optional): 
            string
            The customer account ID associated to the current item.
- 
            deactivationDate(optional): 
            string
            The deactivation date in ISO format.
- 
            detailedItemPriceInfo(optional): 
            object  detailedItemPriceInfo
            
            Detailed Item Price Information.
- 
            detailedRecurringChargeInfo(optional): 
            object  detailedRecurringChargeInfo
            
            Detailed Item Price Information.
- 
            discountAmount(optional): 
            string
            The discount amount.
- 
            displayName(optional): 
            string
            Display Name.
- 
            dynamicProperties(optional): 
            array  dynamicProperties
            
            Array of custom properties at order line item level.
- 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a configurator system.
- 
            externalRecurringCharge(optional): 
            number
            The external recurring price.
- 
            externalRecurringChargeDuration(optional): 
            string
            The duration for the recurring charge e.g. 12 months.
- 
            externalRecurringChargeFrequency(optional): 
            string
            The frequency for the recurring charge e.g. Monthly.
- 
            listPrice(optional): 
            string
            List Price.
- 
            onSale(optional): 
            boolean
            Indicates whether the price is for an item that is on sale.
- 
            parentAssetKey(optional): 
            string
            The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
- 
            pointOfNoRevision(optional): 
            boolean
            The boolean that indicates if the item has passed pointOfNoRevision.
- 
            preOrderQuantity(optional): 
            number
            Pre Order Quantity of the Items.
- 
            primaryImageAltText(optional): 
            string
            Primary Image Alternative Text.
- 
            primaryImageTitle(optional): 
            string
            Primary Image Title.
- 
            primaryThumbImageURL(optional): 
            string
            Primary Thumb Image URL.
- 
            productId(optional): 
            string
            ID of the product in the cart.
- 
            quantity(optional): 
            integer
            The quantity of the product in this shipping group.
- 
            rawTotalPrice(optional): 
            string
            Raw Total Price.
- 
            recurringCharge(optional): 
            number
            The recurring charge for the item.
- 
            relationshipType(optional): 
            string
            The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.
- 
            rootAssetKey(optional): 
            string
            The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
- 
            route(optional): 
            string
            route.
- 
            salePrice(optional): 
            string
            Sale Price.
- 
            serviceAccountId(optional): 
            string
            The service account ID associated to the current item.
- 
            serviceId(optional): 
            string
            The service ID associated to the current item.
- 
            shippingSurchargeValue(optional): 
            number
            shipping surcharge value.
- 
            siteId(optional): 
            string
            The ID of the site on which the item was added.
- 
            skuProperties(optional): 
            array  skuProperties
            
            Sku properties Information
- 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
- 
            unitPrice(optional): 
            number
            The unit price.
- 
            variant(optional): 
            array  variant
            
            List of variants for the product.
Nested Schema : detailedItemPriceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectDetailed Item Price Information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The amount.
- 
            currencyCode(optional): 
            string
            The currency code.
- 
            detailedUnitPrice(optional): 
            number
            Detailed Unit Price.
- 
            discounted(optional): 
            boolean
            Is this item discounted.
- orderDiscountShare(optional): number
- 
            quantity(optional): 
            number
            The quantity.
- 
            tax(optional): 
            number
            The tax amount.
Nested Schema : detailedRecurringChargeInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectDetailed Item Price Information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The monetary amount for the recurring charge.
- 
            currencyCode(optional): 
            string
            The three character currency code for the monetary amounts.
- 
            detailedUnitPrice(optional): 
            number
            The detailed unit price: amount / quantity. (read-only)
- 
            discounted(optional): 
            boolean
            Whether the price is discounted.
- orderDiscountShare(optional): number
- 
            quantity(optional): 
            integer
            The number of items covered by this recurring charge price info
- 
            tax(optional): 
            number
            Monetary tax amount.
Nested Schema : dynamicProperties
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayArray of custom properties at order line item level.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a configurator system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            id(optional): 
            string
            The ID of the dynamic property.
- 
            label(optional): 
            string
            The label of the dynamic property.
- 
            value(optional): 
            string
            The value of the dynamic property.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the configurator system.
- 
            name(optional): 
            string
            The name to be associated with the externalData item.
- 
            values(optional): 
            object  values
            
            The array of values associated with an externalData item.
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe array of values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            dynamic_property_key(optional): 
            string
            This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            id(optional): 
            string
            ID of the Dynamic SKU Property.
- 
            name(optional): 
            string
            Name of the Dynamic SKU Property.
- 
            propertyType(optional): 
            string
            Type that indicates whether it is a base or a custom SKU property,
- 
            value(optional): 
            string
            Value of the Dynamic SKU Property.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            optionName(optional): 
            string
            The variant option name.
- 
            optionValue(optional): 
            string
            The variant option value.
Nested Schema : frequencyAmountTotals
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe total for each recurring charge frequency
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : frequencyTaxTotals
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe tax for each recurring charge frequency
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            frequency(optional): 
            string
            The frequency for the item's total e.g. Monthly.
- 
            total(optional): 
            string
            The total amount for the frequency.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            frequency(optional): 
            string
            The frequency for the item's tax e.g. Monthly.
- 
            tax(optional): 
            string
            The tax amount for the frequency.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            carrierId(optional): 
            string
            Carrier ID for Tracking.
- 
            carrierName(optional): 
            string
            Carrier Name for Tracking.
- 
            carrierUrl(optional): 
            string
            Carrier URL for Tracking.
- 
            trackingNumber(optional): 
            string
            Tracking Number.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the item by the configurator system.
- 
            activationDate(optional): 
            string
            The activation date in ISO format.
- 
            active(optional): 
            boolean
            active or not.
- 
            asset(optional): 
            boolean
            The flag that determines if the current item is an asset or not.
- 
            assetKey(optional): 
            string
            The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
- 
            availabilityDate(optional): 
            string
            The Availability date of commerce Item.
- 
            backOrderQuantity(optional): 
            number
            Back Order Quantity of the Items.
- 
            billingAccountId(optional): 
            string
            The billing account ID associated to the current item.
- 
            billingProfileId(optional): 
            string
            The billing profile ID associated to the current item.
- 
            catRefId(optional): 
            string
            The product variant ID.
- 
            childItems(optional): 
            array  childItems
            
            The array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.
- 
            commerceItemId(optional): 
            string
            The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.
- 
            customerAccountId(optional): 
            string
            The customer account ID associated to the current item.
- 
            deactivationDate(optional): 
            string
            The deactivation date in ISO format.
- 
            detailedRecurringChargeInfo(optional): 
            object  detailedRecurringChargeInfo
            
            Detailed Item Price Information.
- 
            discountInfo(optional): 
            array  discountInfo
            
            The discount information.
- 
            displayName(optional): 
            string
            The name of the product.
- 
            dynamicProperties(optional): 
            array  dynamicProperties
            
            Array of custom properties at order line item level.
- 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a configurator system.
- 
            externalPrice(optional): 
            number
            A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
- 
            externalPriceQuantity(optional): 
            integer
            The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
- 
            externalRecurringCharge(optional): 
            number
            The external recurring price.
- 
            externalRecurringChargeDuration(optional): 
            string
            The duration for the recurring charge e.g. 12 months.
- 
            externalRecurringChargeFrequency(optional): 
            string
            The frequency for the recurring charge e.g. Monthly.
- 
            giftWithPurchaseCommerceItemMarkers(optional): 
            array  giftWithPurchaseCommerceItemMarkers
            
            The array of giftWithPurchaseCommerceItemMarkers.
- 
            id(optional): 
            string
            Repository ID of the commerce item.
- 
            originalCommerceItemId(optional): 
            string
            The Commerce Item ID associated with the original item from which item in cancel order is created.
- 
            parentAssetKey(optional): 
            string
            The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
- 
            pointOfNoRevision(optional): 
            boolean
            The boolean that indicates if the item has passed pointOfNoRevision.
- 
            preOrderQuantity(optional): 
            number
            Pre Order Quantity of the Items.
- 
            price(optional): 
            integer
            The actual price of the product.
- 
            productId(optional): 
            string
            ID of the product in the cart.
- 
            quantity(optional): 
            integer
            The quantity of the product.
- 
            rawTotalPrice(optional): 
            integer
            The raw price of the product.
- 
            recurringCharge(optional): 
            number
            The recurring charge for the item.
- 
            rootAssetKey(optional): 
            string
            The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
- 
            serviceAccountId(optional): 
            string
            The service account ID associated to the current item.
- 
            serviceId(optional): 
            string
            The service ID associated to the current item.
- 
            shopperInput(optional): 
            object  shopperInput
            
            Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
- 
            siteId(optional): 
            string
            The ID of the site on which the item was added.
- 
            skuProperties(optional): 
            array  skuProperties
            
            Sku properties Information
- 
            state(optional): 
            string
            state at commerceItem level
- 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
- 
            unitPrice(optional): 
            integer
            The unit price of the product.
- 
            variant(optional): 
            array  variant
            
            List of variants for the product.
Nested Schema : childItems
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : detailedRecurringChargeInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectDetailed Item Price Information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The monetary amount for the recurring charge.
- 
            currencyCode(optional): 
            string
            The three character currency code for the monetary amounts.
- 
            detailedUnitPrice(optional): 
            number
            The detailed unit price: amount / quantity. (read-only)
- 
            discounted(optional): 
            boolean
            Whether the price is discounted.
- orderDiscountShare(optional): number
- 
            quantity(optional): 
            integer
            The number of items covered by this recurring charge price info
- 
            tax(optional): 
            number
            Monetary tax amount.
Nested Schema : dynamicProperties
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayArray of custom properties at order line item level.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a configurator system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : giftWithPurchaseCommerceItemMarkers
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe array of giftWithPurchaseCommerceItemMarkers.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : shopperInput
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
       objectAdditional Properties Allowed
       Show Source
       
       
    
    
    
    
    
    
    Map of shopper input keys to values
    
    
    
    
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the item by the configurator system.
- 
            activationDate(optional): 
            string
            The activation date in ISO format.
- 
            addOnItem(optional): 
            boolean
            Whether the child item is an add-on (externally configured) or not (externally configured).
- 
            amount(optional): 
            integer
            The total amount of this item including its child items amounts.
- 
            asset(optional): 
            boolean
            The flag that determines if the current item is an asset or not.
- 
            assetKey(optional): 
            string
            The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
- 
            billingAccountId(optional): 
            string
            The billing account ID associated to the current item.
- 
            billingProfileId(optional): 
            string
            The billing profile ID associated to the current item.
- 
            catRefId(optional): 
            string
            skuid of the item.
- 
            configurablePropertyId(optional): 
            string
            ID of the catalog's configurableProperty associated with this item.
- 
            configurationOptionId(optional): 
            string
            ID of the catalog's configurationOption associated with this item.
- 
            customerAccountId(optional): 
            string
            The customer account ID associated to the current item.
- 
            deactivationDate(optional): 
            string
            The deactivation date in ISO format.
- 
            detailedRecurringChargeInfo(optional): 
            object  detailedRecurringChargeInfo
            
            Detailed Item Price Information.
- 
            displayName(optional): 
            string
            The name of the product.
- 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a configurator system.
- 
            externalPrice(optional): 
            number
            A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
- 
            externalPriceQuantity(optional): 
            integer
            The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
- 
            externalRecurringCharge(optional): 
            number
            The external recurring price.
- 
            externalRecurringChargeDuration(optional): 
            string
            The duration for the recurring charge e.g. 12 months.
- 
            externalRecurringChargeFrequency(optional): 
            string
            The frequency for the recurring charge e.g. Monthly.
- 
            id(optional): 
            string
            Repository ID of the commerce item.
- 
            parentAssetKey(optional): 
            string
            The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
- 
            productId(optional): 
            string
            ID of the product in the cart.
- 
            quantity(optional): 
            integer
            The quantity of the product.
- 
            rawTotalPrice(optional): 
            integer
            The raw price of the product.
- 
            recurringCharge(optional): 
            number
            The recurring charge for the item.
- 
            rootAssetKey(optional): 
            string
            The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
- 
            serviceAccountId(optional): 
            string
            The service account ID associated to the current item.
- 
            serviceId(optional): 
            string
            The service ID associated to the current item.
- 
            shopperInput(optional): 
            object  shopperInput
            
            Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
- 
            siteId(optional): 
            string
            The ID of the site on which the item was added.
- 
            state(optional): 
            string
            state at commerceItem level
- 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
- 
            unitPrice(optional): 
            integer
            The unit price of the product.
Nested Schema : detailedRecurringChargeInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectDetailed Item Price Information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The monetary amount for the recurring charge.
- 
            currencyCode(optional): 
            string
            The three character currency code for the monetary amounts.
- 
            detailedUnitPrice(optional): 
            number
            The detailed unit price: amount / quantity. (read-only)
- 
            discounted(optional): 
            boolean
            Whether the price is discounted.
- orderDiscountShare(optional): number
- 
            quantity(optional): 
            integer
            The number of items covered by this recurring charge price info
- 
            tax(optional): 
            number
            Monetary tax amount.
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a configurator system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : shopperInput
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
       objectAdditional Properties Allowed
       Show Source
       
       
    
    
    
    
    
    
    Map of shopper input keys to values
    
    
    
    
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the configurator system.
- 
            name(optional): 
            string
            The name to be associated with the externalData item.
- 
            values(optional): 
            object  values
            
            The array of values associated with an externalData item.
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe array of values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            dynamic_property_key(optional): 
            string
            This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            coupon(optional): 
            string
            The coupon ID.
- 
            external(optional): 
            boolean
            States whether this promotion was applied by an external system (only present on external promotions).
- 
            giftWithPurchaseDiscountInfo(optional): 
            array  giftWithPurchaseDiscountInfo
            
            The gift information.
- 
            promotionDesc(optional): 
            string
            Description of the promotion. Retained for backward compatibility.
- 
            promotionId(optional): 
            string
            The promotion ID.
- 
            promotionLevel(optional): 
            string
            The promotion level.
- 
            promotionLongDesc(optional): 
            string
            The description of the promotion.
- 
            promotionName(optional): 
            string
            The display name of the promotion.
- 
            totalAdjustment(optional): 
            number
            Total adjustment by the promotion.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            giftWithPurchaseChoicesAvailable(optional): 
            boolean
            If this gift with purchase has multiple gift choices.
- 
            giftWithPurchaseIdentifier(optional): 
            integer
            The gift hash code for this gift with purchase promotion.
- 
            giftWithPurchaseQuantity(optional): 
            number
            The quantity that is gift quantity
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            id(optional): 
            string
            The ID of the dynamic property.
- 
            label(optional): 
            string
            The label of the dynamic property.
- 
            value(optional): 
            string
            The value of the dynamic property.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the configurator system.
- 
            name(optional): 
            string
            The name to be associated with the externalData item.
- 
            values(optional): 
            object  values
            
            The array of values associated with an externalData item.
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe array of values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            dynamic_property_key(optional): 
            string
            This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            automaticQuantity(optional): 
            number
            The quantity of the free gift that this commerce item is making free and was auto added by pricing.
- 
            data(optional): 
            integer
            The gift hash code for this gift with purchase promotion.
- 
            key(optional): 
            string
            atg.gwp
- 
            remainingQuantity(optional): 
            number
            The quantity of the commerce item that is not affected by gift with purchase.
- 
            selectedQuantity(optional): 
            number
            The quantity of the free gift that this commerce item is making free and was selected by the shopper.
- 
            targetedQuantity(optional): 
            number
            The quantity of the free gift that this commerce item is making free and was targeted by pricing.
- 
            value(optional): 
            string
            The gift with purchase promotion ID.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            id(optional): 
            string
            ID of the Dynamic SKU Property.
- 
            name(optional): 
            string
            Name of the Dynamic SKU Property.
- 
            propertyType(optional): 
            string
            Type that indicates whether it is a base or a custom SKU property,
- 
            value(optional): 
            string
            Value of the Dynamic SKU Property.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            optionName(optional): 
            string
            The variant option name.
- 
            optionValue(optional): 
            string
            The variant option value.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            carrierId(optional): 
            string
            Carrier ID for Tracking.
- 
            carrierName(optional): 
            string
            Carrier Name for Tracking.
- 
            carrierUrl(optional): 
            string
            Carrier URL for Tracking.
- 
            trackingNumber(optional): 
            string
            Tracking Number.
Example Response (application/json)
                    {
    "totalAmountAuthorized":124.18,
    "agentId":"service",
    "orderComments":[
    ],
    "creationTime":1.436906449E12,
    "sourceSystem":"Cloud Commerce",
    "dynamicProperties":[
        {
            "id":"dynamicPropertyShippingInstructions",
            "value":"Test Instructions"
        }
    ],
    "submittedDate":"2015-07-14T20:41:49.000Z",
    "paymentGroups":[
        {
            "lastName":"Anderson",
            "amountAuthorized":124.18,
            "amount":88.55,
            "totalDue":88.55,
            "cardType":null,
            "zero_value_auto_authorized":"true",
            "IIN":"424242",
            "token":"9997000108950573",
            "paymentGroupId":"pg10411",
            "firstName":"Kim",
            "paymentStateDetailsAsUser":"The authorization succeeded",
            "uiIntervention":"sop",
            "billingAddress":{
                "lastName":"Anderson",
                "country":"US",
                "address3":null,
                "address2":null,
                "city":"Syracuse",
                "address1":"21 Cedar Ave",
                "prefix":null,
                "companyName":null,
                "postalCode":"13202",
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "selectedCountry":"US",
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "stateName":"New York",
                "faxNumber":null,
                "middleName":null,
                "countryName":"United States",
                "state":"NY",
                "email":"kim@example.com",
                "selectedState":"NY",
                "state_ISOCode":"US-NY"
            },
            "paymentState":1,
            "paidAmount":0,
            "cardNumber":"xxxxxxxxxxxx1111",
            "refundAmount":0
        }
    ],
    "priceInfo":{
        "amount":56.99,
        "total":88.55,
        "shipping":25,
        "shippingSurchargeValue":0,
        "tax":6.56,
        "subTotal":56.99,
        "currencyCode":"USD"
    },
    "submissionProgress":[
    ],
    "paymentGroup":{
        "lastName":"Anderson",
        "amountAuthorized":124.18,
        "amount":88.55,
        "totalDue":88.55,
        "cardType":null,
        "zero_value_auto_authorized":"true",
        "token":"9997000108950573",
        "paymentGroupId":"pg10411",
        "firstName":"Kim",
        "paymentStateDetailsAsUser":"The authorization succeeded",
        "uiIntervention":"sop",
        "billingAddress":{
            "lastName":"Anderson",
            "country":"US",
            "address3":null,
            "address2":null,
            "city":"Syracuse",
            "address1":"21 Cedar Ave",
            "prefix":null,
            "companyName":null,
            "postalCode":"13202",
            "jobTitle":null,
            "county":null,
            "suffix":null,
            "selectedCountry":"US",
            "firstName":"Kim",
            "phoneNumber":"212-555-1977",
            "stateName":"New York",
            "faxNumber":null,
            "middleName":null,
            "countryName":"United States",
            "state":"NY",
            "email":"kim@example.com",
            "selectedState":"NY",
            "state_ISOCode":"US-NY"
        },
        "paymentState":1,
        "paidAmount":0,
        "cardNumber":"xxxxxxxxxxxx1111",
        "refundAmount":0
    },
    "shoppingCart":{
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":39.99,
                "returnedQuantity":0,
                "priceOverridenBy":"Damon Weber",
                "displayName":"Fable II",
                "shippingSurchargeValue":0,
                "discountAmount":0,
                "externalData":[
                ],
                "billingProfileId":"billingProfile-123",
                "billingAccountId":"billingAcc-123",
                "imageInfo":{
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/fableIIxbox_LARGE.jpg&height=100&width=100"
                },
                "preOrderQuantity":0,
                "childItems":[
                    {
                        "commerceItemId":"ci19000424",
                        "configurationOptionId":"co40001",
                        "addOnItem":true,
                        "quantity":1,
                        "route":"/intel-pentium-dual-core/product/prod40001",
                        "productId":"prod40001",
                        "displayName":"Intel Pentium Dual Core",
                        "selectedOptions":[
                        ],
                        "siteId":"siteUS",
                        "childItems":[
                            {
                                "commerceItemId":"ci19000424",
                                "addOnItem":false,
                                "quantity":1,
                                "route":"/intel-pentium-dual-core/product/prod40001",
                                "productId":"prod40001",
                                "displayName":"Intel Pentium Dual Core",
                                "selectedOptions":[
                                ],
                                "siteId":"siteUS",
                                "catRefId":"sku40009"
                            }
                        ],
                        "configurablePropertyId":"cp40001",
                        "catRefId":"sku40001"
                    },
                    {
                        "commerceItemId":"ci19000426",
                        "addOnItem":false,
                        "quantity":1,
                        "route":"/8-gb-kingston-sodimm-ddr3-1600mhz/product/prod40007",
                        "productId":"prod40007",
                        "displayName":"8 GB Kingston Sodimm DDR3 1600MHz",
                        "selectedOptions":[
                        ],
                        "siteId":"siteUS",
                        "catRefId":"sku40007"
                    },
                    {
                        "commerceItemId":"ci19000425",
                        "configurationOptionId":"confO_12",
                        "addOnItem":true,
                        "quantity":1,
                        "productId":"prod12344",
                        "displayName":"Gift Wrap",
                        "siteId":"siteUS",
                        "shopperInput":{
                            "color":"neon",
                            "message":"Happy Birthday My Friend",
                            "font":"courier"
                        },
                        "configurablePropertyId":"conf022",
                        "catRefId":"sku12344"
                    }
                ],
                "configuratorId":"36379716",
                "assetKey":"12345",
                "overriddenPrice":3,
                "commerceItemId":"ci1000785",
                "price":3,
                "isPriceOverridden":true,
                "variant":[
                ],
                "onSale":"true",
                "actionCode":"Add",
                "serviceId":"service-123",
                "locationInventoryInfoMap":{
                },
                "stateDetailsAsUser":"The item has been initialized",
                "serviceAccountId":"serviceAcc-123",
                "unitPrice":39.99,
                "quantity":1,
                "productId":"prod10041",
                "parentAssetKey":null,
                "originalCommerceItemId":null,
                "tax":0.34,
                "rootAssetKey":null,
                "transactionDate":"2018-06-27T12:59:59Z",
                "catRefId":"sku10045",
                "skuProperties":[
                    {
                        "propertyType":"sku-base",
                        "name":"Name",
                        "id":"displayName",
                        "value":null
                    },
                    {
                        "propertyType":"sku-base",
                        "name":"Id",
                        "id":"id",
                        "value":"camerasku_1_1"
                    },
                    {
                        "propertyType":"sku-custom",
                        "name":"dynamicskuprop1",
                        "id":"dynamicskuprop1",
                        "value":"dynamicskuprop1"
                    }
                ],
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "siteId":"siteUS",
                "activationDate":"2017-06-27T15:30:00Z",
                "asset":false,
                "backOrderQuantity":0,
                "listPrice":39.99,
                "status":0,
                "priceOverrideReason":{
                    "displayValue":"Agent Price Override",
                    "key":"agentPriceOverride"
                }
            },
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":49.99,
                "returnedQuantity":0,
                "priceOverridenBy":"",
                "displayName":"Dora the Explorer - Season 1",
                "shippingSurchargeValue":0,
                "discountAmount":0,
                "externalData":[
                ],
                "billingProfileId":"billingProfile-123",
                "billingAccountId":"billingAcc-123",
                "imageInfo":{
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/doratheexplorer_season1_LARGE.jpg&height=100&width=100"
                },
                "assetKey":"23456",
                "overriddenPrice":"",
                "price":49.99,
                "isPriceOverridden":false,
                "variant":[
                ],
                "actionCode":"Add",
                "serviceId":"service-123",
                "stateDetailsAsUser":"The item has been initialized",
                "unitPrice":49.99,
                "serviceAccountId":"serviceAcc-123",
                "quantity":1,
                "productId":"Product_21Cxi",
                "parentAssetKey":null,
                "originalCommerceItemId":null,
                "tax":5.75,
                "rootAssetKey":null,
                "transactionDate":"2018-06-27T12:59:59Z",
                "catRefId":"Sku_21Dxy",
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "siteId":"siteUS",
                "activationDate":"2017-06-27T15:30:00Z",
                "asset":false,
                "listPrice":49.99,
                "status":0,
                "priceOverrideReason":{
                }
            },
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":49.98,
                "returnedQuantity":0,
                "priceOverridenBy":"Damon Weber",
                "displayName":"Akira",
                "shippingSurchargeValue":0,
                "discountAmount":0,
                "externalData":[
                ],
                "billingProfileId":"billingProfile-123",
                "billingAccountId":"billingAcc-123",
                "imageInfo":{
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/akira_LARGE.jpg&height=100&width=100"
                },
                "assetKey":"12345",
                "overriddenPrice":4,
                "price":4,
                "isPriceOverridden":true,
                "variant":[
                ],
                "actionCode":"Add",
                "serviceId":"service-123",
                "stateDetailsAsUser":"The item has been initialized",
                "unitPrice":24.99,
                "serviceAccountId":"serviceAcc-123",
                "quantity":2,
                "productId":"Product_27Fxyzi",
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "parentAssetKey":null,
                "originalCommerceItemId":null,
                "tax":0.46,
                "rootAssetKey":null,
                "transactionDate":"2018-06-27T12:59:59Z",
                "catRefId":"Sku_27Gxyzi",
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "siteId":"siteUS",
                "activationDate":"2017-06-27T15:30:00Z",
                "asset":false,
                "listPrice":24.99,
                "status":0,
                "priceOverrideReason":{
                    "displayValue":"Appeasement",
                    "key":"appeasement"
                }
            }
        ]
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/orders/o10411?includeResult=full"
        }
    ],
    "state":1,
    "id":"o10411",
    "stateDetailsAsUser":"Submitted to fulfillment",
    "taxPriceInfo":{
        "cityTax":0,
        "amount":4,
        "valueAddedTax":0,
        "countyTax":2,
        "isTaxIncluded":false,
        "miscTax":0,
        "districtTax":0,
        "stateTax":2,
        "countryTax":0
    },
    "shippingGroups":[
        {
            "trackingInfo":[
            ],
            "shippingMethod":{
                "cost":25,
                "displayName":"Standard",
                "value":"standardShippingMethod"
            },
            "shippingAddress":{
                "lastName":"Anderson",
                "country":"US",
                "address3":null,
                "address2":null,
                "city":"Syracuse",
                "address1":"21 Cedar Ave",
                "prefix":null,
                "companyName":null,
                "postalCode":"13202",
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "selectedCountry":"US",
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "stateName":"New York",
                "faxNumber":null,
                "middleName":null,
                "countryName":"United States",
                "state":"NY",
                "email":"kim@example.com",
                "selectedState":"NY",
                "state_ISOCode":"US-NY"
            },
            "commerceItemRelationships":[
                {
                    "commerceItemId":"ci1000785",
                    "inventoryLocationId":null,
                    "amount":0,
                    "quantity":1,
                    "relationshipType":"SHIPPINGQUANTITY",
                    "returnedQuantity":0,
                    "range":{
                        "lowBound":0,
                        "highBound":0,
                        "size":1
                    },
                    "commerceItemExternalId":null,
                    "state":"INITIAL",
                    "id":"r50387"
                }
            ],
            "trackingNumber":null,
            "items":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":1,
                    "pointOfNoRevision":false,
                    "relationshipType":"SHIPPINGQUANTITY",
                    "productId":"Product_21Cxi",
                    "externalData":[
                    ],
                    "parentAssetKey":null,
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "preOrderQuantity":0,
                    "rootAssetKey":null,
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "catRefId":"Sku_21Dxy",
                    "assetKey":"34567",
                    "skuProperties":[
                        {
                            "propertyType":"sku-base",
                            "name":"Name",
                            "id":"displayName",
                            "value":null
                        },
                        {
                            "propertyType":"sku-base",
                            "name":"Id",
                            "id":"id",
                            "value":"camerasku_1_1"
                        },
                        {
                            "propertyType":"sku-custom",
                            "name":"dynamicskuprop1",
                            "id":"dynamicskuprop1",
                            "value":"dynamicskuprop1"
                        }
                    ],
                    "customerAccountId":"customerAcc-123",
                    "variant":[
                    ],
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "asset":false,
                    "backOrderQuantity":0,
                    "locationInventoryInfoMap":{
                    }
                }
            ]
        }
    ],
    "creationSiteId":"siteUS",
    "approvalSystemMessages":[
        "Order is pending approval because total is greater than the approved order limit."
    ],
    "shippingMethod":{
        "cost":25,
        "displayName":"Standard",
        "value":"standardShippingMethod"
    },
    "isItemPriceOverrideAllowed":true,
    "profile":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "organization":{
            "name":"Oracle India Pvt Ltd",
            "id":"oracle"
        },
        "middleName":null,
        "email":"kim@example.com"
    },
    "priceListGroup":{
        "deleted":false,
        "displayName":"UsDollar",
        "repositoryId":"UsDollar",
        "active":true,
        "currency":{
            "symbol":"$",
            "displayName":"US Dollar",
            "repositoryId":"en_US",
            "fractionalDigits":2,
            "currencyCode":"USD",
            "numericCode":"840"
        },
        "id":"UsDollar",
        "locale":"en_US"
    },
    "cartName":"o10411",
    "returnRequests":[
    ],
    "creationDate":"2015-07-14T20:40:49.000Z",
    "orderAction":"order",
    "originOfOrder":"contactCenter",
    "submissionErrorCodes":[
    ],
    "discountInfo":{
        "unclaimedCouponMultiPromotions":{
        },
        "orderCouponsMap":{
        },
        "orderDiscount":0,
        "shippingDiscount":0,
        "orderImplicitDiscountList":[
        ],
        "unclaimedCouponsMap":{
        },
        "claimedCouponMultiPromotions":{
        }
    },
    "submissionErrorMessages":[
    ],
    "profileId":"se-570031",
    "exchangeRequests":[
    ],
    "giftWithPurchaseInfo":[
    ],
    "siteId":"siteUS",
    "shippingAddress":{
        "lastName":"Anderson",
        "country":"US",
        "address3":null,
        "address2":null,
        "city":"Syracuse",
        "address1":"21 Cedar Ave",
        "prefix":null,
        "companyName":null,
        "postalCode":"13202",
        "jobTitle":null,
        "county":null,
        "suffix":null,
        "selectedCountry":"US",
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "stateName":"New York",
        "faxNumber":null,
        "middleName":null,
        "countryName":"United States",
        "state":"NY",
        "email":"kim@example.com",
        "selectedState":"NY",
        "state_ISOCode":"US-NY"
    },
    "giftWithPurchaseOrderMarkers":[
    ]
}Default Response
The error response.
 The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|100094|Organization passed in the header is currently inactive|
|100095|The order or return request does not belong to the current organization of the shopper profile|
|100096|The organization associated to the order or return request was deleted / does not exist|
|100097|The organization associated to the order or return request is currently inactive|
|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|
|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|
|100101|The shopper profile does not belong to organization passed in the header|
|100102|Organization passed in the header is invalid or does not exist|
                
                
                    Root Schema : errorModel
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            devMessage(optional): 
            string
            An optional non-localized message containing technical information for developers
- 
            errorCode(optional): 
            string
            The numerical code identifying the error
- 
            errors(optional): 
            array  errors
            
            An optional list of errors if multiple errors were encountered
- 
            message(optional): 
            string
            The localized message describing the error
- 
            moreInfo(optional): 
            string
            An optional non-localized message with more information
- 
            o:errorPath(optional): 
            string
            An optional machine readable description of where the error occurred
- 
            status(optional): 
            string
            The HTTP status code
- 
            type(optional): 
            string
            The URI to the HTTP state code definition
Nested Schema : errors
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayAn optional list of errors if multiple errors were encountered
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            devMessage(optional): 
            string
            An optional non-localized message containing technical information for developers
- 
            errorCode(optional): 
            string
            The numerical code identifying the error
- 
            message(optional): 
            string
            The localized message describing the error
- 
            moreInfo(optional): 
            string
            An optional non-localized message with more information
- 
            o:errorPath(optional): 
            string
            An optional machine readable description of where the error occurred
- 
            status(optional): 
            string
            The HTTP status code