rejectOrder
post
/ccstore/v1/orders/reject
Reject Order. Approver rejects an order. Optionally takes the x-ccasset-language headers to get translated content in another language. Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization context of logged in user.
Request
Supported Media Types
- application/json
Header Parameters
- X-CCOrganization
-
Type:
string
Current organization context of the logged in user
Body Parameter
Root Schema : rejectOrder_request
{
"approverMessage":"Rejecting order",
"orderId":"o40411"
}
- approverMessage
-
Type:
string
the message given by approver when he is approving order. - orderId
-
Type:
string
Required:true
the order id of the order which requires approval.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : rejectOrder_response
- approverMessages
-
Type:
string
Approver Messages. - approvers
-
Type:
array
approversList of approvers of the organization. - creationDate
-
Type:
string
The creation date in ISO format. - creationTime
-
Type:
number
Order creation time. - discountInfo
-
Type:
object
discountInfoDiscount information. - dynamicProperties
-
Type:
array
dynamicPropertiesRead-only list of dynamic properties for the order along with meta-data. - giftWithPurchaseInfo
-
Type:
array
giftWithPurchaseInfoGift Selection Information - giftWithPurchaseOrderMarkers
-
Type:
array
giftWithPurchaseOrderMarkersGift With Purchase order markers information - id
-
Type:
string
Required:true
The order id. - orderComments
-
Type:
array
orderCommentsThe list of all logged comments for the order. - paymentGroup
-
Type:
object
paymentGroupPayment Group for the order. - priceInfo
-
Type:
object
priceInfoThe price information. - priceListGroup
-
Type:
object
priceListGroupPriceList group of the order. - pricingMessages
-
Type:
object
pricingMessagesThe Pricing messages information. - profile
-
Type:
object
profileProfile Information for the order. - profileId
-
Type:
string
Required:true
profile id. - returnRequests
-
Type:
array
returnRequestsThe list of the requests raised for the order. - shippingAddress
-
Type:
object
shippingAddressRequired:true
Shipping address. - shippingGroups
-
Type:
array
shippingGroupsShipping Group Information - shippingMethod
-
Type:
object
shippingMethodShipping method information. - shoppingCart
-
Type:
object
shoppingCartShopping cart information. - state
-
Type:
integer
The order state. - stateDetailsAsUser
-
Type:
string
Order State description for this order. - stateString
-
Type:
string
Order state as key string. - taxPriceInfo
-
Type:
object
taxPriceInfoThe tax pricing details for the order. - totalAmountAuthorized
-
Type:
number
total amount authorized for the order.
Nested Schema : approvers
Nested Schema : discountInfo
Type:
object
Discount information.
- claimedCouponMultiPromotions
-
Type:
object
claimedCouponMultiPromotionsThe coupons that were claimed - orderCouponsMap
-
Type:
array
orderCouponsMapMap of coupons. - orderDiscount
-
Type:
number
Discount given on an order. - orderImplicitDiscountList
-
Type:
array
orderImplicitDiscountListList of discounts. - shippingDiscount
-
Type:
integer
The shipping discount. - unclaimedCouponMultiPromotions
-
Type:
object
unclaimedCouponMultiPromotionsThe coupons that were not claimed - unclaimedCouponsMap
-
Type:
array
unclaimedCouponsMapMap 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. - balance
-
Type:
string
The gift card balance available. - billingAddress
-
Type:
object
billingAddressBilling 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. - paymentStatString
-
Type:
string
The payment state as a key string. - PONumber
-
Type:
string
Purchase order number for invoice payment. Payment type: invoice - 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 : priceInfo
Type:
object
The price information.
- amount
-
Type:
number
The total order amount. - currencyCode
-
Type:
string
The currency code. - shipping
-
Type:
number
The total shipping cost. - shippingSurchargeValue
-
Type:
number
Extra handling costs for shipping the products. - subTotal
-
Type:
number
Sub-total. - tax
-
Type:
number
The total tax amount. - total
-
Type:
number
The order total.
Nested Schema : priceListGroup
Type:
object
PriceList group of the order.
- active
-
Type:
boolean
Active status of pricelist group. - currency
-
Type:
object
currencyCurrency 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 : pricingMessages
Type:
object
The Pricing messages information.
- GiftWithPurchaseMessages
-
Type:
array
GiftWithPurchaseMessagesThe GWP messages information.
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
organizationThe Organization associated with the B2B customer profile.
Nested Schema : returnRequests
Nested Schema : shippingAddress
Type:
object
Shipping address.
- address1
-
Type:
string
Required:true
The address1 of the shipping address. - address2
-
Type:
string
Required:true
The address2 of the shipping address. - address3
-
Type:
string
The address3 of the shipping address. - city
-
Type:
string
Required:true
The city of the shipping address. - companyName
-
Type:
string
The companyName. - country
-
Type:
string
Required:true
The country of the shipping address. - county
-
Type:
string
The county of the shipping address. - DEFAULT_POSTAL_CODE_PATTERN
-
Type:
string
The default post code pattern of the shipping address. -
Type:
string
Required:true
email of the shipping address. - faxNumber
-
Type:
string
The faxNumber of the shipping address. - firstName
-
Type:
string
Required:true
The first name of the shipping address. - jobTitle
-
Type:
string
The job title. - lastName
-
Type:
string
Required:true
The last name of the shipping address. - middleName
-
Type:
string
The middle name of the shipping address. - phoneNumber
-
Type:
string
Required:true
The phone Number of the shipping address. - postalCode
-
Type:
string
Required:true
The postal Code of the shipping address. - prefix
-
Type:
string
prefix of shipping address name. - selectedCountry
-
Type:
string
Required:true
The selected country of the shipping address. - selectedState
-
Type:
string
Required:true
The selected state of the shipping address. - state
-
Type:
string
Required:true
The state of the shipping address. - state_ISOCode
-
Type:
string
Required:true
The state ISON code of the shipping address. - suffix
-
Type:
string
suffix of the shipping address name.
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
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 : items
Type:
object
- approverId
-
Type:
string
Id of approver. - firstName
-
Type:
string
First name of approver. - lastName
-
Type:
string
Last name of approver.
Nested Schema : claimedCouponMultiPromotions
Type:
object
The coupons that were claimed
- couponCode
-
Type:
array
couponCodeCoupon Code, corresponding to which promotions were applied
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
- couponCode
-
Type:
array
couponCodeCoupon Code, corresponding to which some promotions were not applied
Nested Schema : couponCode
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Promotion Description - promotionId
-
Type:
string
Promotion Id - promotionLevel
-
Type:
string
Promotion Level - totalAdjustment
-
Type:
number
Adjustment done 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
- 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 : couponCode
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Promotion Description - promotionId
-
Type:
string
Promotion Id - promotionLevel
-
Type:
string
Promotion Level
Nested Schema : items
Type:
object
- couponInfo
-
Type:
array
couponInfoThe coupon Info. - promotionValue
-
Type:
string
The value for 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
- id
-
Type:
string
The ID of the dynamic property. - value
-
Type:
string
The value of the dynamic property.
Nested Schema : items
Type:
object
- giftHashCode
-
Type:
string
The gift hash code for the promotion - 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 : 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 : GiftWithPurchaseMessages
Nested Schema : items
Type:
object
- identifier
-
Type:
string
The pricing message identifier. - params
-
Type:
array
paramsThe list of all message parameters. - priority
-
Type:
integer
The pricing message priority. - summary
-
Type:
string
The pricing message summary. - type
-
Type:
string
The pricing message type.
Nested Schema : items
Type:
object
- promotionId
-
Type:
string
The promotion id.
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
Items in the cart. - shippingAddress
-
Type:
object
shippingAddressshipping address for the order. - shippingMethod
-
Type:
object
shippingMethodShipping method information. - trackingInfo
-
Type:
array
trackingInfoTracking Information for the Order. - trackingNumber
-
Type:
string
Shipping tracking number.
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
skuPropertiesSku properties Information - variant
-
Type:
array
variantProduct Variant Information.
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
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
childItemsChild items of the commerce item - commerceItemId
-
Type:
string
Unique id of the line item - 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. - discountAmount
-
Type:
number
Total discount applied to commerce item. - discountInfo
-
Type:
object
discountInfoDiscount information. - displayName
-
Type:
string
Display name of commerce item. - externalData
-
Type:
array
externalDataExternal data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
number
The Price of the product as per the external pricing system. - externalPriceQuantity
-
Type:
integer
Quantity of the product, the customer is allowed to buy at the external price. - giftWithPurchaseCommerceItemMarkers
-
Type:
array
giftWithPurchaseCommerceItemMarkersThe array of giftWithPurchaseCommerceItemMarkers. - imageInfo
-
Type:
object
imageInfoShipping method information. - isPriceOverridden
-
Type:
boolean
Indicates if commerce item price is overridden or not. - onSale
-
Type:
boolean
indicates if product is on sale or not - overriddenPrice
-
Type:
number
overridden price of commerce item. - price
-
Type:
number
The raw number that represents the price. - priceOverridenBy
-
Type:
string
Name of the agent who has overridden item price. - priceOverrideReason
-
Type:
object
priceOverrideReasonPrice override reason map. - 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
skuPropertiesSku properties Information - stateDescription
-
Type:
string
Item state as a key string. - 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
variantProduct Variant Information.
Nested Schema : discountInfo
Type:
object
Discount information.
- orderCouponsMap
-
Type:
array
orderCouponsMapMap of coupons. - orderDiscount
-
Type:
number
Discount given on an order. - orderImplicitDiscountList
-
Type:
array
orderImplicitDiscountListList of discounts. - shippingDiscount
-
Type:
integer
The shipping discount. - unclaimedCouponsMap
-
Type:
array
unclaimedCouponsMapMap 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 : priceOverrideReason
Type:
object
Price override reason map.
- displayValue
-
Type:
string
price override reason value. - key
-
Type:
string
price override reason key.
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
childItemsChild 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
externalDataExternal 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
Product path - selectedOptions
-
Type:
array
selectedOptionsChild Product Variant Information. - 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 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
externalDataExternal 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
Product path - selectedOptions
-
Type:
array
selectedOptionsChild Product Variant Information. - 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
valuesThe 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
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
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
valuesThe 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
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
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
couponInfoThe coupon Info. - promotionValue
-
Type:
string
The value for 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
- 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
valuesThe 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. - 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 gift with purchase promotion id.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
Name of the Dynamic SKU Property. - optionValue
-
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.428563503E12,
"dynamicProperties":[
{
"id":"dynamicPropertyShippingInstructions",
"label":"Shipping Instructions",
"value":"Test Instructions"
}
],
"payments":[
{
"paymentGroupId":"pg30411",
"PONumber":null,
"amount":78.67,
"gatewayName":"invoiceGateway",
"uiIntervention":null,
"paymentMethod":"invoiceRequest",
"isAmountRemaining":true,
"paymentState":"INITIAL"
}
],
"orderStatus":"Failed Approval",
"approvers":[
{
"firstName":"Peter",
"lastName":"Grun",
"approverId":"bb-110020"
}
],
"submittedDate":"2015-04-09T07:21:43.000Z",
"uuid":"a15543c2-a44f-4640-8ac4-674c594efc85",
"priceInfo":{
"amount":52,
"total":62.6,
"shipping":6.5,
"shippingSurchargeValue":20,
"tax":4.1,
"subTotal":52,
"currencyCode":"USD"
},
"links":[
{
"rel":"self",
"href":"http://www.example.com/ccstoreui/v1/orders/reject"
}
],
"id":"o10004",
"quoteInfo":{
"providerNote":null,
"notes":[
{
"profileType":null,
"profileId":"120213",
"requestDate":1.477479521002E12,
"requesterNote":"This is a sample quote"
}
],
"rejectionDate":null,
"requestDate":"2016-10-26T10:58:41.002Z",
"errorInfo":null,
"externalID":null,
"rejectionNote":null,
"quoteDate":null,
"expirationDate":null
},
"order":{
"numberOfItems":1,
"items":[
{
"unitPrice":52,
"primaryThumbImageURL":"/ccstoreui/v1/images/?source=http://www.example.com/file/products/APP_CowboyShirt_full.jpg&height=100&width=100",
"quantity":1,
"rawTotalPrice":52,
"productId":"prod10002",
"displayName":"Cowboy Shirt",
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"externalRecurringCharge":10,
"giftWithPurchaseCommerceItemMarkers":[
],
"active":true,
"externalRecurringChargeFrequency":"Monthly",
"catRefId":"sku40087",
"externalRecurringChargeDuration":"12",
"discountInfo":[
],
"route":"/cowboy-shirt/product/prod10002",
"price":52,
"variant":[
{
"optionValue":"Blue",
"optionName":"Color"
},
{
"optionValue":"Medium",
"optionName":"Size"
}
],
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"recurringCharge":10
}
]
},
"shippingGroup":{
"shippingMethodDescription":"Ground"
},
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":0,
"amount":4.1,
"valueAddedTax":0,
"countyTax":1.76,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":2.34,
"countryTax":0
},
"shippingMethod":{
"shippingTax":0.46,
"cost":6.5,
"value":"ground",
"shippingMethodDescription":"Ground"
},
"shippingGroupId":"sg10032",
"submittedDate":null,
"priceInfo":{
"amount":52,
"total":62.6,
"shipping":6.5,
"shippingSurchargeValue":0,
"tax":4.1,
"subTotal":52,
"currencyCode":"USD",
"totalWithoutTax":58.5
},
"recurringChargePriceInfo":{
"amount":30,
"total":32.4,
"shipping":0,
"subTotalByFrequency":[
{
"amount":30,
"frequency":"Monthly"
}
],
"taxByFrequency":[
{
"amount":2.4,
"frequency":"Monthly"
}
],
"tax":2.4,
"subTotal":30,
"currencyCode":"USD",
"totalWithoutTax":30
},
"discountInfo":{
"orderDiscount":0,
"shippingDiscount":0,
"discountDescList":[
]
},
"shipOnDate":null,
"trackingInfo":[
],
"actualShipDate":null,
"shippingAddress":{
"lastName":"a",
"country":"US",
"address3":"",
"address2":"a",
"city":"a",
"address1":"a",
"prefix":"",
"companyName":"",
"postalCode":"30005",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"a",
"phoneNumber":"5675675678",
"alias":"Address##0",
"faxNumber":"",
"middleName":"",
"state":"GA",
"email":"a@a.com"
},
"trackingNumber":null,
"items":[
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_CowboyShirt_full.jpg&height=100&width=100",
"rawTotalPrice":52,
"returnedQuantity":0,
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"displayName":"Cowboy Shirt",
"shippingSurchargeValue":0,
"discountAmount":0,
"commerceItemId":"ci3000411",
"price":52,
"variant":[
{
"optionValue":"Blue",
"optionName":"Color"
},
{
"optionValue":"Medium",
"optionName":"Size"
}
],
"onSale":false,
"primaryImageAltText":"Cowboy Shirt",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"unitPrice":52,
"primaryImageTitle":"Cowboy Shirt",
"quantity":1,
"productId":"prod10002",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":52,
"quantity":1,
"tax":3.64,
"orderDiscountShare":0,
"detailedUnitPrice":52,
"currencyCode":"USD"
}
],
"externalRecurringCharge":10,
"active":true,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12",
"catRefId":"sku40087",
"discountInfo":[
],
"route":"/cowboy-shirt/product/prod10002",
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"listPrice":52,
"recurringCharge":10,
"status":"INITIAL"
}
],
"status":"INITIAL"
}
],
"lastModifiedDate":"2015-04-09T07:21:43.000Z",
"approvalSystemMessages":[
"Order is pending approval because total is greater than the approved order limit."
],
"shippingMethod":{
"cost":6.5,
"value":"ground"
},
"approverMessages":[
"I am approving this order"
],
"priceListGroup":{
"repositoryId":"UsDollar"
},
"creationDate":"2015-04-09T07:11:43.000Z",
"orderProfileId":"120029",
"paymentGroupId":"pg10004",
"recurringChargePriceInfo":{
"amount":30,
"total":32.4,
"shipping":0,
"subTotalByFrequency":[
{
"amount":30,
"frequency":"Monthly"
}
],
"taxByFrequency":[
{
"amount":2.4,
"frequency":"Monthly"
}
],
"tax":2.4,
"subTotal":30,
"currencyCode":"USD",
"totalWithoutTax":30
},
"discountInfo":{
"unclaimedCouponMultiPromotions":{
"coupon2":[
{
"promotionLevel":"order",
"promotionDesc":"promo4",
"promotionId":"promo20004"
}
]
},
"orderCouponsMap":{
"coupon1":{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo1",
"promotionId":"promo20001"
},
"coupon2":{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo2",
"promotionId":"promo20002"
}
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
{
"promotionLevel":"item",
"totalAdjustment":"-0.66",
"promotionDesc":"Implicit Item Discount - 3PercentOff",
"promotionId":"implicitItemPercentDiscount"
}
],
"claimedCouponMultiPromotions":{
"coupon1":[
{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo1",
"promotionId":"promo20001"
},
{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo3",
"promotionId":"promo20003"
}
],
"coupon2":[
{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo2",
"promotionId":"promo20002"
}
]
},
"unclaimedCouponsMap":{
"coupon2":{
"promotionLevel":"order",
"promotionDesc":"promo4",
"promotionId":"promo20004"
}
}
},
"trackingInfo":[
{
"carrierName":"OnTrac",
"carrierUrl":"http://www.ontrac.com/trackingdetail.asp?tracking=1224",
"carrierId":"OnTrac",
"trackingNumber":"1224"
}
],
"orderLocale":"en",
"shippingAddress":{
"lastName":"a",
"country":"US",
"address3":null,
"address2":"a",
"city":"a",
"address1":"a",
"prefix":null,
"companyName":null,
"postalCode":"30005",
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":"a",
"phoneNumber":"5675675678",
"faxNumber":null,
"alias":null,
"middleName":null,
"state":"GA",
"email":"a@a.com"
},
"billingAddress":{
"lastName":"a",
"country":"US",
"address3":null,
"address2":"a",
"city":"a",
"address1":"a",
"prefix":null,
"companyName":null,
"postalCode":"30005",
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":"a",
"phoneNumber":"5675675678",
"faxNumber":null,
"alias":null,
"middleName":null,
"state":"GA",
"email":"a@a.com"
},
"giftWithPurchaseOrderMarkers":[
{
"quantity":1,
"selectedQuantity":0,
"removedQuantity":0,
"data":"-1275480226",
"automaticQuantity":0,
"giftType":"product",
"autoRemove":true,
"giftDetail":"camera_1",
"repositoryId":"200001",
"failedQuantity":0,
"value":"promo10002",
"targetedQuantity":0,
"key":"atg.gwp"
}
]
}
Default Response
The error response
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
errorsAn 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:
{ "approverMessage": "Rejecting order", "orderId": "o30411" }
Sample Response Payload returned by endpoint:
{ "creationTime": 1428563503000, "dynamicProperties": [{ "id": "dynamicPropertyShippingInstructions", "label": "Shipping Instructions", "value": "Test Instructions" }], "payments": [{ "paymentGroupId": "pg30411", "PONumber": null, "amount": 78.67, "gatewayName": "invoiceGateway", "uiIntervention": null, "paymentMethod": "invoiceRequest", "isAmountRemaining": true, "paymentState": "INITIAL" }], "orderStatus": "Failed Approval", "approvers": [{ "firstName": "Peter", "lastName": "Grun", "approverId": "bb-110020" }], "submittedDate": "2015-04-09T07:21:43.000Z", "uuid": "a15543c2-a44f-4640-8ac4-674c594efc85", "priceInfo": { "amount": 52, "total": 62.6, "shipping": 6.5, "shippingSurchargeValue": 20, "tax": 4.1, "subTotal": 52, "currencyCode": "USD" }, "links": [{ "rel": "self", "href": "http://www.example.com/ccstoreui/v1/orders/reject" }], "id": "o10004", "quoteInfo": { "providerNote": null, "notes": [{ "profileType": null, "profileId": "120213", "requestDate": 1477479521002, "requesterNote": "This is a sample quote" }], "rejectionDate": null, "requestDate": "2016-10-26T10:58:41.002Z", "errorInfo": null, "externalID": null, "rejectionNote": null, "quoteDate": null, "expirationDate": null }, "order": { "numberOfItems": 1, "items": [{ "unitPrice": 52, "primaryThumbImageURL": "/ccstoreui/v1/images/?source=http://www.example.com/file/products/APP_CowboyShirt_full.jpg&height=100&width=100", "quantity": 1, "rawTotalPrice": 52, "productId": "prod10002", "displayName": "Cowboy Shirt", "dynamicProperties": [{ "id": "dynamicPropertyMode", "label": "Mode", "value": "pickup" }], "externalRecurringCharge": 10, "giftWithPurchaseCommerceItemMarkers": [], "active": true, "externalRecurringChargeFrequency": "Monthly", "catRefId": "sku40087", "externalRecurringChargeDuration": "12", "discountInfo": [], "route": "/cowboy-shirt/product/prod10002", "price": 52, "variant": [ { "optionValue": "Blue", "optionName": "Color" }, { "optionValue": "Medium", "optionName": "Size" } ], "detailedRecurringChargeInfo": [{ "discounted": false, "amount": 10, "quantity": 1, "tax": 0, "orderDiscountShare": 0, "detailedUnitPrice": 10, "currencyCode": "USD" }], "recurringCharge": 10 }] }, "shippingGroup": {"shippingMethodDescription": "Ground"}, "shippingGroups": [{ "taxPriceInfo": { "cityTax": 0, "amount": 4.1, "valueAddedTax": 0, "countyTax": 1.76, "isTaxIncluded": false, "miscTax": 0, "districtTax": 0, "stateTax": 2.34, "countryTax": 0 }, "shippingMethod": { "shippingTax": 0.46, "cost": 6.5, "value": "ground", "shippingMethodDescription": "Ground" }, "shippingGroupId": "sg10032", "submittedDate": null, "priceInfo": { "amount": 52, "total": 62.6, "shipping": 6.5, "shippingSurchargeValue": 0, "tax": 4.1, "subTotal": 52, "currencyCode": "USD", "totalWithoutTax": 58.5 }, "recurringChargePriceInfo": { "amount": 30, "total": 32.4, "shipping": 0, "subTotalByFrequency": [{ "amount": 30, "frequency": "Monthly" }], "taxByFrequency": [{ "amount": 2.4, "frequency": "Monthly" }], "tax": 2.4, "subTotal": 30, "currencyCode": "USD", "totalWithoutTax": 30 }, "discountInfo": { "orderDiscount": 0, "shippingDiscount": 0, "discountDescList": [] }, "shipOnDate": null, "trackingInfo": [], "actualShipDate": null, "shippingAddress": { "lastName": "a", "country": "US", "address3": "", "address2": "a", "city": "a", "address1": "a", "prefix": "", "companyName": "", "postalCode": "30005", "jobTitle": "", "county": "", "suffix": "", "firstName": "a", "phoneNumber": "5675675678", "alias": "Address##0", "faxNumber": "", "middleName": "", "state": "GA", "email": "a@a.com" }, "trackingNumber": null, "items": [{ "primaryThumbImageURL": "/ccstore/v1/images/?source=/file/v2/products/APP_CowboyShirt_full.jpg&height=100&width=100", "rawTotalPrice": 52, "returnedQuantity": 0, "dynamicProperties": [{ "id": "dynamicPropertyMode", "label": "Mode", "value": "pickup" }], "displayName": "Cowboy Shirt", "shippingSurchargeValue": 0, "discountAmount": 0, "commerceItemId": "ci3000411", "price": 52, "variant": [ { "optionValue": "Blue", "optionName": "Color" }, { "optionValue": "Medium", "optionName": "Size" } ], "onSale": false, "primaryImageAltText": "Cowboy Shirt", "stateDetailsAsUser": "The item has been initialized within the shipping group", "unitPrice": 52, "primaryImageTitle": "Cowboy Shirt", "quantity": 1, "productId": "prod10002", "salePrice": 0, "detailedItemPriceInfo": [{ "discounted": false, "amount": 52, "quantity": 1, "tax": 3.64, "orderDiscountShare": 0, "detailedUnitPrice": 52, "currencyCode": "USD" }], "externalRecurringCharge": 10, "active": true, "externalRecurringChargeFrequency": "Monthly", "externalRecurringChargeDuration": "12", "catRefId": "sku40087", "discountInfo": [], "route": "/cowboy-shirt/product/prod10002", "detailedRecurringChargeInfo": [{ "discounted": false, "amount": 10, "quantity": 1, "tax": 0, "orderDiscountShare": 0, "detailedUnitPrice": 10, "currencyCode": "USD" }], "listPrice": 52, "recurringCharge": 10, "status": "INITIAL" }], "status": "INITIAL" }], "lastModifiedDate": "2015-04-09T07:21:43.000Z", "approvalSystemMessages": ["Order is pending approval because total is greater than the approved order limit."], "shippingMethod": { "cost": 6.5, "value": "ground" }, "approverMessages": ["I am approving this order"], "priceListGroup": {"repositoryId": "UsDollar"}, "creationDate": "2015-04-09T07:11:43.000Z", "orderProfileId": "120029", "paymentGroupId": "pg10004", "recurringChargePriceInfo": { "amount": 30, "total": 32.4, "shipping": 0, "subTotalByFrequency": [{ "amount": 30, "frequency": "Monthly" }], "taxByFrequency": [{ "amount": 2.4, "frequency": "Monthly" }], "tax": 2.4, "subTotal": 30, "currencyCode": "USD", "totalWithoutTax": 30 }, "discountInfo": { "unclaimedCouponMultiPromotions": {"coupon2": [{ "promotionLevel": "order", "promotionDesc": "promo4", "promotionId": "promo20004" }]}, "orderCouponsMap": { "coupon1": { "promotionLevel": "order", "totalAdjustment": -1, "promotionDesc": "promo1", "promotionId": "promo20001" }, "coupon2": { "promotionLevel": "order", "totalAdjustment": -1, "promotionDesc": "promo2", "promotionId": "promo20002" } }, "orderDiscount": 0, "shippingDiscount": 0, "orderImplicitDiscountList": [{ "promotionLevel": "item", "totalAdjustment": "-0.66", "promotionDesc": "Implicit Item Discount - 3PercentOff", "promotionId": "implicitItemPercentDiscount" }], "claimedCouponMultiPromotions": { "coupon1": [ { "promotionLevel": "order", "totalAdjustment": -1, "promotionDesc": "promo1", "promotionId": "promo20001" }, { "promotionLevel": "order", "totalAdjustment": -1, "promotionDesc": "promo3", "promotionId": "promo20003" } ], "coupon2": [{ "promotionLevel": "order", "totalAdjustment": -1, "promotionDesc": "promo2", "promotionId": "promo20002" }] }, "unclaimedCouponsMap": {"coupon2": { "promotionLevel": "order", "promotionDesc": "promo4", "promotionId": "promo20004" }} }, "trackingInfo": [{ "carrierName": "OnTrac", "carrierUrl": "http://www.ontrac.com/trackingdetail.asp?tracking=1224", "carrierId": "OnTrac", "trackingNumber": "1224" }], "orderLocale": "en", "shippingAddress": { "lastName": "a", "country": "US", "address3": null, "address2": "a", "city": "a", "address1": "a", "prefix": null, "companyName": null, "postalCode": "30005", "jobTitle": null, "county": null, "suffix": null, "firstName": "a", "phoneNumber": "5675675678", "faxNumber": null, "alias": null, "middleName": null, "state": "GA", "email": "a@a.com" }, "billingAddress": { "lastName": "a", "country": "US", "address3": null, "address2": "a", "city": "a", "address1": "a", "prefix": null, "companyName": null, "postalCode": "30005", "jobTitle": null, "county": null, "suffix": null, "firstName": "a", "phoneNumber": "5675675678", "faxNumber": null, "alias": null, "middleName": null, "state": "GA", "email": "a@a.com" }, "giftWithPurchaseOrderMarkers": [{ "quantity": 1, "selectedQuantity": 0, "removedQuantity": 0, "data": "-1275480226", "automaticQuantity": 0, "giftType": "product", "autoRemove": true, "giftDetail": "camera_1", "repositoryId": "200001", "failedQuantity": 0, "value": "promo10002", "targetedQuantity": 0, "key": "atg.gwp" }] }