repriceOrder
post
                    /ccagent/v1/orders/reprice
Reprice Order. Reprices an order enquiring by id 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
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 : repriceOrder_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.
- 
            billingMethod(optional): 
            object  billingMethod
            
            billing Method information of the order.
- 
            creationDate(optional): 
            string
            Date on which the Order was created.
- 
            creationSiteId(optional): 
            string
            The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.
- 
            creationTime(optional): 
            number
            Order creation time.
- 
            discountInfo(optional): 
            object  discountInfo
            
            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.
- 
            id(optional): 
            string
            Commerce id for this order.
- 
            isItemPriceOverrideAllowed(optional): 
            boolean
            Indicates whether an item price can be overridden.
- 
            orderAction(optional): 
            string
            The action performed on the order.
- 
            orderCancelReason(optional): 
            string
            Reason through which the order has been cancelled.
- 
            orderComments(optional): 
            array  orderComments
            
            The list of all logged comments for the order.
- 
            paymentGroup(optional): 
            object  paymentGroup
            
            Payment Group for the order.
- 
            paymentGroups(optional): 
            array  paymentGroups
            
            List of payment Groups for the order.
- 
            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
            
            Price information of the order.
- 
            priceListGroup(optional): 
            object  priceListGroup
            
            PriceList group of the order.
- 
            pricingMessages(optional): 
            object  pricingMessages
            
            The Pricing messages information.
- 
            profile(optional): 
            object  profile
            
            Profile Information for the order.
- 
            profileId(optional): 
            string
            The Repository Id of the profile to which this Order belongs to.
- 
            returnRequests(optional): 
            array  returnRequests
            
            The list of the requests raised for the order.
- 
            scheduledOrderId(optional): 
            string
            The id of the scheduled order from which the order is placed, if the origin of order is schedule order. This is an optional key and will not be available if the origin of order is not scheduled order.
- 
            scheduledOrderName(optional): 
            string
            The name of the scheduled order from which the order is placed, if the origin of order is schedule order. This is an optional key and will not be available if the origin of order is not scheduled order.
- 
            secondaryCurrencyCode(optional): 
            string
            The currency code of secondary currency associated with the site.
- 
            shippingAddress(optional): 
            object  shippingAddress
            
            shipping address for the order.
- 
            shippingGroups(optional): 
            array  shippingGroups
            
            Shipping Group Information
- 
            shippingMethod(optional): 
            object  shippingMethod
            
            Shipping method information.
- 
            shoppingCart(optional): 
            object  shoppingCart
            
            Shopping cart information.
- 
            siteId(optional): 
            string
            The ID of the site on which the order was placed.
- 
            sourceSystem(optional): 
            string
            The system where the order originated.
- 
            state(optional): 
            integer
            The order state.
- 
            stateDetailsAsUser(optional): 
            string
            Order State description for this order.Incorporates changes made by merchant from admin UI, if any.
- 
            stateString(optional): 
            string
            Order state as key string.
- 
            submissionErrorCodes(optional): 
            array  submissionErrorCodes
            
            Set of error codes recorded during each unsuccessful retry of queued orders.
- 
            submissionErrorMessages(optional): 
            array  submissionErrorMessages
            
            List of failure reasons recorded during each unsuccessful retry of queued orders.
- 
            submissionProgress(optional): 
            array  submissionProgress
            
            Checkpoints crossed successfully during each unsuccessful retry of queued orders.
- 
            submittedDate(optional): 
            string
            Date on which the order was submitted.
- 
            taxPriceInfo(optional): 
            object  taxPriceInfo
            
            The tax pricing details for the order.
- 
            totalAmountAuthorized(optional): 
            number
            total amount authorized for the order.
Nested Schema : billingMethod
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectbilling Method information of the order.
    
    
    
    
        Show Source
        - 
            cost(optional): 
            number
            billing Cost for this order.
- 
            displayName(optional): 
            string
            billing method display name for this billing method.
- 
            value(optional): 
            string
            billing method name for this order.
Nested Schema : discountInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectDiscount information.
    
    
    
    
        Show Source
        - 
            claimedCouponMultiPromotions(optional): 
            object  claimedCouponMultiPromotions
            
            The coupons that were claimed.
- 
            orderCouponsMap(optional): 
            object  orderCouponsMap
            
            The coupons that were claimed.
- 
            orderDiscount(optional): 
            number
            Discount given on an order.
- 
            orderImplicitDiscountList(optional): 
            array  orderImplicitDiscountList
            
            List of discounts.
- 
            secondaryCurrencyShippingDiscount(optional): 
            number
            The shipping discount in secondary currency in case of mix currency scenario.
- 
            shippingDiscount(optional): 
            number
            The shipping discount.
- 
            unclaimedCouponMultiPromotions(optional): 
            object  unclaimedCouponMultiPromotions
            
            The coupons that were not claimed
- 
            unclaimedCouponsMap(optional): 
            array  unclaimedCouponsMap
            
            Map of unclaimed coupons.
Nested Schema : dynamicProperties
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayRead-only list of dynamic properties for the order along with meta-data.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : orderComments
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe list of all logged comments for the order.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : paymentGroup
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPayment Group for the order.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The amount associated with this Payment Group.
- 
            amountAuthorized(optional): 
            number
            The amount authorized with this Payment Group.
- 
            balance(optional): 
            string
            The gift card balance available.
- 
            billingAddress(optional): 
            object  billingAddress
            
            Billing address for the order.
- 
            cardNumber(optional): 
            string
            The masked credit card number.
- 
            cardType(optional): 
            string
            The credit card type.
- 
            firstName(optional): 
            string
            First name associated with this Payment Group.
- 
            lastName(optional): 
            string
            Last name associated with this Payment Group.
- 
            paidAmount(optional): 
            number
            The amount that has been debited to-date for this Payment Group.
- 
            paymentGroupId(optional): 
            integer
            Id of this payment Group.
- 
            paymentState(optional): 
            string
            The Payment Group state.
- 
            paymentStateDetailsAsUser(optional): 
            string
            The payment state description as string.
- 
            paymentStatString(optional): 
            string
            The payment state as a key string.
- 
            PONumber(optional): 
            string
            Purchase order number for invoice payment. Payment type: invoice
- 
            refundAmount(optional): 
            number
            The amount that has been credited to-date for this Payment Group.
- 
            token(optional): 
            string
            Token associated with this Payment Group.
- 
            totalDue(optional): 
            number
            The current working total order price including all discounts, tax, and billing costs.
- 
            uiIntervention(optional): 
            string
            This decides whether the client has to do some intervention for payment. e.g. SOP
- 
            zero_value_auto_authorized(optional): 
            string
            The Payment Group is auto authorized without any payment details for zero amount. e.g. true
Nested Schema : priceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPrice information of the order.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The raw number that represents the price.
- 
            billing(optional): 
            number
            The billing cost of the order.
- 
            currencyCode(optional): 
            string
            Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
- 
            primaryCurrencyTotal(optional): 
            number
            An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
- 
            secondaryCurrencyShippingAmount(optional): 
            number
            This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
- 
            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: Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. 3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.y
- 
            secondaryCurrencyTotal(optional): 
            number
            An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. 3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
- 
            subTotal(optional): 
            number
            The subtotal of the order before applying order-level promotions.
- 
            tax(optional): 
            number
            The tax on the order.
- 
            taxExclusiveAmount(optional): 
            number
            Total excluding shipping and tax in monetary currency
- 
            total(optional): 
            number
            The current working total, including all promotions, tax, and billing costs.
Nested Schema : priceListGroup
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPriceList group of the order.
    
    
    
    
        Show Source
        - 
            active(optional): 
            boolean
            Active status of pricelist group.
- 
            currency(optional): 
            object  currency
            
            Currency of the PriceList group.
- 
            deleted(optional): 
            boolean
            Pricelist group deleted status.
- 
            displayName(optional): 
            string
            Display Name.
- 
            id(optional): 
            string
            Id.
- 
            locale(optional): 
            string
            Locale.
- 
            repositoryId(optional): 
            string
            Repository Id.
Nested Schema : pricingMessages
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe Pricing messages information.
    
    
    
    
        Show Source
        - 
            promotionUpsellMessages(optional): 
            array  promotionUpsellMessages
            
            The promotion upsell messages.
Nested Schema : profile
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectProfile Information for the order.
    
    
    
    
        Show Source
        - 
            email(optional): 
            string
            Email Address corresponding to the profile.
- 
            firstName(optional): 
            string
            First name of profile.
- 
            isAnonymous(optional): 
            boolean
            Indicates whether this profile is an anonymous profile. By default, it is false.
- 
            lastName(optional): 
            string
            Last name of profile.
- 
            middleName(optional): 
            string
            Middle name of profile.
- 
            organization(optional): 
            object  organization
            
            The Organization associated with the B2B customer profile.
Nested Schema : returnRequests
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe list of the requests raised for the order.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : shippingAddress
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectshipping address for the order.
    
    
    
    
        Show Source
        - 
            address1(optional): 
            string
            Address Line 1 for this shipping address.
- 
            address2(optional): 
            string
            Address Line 2 for this shipping address.
- 
            address3(optional): 
            string
            Address Line 3 for this shipping address.
- 
            city(optional): 
            string
            City for this shipping address.
- 
            companyName(optional): 
            string
            Company name for this shipping address.
- 
            country(optional): 
            string
            Country for this shipping address.
- 
            county(optional): 
            string
            County for this shipping address.
- 
            email(optional): 
            string
            Email for this shipping address.
- 
            faxNumber(optional): 
            string
            Fax number for this shipping address.
- 
            firstName(optional): 
            string
            First name for this shipping address.
- 
            jobTitle(optional): 
            string
            Job title for this shipping address.
- 
            lastName(optional): 
            string
            Last name for this shipping address.
- 
            middleName(optional): 
            string
            Middle name for this shipping address.
- 
            phoneNumber(optional): 
            string
            Phone number for this shipping address.
- 
            postalCode(optional): 
            string
            Postal code for this shipping address.
- 
            prefix(optional): 
            string
            Prefix for this shipping address.
- 
            selectedCountry(optional): 
            string
            The selected country of the shipping address.
- 
            selectedState(optional): 
            string
            The selected state of the shipping address.
- 
            state(optional): 
            string
            State for this shipping address.
- 
            state_ISOCode(optional): 
            string
            The state ISON code of the shipping address.
- 
            suffix(optional): 
            string
            Suffix for this shipping address.
Nested Schema : shippingMethod
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectShipping method information.
    
    
    
    
        Show Source
        - 
            cost(optional): 
            number
            shipping cost.
- 
            displayName(optional): 
            string
            Display Name of shipment.
- 
            secondaryCurrencyShippingAmount(optional): 
            string
            shipping amount in secondary currency.
- 
            secondaryCurrencyTaxAmount(optional): 
            string
            tax amount in secondary currency.
- 
            value(optional): 
            string
            method type of shipment
Nested Schema : shoppingCart
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectShopping cart information.
    
    
    
    
        Show Source
        - 
            items(optional): 
            array  items
            
            Items in the cart.
Nested Schema : submissionErrorCodes
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arraySet of error codes recorded during each unsuccessful retry of queued orders.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : submissionErrorMessages
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayList of failure reasons recorded during each unsuccessful retry of queued orders.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : submissionProgress
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayCheckpoints crossed successfully during each unsuccessful retry of queued orders.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : taxPriceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe tax pricing details for the order.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The monetary amount.
- 
            amountIsFinal(optional): 
            boolean
            Whether the amount is final.
- 
            cityTax(optional): 
            number
            The monetary amount of city tax.
- 
            countryTax(optional): 
            number
            The monetary amount of country tax.
- 
            countyTax(optional): 
            number
            The monetary amount of county tax.
- 
            currencyCode(optional): 
            string
            The three character currency code.
- 
            discounted(optional): 
            boolean
            Whether the price was discounted.
- 
            districtTax(optional): 
            number
            Tax amount for the district.
- 
            secondaryCurrencyTaxAmount(optional): 
            number
            The monetary total amount of tax.
- 
            stateTax(optional): 
            number
            Tax amount for the state.
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 : 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 : couponCode
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayCoupon Code, corresponding to which promotions were applied
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            promotionDesc(optional): 
            string
            Promotion description.
- 
            promotionId(optional): 
            string
            The Id of the promotion.
- 
            promotionLevel(optional): 
            string
            The promotion level.
- 
            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.
- 
            totalAdjustment(optional): 
            number
            Total adjustment caused by the promotion.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            promotionDesc(optional): 
            string
            Description of the promotion.
- 
            promotionId(optional): 
            string
            Id of the promotion.
- 
            promotionLevel(optional): 
            string
            The promotion level.
- 
            totalAdjustment(optional): 
            string
            Total adjustment caused by 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- 
            promotionDesc(optional): 
            string
            Promotion description.
- 
            promotionId(optional): 
            string
            The Id of the promotion.
- 
            promotionLevel(optional): 
            string
            The promotion level.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            couponInfo(optional): 
            array  couponInfo
            
            The coupon Info.
- 
            promotionValue(optional): 
            string
            The value for promotion.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            promotionDesc(optional): 
            string
            Description of the promotion.
- 
            promotionId(optional): 
            string
            Id of the promotion.
- 
            promotionLevel(optional): 
            string
            The promotion level.
- 
            totalAdjustment(optional): 
            string
            Total adjustment caused by the promotion.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            id(optional): 
            string
            The ID of the dynamic property.
- 
            value(optional): 
            string
            The value of the dynamic property.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            comment(optional): 
            string
            The comment string.
- 
            creationDate(optional): 
            string
            Date on which the comment was created.
- 
            repositoryId(optional): 
            string
            The repository id of the comment record.
Nested Schema : billingAddress
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectBilling address for the order.
    
    
    
    
        Show Source
        - 
            address1(optional): 
            string
            Address line 1 for this billing address.
- 
            address2(optional): 
            string
            Address line 2 for this billing address.
- 
            address3(optional): 
            string
            Address line 3 for this billing address.
- 
            city(optional): 
            string
            City for this billing address.
- 
            companyName(optional): 
            string
            Company name for this billing address.
- 
            country(optional): 
            string
            Country for this billing address.
- 
            county(optional): 
            string
            County for this billing address.
- 
            email(optional): 
            string
            Email for this billing address.
- 
            faxNumber(optional): 
            string
            Fax number for this billing address.
- 
            firstName(optional): 
            string
            First name for this billing address.
- 
            jobTitle(optional): 
            string
            Job title for this billing address.
- 
            lastName(optional): 
            string
            Last name for this billing address.
- 
            middleName(optional): 
            string
            Middle name for this billing address.
- 
            phoneNumber(optional): 
            string
            Phone number for this billing address.
- 
            postalCode(optional): 
            string
            Postal code for this billing address.
- 
            prefix(optional): 
            string
            Prefix for this billing address.
- 
            selectedCountry(optional): 
            string
            The selected country of the shipping address.
- 
            selectedState(optional): 
            string
            The selected state of the shipping address.
- 
            state(optional): 
            string
            State for this billing address.
- 
            state_ISOCode(optional): 
            string
            The state ISON code of the shipping address.
- 
            suffix(optional): 
            string
            Suffix for this billing address.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            amount(optional): 
            number
            The amount associated with this Payment Group.
- 
            amountAuthorized(optional): 
            number
            The amount authorized with this Payment Group.
- 
            balance(optional): 
            string
            The gift card balance available.
- 
            billingAddress(optional): 
            object  billingAddress
            
            Billing address for the order.
- 
            cardNumber(optional): 
            string
            The masked credit card number.
- 
            cardType(optional): 
            string
            Payment method. e.g. physicalGiftCard/ creditCard
- 
            firstName(optional): 
            string
            First name associated with this Payment Group.
- 
            lastName(optional): 
            string
            Last name associated with this Payment Group.
- 
            paidAmount(optional): 
            number
            The amount that has been debited to-date for this Payment Group.
- 
            paymentGroupId(optional): 
            integer
            Id of this payment Group.
- 
            paymentState(optional): 
            string
            The Payment Group state.
- 
            paymentStateDetailsAsUser(optional): 
            string
            The payment state description as string.
- 
            paymentStateString(optional): 
            string
            The payment state as a key String.
- 
            PONumber(optional): 
            string
            Purchase order number for invoice payment. Payment type: invoice
- 
            refundAmount(optional): 
            number
            The amount that has been credited to-date for this Payment Group.
- 
            token(optional): 
            string
            Token associated with this Payment Group.
- 
            totalDue(optional): 
            number
            The current working total order price including all discounts, tax, and billing costs.
- 
            uiIntervention(optional): 
            string
            This decides whether the client has to do some intervention for payment. e.g. SOP
- 
            zero_value_auto_authorized(optional): 
            string
            The Payment Group is auto authorized without any payment details for zero amount. e.g. true
Nested Schema : billingAddress
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectBilling address for the order.
    
    
    
    
        Show Source
        - 
            address1(optional): 
            string
            Address line 1 for this billing address.
- 
            address2(optional): 
            string
            Address line 2 for this billing address.
- 
            address3(optional): 
            string
            Address line 3 for this billing address.
- 
            city(optional): 
            string
            City for this billing address.
- 
            companyName(optional): 
            string
            Company name for this billing address.
- 
            country(optional): 
            string
            Country for this billing address.
- 
            county(optional): 
            string
            County for this billing address.
- 
            email(optional): 
            string
            Email for this billing address.
- 
            faxNumber(optional): 
            string
            Fax number for this billing address.
- 
            firstName(optional): 
            string
            First name for this billing address.
- 
            jobTitle(optional): 
            string
            Job title for this billing address.
- 
            lastName(optional): 
            string
            Last name for this billing address.
- 
            middleName(optional): 
            string
            Middle name for this billing address.
- 
            phoneNumber(optional): 
            string
            Phone number for this billing address.
- 
            postalCode(optional): 
            string
            Postal code for this billing address.
- 
            prefix(optional): 
            string
            Prefix for this billing address.
- 
            selectedCountry(optional): 
            string
            The selected country of the shipping address.
- 
            selectedState(optional): 
            string
            The selected state of the shipping address.
- 
            state(optional): 
            string
            State for this billing address.
- 
            state_ISOCode(optional): 
            string
            The state ISON code of the shipping address.
- 
            suffix(optional): 
            string
            Suffix for this billing address.
Nested Schema : currency
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectCurrency of the PriceList group.
    
    
    
    
        Show Source
        - 
            currencyCode(optional): 
            string
            Currency Code.
- 
            displayName(optional): 
            string
            Display Name.
- 
            fractionalDigits(optional): 
            integer
            Fractional Digits.
- 
            numericCode(optional): 
            string
            Numeric Code.
- 
            repositoryId(optional): 
            string
            Repository Id.
- 
            symbol(optional): 
            string
            currency Symbol.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            tags(optional): 
            array  tags
            
            The tags the promotion upsell message is associated with.
- 
            text(optional): 
            string
            The promotion upsell message.
Nested Schema : organization
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe Organization associated with the B2B customer profile.
    
    
    
    
        Show Source
        - 
            id(optional): 
            string
            The id of the organization.
- 
            name(optional): 
            string
            The name of of the organization.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            createdDate(optional): 
            string
            The creation date of the return request.
- 
            returnRequestId(optional): 
            string
            The return request id.
- 
            state(optional): 
            string
            The status of the return request.
- 
            stateKey(optional): 
            string
            State key for return request which is not localized
- 
            totalRefund(optional): 
            number
            The total amount to be refunded on return.
- 
            totalReturnQuantity(optional): 
            integer
            The total quantity for which return request has been raised.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            approvalSystemMessages(optional): 
            array  approvalSystemMessages
            
            The array of messages which are stored during order processing
- 
            email(optional): 
            string
            The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
- 
            firstName(optional): 
            string
            The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
- 
            items: 
            array  items
            
            Items in the cart.
- 
            lastName(optional): 
            string
            The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
- 
            middleName(optional): 
            string
            The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
- 
            phoneNumber(optional): 
            string
            The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
- 
            shippingAddress(optional): 
            object  shippingAddress
            
            shipping address for the order.
- 
            shippingMethod(optional): 
            object  shippingMethod
            
            Shipping method information.
- 
            store(optional): 
            object  store
            
            Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
- 
            trackingInfo(optional): 
            array  trackingInfo
            
            Tracking Information for the Order.
- 
            trackingNumber(optional): 
            string
            Shipping tracking number.
- 
            type(optional): 
            string
            The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
Nested Schema : approvalSystemMessages
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe array of messages which are stored during order processing
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : shippingAddress
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectshipping address for the order.
    
    
    
    
        Show Source
        - 
            address1(optional): 
            string
            Address Line 1 for this shipping address.
- 
            address2(optional): 
            string
            Address Line 2 for this shipping address.
- 
            address3(optional): 
            string
            Address Line 3 for this shipping address.
- 
            city(optional): 
            string
            City for this shipping address.
- 
            companyName(optional): 
            string
            Company name for this shipping address.
- 
            country(optional): 
            string
            Country for this shipping address.
- 
            county(optional): 
            string
            County for this shipping address.
- 
            email(optional): 
            string
            Email for this shipping address.
- 
            faxNumber(optional): 
            string
            Fax number for this shipping address.
- 
            firstName(optional): 
            string
            First name for this shipping address.
- 
            jobTitle(optional): 
            string
            Job title for this shipping address.
- 
            lastName(optional): 
            string
            Last name for this shipping address.
- 
            middleName(optional): 
            string
            Middle name for this shipping address.
- 
            phoneNumber(optional): 
            string
            Phone number for this shipping address.
- 
            postalCode(optional): 
            string
            Postal code for this shipping address.
- 
            prefix(optional): 
            string
            Prefix for this shipping address.
- 
            selectedCountry(optional): 
            string
            The selected country of the shipping address.
- 
            selectedState(optional): 
            string
            The selected state of the shipping address.
- 
            state(optional): 
            string
            State for this shipping address.
- 
            state_ISOCode(optional): 
            string
            The state ISON code of the shipping address.
- 
            suffix(optional): 
            string
            Suffix for this shipping address.
Nested Schema : shippingMethod
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectShipping method information.
    
    
    
    
        Show Source
        - 
            cost(optional): 
            number
            shipping cost.
- 
            displayName(optional): 
            string
            Display Name of shipment.
- 
            secondaryCurrencyShippingAmount(optional): 
            string
            shipping amount in secondary currency.
- 
            secondaryCurrencyTaxAmount(optional): 
            string
            tax amount in secondary currency.
- 
            value(optional): 
            string
            method type of shipment.
Nested Schema : store
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectInformation about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
    
    
    
    
        Show Source
        - 
            address1(optional): 
            string
            Address line 1 of the store.
- 
            address2(optional): 
            string
            Address line 2 of the store.
- 
            address3(optional): 
            string
            Address line 3 of the store.
- 
            city(optional): 
            string
            The city in which the store resides.
- 
            country(optional): 
            string
            The country in which the store resides.
- 
            county(optional): 
            string
            The county in which the store resides.
- 
            email(optional): 
            string
            The email address of the store.
- 
            faxNumber(optional): 
            string
            The fax number of the store.
- 
            hours(optional): 
            string
            The opening hours of the store.
- 
            locationId(optional): 
            string
            The location id of the store.
- 
            name(optional): 
            string
            Name of the store.
- 
            phoneNumber(optional): 
            string
            The phone number of the store.
- 
            postalCode(optional): 
            string
            The postal code of the store.
- 
            stateAddress(optional): 
            string
            The state in which the store resides.
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.
- 
            asset(optional): 
            boolean
            The flag that determines if the current item is an asset or not.
- 
            assetKey(optional): 
            string
            The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
- 
            availablePickupDate(optional): 
            string
            The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
- 
            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: 
            string
            catRefId of the product.
- 
            commerceItemId(optional): 
            string
            The unique id of the line item.
- 
            customerAccountId(optional): 
            string
            The customer account ID associated to the current item.
- 
            deactivationDate(optional): 
            string
            The deactivation date in ISO format.
- 
            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.
- 
            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.
- 
            preferredPickupDate(optional): 
            string
            The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
- 
            productId: 
            string
            Id of the product.
- 
            quantity: 
            integer
            quantity of the product.
- 
            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.
- 
            serviceAccountId(optional): 
            string
            The service account ID associated to the current item.
- 
            serviceId(optional): 
            string
            The service ID associated to the current item.
- 
            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.
- 
            variant(optional): 
            array  variant
            
            Product Variant Information.
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
            Name of the Dynamic attribute.
- 
            optionValue(optional): 
            string
            Value of the Dynamic attribute.
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.
- 
            asset(optional): 
            boolean
            The flag that determines if the current item is an asset or not.
- 
            assetKey(optional): 
            string
            The assetKey is only assigned 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
            Catalog Reference Id of commerce item.
- 
            childItems(optional): 
            array  childItems
            
            Child items of the commerce item
- 
            commerceItemId(optional): 
            string
            The unique id of the line item.
- 
            configuratorId(optional): 
            string
            Configuration id of the configurable product
- 
            customerAccountId(optional): 
            string
            The customer account ID associated to the current item.
- 
            deactivationDate(optional): 
            string
            The deactivation date in ISO format.
- 
            discountAmount(optional): 
            number
            Total discount applied to commerce item.
- 
            discountInfo(optional): 
            object  discountInfo
            
            Discount information.
- 
            displayName(optional): 
            string
            Display name of commerce item.
- 
            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
            The Price of the product as per the external pricing system.
- 
            externalPriceQuantity(optional): 
            integer
            Quantity of the product, the customer is allowed to buy at the external price.
- 
            giftWithPurchaseCommerceItemMarkers(optional): 
            array  giftWithPurchaseCommerceItemMarkers
            
            The array of giftWithPurchaseCommerceItemMarkers.
- 
            imageInfo(optional): 
            object  imageInfo
            
            Shipping method information.
- 
            isPriceOverridden(optional): 
            boolean
            Indicates if commerce item price is overridden or not.
- 
            onSale(optional): 
            boolean
            indicates if product is on sale or not
- 
            originalCommerceItemId(optional): 
            string
            The Commerce Item ID associated with the original item from which item in cancel order is created.
- 
            overriddenPrice(optional): 
            number
            overridden price of 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.
- 
            price(optional): 
            number
            The raw number that represents the price.
- 
            priceOverridenBy(optional): 
            string
            Name of the agent who has overridden item price.
- 
            priceOverrideReason(optional): 
            object  priceOverrideReason
            
            Price override reason map.
- 
            productId(optional): 
            string
            Product Id of commerce item.
- 
            quantity(optional): 
            number
            Quantity of the items.
- 
            rawTotalPrice(optional): 
            number
            The raw total price.
- 
            returnedQuantity(optional): 
            number
            Quantity for which return request has been raised.
- 
            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
- 
            stateDescription(optional): 
            string
            Item state as a key string.
- 
            stateDetailsAsUser(optional): 
            string
            State description of the commerce item.
- 
            status(optional): 
            integer
            State of the commerce item.
- 
            subTotal(optional): 
            number
            The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.
- 
            tax(optional): 
            number
            The amount of tax paid for this item.
- 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
- 
            unitPrice(optional): 
            number
            Sale price or list price of commerceItem.
- 
            variant(optional): 
            array  variant
            
            Product Variant Information.
Nested Schema : discountInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectDiscount information.
    
    
    
    
        Show Source
        - 
            orderCouponsMap(optional): 
            object  orderCouponsMap
            
            The coupons that were claimed.
- 
            orderDiscount(optional): 
            number
            Discount given on an order.
- 
            orderImplicitDiscountList(optional): 
            array  orderImplicitDiscountList
            
            List of discounts.
- 
            secondaryCurrencyShippingDiscount(optional): 
            number
            The shipping discount in secondary currency in case of mix currency scenario.
- 
            shippingDiscount(optional): 
            number
            The shipping discount.
- 
            unclaimedCouponsMap(optional): 
            array  unclaimedCouponsMap
            
            Map of unclaimed coupons.
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 : imageInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectShipping method information.
    
    
    
    
        Show Source
        - 
            primaryThumbImageURL(optional): 
            string
            ThumbNail Image URL
Nested Schema : priceOverrideReason
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPrice override reason map.
    
    
    
    
        Show Source
        - 
            displayValue(optional): 
            string
            price override reason value.
- 
            key(optional): 
            string
            price override reason key.
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 sub commerce item is an add-on (internally configured) or not (externally configured).
- 
            asset(optional): 
            boolean
            The flag that determines if the current item is an asset or not.
- 
            assetKey(optional): 
            string
            The assetKey is only assigned 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
            Sku Id of the child item
- 
            childItems(optional): 
            array  childItems
            
            Child items of the commerce item
- 
            configurablePropertyId(optional): 
            string
            ID of the catalog's configurableProperty associated with this sub commerce item.
- 
            configurationOptionId(optional): 
            string
            ID of the catalog's configurationOption associated with this sub commerce item.
- 
            customerAccountId(optional): 
            string
            The customer account ID associated to the current item.
- 
            deactivationDate(optional): 
            string
            The deactivation date in ISO format.
- 
            displayName(optional): 
            string
            Display name of the child product
- 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a configurator system.
- 
            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
            Product Id of the child item
- 
            quantity(optional): 
            number
            Quantity of the child 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.
- 
            route(optional): 
            string
            Product path
- 
            selectedOptions(optional): 
            array  selectedOptions
            
            Child Product Variant Information.
- 
            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
- 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
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 item by the configurator system.
- 
            activationDate(optional): 
            string
            The activation date in ISO format.
- 
            addOnItem(optional): 
            boolean
            Whether the sub commerce item is an add-on (internally configured) or not (externally configured).
- 
            asset(optional): 
            boolean
            The flag that determines if the current item is an asset or not.
- 
            assetKey(optional): 
            string
            The assetKey is only assigned 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
            Sku Id of the child item
- 
            commerceItemId(optional): 
            string
            commerce item id of the child item
- 
            configurablePropertyId(optional): 
            string
            ID of the catalog's configurableProperty associated with this sub commerce item.
- 
            configurationOptionId(optional): 
            string
            ID of the catalog's configurationOption associated with this sub commerce item.
- 
            customerAccountId(optional): 
            string
            The customer account ID associated to the current item.
- 
            deactivationDate(optional): 
            string
            The deactivation date in ISO format.
- 
            displayName(optional): 
            string
            Display name of the child product
- 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a configurator system.
- 
            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
            Product Id of the child item
- 
            quantity(optional): 
            number
            Quantity of the child 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.
- 
            route(optional): 
            string
            Product path
- 
            selectedOptions(optional): 
            array  selectedOptions
            
            Child Product Variant Information.
- 
            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.
- 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
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- 
            optionName(optional): 
            string
            Name of the Dynamic attribute.
- 
            optionValue(optional): 
            string
            Value of the Dynamic attribute.
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- 
            optionName(optional): 
            string
            Name of the Dynamic attribute.
- 
            optionValue(optional): 
            string
            Value of the Dynamic attribute.
Nested Schema : orderCouponsMap
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe coupons that were claimed.
    
    
    
    
        Show Source
        - 
            couponCode(optional): 
            object  couponCode
            
            Coupon Code.
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.
- 
            totalAdjustment(optional): 
            number
            Total adjustment caused by the promotion.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            promotionDesc(optional): 
            string
            Description of the promotion.
- 
            promotionId(optional): 
            string
            Id of the promotion.
- 
            promotionLevel(optional): 
            string
            The promotion level.
- 
            totalAdjustment(optional): 
            string
            Total adjustment caused by the promotion.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            couponInfo(optional): 
            array  couponInfo
            
            The coupon Info.
- 
            promotionValue(optional): 
            string
            The value for promotion.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            promotionDesc(optional): 
            string
            Description of the promotion.
- 
            promotionId(optional): 
            string
            Id of the promotion.
- 
            promotionLevel(optional): 
            string
            The promotion level.
- 
            totalAdjustment(optional): 
            string
            Total adjustment caused by 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- 
            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 GWP promotion.
- 
            key(optional): 
            string
            atg.gwp
- 
            remainingQuantity(optional): 
            number
            The quantity of the commerce item that is not affected by GWP.
- 
            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- 
            optionName(optional): 
            string
            Name of the Dynamic SKU Property.
- 
            optionValue(optional): 
            string
            Value of the Dynamic SKU Property.
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            optionName(optional): 
            string
            Name of the Dynamic attribute.
- 
            optionValue(optional): 
            string
            Value of the Dynamic attribute.
Example Response (application/json)
                    {
    "totalAmountAuthorized":124.18,
    "orderComments":[
    ],
    "creationTime":1.436906449E12,
    "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",
            "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":[
    ],
    "pricingMessages":{
        "promotionUpsellMessages":[
            {
                "text":"Spend $20 more get free shipping!",
                "tags":[
                    "CART_UPSELL"
                ]
            },
            {
                "text":"You have qualified for a free Sports DVD!",
                "tags":[
                    "BANNER_UPSELL",
                    "CART_UPSELL"
                ]
            }
        ]
    },
    "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"
                },
                "childItems":[
                    {
                        "deactivationDate":"2018-06-27T12:59:59Z",
                        "addOnItem":true,
                        "displayName":"Intel Pentium Dual Core",
                        "externalData":[
                        ],
                        "billingProfileId":"billingProfile-123",
                        "billingAccountId":"billingAcc-123",
                        "childItems":[
                            {
                                "serviceAccountId":"serviceAcc-123",
                                "deactivationDate":"2018-06-27T12:59:59Z",
                                "quantity":1,
                                "productId":"prod40007",
                                "displayName":"8 GB Kingston Sodimm DDR3 1600MHz",
                                "externalData":[
                                ],
                                "parentAssetKey":"56789",
                                "billingProfileId":"billingProfile-123",
                                "billingAccountId":"billingAcc-123",
                                "rootAssetKey":"12345",
                                "transactionDate":"2018-06-27T12:59:59Z",
                                "catRefId":"sku40009",
                                "assetKey":"23456",
                                "route":"/8-gb-kingston-sodimm-ddr3-1600mhz/product/prod40007",
                                "customerAccountId":"customerAcc-123",
                                "selectedOptions":[
                                ],
                                "siteId":"siteUS",
                                "actionCode":"Add",
                                "activationDate":"2017-06-27T15:30:00Z",
                                "serviceId":"service-123",
                                "asset":false
                            }
                        ],
                        "assetKey":"56789",
                        "commerceItemId":"ci19000424",
                        "selectedOptions":[
                        ],
                        "actionCode":"Add",
                        "serviceId":"service-123",
                        "serviceAccountId":"serviceAcc-123",
                        "configurationOptionId":"co40001",
                        "quantity":1,
                        "productId":"prod40001",
                        "parentAssetKey":null,
                        "rootAssetKey":null,
                        "configurablePropertyId":"cp40001",
                        "transactionDate":"2018-06-27T12:59:59Z",
                        "catRefId":"sku40001",
                        "route":"/intel-pentium-dual-core/product/prod40001",
                        "customerAccountId":"customerAcc-123",
                        "siteId":"siteUS",
                        "activationDate":"2017-06-27T15:30:00Z",
                        "asset":false
                    },
                    {
                        "serviceAccountId":"serviceAcc-123",
                        "deactivationDate":"2018-06-27T12:59:59Z",
                        "addOnItem":false,
                        "quantity":1,
                        "productId":"prod40007",
                        "displayName":"8 GB Kingston Sodimm DDR3 1600MHz",
                        "externalData":[
                        ],
                        "parentAssetKey":"12345",
                        "billingProfileId":"billingProfile-123",
                        "billingAccountId":"billingAcc-123",
                        "rootAssetKey":"12345",
                        "transactionDate":"2018-06-27T12:59:59Z",
                        "catRefId":"sku40007",
                        "assetKey":"98765",
                        "commerceItemId":"ci19000426",
                        "route":"/8-gb-kingston-sodimm-ddr3-1600mhz/product/prod40007",
                        "customerAccountId":"customerAcc-123",
                        "selectedOptions":[
                        ],
                        "siteId":"siteUS",
                        "actionCode":"Add",
                        "activationDate":"2017-06-27T15:30:00Z",
                        "serviceId":"service-123",
                        "asset":false
                    },
                    {
                        "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",
                "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,
                "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":"12345",
                "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":"94736",
                "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"
            },
            "trackingNumber":null,
            "items":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":1,
                    "productId":"Product_21Cxi",
                    "pointOfNoRevision":false,
                    "relationshipType":"SHIPPINGQUANTITY",
                    "externalData":[
                    ],
                    "parentAssetKey":null,
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "rootAssetKey":null,
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "catRefId":"Sku_21Dxy",
                    "assetKey":"96492",
                    "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":[
                    ],
                    "siteId":"siteUS",
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "asset":false
                }
            ]
        }
    ],
    "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"
    },
    "returnRequests":[
    ],
    "creationDate":"2015-07-14T20:40:49.000Z",
    "orderAction":"order",
    "submissionErrorCodes":[
    ],
    "discountInfo":{
        "unclaimedCouponMultiPromotions":{
        },
        "orderCouponsMap":{
        },
        "orderDiscount":0,
        "shippingDiscount":0,
        "orderImplicitDiscountList":[
        ],
        "unclaimedCouponsMap":{
        },
        "claimedCouponMultiPromotions":{
        }
    },
    "submissionErrorMessages":[
    ],
    "profileId":"se-570031",
    "exchangeRequests":[
    ],
    "giftWithPurchaseInfo":[
    ],
    "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"
    },
    "siteId":"siteUS",
    "giftWithPurchaseOrderMarkers":[
    ]
}Default Response
The error response. In case of any failure in external tax or external shipping webhooks, the errors returned in the webhook response payload get added to the errors property in this endpoint???s 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|
|------------------|------------------|
|28088|The selected shipping method is no longer available.|
|28122|Specified order does not exist|
|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|
|28123|The order cannot be repriced.|
|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|
|28124|An error occurred while re-pricing the order.|
|100101|The shopper profile does not belong to organization passed in the header|
                
                
                    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