copyOrder
post
/ccagent/v1/orders/copyOrder
Copy Order. Duplicates given order.
1. The cloned order will always be in INCOMPLETE state
2. PaymentGroups and coupons/promotions if any would not be copied
3. If there is an already existing incomplete order it would be merged with newly created clone order.
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
-
Type:
stringthe organization Id in which order should be created
Body Parameter
Root Schema : copyOrder_request
{
"orderId":"o30411",
"exclude":{
"commerceItem":[
"priceInfo",
"externalPriceDetails"
],
"order":[
"approverMessages",
"quoteInfo",
"approverIds",
"submittedDate",
"originOfOrder",
"createdByOrderId",
"priceInfo",
"externalOrderPriceDetails",
"cancelReason",
"shippingGroups",
"relationships",
"paymentGroups"
]
}
}
- exclude
-
Type:
objectexcludeAdditional Properties Allowed:Properties to exclude at the time of copy order. Key is item descriptor name. Value is the aray of properties which we want to exclude - pInputData
-
Type:
stringRequired:trueOrder Id to be duplicated
Nested Schema : exclude
Type:
objectProperties to exclude at the time of copy order. Key is item descriptor name. Value is the aray of properties which we want to exclude
- commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed:Item descriptor name - order
-
Type:
arrayorderAdditional Properties Allowed:Item descriptor name
Nested Schema : commerceItems
Nested Schema : order
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : copyOrder_response
- approvalSystemMessages
-
Type:
arrayapprovalSystemMessagesAdditional Properties Allowed:The array of messages which are stored during order processing - billingMethod
-
Type:
objectbillingMethodAdditional Properties Allowed:billing Method information of the order. - creationDate
-
Type:
stringDate on which the Order was created. - creationTime
-
Type:
numberOrder creation time. - discountInfo
-
Type:
objectdiscountInfoAdditional Properties Allowed:Discount information. - dynamicProperties
-
Type:
arraydynamicPropertiesAdditional Properties Allowed:Read-only list of dynamic properties for the order along with meta-data. - giftWithPurchaseInfo
-
Type:
arraygiftWithPurchaseInfoAdditional Properties Allowed:Gift Selection Information - giftWithPurchaseOrderMarkers
-
Type:
arraygiftWithPurchaseOrderMarkersAdditional Properties Allowed:Gift With Purchase order markers information - id
-
Type:
stringCommerce id for this duplicated order. - orderComments
-
Type:
arrayorderCommentsAdditional Properties Allowed:The list of all logged comments for the order. - paymentGroup
-
Type:
objectpaymentGroupAdditional Properties Allowed:Payment Group for the order. - paymentGroups
-
Type:
arraypaymentGroupsAdditional Properties Allowed:List of payment Groups for the order. - priceInfo
-
Type:
objectpriceInfoAdditional Properties Allowed:Price information of the order. - priceListGroup
-
Type:
objectpriceListGroupAdditional Properties Allowed:PriceList group of the order. - profile
-
Type:
objectprofileAdditional Properties Allowed:Profile Information for the order. - profileId
-
Type:
stringThe Repository Id of the profile to which this Order belongs to. - returnRequests
-
Type:
arrayreturnRequestsAdditional Properties Allowed:The list of the requests raised for the order. - shippingAddress
-
Type:
objectshippingAddressAdditional Properties Allowed:shipping address for the order. - shippingGroups
-
Type:
arrayshippingGroupsAdditional Properties Allowed:Shipping Group infomration - shippingMethod
-
Type:
objectshippingMethodAdditional Properties Allowed:Shipping method information. - shoppingCart
-
Type:
objectshoppingCartAdditional Properties Allowed:Shopping cart information. - sourceSystem
-
Type:
stringThe system where the order originated. - state
-
Type:
integerThe order state. - stateDetailsAsUser
-
Type:
stringOrder State description for this order. - taxPriceInfo
-
Type:
objecttaxPriceInfoAdditional Properties Allowed:The tax pricing details for the order.
Nested Schema : approvalSystemMessages
Nested Schema : billingMethod
Type:
objectbilling Method information of the order.
- cost
-
Type:
numberbilling Cost for this order. - displayName
-
Type:
stringbilling method display name for this billing method. - value
-
Type:
stringbilling method name for this order.
Nested Schema : discountInfo
Type:
objectDiscount information.
- orderCouponsMap
-
Type:
arrayorderCouponsMapAdditional Properties Allowed:Map of coupons. - orderDiscount
-
Type:
numberDiscount given on an order. - orderImplicitDiscountList
-
Type:
arrayorderImplicitDiscountListAdditional Properties Allowed:List of discounts. - unclaimedCouponsMap
-
Type:
arrayunclaimedCouponsMapAdditional Properties Allowed:Map of unclaimed coupons.
Nested Schema : dynamicProperties
Nested Schema : giftWithPurchaseInfo
Nested Schema : giftWithPurchaseOrderMarkers
Nested Schema : orderComments
Nested Schema : paymentGroup
Type:
objectPayment Group for the order.
- amount
-
Type:
numberThe amount associated with this Payment Group. - amountAuthorized
-
Type:
numberThe amount authorized with this Payment Group. - billingAddress
-
Type:
objectbillingAddressAdditional Properties Allowed:Billing address for the order. - cardNumber
-
Type:
stringThe masked credit card number. - cardType
-
Type:
stringThe credit card type. - firstName
-
Type:
stringFirst name associated with this Payment Group. - lastName
-
Type:
stringLast name associated with this Payment Group. - paidAmount
-
Type:
numberThe amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
integerId of this payment Group. - paymentState
-
Type:
stringThe Payment Group state. - paymentStateDetailsAsUser
-
Type:
stringThe payment state description as string. - refundAmount
-
Type:
numberThe amount that has been credited to-date for this Payment Group. - token
-
Type:
stringToken associated with this Payment Group. - totalDue
-
Type:
numberThe current working total order price including all discounts, tax, and billing costs. - uiIntervention
-
Type:
stringThis decides whether the client has to do some intervention for payment. e.g. SOP - zero_value_auto_authorized
-
Type:
stringThe Payment Group is auto authorized without any payment details for zero amount. e.g. true
Nested Schema : paymentGroups
Nested Schema : priceInfo
Type:
objectPrice information of the order.
- amount
-
Type:
numberThe raw number that represents the price. - billing
-
Type:
numberThe billing cost of the order. - currencyCode
-
Type:
stringIndicates the currency of the price. For example, USD indicates that the price is in US dollars. - subTotal
-
Type:
numberThe subtotal of the order before applying order-level promotions. - tax
-
Type:
numberThe tax on the order. - total
-
Type:
numberThe current working total, including all promotions, tax, and billing costs.
Nested Schema : priceListGroup
Type:
objectPriceList group of the order.
- active
-
Type:
booleanActive status of pricelist group. - currency
-
Type:
objectcurrencyAdditional Properties Allowed:Currency of the PriceList group. - deleted
-
Type:
booleanPricelist group deleted status. - displayName
-
Type:
stringDisplay Name. - id
-
Type:
stringId. - locale
-
Type:
stringLocale. - repositoryId
-
Type:
stringRepository Id.
Nested Schema : profile
Type:
objectProfile Information for the order.
-
Type:
stringEmail Address corresponding to the profile. - firstName
-
Type:
stringFirst name of profile. - lastName
-
Type:
stringLast name of profile. - middleName
-
Type:
stringMiddle name of profile. - organization
-
Type:
objectorganizationAdditional Properties Allowed:The Organization associated with the B2B customer profile.
Nested Schema : returnRequests
Nested Schema : shippingAddress
Type:
objectshipping address for the order.
- address1
-
Type:
stringAddress Line 1 for this shipping address. - address2
-
Type:
stringAddress Line 2 for this shipping address. - address3
-
Type:
stringAddress Line 3 for this shipping address. - city
-
Type:
stringCity for this shipping address. - companyName
-
Type:
stringCompany name for this shipping address. - country
-
Type:
stringCountry for this shipping address. - county
-
Type:
stringCounty for this shipping address. -
Type:
stringEmail for this shipping address. - faxNumber
-
Type:
stringFax number for this shipping address. - firstName
-
Type:
stringFirst name for this shipping address. - jobTitle
-
Type:
stringJob title for this shipping address. - lastName
-
Type:
stringLast name for this shipping address. - middleName
-
Type:
stringMiddle name for this shipping address. - phoneNumber
-
Type:
stringPhone number for this shipping address. - postalCode
-
Type:
stringPostal code for this shipping address. - prefix
-
Type:
stringPrefix for this shipping address. - selectedCountry
-
Type:
stringThe selected country of the shipping address. - selectedState
-
Type:
stringThe selected state of the shipping address. - state
-
Type:
stringState for this shipping address. - state_ISOCode
-
Type:
stringThe state ISON code of the shipping address. - suffix
-
Type:
stringSuffix for this shipping address.
Nested Schema : shippingGroups
Nested Schema : shippingMethod
Type:
objectShipping method information.
- cost
-
Type:
numbershipping cost. - displayName
-
Type:
stringDisplay Name of shipment. - value
-
Type:
stringmethod type of shipment.
Nested Schema : shoppingCart
Type:
objectShopping cart information.
- items
-
Type:
arrayitemsAdditional Properties Allowed:Items in the cart.
Nested Schema : taxPriceInfo
Type:
objectThe tax pricing details for the order.
- amount
-
Type:
numberThe monetary amount. - amountIsFinal
-
Type:
booleanWhether the amount is final. - cityTax
-
Type:
numberThe monetary amount of city tax. - countryTax
-
Type:
numberThe monetary amount of country tax. - countyTax
-
Type:
numberThe monetary amount of county tax. - currencyCode
-
Type:
stringThe three character currency code. - discounted
-
Type:
booleanWhether the price was discounted. - districtTax
-
Type:
numberTax amount for the district. - stateTax
-
Type:
numberTax amount for the state.
Nested Schema : orderCouponsMap
Nested Schema : orderImplicitDiscountList
Nested Schema : unclaimedCouponsMap
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringDescription of the promotion. - promotionId
-
Type:
stringId of the promotion. - promotionLevel
-
Type:
stringLevel of the promotion. - totalAdjustment
-
Type:
stringTotal adjustment caused by the promotion.
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringDescription of the promotion. - promotionId
-
Type:
stringId of the promotion. - promotionLevel
-
Type:
stringLevel of the promotion. - totalAdjustment
-
Type:
stringTotal adjustment caused by the promotion.
Nested Schema : items
Type:
object- couponInfo
-
Type:
arraycouponInfoAdditional Properties Allowed:The coupon Info. - promotionValue
-
Type:
stringThe value for promotion.
Nested Schema : couponInfo
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringDescription of the promotion. - promotionId
-
Type:
stringId of the promotion. - promotionLevel
-
Type:
stringLevel of the promotion. - totalAdjustment
-
Type:
stringTotal adjustment caused by the promotion.
Nested Schema : items
Type:
object- id
-
Type:
stringThe ID of the dynamic property. - value
-
Type:
stringThe value of the dynamic property.
Nested Schema : items
Type:
object- giftWithPurchaseDetail
-
Type:
stringString identifying the gift usually the repository ID of the gift type. - giftWithPurchaseIdentifier
-
Type:
integerAn identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. - giftWithPurchaseQuantityAvailableForSelection
-
Type:
numberQuantity of gift that the shopper still needs to select. - giftWithPurchaseType
-
Type:
stringThe type of gift like sku, product, category, skuContentGroup or productContentGroup. - promotionDesc
-
Type:
stringThe promotion description. - promotionId
-
Type:
stringThe gift with purchase promotion id
Nested Schema : items
Type:
object- automaticQuantity
-
Type:
numberThe quantity of free sku for this gift selection that has already been auto added to the order. - autoRemove
-
Type:
booleanFlag to indicate whether free gifts should be auto removed if the promotion no longer qualifies. - data
-
Type:
stringGift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. - failedQuantity
-
Type:
numberThe amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.. - giftDetail
-
Type:
stringString identifying the free gift, usually the repository id of the gift type. - giftType
-
Type:
stringThe type of gift like sku, product, category, skuContentGroup or productContentGroup. - key
-
Type:
stringatg.gwp. - quantity
-
Type:
numberThe total quantity of sku for this gift selection. - removedQuantity
-
Type:
numberThe amount of free quantity that has since been manually removed by a Shopper. - repositoryId
-
Type:
stringThe repository id of the gwp order marker. - selectedQuantity
-
Type:
numberThe quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order. - targetedQuantity
-
Type:
numberThe quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order. - value
-
Type:
stringThe GWP promotion id.
Nested Schema : items
Type:
object- comment
-
Type:
stringThe comment string. - creationDate
-
Type:
stringDate on which the comment was created. - repositoryId
-
Type:
stringThe repository id of the comment record.
Nested Schema : billingAddress
Type:
objectBilling address for the order.
- address1
-
Type:
stringAddress line 1 for this billing address. - address2
-
Type:
stringAddress line 2 for this billing address. - address3
-
Type:
stringAddress line 3 for this billing address. - city
-
Type:
stringCity for this billing address. - companyName
-
Type:
stringCompany name for this billing address. - country
-
Type:
stringCountry for this billing address. - county
-
Type:
stringCounty for this billing address. -
Type:
stringEmail for this billing address. - faxNumber
-
Type:
stringFax number for this billing address. - firstName
-
Type:
stringFirst name for this billing address. - jobTitle
-
Type:
stringJob title for this billing address. - lastName
-
Type:
stringLast name for this billing address. - middleName
-
Type:
stringMiddle name for this billing address. - phoneNumber
-
Type:
stringPhone number for this billing address. - postalCode
-
Type:
stringPostal code for this billing address. - prefix
-
Type:
stringPrefix for this billing address. - selectedCountry
-
Type:
stringThe selected country of the shipping address. - selectedState
-
Type:
stringThe selected state of the shipping address. - state
-
Type:
stringState for this billing address. - state_ISOCode
-
Type:
stringThe state ISON code of the shipping address. - suffix
-
Type:
stringSuffix for this billing address.
Nested Schema : items
Type:
object- amount
-
Type:
numberThe amount associated with this Payment Group. - amountAuthorized
-
Type:
numberThe amount authorized with this Payment Group. - billingAddress
-
Type:
objectbillingAddressAdditional Properties Allowed:Billing address for the order. - cardNumber
-
Type:
stringThe masked credit card number. - cardType
-
Type:
stringPayment method. e.g. physicalGiftCard/ creditCard - firstName
-
Type:
stringFirst name associated with this Payment Group. - lastName
-
Type:
stringLast name associated with this Payment Group. - paidAmount
-
Type:
numberThe amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
integerId of this payment Group. - paymentState
-
Type:
stringThe Payment Group state. - paymentStateDetailsAsUser
-
Type:
stringThe payment state description as string. - refundAmount
-
Type:
numberThe amount that has been credited to-date for this Payment Group. - token
-
Type:
stringToken associated with this Payment Group. - totalDue
-
Type:
numberThe current working total order price including all discounts, tax, and billing costs. - uiIntervention
-
Type:
stringThis decides whether the client has to do some intervention for payment. e.g. SOP - zero_value_auto_authorized
-
Type:
stringThe Payment Group is auto authorized without any payment details for zero amount. e.g. true
Nested Schema : billingAddress
Type:
objectBilling address for the order.
- address1
-
Type:
stringAddress line 1 for this billing address. - address2
-
Type:
stringAddress line 2 for this billing address. - address3
-
Type:
stringAddress line 3 for this billing address. - city
-
Type:
stringCity for this billing address. - companyName
-
Type:
stringCompany name for this billing address. - country
-
Type:
stringCountry for this billing address. - county
-
Type:
stringCounty for this billing address. -
Type:
stringEmail for this billing address. - faxNumber
-
Type:
stringFax number for this billing address. - firstName
-
Type:
stringFirst name for this billing address. - jobTitle
-
Type:
stringJob title for this billing address. - lastName
-
Type:
stringLast name for this billing address. - middleName
-
Type:
stringMiddle name for this billing address. - phoneNumber
-
Type:
stringPhone number for this billing address. - postalCode
-
Type:
stringPostal code for this billing address. - prefix
-
Type:
stringPrefix for this billing address. - selectedCountry
-
Type:
stringThe selected country of the shipping address. - selectedState
-
Type:
stringThe selected state of the shipping address. - state
-
Type:
stringState for this billing address. - state_ISOCode
-
Type:
stringThe state ISON code of the shipping address. - suffix
-
Type:
stringSuffix for this billing address.
Nested Schema : currency
Type:
objectCurrency of the PriceList group.
- currencyCode
-
Type:
stringCurrency Code. - displayName
-
Type:
stringDisplay Name. - fractionalDigits
-
Type:
integerFractional Digits. - numericCode
-
Type:
stringNumeric Code. - repositoryId
-
Type:
stringRepository Id. - symbol
-
Type:
stringcurrency Symbol.
Nested Schema : organization
Type:
objectThe Organization associated with the B2B customer profile.
- id
-
Type:
stringThe id of the organization. - name
-
Type:
stringThe name of of the organization.
Nested Schema : items
Type:
object- createdDate
-
Type:
stringThe creation date of the return request. - returnRequestId
-
Type:
stringThe return request id. - state
-
Type:
stringThe status of the return request. - totalRefund
-
Type:
numberThe total amount to be refunded on return. - totalReturnQuantity
-
Type:
integerThe total quantity for which return request has been raised.
Nested Schema : items
Type:
object- items
-
Type:
arrayitemsRequired:trueAdditional Properties Allowed:Items in the cart. - shippingAddress
-
Type:
objectshippingAddressAdditional Properties Allowed:shipping address for the order. - shippingMethod
-
Type:
objectshippingMethodAdditional Properties Allowed:Shipping method information. - trackingInfo
-
Type:
arraytrackingInfoAdditional Properties Allowed:Tracking Information for the Order. - trackingNumber
-
Type:
stringShipping tracking number.
Nested Schema : items
Nested Schema : shippingAddress
Type:
objectshipping address for the order.
- address1
-
Type:
stringAddress Line 1 for this shipping address. - address2
-
Type:
stringAddress Line 2 for this shipping address. - address3
-
Type:
stringAddress Line 3 for this shipping address. - city
-
Type:
stringCity for this shipping address. - companyName
-
Type:
stringCompany name for this shipping address. - country
-
Type:
stringCountry for this shipping address. - county
-
Type:
stringCounty for this shipping address. -
Type:
stringEmail for this shipping address. - faxNumber
-
Type:
stringFax number for this shipping address. - firstName
-
Type:
stringFirst name for this shipping address. - jobTitle
-
Type:
stringJob title for this shipping address. - lastName
-
Type:
stringLast name for this shipping address. - middleName
-
Type:
stringMiddle name for this shipping address. - phoneNumber
-
Type:
stringPhone number for this shipping address. - postalCode
-
Type:
stringPostal code for this shipping address. - prefix
-
Type:
stringPrefix for this shipping address. - selectedCountry
-
Type:
stringThe selected country of the shipping address. - selectedState
-
Type:
stringThe selected state of the shipping address. - state
-
Type:
stringState for this shipping address. - state_ISOCode
-
Type:
stringThe state ISON code of the shipping address. - suffix
-
Type:
stringSuffix for this shipping address.
Nested Schema : shippingMethod
Type:
objectShipping method information.
- cost
-
Type:
numbershipping cost. - displayName
-
Type:
stringDisplay Name of shipment. - value
-
Type:
stringmethod type of shipment.
Nested Schema : trackingInfo
Nested Schema : items
Type:
object- catRefId
-
Type:
stringRequired:truecatRefId of the product. - productId
-
Type:
stringRequired:trueId of the product. - quantity
-
Type:
integerRequired:truequantity of the product. - skuProperties
-
Type:
arrayskuPropertiesAdditional Properties Allowed:Sku properties Information - variant
-
Type:
arrayvariantAdditional Properties Allowed:Product Variant Information.
Nested Schema : skuProperties
Nested Schema : variant
Nested Schema : items
Type:
object- id
-
Type:
stringID of the Dynamic SKU Property. - name
-
Type:
stringName of the Dynamic SKU Property. - propertyType
-
Type:
stringType that indicates whether it is a base or a custom SKU property, - value
-
Type:
stringValue of the Dynamic SKU Property.
Nested Schema : items
Type:
object- optionName
-
Type:
stringName of the Dynamic attribute. - optionValue
-
Type:
stringValue of the Dynamic attribute.
Nested Schema : items
Type:
object- carrierId
-
Type:
stringCarrier Id for Tracking. - carrierName
-
Type:
stringCarrier Name for Tracking. - carrierUrl
-
Type:
stringCarrier URL for Tracking. - trackingNumber
-
Type:
stringTracking Number.
Nested Schema : items
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - billingAccountId
-
Type:
stringThe billing account ID associated to the current item. - catRefId
-
Type:
stringCatalog Reference Id of commerce item. - childItems
-
Type:
arraychildItemsAdditional Properties Allowed:Child items of the commerce item - commerceItemId
-
Type:
stringCommerceItemId id of the configurable product - configuratorId
-
Type:
stringConfiguration id of the configurable product - customerAccountId
-
Type:
stringThe customer account ID associated to the current item. - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - discountInfo
-
Type:
objectdiscountInfoAdditional Properties Allowed:Discount information. - displayName
-
Type:
stringDisplay name of commerce item. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - giftWithPurchaseCommerceItemMarkers
-
Type:
arraygiftWithPurchaseCommerceItemMarkersAdditional Properties Allowed:The array of giftWithPurchaseCommerceItemMarkers. - imageInfo
-
Type:
objectimageInfoAdditional Properties Allowed:Shipping method information. - onSale
-
Type:
booleanIndicates if product is on Sale or not. - price
-
Type:
numberThe raw number that represents the price. - productId
-
Type:
stringProduct Id of commerce item. - quantity
-
Type:
numberQuantity of the items. - rawTotalPrice
-
Type:
numberThe raw total price. - returnedQuantity
-
Type:
numberQuantity for which return request has been raised. - serviceAccountId
-
Type:
stringThe service account ID associated to the current item. - serviceId
-
Type:
stringThe service ID associated to the current item. - skuProperties
-
Type:
arrayskuPropertiesAdditional Properties Allowed:Sku properties Information - stateDetailsAsUser
-
Type:
stringState description of the commerce item. - status
-
Type:
integerState of the commerce item. - subTotal
-
Type:
numberThe base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice. - tax
-
Type:
numberThe amount of tax paid for this item. - unitPrice
-
Type:
numberSale price or list price of commerceItem. - variant
-
Type:
arrayvariantAdditional Properties Allowed:Product Variant Information.
Nested Schema : childItems
Nested Schema : discountInfo
Type:
objectDiscount information.
- orderCouponsMap
-
Type:
arrayorderCouponsMapAdditional Properties Allowed:Map of coupons. - orderDiscount
-
Type:
numberDiscount given on an order. - orderImplicitDiscountList
-
Type:
arrayorderImplicitDiscountListAdditional Properties Allowed:List of discounts. - unclaimedCouponsMap
-
Type:
arrayunclaimedCouponsMapAdditional Properties Allowed:Map of unclaimed coupons.
Nested Schema : externalData
Nested Schema : giftWithPurchaseCommerceItemMarkers
Nested Schema : imageInfo
Type:
objectShipping method information.
- primaryThumbImageURL
-
Type:
stringThumbNail Image URL
Nested Schema : skuProperties
Nested Schema : variant
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - billingAccountId
-
Type:
stringThe billing account ID associated to the current item. - catRefId
-
Type:
stringSku Id of the child item - childItems
-
Type:
arraychildItemsAdditional Properties Allowed:Child items of the commerce item - customerAccountId
-
Type:
stringThe customer account ID associated to the current item. - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - displayName
-
Type:
stringDisplay name of the child product - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - productId
-
Type:
stringProduct Id of the child item - quantity
-
Type:
numberQuantity of the child item - route
-
Type:
stringImage route - selectedOptions
-
Type:
arrayselectedOptionsAdditional Properties Allowed:The array of variants of the child item. - serviceAccountId
-
Type:
stringThe service account ID associated to the current item. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : childItems
Nested Schema : externalData
Nested Schema : selectedOptions
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - billingAccountId
-
Type:
stringThe billing account ID associated to the current item. - catRefId
-
Type:
stringSku Id of the child item - customerAccountId
-
Type:
stringThe customer account ID associated to the current item. - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - displayName
-
Type:
stringDisplay name of the child product - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - productId
-
Type:
stringProduct Id of the child item - quantity
-
Type:
numberQuantity of the child item - route
-
Type:
stringImage route - selectedOptions
-
Type:
arrayselectedOptionsAdditional Properties Allowed:The array of variants of the child item. - serviceAccountId
-
Type:
stringThe service account ID associated to the current item. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : selectedOptions
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringThe name to be associated with the externalData item. - values
-
Type:
objectvaluesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object- optionName
-
Type:
stringThe varian option name. - optionValue
-
Type:
stringThe variant option value
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringThe name to be associated with the externalData item. - values
-
Type:
objectvaluesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object- optionName
-
Type:
stringThe varian option name. - optionValue
-
Type:
stringThe variant option value
Nested Schema : orderCouponsMap
Nested Schema : orderImplicitDiscountList
Nested Schema : unclaimedCouponsMap
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringDescription of the promotion. - promotionId
-
Type:
stringId of the promotion. - promotionLevel
-
Type:
stringLevel of the promotion. - totalAdjustment
-
Type:
stringTotal adjustment caused by the promotion.
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringDescription of the promotion. - promotionId
-
Type:
stringId of the promotion. - promotionLevel
-
Type:
stringLevel of the promotion. - totalAdjustment
-
Type:
stringTotal adjustment caused by the promotion.
Nested Schema : items
Type:
object- couponInfo
-
Type:
arraycouponInfoAdditional Properties Allowed:The coupon Info. - promotionValue
-
Type:
stringThe value for promotion.
Nested Schema : couponInfo
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringDescription of the promotion. - promotionId
-
Type:
stringId of the promotion. - promotionLevel
-
Type:
stringLevel of the promotion. - totalAdjustment
-
Type:
stringTotal adjustment caused by the promotion.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringThe name to be associated with the externalData item. - values
-
Type:
objectvaluesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object- automaticQuantity
-
Type:
numberThe quantity of the free gift that this commerce item is making free and was auto added by pricing. - data
-
Type:
integerThe gift hash code for this GWP promotion. - key
-
Type:
stringatg.gwp - remainingQuantity
-
Type:
numberThe quantity of the commerce item that is not affected by GWP. - repositoryId
-
Type:
stringThe repository id - selectedQuantity
-
Type:
numberThe quantity of the free gift that this commerce item is making free and was selected by the shopper. - targetedQuantity
-
Type:
numberThe quantity of the free gift that this commerce item is making free and was targeted by pricing. - value
-
Type:
stringThe GWP promotion id.
Nested Schema : items
Type:
object- id
-
Type:
stringID of the Dynamic SKU Property. - name
-
Type:
stringName of the Dynamic SKU Property. - propertyType
-
Type:
stringType that indicates whether it is a base or a custom SKU property, - value
-
Type:
stringValue of the Dynamic SKU Property.
Nested Schema : items
Type:
object- optionName
-
Type:
stringName of the Dynamic attribute. - optionValue
-
Type:
stringValue of the Dynamic attribute.
Example application/json
{
"creationTime":1.478264292E12,
"orderComments":[
],
"sourceSystem":"Cloud Commerce",
"dynamicProperties":[
],
"stateString":"INCOMPLETE",
"submittedDate":"2016-11-04T12:58:13.000Z",
"paymentGroups":[
],
"priceInfo":{
"amount":249.95,
"total":309.88,
"shipping":35,
"shippingSurchargeValue":0,
"tax":24.93,
"subTotal":249.95,
"currencyCode":"USD",
"totalWithoutTax":284.95
},
"pricingMessages":{
},
"shoppingCart":{
"items":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":249.95,
"returnedQuantity":0,
"displayName":"Dora the Explorer - Season 1",
"shippingSurchargeValue":0,
"externalData":[
],
"discountAmount":0,
"billingAccountId":"billingAcc-123",
"imageInfo":{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=100&width=100"
},
"assetId":"asset10001",
"price":249.95,
"variant":[
],
"onSale":false,
"actionCode":"Add",
"serviceId":"service-123",
"stateDetailsAsUser":"Added to order",
"unitPrice":49.99,
"serviceAccountId":"serviceAcc-123",
"quantity":5,
"productId":"Product_21Cxi",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":249.95,
"quantity":5,
"tax":21.86,
"orderDiscountShare":0,
"detailedUnitPrice":49.99,
"currencyCode":"USD"
}
],
"giftWithPurchaseCommerceItemMarkers":[
],
"tax":21.86,
"catRefId":"Sku_21Dxy",
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"stateDescription":"INITIAL",
"activationDate":"2017-06-27T15:30:00Z",
"listPrice":49.99,
"status":0
}
]
},
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/orders/copyOrder"
}
],
"id":"o50415",
"state":0,
"stateDetailsAsUser":"Incomplete",
"taxPriceInfo":{
"cityTax":0.71,
"amount":24.93,
"valueAddedTax":0,
"countyTax":0.71,
"isTaxIncluded":false,
"miscTax":6.41,
"districtTax":0,
"stateTax":17.1,
"countryTax":0
},
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":0.71,
"amount":24.93,
"valueAddedTax":0,
"countyTax":0.71,
"isTaxIncluded":false,
"miscTax":6.41,
"districtTax":0,
"stateTax":17.1,
"countryTax":0
},
"shippingMethod":{
"shippingTax":3.07,
"cost":35,
"displayName":"Standard",
"value":"standardShippingMethod",
"shippingMethodDescription":"Standard"
},
"shippingGroupId":"sg60415",
"submittedDate":null,
"priceInfo":{
"amount":249.95,
"total":309.88,
"shipping":35,
"shippingSurchargeValue":0,
"tax":24.93,
"subTotal":249.95,
"currencyCode":"USD",
"totalWithoutTax":284.95
},
"discountInfo":{
"orderDiscount":0,
"shippingDiscount":0,
"discountDescList":[
]
},
"shipOnDate":null,
"trackingInfo":[
],
"actualShipDate":null,
"shippingAddress":{
"lastName":"Blooming",
"country":"US",
"address3":null,
"address2":"Santa Clara County",
"city":"San Jose",
"prefix":null,
"address1":"7 W Jackson Blvd",
"postalCode":"95111",
"companyName":"US Motor Works, Inc.",
"jobTitle":null,
"county":null,
"suffix":null,
"selectedCountry":"US",
"firstName":"Ron",
"phoneNumber":"408-752-3500",
"stateName":"California",
"faxNumber":null,
"alias":null,
"middleName":null,
"state":"CA",
"countryName":"United States",
"email":"ron@example.com",
"selectedState":"NY",
"state_ISOCode":"US-NY"
},
"items":[
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=100&width=100",
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":249.95000000000002,
"returnedQuantity":0,
"displayName":"Dora the Explorer - Season 1",
"shippingSurchargeValue":0,
"externalData":[
],
"discountAmount":0,
"billingAccountId":"billingAcc-123",
"assetId":"asset10001",
"price":249.95,
"variant":[
],
"onSale":false,
"primaryImageAltText":"Dora the Explorer - Season 1",
"actionCode":"Add",
"serviceId":"service-123",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"serviceAccountId":"serviceAcc-123",
"unitPrice":49.99,
"primaryImageTitle":"Dora the Explorer - Season 1",
"quantity":5,
"productId":"Product_21Cxi",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":249.95,
"quantity":5,
"tax":21.86,
"orderDiscountShare":0,
"detailedUnitPrice":49.99,
"currencyCode":"USD"
}
],
"active":true,
"catRefId":"Sku_21Dxy",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"Name",
"id":"displayName",
"value":null
},
{
"propertyType":"sku-base",
"name":"Active",
"id":"active",
"value":true
},
{
"propertyType":"sku-base",
"name":"Id",
"id":"id",
"value":"Sku_21Dxy"
}
],
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"route":"/dora-the-explorer-season-1/product/Product_21Cxi",
"activationDate":"2017-06-27T15:30:00Z",
"listPrice":49.99,
"status":"INITIAL"
}
],
"trackingNumber":null,
"status":"PENDING_MERCHANT_ACTION"
}
],
"approvalSystemMessages":[
"Order is pending approval because total is greater than the approved order limit."
],
"shippingMethod":{
"shippingTax":3.07,
"cost":35,
"displayName":"Standard",
"value":"standardShippingMethod",
"shippingMethodDescription":"Standard"
},
"profile":{
"firstName":"Ron",
"lastName":"Blooming",
"organization":{
"approvalRequired":true,
"name":"US Motor Works, Inc.",
"id":"or-100002"
},
"middleName":null,
"email":"ron@example.com"
},
"priceListGroup":{
"repositoryId":"defaultPriceGroup"
},
"returnRequests":[
],
"creationDate":"2016-11-04T12:58:12.000Z",
"discountInfo":{
"unclaimedCouponMultiPromotions":{
},
"orderCouponsMap":{
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
],
"unclaimedCouponsMap":{
},
"claimedCouponMultiPromotions":{
}
},
"profileId":"bb-110023",
"exchangeRequests":[
],
"giftWithPurchaseInfo":[
],
"shippingAddress":{
"lastName":"Blooming",
"country":"US",
"address3":null,
"address2":"Santa Clara County",
"city":"San Jose",
"prefix":null,
"address1":"7 W Jackson Blvd",
"postalCode":"95111",
"companyName":"US Motor Works, Inc.",
"jobTitle":null,
"county":null,
"suffix":null,
"selectedCountry":"US",
"firstName":"Ron",
"phoneNumber":"408-752-3500",
"stateName":"California",
"faxNumber":null,
"alias":null,
"middleName":null,
"state":"CA",
"countryName":"United States",
"email":"ron@example.com",
"selectedState":"NY",
"state_ISOCode":"US-NY"
},
"giftWithPurchaseOrderMarkers":[
]
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|28320|Order duplication failed.|
|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|
|28321|No Order id specified|
|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|
|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|
|100101|The shopper profile does not belong to organization passed in the header|
Body
Root Schema : errorModel
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - errors
-
Type:
arrayerrorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code - type
-
Type:
stringThe URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code
Examples
Sample Request:
{
"orderId": "o30411",
"exclude": {
"commerceItem": [
"priceInfo",
"externalPriceDetails"
],
"order": [
"approverMessages",
"quoteInfo",
"approverIds",
"submittedDate",
"originOfOrder",
"createdByOrderId",
"priceInfo",
"externalOrderPriceDetails",
"cancelReason",
"shippingGroups",
"relationships",
"paymentGroups"
]
}
}
Sample Response Payload returned by endpoint:
{
"creationTime": 1478264292000,
"orderComments": [],
"sourceSystem": "Cloud Commerce",
"dynamicProperties": [],
"stateString": "INCOMPLETE",
"submittedDate": "2016-11-04T12:58:13.000Z",
"paymentGroups": [],
"priceInfo": {
"amount": 249.95,
"total": 309.88,
"shipping": 35,
"shippingSurchargeValue": 0,
"tax": 24.93,
"subTotal": 249.95,
"currencyCode": "USD",
"totalWithoutTax": 284.95
},
"pricingMessages": {},
"shoppingCart": {"items": [{
"deactivationDate": "2018-06-27T12:59:59Z",
"rawTotalPrice": 249.95,
"returnedQuantity": 0,
"displayName": "Dora the Explorer - Season 1",
"shippingSurchargeValue": 0,
"externalData": [],
"discountAmount": 0,
"billingAccountId": "billingAcc-123",
"imageInfo": {"primaryThumbImageURL": "/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=100&width=100"},
"assetId": "asset10001",
"price": 249.95,
"variant": [],
"onSale": false,
"actionCode": "Add",
"serviceId": "service-123",
"stateDetailsAsUser": "Added to order",
"unitPrice": 49.99,
"serviceAccountId": "serviceAcc-123",
"quantity": 5,
"productId": "Product_21Cxi",
"salePrice": 0,
"detailedItemPriceInfo": [{
"discounted": false,
"amount": 249.95,
"quantity": 5,
"tax": 21.86,
"orderDiscountShare": 0,
"detailedUnitPrice": 49.99,
"currencyCode": "USD"
}],
"giftWithPurchaseCommerceItemMarkers": [],
"tax": 21.86,
"catRefId": "Sku_21Dxy",
"customerAccountId": "customerAcc-123",
"discountInfo": [],
"stateDescription": "INITIAL",
"activationDate": "2017-06-27T15:30:00Z",
"listPrice": 49.99,
"status": 0
}]},
"links": [{
"rel": "self",
"href": "http://localhost:9080/ccagentui/v1/orders/copyOrder"
}],
"id": "o50415",
"state": 0,
"stateDetailsAsUser": "Incomplete",
"taxPriceInfo": {
"cityTax": 0.71,
"amount": 24.93,
"valueAddedTax": 0,
"countyTax": 0.71,
"isTaxIncluded": false,
"miscTax": 6.41,
"districtTax": 0,
"stateTax": 17.1,
"countryTax": 0
},
"shippingGroups": [{
"taxPriceInfo": {
"cityTax": 0.71,
"amount": 24.93,
"valueAddedTax": 0,
"countyTax": 0.71,
"isTaxIncluded": false,
"miscTax": 6.41,
"districtTax": 0,
"stateTax": 17.1,
"countryTax": 0
},
"shippingMethod": {
"shippingTax": 3.07,
"cost": 35,
"displayName": "Standard",
"value": "standardShippingMethod",
"shippingMethodDescription": "Standard"
},
"shippingGroupId": "sg60415",
"submittedDate": null,
"priceInfo": {
"amount": 249.95,
"total": 309.88,
"shipping": 35,
"shippingSurchargeValue": 0,
"tax": 24.93,
"subTotal": 249.95,
"currencyCode": "USD",
"totalWithoutTax": 284.95
},
"discountInfo": {
"orderDiscount": 0,
"shippingDiscount": 0,
"discountDescList": []
},
"shipOnDate": null,
"trackingInfo": [],
"actualShipDate": null,
"shippingAddress": {
"lastName": "Blooming",
"country": "US",
"address3": null,
"address2": "Santa Clara County",
"city": "San Jose",
"prefix": null,
"address1": "7 W Jackson Blvd",
"postalCode": "95111",
"companyName": "US Motor Works, Inc.",
"jobTitle": null,
"county": null,
"suffix": null,
"selectedCountry": "US",
"firstName": "Ron",
"phoneNumber": "408-752-3500",
"stateName": "California",
"faxNumber": null,
"alias": null,
"middleName": null,
"state": "CA",
"countryName": "United States",
"email": "ron@example.com",
"selectedState": "NY",
"state_ISOCode": "US-NY"
},
"items": [{
"primaryThumbImageURL": "/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=100&width=100",
"deactivationDate": "2018-06-27T12:59:59Z",
"rawTotalPrice": 249.95000000000002,
"returnedQuantity": 0,
"displayName": "Dora the Explorer - Season 1",
"shippingSurchargeValue": 0,
"externalData": [],
"discountAmount": 0,
"billingAccountId": "billingAcc-123",
"assetId": "asset10001",
"price": 249.95,
"variant": [],
"onSale": false,
"primaryImageAltText": "Dora the Explorer - Season 1",
"actionCode": "Add",
"serviceId": "service-123",
"stateDetailsAsUser": "The item has been initialized within the shipping group",
"serviceAccountId": "serviceAcc-123",
"unitPrice": 49.99,
"primaryImageTitle": "Dora the Explorer - Season 1",
"quantity": 5,
"productId": "Product_21Cxi",
"salePrice": 0,
"detailedItemPriceInfo": [{
"discounted": false,
"amount": 249.95,
"quantity": 5,
"tax": 21.86,
"orderDiscountShare": 0,
"detailedUnitPrice": 49.99,
"currencyCode": "USD"
}],
"active": true,
"catRefId": "Sku_21Dxy",
"skuProperties": [
{
"propertyType": "sku-base",
"name": "Name",
"id": "displayName",
"value": null
},
{
"propertyType": "sku-base",
"name": "Active",
"id": "active",
"value": true
},
{
"propertyType": "sku-base",
"name": "Id",
"id": "id",
"value": "Sku_21Dxy"
}
],
"customerAccountId": "customerAcc-123",
"discountInfo": [],
"route": "/dora-the-explorer-season-1/product/Product_21Cxi",
"activationDate": "2017-06-27T15:30:00Z",
"listPrice": 49.99,
"status": "INITIAL"
}],
"trackingNumber": null,
"status": "PENDING_MERCHANT_ACTION"
}],
"approvalSystemMessages": ["Order is pending approval because total is greater than the approved order limit."],
"shippingMethod": {
"shippingTax": 3.07,
"cost": 35,
"displayName": "Standard",
"value": "standardShippingMethod",
"shippingMethodDescription": "Standard"
},
"profile": {
"firstName": "Ron",
"lastName": "Blooming",
"organization": {
"approvalRequired": true,
"name": "US Motor Works, Inc.",
"id": "or-100002"
},
"middleName": null,
"email": "ron@example.com"
},
"priceListGroup": {"repositoryId": "defaultPriceGroup"},
"returnRequests": [],
"creationDate": "2016-11-04T12:58:12.000Z",
"discountInfo": {
"unclaimedCouponMultiPromotions": {},
"orderCouponsMap": {},
"orderDiscount": 0,
"shippingDiscount": 0,
"orderImplicitDiscountList": [],
"unclaimedCouponsMap": {},
"claimedCouponMultiPromotions": {}
},
"profileId": "bb-110023",
"exchangeRequests": [],
"giftWithPurchaseInfo": [],
"shippingAddress": {
"lastName": "Blooming",
"country": "US",
"address3": null,
"address2": "Santa Clara County",
"city": "San Jose",
"prefix": null,
"address1": "7 W Jackson Blvd",
"postalCode": "95111",
"companyName": "US Motor Works, Inc.",
"jobTitle": null,
"county": null,
"suffix": null,
"selectedCountry": "US",
"firstName": "Ron",
"phoneNumber": "408-752-3500",
"stateName": "California",
"faxNumber": null,
"alias": null,
"middleName": null,
"state": "CA",
"countryName": "United States",
"email": "ron@example.com",
"selectedState": "NY",
"state_ISOCode": "US-NY"
},
"giftWithPurchaseOrderMarkers": []
}