REST API for Oracle Commerce Cloud December 2017

getOrders

get

/ccadmin/v1/orders

Get Orders. This operation is used to get a collection of orders from Oracle Commerce Cloud.

Request

Supported Media Types

application/json

Query Parameters

fields: Type: string

This controls which fields are returned in the response body. The default is to include the top-level response fields and the Audience id, displayName, description, and enabled fields.
limit: Type: integer

This is the field to specify the number of records to be fetched per REST call.
offset: Type: integer

This field specifies the offset/starting index from which data to be fetched.
q: Type: string

This field specifies the query used to limit the orders returns. Defaults to RQL. To use SCIM use the queryFormat parameter
queryFormat: Type: string

Specifies the format of the query. For backwards compatibility, the default query format is RQL. Specify a value of "SCIM" to use SCIM query format.
sort: Type: string

This field specifies the sort order of the list to be fetched.
totalResults: Type: boolean

Indicates if the total results should be included in the response.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getOrders_response

Properties

items: Type: array items

Additional Properties Allowed:

Array containing the object representations of orders. See updateOrder for a description of the values of each order.
limit: Type: integer

Limit of number of products.
offset: Type: integer

Numeric offset of the first order item returned.
sort: Type: array sort

Additional Properties Allowed:

An array that specifies the sort order.
total: Type: integer

Total number of products. Deprecated.
totalResults: Type: integer

Total number of products.

Nested Schema : items

Type: array

Array containing the object representations of orders. See updateOrder for a description of the values of each order.

Items

Type: object updateOrder_request

Additional Properties Allowed:

Nested Schema : sort

Type: array

An array that specifies the sort order.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : updateOrder_request

Example


{
    "isAnonymousCheckout":false,
    "visitId":"27c79ed0-384f-4658-824d-c5b8518bfde0",
    "appliedPromotions":[
        "explicitItemFreeDiscount"
    ],
    "shippingMethod":{
        "value":"twoDay"
    },
    "payments":[
        {
            "cardCVV":"123",
            "nameOnCard":"test",
            "cardTypeName":"Visa",
            "cardType":"visa",
            "endMonth":"02",
            "type":"card",
            "endYear":2018,
            "cardNumber":"4055011111111111"
        }
    ],
    "shoppingCart":{
        "coupons":[
            {
                "code":"FREETATTOO",
                "level":"item",
                "description":"Explicit Item Discount - FREETATTOO",
                "id":"explicitItemFreeDiscount",
                "totalAdjustment":"-21.99",
                "status":"claimed"
            }
        ],
        "items":[
            {
                "serviceAccountId":"serviceAcc-123",
                "deactivationDate":"2018-06-27T12:59:59Z",
                "quantity":1,
                "dynamicPropertyMode":"pickup",
                "productId":"prod20006",
                "externalRecurringCharge":10,
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "externalData":[
                ],
                "billingAccountId":"billingAcc-123",
                "externalRecurringChargeFrequency":"Monthly",
                "catRefId":"sku40105",
                "externalRecurringChargeDuration":"12",
                "customerAccountId":"customerAcc-123",
                "assetId":"asset10001",
                "actionCode":"Add",
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "activationDate":"2017-06-27T15:30:00Z",
                "serviceId":"service-123",
                "recurringCharge":10
            }
        ],
        "orderTotal":109.46
    },
    "shippingAddress":{
        "lastName":"h",
        "country":"United States",
        "address3":"",
        "address2":"A2",
        "city":"C1",
        "prefix":"",
        "address1":"A1",
        "defaultCountryCode":null,
        "postalCode":"36123",
        "jobTitle":"",
        "companyName":"",
        "county":"",
        "suffix":"",
        "selectedCountry":"US",
        "firstName":"h",
        "phoneNumber":"34534533",
        "faxNumber":"",
        "alias":"",
        "middleName":"",
        "state":"Alabama",
        "selectedState":"AL",
        "email":"h@h.com",
        "state_ISOCode":"US-AL"
    },
    "id":"o10003",
    "billingAddress":{
        "lastName":"Test",
        "country":"United States",
        "address3":"",
        "address2":"Line 2",
        "city":"Montgomery",
        "prefix":"",
        "address1":"Line 1",
        "postalCode":"36123",
        "jobTitle":"",
        "companyName":"",
        "county":"",
        "suffix":"",
        "selectedCountry":"US",
        "firstName":"Steve",
        "phoneNumber":"45454545",
        "faxNumber":"",
        "alias":"",
        "middleName":"",
        "state":"Alabama",
        "selectedState":"AL",
        "state_ISOCode":"US-AL"
    },
    "dynamicPropertyShippingInstructions":"Test Instructions",
    "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"
        }
    ],
    "visitorId":"-6820098066093706883"
}

Properties

appliedPromotions: Type: array appliedPromotions

Additional Properties Allowed:

The array of applied promotions.
billingAddress: Type: object billingAddress

Additional Properties Allowed:

The billing address details.
combineLineItems: Type: string

Value to determine if line items are to be combined. Can be yes or no.
giftWithPurchaseOrderMarkers: Type: array giftWithPurchaseOrderMarkers

Additional Properties Allowed:

giftWithPurchaseOrderMarker information. Required if giftWithPurchaseOrderMarker information is present.
isAnonymousCheckout: Type: boolean

Returns false if the order is for a logged-in user.
payments: Type: array payments

Additional Properties Allowed:

Payment details to update the order.
shippingAddress: Type: object shippingAddress

Required: true

Additional Properties Allowed:

The shipping address details.
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:

The shipping groups for the order.
shippingMethod: Type: object shippingMethod

Required: true

Additional Properties Allowed:

The shipping method details for the order.
shoppingCart: Type: object shoppingCart

Required: true

Additional Properties Allowed:

The shopping cart contents of the current order.

Nested Schema : appliedPromotions

Type: array

The array of applied promotions.

Items

Type: string

Nested Schema : billingAddress

Type: object

The billing address details.

Properties

address1: Type: string

Required: true

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
alias: Type: string

Address alias.
city: Type: string

Required: true

City.
companyName: Type: string

Company name.
country: Type: string

Required: true

Country.
county: Type: string

County.
faxNumber: Type: string

Fax number.
firstName: Type: string

Required: true

First name.
jobTitle: Type: string

Job title.
lastName: Type: string

Required: true

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Required: true

Postal code.
prefix: Type: string

Name prefix.
selectedCountry: Type: string

Required: true

Country code.
selectedState: Type: string

Required: true

State code.
state: Type: string

Required: true

State.
state_ISOCode: Type: string

Required: true

State ISO code.
suffix: Type: string

Name suffix.

Nested Schema : giftWithPurchaseOrderMarkers

Type: array

giftWithPurchaseOrderMarker information. Required if giftWithPurchaseOrderMarker information is present.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : payments

Type: array

Payment details to update the order.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

The shipping address details.

Properties

address1: Type: string

Required: true

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
alias: Type: string

Address alias.
city: Type: string

Required: true

City.
companyName: Type: string

Company name.
country: Type: string

Required: true

Country.
county: Type: string

County.
email: Type: string

Required: true

Email address.
faxNumber: Type: string

Fax number.
firstName: Type: string

Required: true

First name.
jobTitle: Type: string

Job title.
lastName: Type: string

Required: true

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Required: true

Postal code.
prefix: Type: string

Name prefix.
selectedCountry: Type: string

Required: true

Country code.
selectedState: Type: string

Required: true

State code.
state: Type: string

Required: true

State.
state_ISOCode: Type: string

Required: true

State ISO code.
suffix: Type: string

Name suffix.

Nested Schema : shippingGroups

Type: array

The shipping groups for the order.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingMethod

Type: object

The shipping method details for the order.

Properties

value: Type: string

Required: true

The shipping method applied to the order.

Nested Schema : shoppingCart

Type: object

The shopping cart contents of the current order.

Properties

coupons: Type: array coupons

Additional Properties Allowed:

The array of coupons applied to the order.
items: Type: array items

Required: true

Additional Properties Allowed:

The array of products in the shopping cart.
orderTotal: Type: number

The total price of the order.

Nested Schema : items

Type: object

Properties

automaticQuantity: Type: number

Required: true

The quantity of free sku for this gift selection that has already been auto added to the order.
autoRemove: Type: boolean

Required: true

Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
data: Type: integer

Required: true

An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
failedQuantity: Type: number

Required: true

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

Required: true

String identifying the free gift, usually the repository id of the gift type.
giftType: Type: string

Required: true

The type of the gift. (sku, product)
key: Type: string

Required: true

atg.gwp
quantity: Type: number

Required: true

The total quantity of sku for this gift selection.
removedQuantity: Type: number

Required: true

The amount of free quantity that has since been manually removed by a Shopper.
selectedQuantity: Type: integer

Required: true

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

Required: true

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

Required: true

The gift with purchase promotion id

Nested Schema : items

Type: object

Properties

amount: Type: number

Amount to be authorized from the gift card. Payment type:invoice,card, physicalGiftCard, paypalCheckout, payUWebLatamCheckout.
cardCVV: Type: string

Credit/Debit card secret pin. Payment type:card.
cardNumber: Type: string

Credit/Debit card number used for payment. Payment type:card.
cardType: Type: string

Credit/Debit card type. e.g. visa. Payment type:card.
cardTypeName: Type: string

Credit/Debit card type name. e.g. Visa. Payment type:card.
endMonth: Type: string

Credit/Debit card expiry month. Payment type:card.
endYear: Type: string

Credit/Debit card expiry year. Payment type:card.
giftCardNumber: Type: string

Gift card number used for payment. Payment type:physicalGiftCard.
giftCardPin: Type: string

Gift card pin. Payment type:physicalGiftCard.
nameOnCard: Type: string

Name on the credit/debit card. Payment type:card.
PayerID: Type: string

Payer ID relevant to paypal checkout type. Payment type:paypalCheckout.
paymentGroupId: Type: string

Payment Group Id of the gift card payment group. Payment type:physicalGiftCard.
paymentId: Type: string

Payment ID relevant to the payment type. Payment type:paypalCheckout, payUWebLatamCheckout.
PONumber: Type: string

Purchase order number. Pament type:invoice
type: Type: string

Required: true

Payment type. e.g. paypalCheckout, payUWebLatamCheckout.

Nested Schema : items

Type: object

Properties

items: Type: array items

Required: true

Additional Properties Allowed:

The array of products in the shipping group.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address details.
shippingMethod: Type: object shippingMethod

Additional Properties Allowed:

The shipping method details for the order.

Nested Schema : items

Type: array

The array of products in the shipping group.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

The shipping address details.

Properties

address1: Type: string

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
alias: Type: string

Address alias.
city: Type: string

City.
companyName: Type: string

Company name.
country: Type: string

Country.
county: Type: string

County.
email: Type: string

Email address.
faxNumber: Type: string

Fax number.
firstName: Type: string

First name
jobTitle: Type: string

Job title.
lastName: Type: string

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Postal code.
prefix: Type: string

Name prefix.
selectedCountry: Type: string

Country code.
selectedState: Type: string

State code.
state: Type: string

State.
state_ISOCode: Type: string

State ISO code.
suffix: Type: string

Name suffix.

Nested Schema : shippingMethod

Type: object

The shipping method details for the order.

Properties

value: Type: string

The shipping method applied to the order.

Nested Schema : items

Type: object

Properties

catRefId: Type: string

Required: true

The category to which the product belongs.
commerceItemId: Type: string

The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no.
productId: Type: string

Required: true

ID of the product in the cart.
quantity: Type: integer

Required: true

The quantity of the product in the shipping group.

Nested Schema : coupons

Type: array

The array of coupons applied to the order.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: array

The array of products in the shopping cart.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

code: Type: string

Required: true

The coupon code.
description: Type: string

The coupon description.
id: Type: string

Required: true

The coupon ID.
level: Type: string

Required: true

The level of the coupon (whether the coupon is item level, etc).
status: Type: string

Required: true

The current status of the coupon.

Nested Schema : items

Type: object

Properties

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

Required: true

The category to which the product belongs.
childItems: Type: array childItems

Additional Properties Allowed:

The array of child items in the item, if the item is a configurable item. A child item can itself contain child item array if it is a configurable product in itself.
commerceItemId: Type: string

The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPrice: Type: number

A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
externalPriceQuantity: Type: integer

The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
giftWithPurchaseCommerceItemMarkers: Type: array giftWithPurchaseCommerceItemMarkers

Additional Properties Allowed:

giftWithPurchaseCommerceItemMarker information. If giftWithPurchaseCommerceItemMarker information is present on the order is should be passed in.
productId: Type: string

Required: true

ID of the product in the cart.
quantity: Type: integer

Required: true

The quantity of the product in the cart.
recurringCharge: Type: number

The recurring charge for the 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

Type: array

The array of child items in the item, if the item is a configurable item. A child item can itself contain child item array if it is a configurable product in itself.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

Properties

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : giftWithPurchaseCommerceItemMarkers

Type: array

giftWithPurchaseCommerceItemMarker information. If giftWithPurchaseCommerceItemMarker information is present on the order is should be passed in.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

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

Required: true

Sku reference id.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPrice: Type: number

Required: true

A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
externalPriceQuantity: Type: integer

Required: true

The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable). The value of this property should be -1 in case if the current item is a sub item of a configurable product
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
productId: Type: string

Required: true

ID of the product in the cart.
quantity: Type: integer

Required: true

The quantity of the product in the cart.
recurringCharge: Type: number

The recurring charge for the 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 : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

Properties

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional 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.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional 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.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

automaticQuantity: Type: number

Required: true

The quantity of the free gift that this commerce item is making free and was auto added by pricing.
data: Type: integer

Required: true

The gift hash code for this gift with purchase promotion.
key: Type: string

Required: true

atg.gwp
remainingQuantity: Type: number

Required: true

The quantity of the commerce item that is not affected by gift with purchase.
selectedQuantity: Type: number

Required: true

The quantity of the free gift that this commerce item is making free and was selected by the shopper.
targetedQuantity: Type: number

Required: true

The quantity of the free gift that this commerce item is making free and was targeted by pricing.
value: Type: string

Required: true

The gift with purchase promotion id.

Nested Schema : items

Type: object

Properties

order: Type: string

Whether this property should be sorted ascending ("asc") or descending ("dsc").
property: Type: string

The name of the property to use for sorting.

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

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 errors

Additional 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

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

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