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:
string
the 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:
object
excludeAdditional 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:
string
Required:true
Order Id to be duplicated
Nested Schema : exclude
Type:
object
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
- commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed:Item descriptor name - order
-
Type:
array
orderAdditional 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:
array
approvalSystemMessagesAdditional Properties Allowed:The array of messages which are stored during order processing - billingMethod
-
Type:
object
billingMethodAdditional Properties Allowed:billing Method information of the order. - creationDate
-
Type:
string
Date on which the Order was created. - creationTime
-
Type:
number
Order creation time. - discountInfo
-
Type:
object
discountInfoAdditional Properties Allowed:Discount information. - dynamicProperties
-
Type:
array
dynamicPropertiesAdditional Properties Allowed:Read-only list of dynamic properties for the order along with meta-data. - giftWithPurchaseInfo
-
Type:
array
giftWithPurchaseInfoAdditional Properties Allowed:Gift Selection Information - giftWithPurchaseOrderMarkers
-
Type:
array
giftWithPurchaseOrderMarkersAdditional Properties Allowed:Gift With Purchase order markers information - id
-
Type:
string
Commerce id for this duplicated order. - orderComments
-
Type:
array
orderCommentsAdditional Properties Allowed:The list of all logged comments for the order. - paymentGroup
-
Type:
object
paymentGroupAdditional Properties Allowed:Payment Group for the order. - paymentGroups
-
Type:
array
paymentGroupsAdditional Properties Allowed:List of payment Groups for the order. - priceInfo
-
Type:
object
priceInfoAdditional Properties Allowed:Price information of the order. - priceListGroup
-
Type:
object
priceListGroupAdditional Properties Allowed:PriceList group of the order. - profile
-
Type:
object
profileAdditional Properties Allowed:Profile Information for the order. - profileId
-
Type:
string
The Repository Id of the profile to which this Order belongs to. - returnRequests
-
Type:
array
returnRequestsAdditional Properties Allowed:The list of the requests raised for the order. - shippingAddress
-
Type:
object
shippingAddressAdditional Properties Allowed:shipping address for the order. - shippingGroups
-
Type:
array
shippingGroupsAdditional Properties Allowed:Shipping Group infomration - shippingMethod
-
Type:
object
shippingMethodAdditional Properties Allowed:Shipping method information. - shoppingCart
-
Type:
object
shoppingCartAdditional Properties Allowed:Shopping cart information. - sourceSystem
-
Type:
string
The system where the order originated. - state
-
Type:
integer
The order state. - stateDetailsAsUser
-
Type:
string
Order State description for this order. - taxPriceInfo
-
Type:
object
taxPriceInfoAdditional Properties Allowed:The tax pricing details for the order.
Nested Schema : approvalSystemMessages
Nested Schema : billingMethod
Type:
object
billing Method information of the order.
- cost
-
Type:
number
billing Cost for this order. - displayName
-
Type:
string
billing method display name for this billing method. - value
-
Type:
string
billing method name for this order.
Nested Schema : discountInfo
Type:
object
Discount information.
- orderCouponsMap
-
Type:
array
orderCouponsMapAdditional Properties Allowed:Map of coupons. - orderDiscount
-
Type:
number
Discount given on an order. - orderImplicitDiscountList
-
Type:
array
orderImplicitDiscountListAdditional Properties Allowed:List of discounts. - unclaimedCouponsMap
-
Type:
array
unclaimedCouponsMapAdditional Properties Allowed:Map of unclaimed coupons.
Nested Schema : dynamicProperties
Nested Schema : giftWithPurchaseInfo
Nested Schema : giftWithPurchaseOrderMarkers
Nested Schema : orderComments
Nested Schema : paymentGroup
Type:
object
Payment Group for the order.
- amount
-
Type:
number
The amount associated with this Payment Group. - amountAuthorized
-
Type:
number
The amount authorized with this Payment Group. - billingAddress
-
Type:
object
billingAddressAdditional Properties Allowed:Billing address for the order. - cardNumber
-
Type:
string
The masked credit card number. - cardType
-
Type:
string
The credit card type. - firstName
-
Type:
string
First name associated with this Payment Group. - lastName
-
Type:
string
Last name associated with this Payment Group. - paidAmount
-
Type:
number
The amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
integer
Id of this payment Group. - paymentState
-
Type:
string
The Payment Group state. - paymentStateDetailsAsUser
-
Type:
string
The payment state description as string. - refundAmount
-
Type:
number
The amount that has been credited to-date for this Payment Group. - token
-
Type:
string
Token associated with this Payment Group. - totalDue
-
Type:
number
The current working total order price including all discounts, tax, and billing costs. - uiIntervention
-
Type:
string
This decides whether the client has to do some intervention for payment. e.g. SOP - zero_value_auto_authorized
-
Type:
string
The Payment Group is auto authorized without any payment details for zero amount. e.g. true
Nested Schema : paymentGroups
Nested Schema : priceInfo
Type:
object
Price information of the order.
- amount
-
Type:
number
The raw number that represents the price. - billing
-
Type:
number
The billing cost of the order. - currencyCode
-
Type:
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars. - subTotal
-
Type:
number
The subtotal of the order before applying order-level promotions. - tax
-
Type:
number
The tax on the order. - total
-
Type:
number
The current working total, including all promotions, tax, and billing costs.
Nested Schema : priceListGroup
Type:
object
PriceList group of the order.
- active
-
Type:
boolean
Active status of pricelist group. - currency
-
Type:
object
currencyAdditional Properties Allowed:Currency of the PriceList group. - deleted
-
Type:
boolean
Pricelist group deleted status. - displayName
-
Type:
string
Display Name. - id
-
Type:
string
Id. - locale
-
Type:
string
Locale. - repositoryId
-
Type:
string
Repository Id.
Nested Schema : profile
Type:
object
Profile Information for the order.
-
Type:
string
Email Address corresponding to the profile. - firstName
-
Type:
string
First name of profile. - lastName
-
Type:
string
Last name of profile. - middleName
-
Type:
string
Middle name of profile. - organization
-
Type:
object
organizationAdditional Properties Allowed:The Organization associated with the B2B customer profile.
Nested Schema : returnRequests
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
- address1
-
Type:
string
Address Line 1 for this shipping address. - address2
-
Type:
string
Address Line 2 for this shipping address. - address3
-
Type:
string
Address Line 3 for this shipping address. - city
-
Type:
string
City for this shipping address. - companyName
-
Type:
string
Company name for this shipping address. - country
-
Type:
string
Country for this shipping address. - county
-
Type:
string
County for this shipping address. -
Type:
string
Email for this shipping address. - faxNumber
-
Type:
string
Fax number for this shipping address. - firstName
-
Type:
string
First name for this shipping address. - jobTitle
-
Type:
string
Job title for this shipping address. - lastName
-
Type:
string
Last name for this shipping address. - middleName
-
Type:
string
Middle name for this shipping address. - phoneNumber
-
Type:
string
Phone number for this shipping address. - postalCode
-
Type:
string
Postal code for this shipping address. - prefix
-
Type:
string
Prefix for this shipping address. - selectedCountry
-
Type:
string
The selected country of the shipping address. - selectedState
-
Type:
string
The selected state of the shipping address. - state
-
Type:
string
State for this shipping address. - state_ISOCode
-
Type:
string
The state ISON code of the shipping address. - suffix
-
Type:
string
Suffix for this shipping address.
Nested Schema : shippingGroups
Nested Schema : shippingMethod
Type:
object
Shipping method information.
- cost
-
Type:
number
shipping cost. - displayName
-
Type:
string
Display Name of shipment. - value
-
Type:
string
method type of shipment.
Nested Schema : shoppingCart
Type:
object
Shopping cart information.
- items
-
Type:
array
itemsAdditional Properties Allowed:Items in the cart.
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
- amount
-
Type:
number
The monetary amount. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - cityTax
-
Type:
number
The monetary amount of city tax. - countryTax
-
Type:
number
The monetary amount of country tax. - countyTax
-
Type:
number
The monetary amount of county tax. - currencyCode
-
Type:
string
The three character currency code. - discounted
-
Type:
boolean
Whether the price was discounted. - districtTax
-
Type:
number
Tax amount for the district. - stateTax
-
Type:
number
Tax amount for the state.
Nested Schema : orderCouponsMap
Nested Schema : orderImplicitDiscountList
Nested Schema : unclaimedCouponsMap
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- couponInfo
-
Type:
array
couponInfoAdditional Properties Allowed:The coupon Info. - promotionValue
-
Type:
string
The value for promotion.
Nested Schema : couponInfo
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- id
-
Type:
string
The ID of the dynamic property. - value
-
Type:
string
The value of the dynamic property.
Nested Schema : items
Type:
object
- giftWithPurchaseDetail
-
Type:
string
String identifying the gift usually the repository ID of the gift type. - giftWithPurchaseIdentifier
-
Type:
integer
An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. - giftWithPurchaseQuantityAvailableForSelection
-
Type:
number
Quantity of gift that the shopper still needs to select. - giftWithPurchaseType
-
Type:
string
The type of gift like sku, product, category, skuContentGroup or productContentGroup. - promotionDesc
-
Type:
string
The promotion description. - promotionId
-
Type:
string
The gift with purchase promotion id
Nested Schema : items
Type:
object
- automaticQuantity
-
Type:
number
The quantity of free sku for this gift selection that has already been auto added to the order. - autoRemove
-
Type:
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies. - data
-
Type:
string
Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. - failedQuantity
-
Type:
number
The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.. - giftDetail
-
Type:
string
String identifying the free gift, usually the repository id of the gift type. - giftType
-
Type:
string
The type of gift like sku, product, category, skuContentGroup or productContentGroup. - key
-
Type:
string
atg.gwp. - quantity
-
Type:
number
The total quantity of sku for this gift selection. - removedQuantity
-
Type:
number
The amount of free quantity that has since been manually removed by a Shopper. - repositoryId
-
Type:
string
The repository id of the gwp order marker. - selectedQuantity
-
Type:
number
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order. - targetedQuantity
-
Type:
number
The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order. - value
-
Type:
string
The GWP promotion id.
Nested Schema : items
Type:
object
- comment
-
Type:
string
The comment string. - creationDate
-
Type:
string
Date on which the comment was created. - repositoryId
-
Type:
string
The repository id of the comment record.
Nested Schema : billingAddress
Type:
object
Billing address for the order.
- address1
-
Type:
string
Address line 1 for this billing address. - address2
-
Type:
string
Address line 2 for this billing address. - address3
-
Type:
string
Address line 3 for this billing address. - city
-
Type:
string
City for this billing address. - companyName
-
Type:
string
Company name for this billing address. - country
-
Type:
string
Country for this billing address. - county
-
Type:
string
County for this billing address. -
Type:
string
Email for this billing address. - faxNumber
-
Type:
string
Fax number for this billing address. - firstName
-
Type:
string
First name for this billing address. - jobTitle
-
Type:
string
Job title for this billing address. - lastName
-
Type:
string
Last name for this billing address. - middleName
-
Type:
string
Middle name for this billing address. - phoneNumber
-
Type:
string
Phone number for this billing address. - postalCode
-
Type:
string
Postal code for this billing address. - prefix
-
Type:
string
Prefix for this billing address. - selectedCountry
-
Type:
string
The selected country of the shipping address. - selectedState
-
Type:
string
The selected state of the shipping address. - state
-
Type:
string
State for this billing address. - state_ISOCode
-
Type:
string
The state ISON code of the shipping address. - suffix
-
Type:
string
Suffix for this billing address.
Nested Schema : items
Type:
object
- amount
-
Type:
number
The amount associated with this Payment Group. - amountAuthorized
-
Type:
number
The amount authorized with this Payment Group. - billingAddress
-
Type:
object
billingAddressAdditional Properties Allowed:Billing address for the order. - cardNumber
-
Type:
string
The masked credit card number. - cardType
-
Type:
string
Payment method. e.g. physicalGiftCard/ creditCard - firstName
-
Type:
string
First name associated with this Payment Group. - lastName
-
Type:
string
Last name associated with this Payment Group. - paidAmount
-
Type:
number
The amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
integer
Id of this payment Group. - paymentState
-
Type:
string
The Payment Group state. - paymentStateDetailsAsUser
-
Type:
string
The payment state description as string. - refundAmount
-
Type:
number
The amount that has been credited to-date for this Payment Group. - token
-
Type:
string
Token associated with this Payment Group. - totalDue
-
Type:
number
The current working total order price including all discounts, tax, and billing costs. - uiIntervention
-
Type:
string
This decides whether the client has to do some intervention for payment. e.g. SOP - zero_value_auto_authorized
-
Type:
string
The Payment Group is auto authorized without any payment details for zero amount. e.g. true
Nested Schema : billingAddress
Type:
object
Billing address for the order.
- address1
-
Type:
string
Address line 1 for this billing address. - address2
-
Type:
string
Address line 2 for this billing address. - address3
-
Type:
string
Address line 3 for this billing address. - city
-
Type:
string
City for this billing address. - companyName
-
Type:
string
Company name for this billing address. - country
-
Type:
string
Country for this billing address. - county
-
Type:
string
County for this billing address. -
Type:
string
Email for this billing address. - faxNumber
-
Type:
string
Fax number for this billing address. - firstName
-
Type:
string
First name for this billing address. - jobTitle
-
Type:
string
Job title for this billing address. - lastName
-
Type:
string
Last name for this billing address. - middleName
-
Type:
string
Middle name for this billing address. - phoneNumber
-
Type:
string
Phone number for this billing address. - postalCode
-
Type:
string
Postal code for this billing address. - prefix
-
Type:
string
Prefix for this billing address. - selectedCountry
-
Type:
string
The selected country of the shipping address. - selectedState
-
Type:
string
The selected state of the shipping address. - state
-
Type:
string
State for this billing address. - state_ISOCode
-
Type:
string
The state ISON code of the shipping address. - suffix
-
Type:
string
Suffix for this billing address.
Nested Schema : currency
Type:
object
Currency of the PriceList group.
- currencyCode
-
Type:
string
Currency Code. - displayName
-
Type:
string
Display Name. - fractionalDigits
-
Type:
integer
Fractional Digits. - numericCode
-
Type:
string
Numeric Code. - repositoryId
-
Type:
string
Repository Id. - symbol
-
Type:
string
currency Symbol.
Nested Schema : organization
Type:
object
The Organization associated with the B2B customer profile.
- id
-
Type:
string
The id of the organization. - name
-
Type:
string
The name of of the organization.
Nested Schema : items
Type:
object
- createdDate
-
Type:
string
The creation date of the return request. - returnRequestId
-
Type:
string
The return request id. - state
-
Type:
string
The status of the return request. - totalRefund
-
Type:
number
The total amount to be refunded on return. - totalReturnQuantity
-
Type:
integer
The total quantity for which return request has been raised.
Nested Schema : items
Type:
object
- items
-
Type:
array
itemsRequired:true
Additional Properties Allowed:Items in the cart. - shippingAddress
-
Type:
object
shippingAddressAdditional Properties Allowed:shipping address for the order. - shippingMethod
-
Type:
object
shippingMethodAdditional Properties Allowed:Shipping method information. - trackingInfo
-
Type:
array
trackingInfoAdditional Properties Allowed:Tracking Information for the Order. - trackingNumber
-
Type:
string
Shipping tracking number.
Nested Schema : items
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
- address1
-
Type:
string
Address Line 1 for this shipping address. - address2
-
Type:
string
Address Line 2 for this shipping address. - address3
-
Type:
string
Address Line 3 for this shipping address. - city
-
Type:
string
City for this shipping address. - companyName
-
Type:
string
Company name for this shipping address. - country
-
Type:
string
Country for this shipping address. - county
-
Type:
string
County for this shipping address. -
Type:
string
Email for this shipping address. - faxNumber
-
Type:
string
Fax number for this shipping address. - firstName
-
Type:
string
First name for this shipping address. - jobTitle
-
Type:
string
Job title for this shipping address. - lastName
-
Type:
string
Last name for this shipping address. - middleName
-
Type:
string
Middle name for this shipping address. - phoneNumber
-
Type:
string
Phone number for this shipping address. - postalCode
-
Type:
string
Postal code for this shipping address. - prefix
-
Type:
string
Prefix for this shipping address. - selectedCountry
-
Type:
string
The selected country of the shipping address. - selectedState
-
Type:
string
The selected state of the shipping address. - state
-
Type:
string
State for this shipping address. - state_ISOCode
-
Type:
string
The state ISON code of the shipping address. - suffix
-
Type:
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
- cost
-
Type:
number
shipping cost. - displayName
-
Type:
string
Display Name of shipment. - value
-
Type:
string
method type of shipment.
Nested Schema : trackingInfo
Nested Schema : items
Type:
object
- catRefId
-
Type:
string
Required:true
catRefId of the product. - productId
-
Type:
string
Required:true
Id of the product. - quantity
-
Type:
integer
Required:true
quantity of the product. - skuProperties
-
Type:
array
skuPropertiesAdditional Properties Allowed:Sku properties Information - variant
-
Type:
array
variantAdditional Properties Allowed:Product Variant Information.
Nested Schema : skuProperties
Nested Schema : variant
Nested Schema : items
Type:
object
- id
-
Type:
string
ID of the Dynamic SKU Property. - name
-
Type:
string
Name of the Dynamic SKU Property. - propertyType
-
Type:
string
Type that indicates whether it is a base or a custom SKU property, - value
-
Type:
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
object
- carrierId
-
Type:
string
Carrier Id for Tracking. - carrierName
-
Type:
string
Carrier Name for Tracking. - carrierUrl
-
Type:
string
Carrier URL for Tracking. - trackingNumber
-
Type:
string
Tracking Number.
Nested Schema : items
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Catalog Reference Id of commerce item. - childItems
-
Type:
array
childItemsAdditional Properties Allowed:Child items of the commerce item - commerceItemId
-
Type:
string
CommerceItemId id of the configurable product - configuratorId
-
Type:
string
Configuration id of the configurable product - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - discountInfo
-
Type:
object
discountInfoAdditional Properties Allowed:Discount information. - displayName
-
Type:
string
Display name of commerce item. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - giftWithPurchaseCommerceItemMarkers
-
Type:
array
giftWithPurchaseCommerceItemMarkersAdditional Properties Allowed:The array of giftWithPurchaseCommerceItemMarkers. - imageInfo
-
Type:
object
imageInfoAdditional Properties Allowed:Shipping method information. - onSale
-
Type:
boolean
Indicates if product is on Sale or not. - price
-
Type:
number
The raw number that represents the price. - productId
-
Type:
string
Product Id of commerce item. - quantity
-
Type:
number
Quantity of the items. - rawTotalPrice
-
Type:
number
The raw total price. - returnedQuantity
-
Type:
number
Quantity for which return request has been raised. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item. - skuProperties
-
Type:
array
skuPropertiesAdditional Properties Allowed:Sku properties Information - stateDetailsAsUser
-
Type:
string
State description of the commerce item. - status
-
Type:
integer
State of the commerce item. - subTotal
-
Type:
number
The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice. - tax
-
Type:
number
The amount of tax paid for this item. - unitPrice
-
Type:
number
Sale price or list price of commerceItem. - variant
-
Type:
array
variantAdditional Properties Allowed:Product Variant Information.
Nested Schema : childItems
Nested Schema : discountInfo
Type:
object
Discount information.
- orderCouponsMap
-
Type:
array
orderCouponsMapAdditional Properties Allowed:Map of coupons. - orderDiscount
-
Type:
number
Discount given on an order. - orderImplicitDiscountList
-
Type:
array
orderImplicitDiscountListAdditional Properties Allowed:List of discounts. - unclaimedCouponsMap
-
Type:
array
unclaimedCouponsMapAdditional Properties Allowed:Map of unclaimed coupons.
Nested Schema : externalData
Nested Schema : giftWithPurchaseCommerceItemMarkers
Nested Schema : imageInfo
Type:
object
Shipping method information.
- primaryThumbImageURL
-
Type:
string
ThumbNail Image URL
Nested Schema : skuProperties
Nested Schema : variant
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Sku Id of the child item - childItems
-
Type:
array
childItemsAdditional Properties Allowed:Child items of the commerce item - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - displayName
-
Type:
string
Display name of the child product - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - productId
-
Type:
string
Product Id of the child item - quantity
-
Type:
number
Quantity of the child item - route
-
Type:
string
Image route - selectedOptions
-
Type:
array
selectedOptionsAdditional Properties Allowed:The array of variants of the child item. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : childItems
Nested Schema : externalData
Nested Schema : selectedOptions
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Sku Id of the child item - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - displayName
-
Type:
string
Display name of the child product - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - productId
-
Type:
string
Product Id of the child item - quantity
-
Type:
number
Quantity of the child item - route
-
Type:
string
Image route - selectedOptions
-
Type:
array
selectedOptionsAdditional Properties Allowed:The array of variants of the child item. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : selectedOptions
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
The varian option name. - optionValue
-
Type:
string
The variant option value
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
The varian option name. - optionValue
-
Type:
string
The variant option value
Nested Schema : orderCouponsMap
Nested Schema : orderImplicitDiscountList
Nested Schema : unclaimedCouponsMap
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- couponInfo
-
Type:
array
couponInfoAdditional Properties Allowed:The coupon Info. - promotionValue
-
Type:
string
The value for promotion.
Nested Schema : couponInfo
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- automaticQuantity
-
Type:
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing. - data
-
Type:
integer
The gift hash code for this GWP promotion. - key
-
Type:
string
atg.gwp - remainingQuantity
-
Type:
number
The quantity of the commerce item that is not affected by GWP. - repositoryId
-
Type:
string
The repository id - selectedQuantity
-
Type:
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper. - targetedQuantity
-
Type:
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing. - value
-
Type:
string
The GWP promotion id.
Nested Schema : items
Type:
object
- id
-
Type:
string
ID of the Dynamic SKU Property. - name
-
Type:
string
Name of the Dynamic SKU Property. - propertyType
-
Type:
string
Type that indicates whether it is a base or a custom SKU property, - value
-
Type:
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value 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:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - errors
-
Type:
array
errorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code - type
-
Type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object
- devMessage
-
Type:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The 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": [] }