createExchangeRequest
post
/ccagent/v1/exchanges
Create Exchange Request. Gets list of items from an order for which exchange request can be created with operation set as 'initiateExchange'. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.Additonally takes x-ccsite header. If the site information is not provided by default it takes the order site
Request
Supported Media Types
- application/json
Header Parameters
-
x-ccsite(optional): string
the site id on which the orders is laced
Root Schema : createExchangeRequest_request
Type:
Show Source
object
-
op:
string
Specify the operation to be performed. Related Endpoint Operations - InitiateExchange, SubmitExchangeOrder, CreateExchangeRequest
-
orderId:
string
Commerce id of order. Related Endpoint Operations - InitiateExchange, CreateExchangeRequest
-
returnItems(optional):
array returnItems
List of returnable Items. Related Endpoint Operations - SubmitExchangeOrder
-
returnRequestId(optional):
string
Id of the returnrequest. Related Endpoint Operations - SubmitExchangeOrder
Example:
{
"op":"initiateExchange",
"orderId":"o10400"
}
Nested Schema : returnItems
Type:
array
List of returnable Items. Related Endpoint Operations - SubmitExchangeOrder
Show Source
Nested Schema : items
Type:
Show Source
object
-
catRefId(optional):
string
Catalog Reference Id
-
commerceItemId(optional):
number
Commerce Id of the returned item
-
dynamicProperties(optional):
string
Map containing dynamic properties as key value pairs
-
quantityToReturn(optional):
string
Quantity to be Returned
-
replacementSkuId(optional):
string
SkuId of the replaced Item
-
returnReason(optional):
string
Return Reason
-
shippingGroupId(optional):
string
Shipping group Id of the returned item
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createExchangeRequest_response
Type:
Show Source
object
-
additionalProperties(optional):
object additionalProperties
Additional properties of the return request
-
orderInfo(optional):
object orderInfo
Order Information.
-
profileInfo(optional):
object profileInfo
Profile Information for the order.
-
quoteInfo(optional):
object quoteInfo
the quote information of the order
-
returnItems(optional):
array returnItems
List of returnable Items
-
returnLabel(optional):
string
Return Label of the return request
-
trackingNumber(optional):
array trackingNumber
List of tracking numbers for the return request
Nested Schema : additionalProperties
Type:
object
Additional properties of the return request
Show Source
-
property1(optional):
string
Additional Property 1
-
property2(optional):
string
Additional Property 2
Nested Schema : orderInfo
Type:
object
Order Information.
Show Source
-
creationDate(optional):
string
Date on which the Order was created.
-
orderId(optional):
string
Commerce id for this order.
-
priceInfo(optional):
object priceInfo
Price information of the order.
-
priceListGroup(optional):
object priceListGroup
PriceList group of the order.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Detailed information of the recurring charges at the shipping groups level
-
siteId(optional):
string
Site Id on which the Order was placed.
-
submittedDate(optional):
string
Date on which the Order was submitted.
Nested Schema : profileInfo
Type:
object
Profile Information for the order.
Show Source
-
email(optional):
string
Email address of the profile
-
firstName(optional):
string
First name of profile.
-
lastName(optional):
string
Last name of profile.
-
middleName(optional):
string
Middle name of profile.
-
organization(optional):
object organization
The Organization associated with the B2B customer profile.
Nested Schema : quoteInfo
Type:
object
the quote information of the order
Show Source
-
errorInfo(optional):
array errorInfo
the array of errors, if any
-
expirationDate(optional):
string
the expiration date of the quoted order, if any
-
externalId(optional):
string
the external id for the quote
-
notes(optional):
array notes
the notes (history) for the order
-
providerNote(optional):
string
the provider note for the quoted order
-
quoteDate(optional):
number
the date the order was quoted in milliseconds
-
rejectionDate(optional):
string
rejection date of the quoted order
-
rejectionNote(optional):
string
the rejection note for an order whose quote has been rejected by user
-
requestDate(optional):
string
the date when the quote was requested in ISO format
Nested Schema : trackingNumber
Type:
array
List of tracking numbers for the return request
Show Source
Nested Schema : priceInfo
Type:
object
Price information of the order.
Show Source
-
amount(optional):
number
The raw number that represents the price.
-
currencyCode(optional):
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
-
isTaxIncluded(optional):
boolean
Indicates if tax is included in item price
-
orderDiscountAmount(optional):
number
Total Order Discount Ampunt
-
shipping(optional):
number
The shipping cost of the order.
-
subTotal(optional):
number
The subtotal of the order before applying order-level promotions.
-
tax(optional):
number
The tax on the order.
-
total(optional):
number
The current working total, including all promotions, tax, and billing costs.
-
totalWithoutTax(optional):
number
The total cost without Tax.
Nested Schema : priceListGroup
Type:
object
PriceList group of the order.
Show Source
-
active(optional):
boolean
Active status of pricelist group.
-
currency(optional):
object currency
Currency of the PriceList group.
-
deleted(optional):
boolean
Pricelist group deleted status.
-
displayName(optional):
string
Display Name.
-
id(optional):
string
Id.
-
listPriceList(optional):
object listPriceList
Price List for list prices
-
locale(optional):
string
Locale.
-
repositoryId(optional):
string
Repository Id.
-
salePriceList(optional):
object salePriceList
Price List for sale prices
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
Price List for shipping surcharge prices
Nested Schema : recurringChargePriceInfo
Type:
object
Detailed information of the recurring charges at the shipping groups level
Show Source
-
amount(optional):
integer
amount
-
currencyCode(optional):
string
Currency code
-
shipping(optional):
integer
shipping charge
-
subtotal(optional):
integer
sub total
-
subTotalByFrequency(optional):
array subTotalByFrequency
subtotal of the item by frequency
-
tax(optional):
integer
total tax
-
taxByFrequency(optional):
array taxByFrequency
tax by frequency
-
total(optional):
integer
total amount
-
totalWithoutTax(optional):
integer
total without tax
Nested Schema : currency
Type:
object
Currency of the PriceList group.
Show Source
-
currencyCode(optional):
string
Currency Code.
-
displayName(optional):
string
Display Name.
-
fractionalDigits(optional):
integer
Fractional Digits.
-
numericCode(optional):
string
Numeric Code.
-
repositoryId(optional):
string
Repository Id.
-
symbol(optional):
string
currency Symbol.
Nested Schema : listPriceList
Type:
object
Price List for list prices
Show Source
-
repositoryId(optional):
string
Repository ID of the list prices
Nested Schema : salePriceList
Type:
object
Price List for sale prices
Show Source
-
repositoryId(optional):
string
Repository ID of the sale prices
Nested Schema : shippingSurchargePriceList
Type:
object
Price List for shipping surcharge prices
Show Source
-
repositoryId(optional):
string
Repository ID of the shipping surcharge prices
Nested Schema : taxByFrequency
Type:
array
tax by frequency
Show Source
-
Array of:
integer
tax for each frequency
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
integer
amount
-
frequency(optional):
string
frequency of the recurring charges
Nested Schema : organization
Type:
object
The Organization associated with the B2B customer profile.
Show Source
-
id(optional):
string
The id of the organization.
-
name(optional):
string
The name of of the organization.
Nested Schema : items
Type:
Show Source
object
-
profileId(optional):
string
the profile id of the user
-
profileType(optional):
string
the profile type of the user that requested the quote
-
requestDate/quoteDate/rejectionDate(optional):
number
the request/quote/rejection date for the note
-
requesterNote/providerNote/rejectionNote(optional):
string
the requester/provider/rejection note
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
additionalProperties(optional):
object additionalProperties
Additional properties of the return item
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Catalog Reference Id
-
childItems(optional):
array childItems
Returned Item child items
-
comments(optional):
string
Comments at returnItem level
-
commerceItemId(optional):
string
Commerce Id of the returned item
-
configuratorId(optional):
string
Configurator Id of the returned item
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Display Name of the Product
-
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
nonreturnable(optional):
boolean
Indicates whether the item is returnable or not
-
nonReturnableReason(optional):
string
Indicates the reason for non-returnable
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
price(optional):
number
Total price of items
-
productId(optional):
string
Id of the Product
-
quantityAvailableForReturn(optional):
number
Quantity Available
-
quantityReturned(optional):
number
Quantity Returned
-
quantityShipped(optional):
number
Quantity Shipped
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shippingGroup(optional):
object shippingGroup
Shipping group details
-
shippingGroupId(optional):
string
Shipping group Id of the returned item
-
skuOptionInfo(optional):
array skuOptionInfo
Product Variant Information.
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice(optional):
number
Unit price of the item
Nested Schema : additionalProperties
Type:
object
Additional properties of the return item
Show Source
-
property1(optional):
string
Additional Property 1
-
property2(optional):
string
Additional Property 2
Nested Schema : dynamicProperties
Type:
array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shippingGroup
Type:
object
Shipping group details
Show Source
-
availablePickupDate(optional):
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
email(optional):
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName(optional):
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
lastName(optional):
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
middleName(optional):
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber(optional):
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
preferredPickupDate(optional):
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
shippingAddress(optional):
object shippingAddress
shipping address for the order.
-
shippingMethod(optional):
object shippingMethod
Shipping method information.
-
store(optional):
object store
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
type(optional):
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Catalog Reference Id of the child Item
-
childItems(optional):
array childItems
Returned Item child items
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Product display name of the sub sku commerce item
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
Product Id of teh
-
quantity(optional):
number
quantity of the child Item
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route(optional):
string
Product path
-
selectedOptions(optional):
array selectedOptions
Child Product Variant Information.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Catalog Reference Id of the child Item
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Product display name of the sub sku commerce item
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
Product Id of teh
-
quantity(optional):
number
quantity of the child Item
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route(optional):
string
Product path
-
selectedOptions(optional):
array selectedOptions
Child Product Variant Information.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
Name of the Dynamic attribute.
-
optionValue(optional):
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
Name of the Dynamic attribute.
-
optionValue(optional):
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
Show Source
-
address1(optional):
string
Address Line 1 for this shipping address.
-
address2(optional):
string
Address Line 2 for this shipping address.
-
address3(optional):
string
Address Line 3 for this shipping address.
-
city(optional):
string
City for this shipping address.
-
companyName(optional):
string
Company name for this shipping address.
-
country(optional):
string
Country code for this shipping address.
-
countryName(optional):
string
Country name for this shipping address.
-
county(optional):
string
County for this shipping address.
-
email(optional):
string
Email for this shipping address.
-
faxNumber(optional):
string
Fax number for this shipping address.
-
firstName(optional):
string
First name for this shipping address.
-
jobTitle(optional):
string
Job title for this shipping address.
-
lastName(optional):
string
Last name for this shipping address.
-
middleName(optional):
string
Middle name for this shipping address.
-
phoneNumber(optional):
string
Phone number for this shipping address.
-
postalCode(optional):
string
Postal code for this shipping address.
-
prefix(optional):
string
Prefix for this shipping address.
-
state(optional):
string
State code for this shipping address.
-
stateName(optional):
string
State name for this shipping address.
-
suffix(optional):
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
Show Source
-
shippingMethod(optional):
string
Shipping method Name.
-
shippingMethodDescription(optional):
number
shipping method description.
Nested Schema : store
Type:
object
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
-
address1(optional):
string
Address line 1 of the store.
-
address2(optional):
string
Address line 2 of the store.
-
address3(optional):
string
Address line 3 of the store.
-
city(optional):
string
The city in which the store resides.
-
country(optional):
string
The country in which the store resides.
-
county(optional):
string
The county in which the store resides.
-
email(optional):
string
The email address of the store.
-
faxNumber(optional):
string
The fax number of the store.
-
hours(optional):
string
The opening hours of the store.
-
locationId(optional):
string
The location id of the store.
-
name(optional):
string
Name of the store.
-
phoneNumber(optional):
string
The phone number of the store.
-
postalCode(optional):
string
The postal code of the store.
-
stateAddress(optional):
string
The state in which the store resides.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
Name of the Dynamic attribute
-
optionValue(optional):
string
Value of the Dynamic attribute
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the Dynamic SKU Property.
-
name(optional):
string
Name of the Dynamic SKU Property.
-
propertyType(optional):
string
Type that indicates whether it is a base or a custom SKU property,
-
value(optional):
string
Value of the Dynamic SKU Property.
Example Response (application/json)
{
"returnLabel":"return label 1",
"returnItems":[
{
"quantityReturned":0,
"deactivationDate":"2018-06-27T12:59:59Z",
"nonreturnable":false,
"dynamicProperties":[
{
"id":"ReferralCode",
"label":"ReferralCode",
"value":null
},
{
"id":"OfferEndsDate",
"label":"OfferEndsDate",
"value":"2020-07-02T03:42:42.000Z"
},
{
"id":"Discount",
"label":"Discount",
"value":10
},
{
"id":"GiftWrapping",
"label":"Gift Wrapping",
"value":false
},
{
"id":"name",
"label":"Name on product(Mug)",
"value":"My name"
},
{
"id":"ShippingInstructions",
"label":"Shipping Instructions",
"value":null
}
],
"displayName":"Fifa 2010",
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"childItems":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":2,
"productId":"prod10040",
"displayName":"Super Smash Brothers Brawl",
"externalData":[
],
"parentAssetKey":"12345",
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"childItems":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":2,
"productId":"prod10049",
"displayName":"Super Smash Brothers Brawl one",
"externalData":[
],
"parentAssetKey":"23456",
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"rootAssetKey":"12345",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"sku10041",
"assetKey":"34567",
"route":"product/prod10049",
"customerAccountId":"customerAcc-123",
"selectedOptions":[
],
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
}
],
"rootAssetKey":"12345",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"sku10041",
"assetKey":"23456",
"route":"product/prod10040",
"customerAccountId":"customerAcc-123",
"selectedOptions":[
],
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
},
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"prod10038",
"displayName":"Wii Music",
"externalData":[
],
"parentAssetKey":"12345",
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"rootAssetKey":"12345",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"sku10042",
"assetKey":"56789",
"route":"product/prod10038",
"customerAccountId":"customerAcc-123",
"selectedOptions":[
],
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
}
],
"configuratorId":"12345677",
"skuOptionInfo":[
],
"assetKey":"12345",
"quantityAvailableForReturn":3,
"commerceItemId":"ci9000467",
"price":29.97,
"actionCode":"Add",
"serviceId":"service-123",
"nonReturnableReason":null,
"unitPrice":9.99,
"serviceAccountId":"serviceAcc-123",
"shippingGroup":{
"firstName":null,
"lastName":null,
"emailAddress":null,
"phoneNumber":null,
"locationId":"testLoc2",
"shippingMethod":{
"shippingMethod":"inStorePickupShippingGroup",
"shippingMethodDescription":"inStorePickupShippingGroup"
},
"shippingGroupId":"sg40412",
"middleName":null,
"store":{
"country":"USA",
"hours":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM",
"address3":null,
"address2":"15th Floor",
"city":"San Francisco",
"address1":"475 Sansome Street",
"postalCode":"94111",
"county":null,
"stateAddress":"CA",
"phoneNumber":"(617) 386-1200",
"locationId":"testLoc2",
"name":"Cloud Store - SanFrancisco",
"faxNumber":"(617) 386-1200",
"email":"store113@example.com"
},
"type":"inStorePickupShippingGroup"
},
"comments":null,
"productId":"prod10035",
"shippingGroupId":"sg80417",
"parentAssetKey":null,
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"sku10037",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"Name",
"id":"displayName",
"value":null
},
{
"propertyType":"sku-base",
"name":"Id",
"id":"id",
"value":"camerasku_1_1"
},
{
"propertyType":"sku-custom",
"name":"dynamicskuprop1",
"id":"dynamicskuprop1",
"value":"dynamicskuprop1"
}
],
"customerAccountId":"customerAcc-123",
"quantityShipped":3,
"additionalProperties":{
"property2":"tag",
"property":"display"
},
"activationDate":"2017-06-27T15:30:00Z",
"asset":false
}
],
"profileInfo":{
"lastName":"Anderson",
"firstName":"Kim",
"organization":{
"name":"Oracle India Pvt Ltd",
"id":"oracle"
},
"middleName":null,
"email":"kim@example.com"
},
"orderInfo":{
"priceInfo":{
"total":58.4,
"amount":29.97,
"shipping":25,
"isTaxIncluded":false,
"tax":3.43,
"subTotal":29.97,
"orderDiscountAmount":0,
"currencyCode":"USD",
"totalWithoutTax":145.2
},
"recurringChargePriceInfo":{
"amount":20,
"total":20,
"shipping":0,
"subTotalByFrequency":[
{
"amount":20,
"frequency":"Monthly"
}
],
"taxByFrequency":[
{
"amount":0,
"frequency":"Monthly"
}
],
"tax":0,
"subTotal":20,
"currencyCode":"USD",
"totalWithoutTax":20
},
"orderId":"o10400",
"priceListGroup":{
"deleted":false,
"displayName":"UsDollar",
"listPriceList":{
"repositoryId":"listPrices"
},
"repositoryId":"UsDollar",
"active":true,
"salePriceList":{
"repositoryId":"salePrices"
},
"currency":{
"symbol":"$",
"displayName":"US Dollar",
"repositoryId":"en_US",
"fractionalDigits":2,
"currencyCode":"USD",
"numericCode":"840"
},
"id":"UsDollar",
"locale":"en_US",
"shippingSurchargePriceList":{
"repositoryId":"shippingSurchargePrices"
}
},
"siteId":"siteUS",
"creationDate":"2014-05-20 16:06:44.0",
"submittedDate":"2014-05-20 16:07:44.0"
},
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/exchanges"
}
],
"additionalProperties":{
"property2":"tag",
"property":"display"
},
"quoteInfo":{
"providerNote":null,
"notes":[
{
"providerDate":"2016-11-25T13:33:48.000Z",
"providerNote":"The quote is approved as per the request",
"profileType":null,
"profileId":"se-570031"
},
{
"profileType":null,
"profileId":"se-570031",
"requestDate":"2016-10-25T13:33:48.000Z",
"requesterNote":"provide 10 percent off on the total quantity"
}
],
"rejectionDate":null,
"requestDate":"2016-10-25T13:33:48.000Z",
"errorInfo":null,
"externalID":null,
"rejectionNote":null,
"quoteDate":"2016-10-25T13:35:32.000Z",
"expirationDate":"2026-04-28T18:53:48.000Z"
},
"trackingNumber":[
"http://localhost:9080/trackingNumber",
"http://localhost:9080/trackingNumber2"
]
}
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|
|------------------|------------------|
|200188|The shipping method(s) associated with the order is no longer available.|
|30015|SiteId passed in x-ccsite header is currently inactive|
|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|
|200171|Order is not allowed for exchange.|
|30020|The Site to which the order belongs was deleted|
|30021|The Site to which the order belongs is currently inactive|
|200105|Order Id passed in is null.|
|200189|An internal error occurred while validating shipping method(s) associated with the order.|
|30019|SiteId passed in x-ccsite header is not related to the order being worked upon|
|28410|The structure of add-ons defined for the order is invalid.|
|200171|This order has not been fulfilled.|
|200171|Order organization is not valid. Exchange request cannot be created.|
|200171|Price List Group is is no longer available. Exchange request cannot be created.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code