REST API for Oracle Commerce Cloud December 2017

checkOrderApprovalWebhook

post

/ccadmin/v1/webhook/checkOrderApprovalWebhook

This event will be called if approval check from webhook is enabled from admin's approval setting page.

Request

Supported Media Types

application/json

Body Parameter

This event will be called if approval check from webhook is enabled from admin's approval setting page.

Root Schema : checkOrderApprovalWebhook_request

This event will be called if approval check from webhook is enabled from admin's approval setting page.

Properties

request: Type: object request

Additional Properties Allowed:

Nested Schema : request

Type: object

Properties

creationDate: Type: string

The order creation date.
creationTime: Type: number

The creation time of the order.
discountInfo: Type: object discountInfo

Additional Properties Allowed:

The discount information.
dynamicProperties: Type: array dynamicProperties

Additional Properties Allowed:

the value of the dynamic Properties
exchangeRate: Type: number

exchangeRate
giftWithPurchaseInfo: Type: array giftWithPurchaseInfo

Additional Properties Allowed:
giftWithPurchaseOrderMarkers: Type: array giftWithPurchaseOrderMarkers

Additional Properties Allowed:
isItemPriceOverrideAllowed: Type: boolean
locale: Type: string

the locale of the request/response
orderId: Type: string

The ID of the order.
orderProfileId: Type: string

The profile id on the order.
orderStatus: Type: string

The order status.
organization: Type: object organization

Additional Properties Allowed:

The organization related property object
priceInfo: Type: object priceInfo

Additional Properties Allowed:
pricingMessages: Type: object pricingMessages

Additional Properties Allowed:
profile: Type: object profile

Additional Properties Allowed:
secondaryCurrencyCode: Type: string

Secondary currencyCode
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

Default shipping address of the profile
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:
shoppingCart: Type: object shoppingCart

Additional Properties Allowed:
siteId: Type: string

Nested Schema : discountInfo

Type: object

The discount information.

Properties

orderCouponsMap: Type: array orderCouponsMap

Additional Properties Allowed:

The list of all the coupons with the order.
orderDiscount: Type: integer

The order discount.
shippingDiscount: Type: integer

The shipping discount.

Nested Schema : dynamicProperties

Type: array

the value of the dynamic Properties

Items

Type: object items

Additional Properties Allowed:

Nested Schema : giftWithPurchaseInfo

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : giftWithPurchaseOrderMarkers

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : organization

Type: object

The organization related property object

Properties

active: Type: boolean

Active status of an Organization. Should be true or false. By default the value is set to true
allApprovers: Type: array allApprovers

Additional Properties Allowed:

list of all the approvers
allContracts: Type: object allContracts

Additional Properties Allowed:
allCostCenters: Type: array allCostCenters

Additional Properties Allowed:
allCreditCards: Type: object allCreditCards

Additional Properties Allowed:
allMembers: Type: array allMembers

Additional Properties Allowed:
allPreferredVendors: Type: array allPreferredVendors

Additional Properties Allowed:
ancestorOrganizations: Type: array ancestorOrganizations

Additional Properties Allowed:

List of ancestors for the Organization
approvalRequired: Type: boolean

Approval flag is required for the organization, by default it is set to false
approvers: Type: array approvers

Additional Properties Allowed:
billingAddress: Type: object billingAddress

Additional Properties Allowed:

The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
childOrganizations: Type: array childOrganizations

Additional Properties Allowed:
contacts: Type: array contacts

Additional Properties Allowed:
contract: Type: object contract

Additional Properties Allowed:

Contract
costCenters: Type: array costCenters

Additional Properties Allowed:
creditCards: Type: object creditCards

Additional Properties Allowed:
customerType: Type: string

Customer Type for Organization
delegateApprovalManagement: Type: boolean

This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
derivedApprovalRequired: Type: boolean

Approval flag is required for the organization, by default it is set to false
derivedBillingAddress: Type: object derivedBillingAddress

Additional Properties Allowed:

Default billing address of the profile
derivedContract: Type: object derivedContract

Additional Properties Allowed:

Contract
derivedCustomerType: Type: string

Derived customer type of the Organization
derivedDunsNumber: Type: string

Derived dunsNumber of the Organization
derivedShippingAddress: Type: object derivedShippingAddress

Additional Properties Allowed:

The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.
derivedTaxReferenceNumber: Type: string

Derived taxReferenceNumber of the Organization
derivedType: Type: string

Derived type of the Organization
dunsNumber: Type: string

DUNS Number for Organization. Should be 9 digit number
dynamicPropertyMapBigString: Type: array dynamicPropertyMapBigString

Additional Properties Allowed:
dynamicPropertyMapDouble: Type: array dynamicPropertyMapDouble

Additional Properties Allowed:
dynamicPropertyMapLong: Type: array dynamicPropertyMapLong

Additional Properties Allowed:
dynamicPropertyMapString: Type: array dynamicPropertyMapString

Additional Properties Allowed:
id: Type: string

Id of the Organization
members: Type: array members

Additional Properties Allowed:
name: Type: string

The name for Organization
preferredVendors: Type: array preferredVendors

Additional Properties Allowed:
relativeRoles: Type: array relativeRoles

Additional Properties Allowed:

List of organization roles.
roles: Type: array roles

Additional Properties Allowed:
secondaryMembers: Type: array secondaryMembers

Additional Properties Allowed:
siteOrganizationProperties: Type: object siteOrganizationProperties

Additional Properties Allowed:

Site Organization Properties
taxReferenceNumber: Type: string

Tax Reference Number of the Organization
type: Type: string

Type for Organization
useExternalApprovalWebhook: Type: boolean

Flag to enable/disable Order Approval check from External Webhook

Nested Schema : priceInfo

Type: object

Properties

amount: Type: number
currencyCode: Type: string
shipping: Type: number
shippingSurchargeValue: Type: number
subTotal: Type: number
tax: Type: number
total: Type: number
totalWithoutTax: Type: number

Nested Schema : pricingMessages

Type: object

Nested Schema : profile

Type: object

Properties

abandonedOrderCount: Type: integer
abandonedOrders: Type: array abandonedOrders

Additional Properties Allowed:
active: Type: boolean

the user status of the profile. Should be true or false
activePromotions: Type: array activePromotions

Additional Properties Allowed:
allApprovers: Type: array allApprovers

Additional Properties Allowed:

list of all the approvers
allCostCenters: Type: array allCostCenters

Additional Properties Allowed:
allCreditCards: Type: object allCreditCards

Additional Properties Allowed:
allowPartialShipment: Type: boolean
allPreferedVenders: Type: array allPreferedVenders

Additional Properties Allowed:
allSecondaryAddresses: Type: array allSecondaryAddresses

Additional Properties Allowed:

List of all shipping addresses associated with profile.
ancestors: Type: array ancestors

Additional Properties Allowed:
approvers: Type: array approvers

Additional Properties Allowed:
businessProcessMarkers: Type: array businessProcessMarkers

Additional Properties Allowed:
catalog: Type: string

This is a read only attribute added for 'Account Based Commerce', this is the ID of the catalog that is associated with the organization to which this user is associated
comments: Type: array comments

Additional Properties Allowed:
contract: Type: object contract

Additional Properties Allowed:
costCenters: Type: array costCenters

Additional Properties Allowed:
creditCards: Type: object creditCards

Additional Properties Allowed:
currentLocation: Type: string
currentOrganization: Type: object currentOrganization

Additional Properties Allowed:
derivedApprovalRequired: Type: boolean

Profile level approval required enable/disable
derivedBillingAddress: Type: object derivedBillingAddress

Additional Properties Allowed:

Default billing address of the profile
derivedCatalog: Type: object derivedCatalog

Additional Properties Allowed:
derivedPriceList: Type: object derivedPriceList

Additional Properties Allowed:
derivedPriceListGroup: Type: object derivedPriceListGroup

Additional Properties Allowed:
derivedSalePriceList: Type: object derivedSalePriceList

Additional Properties Allowed:

The derived sale price list from the user's parent organization
derivedShippingAddress: Type: array derivedShippingAddress

Additional Properties Allowed:

List of shipping addresses associated with profile.
dynamicPropertyMapBigString: Type: array dynamicPropertyMapBigString

Additional Properties Allowed:
dynamicPropertyMapDouble: Type: array dynamicPropertyMapDouble

Additional Properties Allowed:
dynamicPropertyMapLong: Type: array dynamicPropertyMapLong

Additional Properties Allowed:
dynamicPropertyMapString: Type: object dynamicPropertyMapString

Additional Properties Allowed:
email: Type: string

the email address of the profile
emailStatus: Type: string
expressCheckout: Type: boolean
favoriteStores: Type: array favoriteStores

Additional Properties Allowed:
firstName: Type: string

the first name of the profile
gender: Type: string
generatedPassword: Type: boolean
giftlistAddresses: Type: object giftlistAddresses

Additional Properties Allowed:
giftlists: Type: array giftlists

Additional Properties Allowed:
homeAddress: Type: object homeAddress

Additional Properties Allowed:

Home address which is set on the profile
id: Type: string

get the shopper profile with id
lastName: Type: string

the last name of the profile
lastPurchaseAmount: Type: integer
lifetimeAOV: Type: integer
lifetimeSpend: Type: integer
login: Type: string

login of the user
loyaltyPrograms: Type: array loyaltyPrograms

Additional Properties Allowed:

Loyalty Programs Information
mailings: Type: array mailings

Additional Properties Allowed:
markers: Type: array markers

Additional Properties Allowed:
member: Type: boolean
numberOfOrders: Type: integer
otherGiftlists: Type: array otherGiftlists

Additional Properties Allowed:
parentOrganization: Type: object parentOrganization

Additional Properties Allowed:

This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated
preferredVendors: Type: array preferredVendors

Additional Properties Allowed:
priceList: Type: object priceList

Additional Properties Allowed:
priceListGroup: Type: object priceListGroup

Additional Properties Allowed:

The associated price list group for this user
profileType: Type: string

This attribute is added for account based commerce, It's value is 'b2b_user'
purchaseLists: Type: array purchaseLists

Additional Properties Allowed:
receiveEmail: Type: string

this is site specific email marketing flag. can be yes or no
registrationDate: Type: string
roles: Type: array roles

Additional Properties Allowed:

List of user roles.
salePriceList: Type: object salePriceList

Additional Properties Allowed:
scenarioInstances: Type: array scenarioInstances

Additional Properties Allowed:
scenarioValues: Type: object scenarioValues

Additional Properties Allowed:
secondaryAddresses: Type: array secondaryAddresses

Additional Properties Allowed:

List of shipping addresses associated with profile.
secondaryOrganizations: Type: array secondaryOrganizations

Additional Properties Allowed:

List of secondary organizations associated to profile. It will be empty always. Secondary Organizations associated to the profile can be fetched using organization endpoints
securityStatus: Type: integer
sessionOrganization: Type: object sessionOrganization

Additional Properties Allowed:
shippingAddresses: Type: object shippingAddresses

Additional Properties Allowed:

Default shipping address of the profile
shippingSurchargePriceList: Type: object shippingSurchargePriceList

Additional Properties Allowed:

The shipping surcharge price list for this user
siteProperties: Type: object siteProperties

Additional Properties Allowed:
slotInstances: Type: array slotInstances

Additional Properties Allowed:
taxExempt: Type: boolean

Indicates tax exemption status.True or False
usedPromotions: Type: array usedPromotions

Additional Properties Allowed:
version: Type: integer
wishlist: Type: object wishlist

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

Default shipping address of the profile

Properties

address1: Type: string

the address1 of the shipping address
address2: Type: string

the address2 of the shipping address
city: Type: string

the city of the shipping address
country: Type: string

the country of the shipping address
county: Type: string

the county of the shipping address
firstName: Type: string

the first name of the shipping address
lastName: Type: string

the last name of the shipping address
phoneNumber: Type: string

the phone Number of the shipping address
postalCode: Type: string

the postal Code of the shipping address
repositoryId: Type: string

the id of the shipping address
state: Type: string

the state of the shipping address

Nested Schema : shippingGroups

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shoppingCart

Type: object

Properties

items: Type: array items

Additional Properties Allowed:
numberOfItems: Type: integer

Nested Schema : orderCouponsMap

Type: array

The list of all the coupons with the order.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

promotionDesc: Type: string

The promotion description.
promotionId: Type: string

The promotion ID.
promotionLevel: Type: string

The promotion level.
totalAdjustment: Type: string

The total adjustment.

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Properties

giftWithPurchaseDetail: Type: string

String identifying the free gift, usually the repository id of the gift type.
giftWithPurchaseIdentifier: Type: number

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

gift quantity available for selection
giftWithPurchaseType: Type: string

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

The gift with purchase promotion id

Nested Schema : items

Type: object

Nested Schema : allApprovers

Type: array

list of all the approvers

Items

Type: object items

Additional Properties Allowed:

Nested Schema : allContracts

Type: object

Nested Schema : allCostCenters

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : allCreditCards

Type: object

Nested Schema : allMembers

Type: array

Items

Type: object items

Additional Properties Allowed:

All member details

Nested Schema : allPreferredVendors

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : ancestorOrganizations

Type: array

List of ancestors for the Organization

Items

Type: object items

Additional Properties Allowed:

Nested Schema : approvers

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : billingAddress

Type: object

The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.

Properties

address1: Type: string

the address1 of the address
address2: Type: string

the address2 of the address
city: Type: string

the city of the address
companyName: Type: string

the company name of the address
country: Type: string

the country of the address
phoneNumber: Type: string

the phone Number of the address
postalCode: Type: string

the postal Code of the address
repositoryId: Type: string

Repository Id of the address
state: Type: string

the state of the address

Nested Schema : childOrganizations

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : contacts

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : contract

Type: object

Contract

Properties

catalog: Type: object catalog

Additional Properties Allowed:

Catalog associated with contract
creationDate: Type: string

Contract creation date time stamp
description: Type: string

Description for contract
displayName: Type: string

Name of the contract
endDate: Type: string

Contract end date time stamp
externalContractReference: Type: string

External contract reference
priceListGroup: Type: object priceListGroup

Additional Properties Allowed:

Price ListGroup associated with contract
repositoryId: Type: string

Repository Id of the contract
startDate: Type: string

Contract start date time stamp
terms: Type: object terms

Additional Properties Allowed:

Terms and Conditions

Nested Schema : costCenters

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : creditCards

Type: object

Nested Schema : derivedBillingAddress

Type: object

Default billing address of the profile

Properties

address1: Type: string

the address1 of the billing address
address2: Type: string

the address2 of the billing address
city: Type: string

the city of the billing address
country: Type: string

the country of the billing address
county: Type: string

the county of the billing address
firstName: Type: string

the first name of the billing address
lastName: Type: string

the last name of the billing address
phoneNumber: Type: string

the phone Number of the billing address
postalCode: Type: string

the postal Code of the billing address
repositoryId: Type: string

the id of the billing address
state: Type: string

the state of the billing address

Nested Schema : derivedContract

Type: object

Contract

Properties

catalog: Type: object catalog

Additional Properties Allowed:

Catalog associated with contract
creationDate: Type: string

Contract creation date time stamp
description: Type: string

Description for contract
displayName: Type: string

Name of the contract
endDate: Type: string

Contract end date time stamp
externalContractReference: Type: string

External contract reference
priceListGroup: Type: object priceListGroup

Additional Properties Allowed:

Price ListGroup associated with contract
repositoryId: Type: string

Repository Id of the contract
startDate: Type: string

Contract start date time stamp
terms: Type: object terms

Additional Properties Allowed:

Terms and Conditions

Nested Schema : derivedShippingAddress

Type: object

The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.

Properties

address1: Type: string

the address1 of the address
address2: Type: string

the address2 of the address
city: Type: string

the city of the address
companyName: Type: string

the company name shipping address
country: Type: string

the country of the address
phoneNumber: Type: string

the phone Number of the company address
postalCode: Type: string

the postal Code of the address
repositoryId: Type: string

Repository Id of the address
state: Type: string

the state of the address

Nested Schema : dynamicPropertyMapBigString

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicPropertyMapDouble

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicPropertyMapLong

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicPropertyMapString

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : members

Type: array

Items

Type: object items

Additional Properties Allowed:

Member details

Nested Schema : preferredVendors

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : relativeRoles

Type: array

List of organization roles.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : roles

Type: array

Items

Type: string

Nested Schema : secondaryMembers

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : siteOrganizationProperties

Type: object

Site Organization Properties

Properties

site: Type: object site

Additional Properties Allowed:

Site information

Nested Schema : items

Type: object

Properties

firstName: Type: string

the first name of the approver
lastName: Type: string

the last name of the apporver
middleName: Type: string

the middle name of the approver

Nested Schema : items

Type: object

Nested Schema : items

Type: object

All member details

Properties

firstName: Type: string

the first name of the member
lastName: Type: string

the last name of the member
middleName: Type: string

the middle name of the member

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Properties

active: Type: boolean

Active flag of the organization.
id: Type: string

Id of the organization.
name: Type: string

Name of the organization.
repositoryId: Type: string

Repository Id of the organization.

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : catalog

Type: object

Catalog associated with contract

Properties

displayName: Type: string

Name of the catalog
id: Type: string

id of the catalog
status: Type: string

Nested Schema : priceListGroup

Type: object

Price ListGroup associated with contract

Properties

repositoryId: Type: string

Repository Id of the price list group

Nested Schema : terms

Type: object

Terms and Conditions

Properties

repositoryId: Type: string

Repository Id of terms and conditions
terms: Type: string

Terms and Conditions

Nested Schema : items

Type: object

Nested Schema : catalog

Type: object

Catalog associated with contract

Properties

displayName: Type: string

Name of the catalog
id: Type: string

id of the catalog
status: Type: string

Nested Schema : priceListGroup

Type: object

Price ListGroup associated with contract

Properties

repositoryId: Type: string

Repository Id of the price list group

Nested Schema : terms

Type: object

Terms and Conditions

Properties

repositoryId: Type: string

Repository Id of terms and conditions
terms: Type: string

Terms and Conditions

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Member details

Properties

firstName: Type: string

the first name of the member
lastName: Type: string

the last name of the member
middleName: Type: string

the middle name of the member

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Properties

function: Type: string

Function of the role which can be admin, buyer or approver.
repositoryId: Type: string

Repository Id of the role.

Nested Schema : items

Type: object

Nested Schema : site

Type: object

Site information

Properties

approvalRequired: Type: boolean

Approval flag is required for the organization, by default it is set to false
contract: Type: object contract

Additional Properties Allowed:

Contract
delegateApprovalManagement: Type: boolean

This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
orderPriceLimit: Type: number

Its order limit value for the organization, if order limit is more than this value then approval is needed for the order
useExternalApprovalWebhook: Type: boolean

Flag to enable/disable Order Approval check from External Webhook

Nested Schema : contract

Type: object

Contract

Properties

catalog: Type: object catalog

Additional Properties Allowed:

Catalog associated with contract
creationDate: Type: string

Contract creation date time stamp
description: Type: string

Description for contract
displayName: Type: string

Name of the contract
endDate: Type: string

Contract end date time stamp
externalContractReference: Type: string

External contract reference
priceListGroup: Type: object priceListGroup

Additional Properties Allowed:

Price ListGroup associated with contract
repositoryId: Type: string

Repository Id of the contract
startDate: Type: string

Contract start date time stamp
terms: Type: object terms

Additional Properties Allowed:

Terms and Conditions

Nested Schema : catalog

Type: object

Catalog associated with contract

Properties

displayName: Type: string

Name of the catalog
id: Type: string

id of the catalog
status: Type: string

Nested Schema : priceListGroup

Type: object

Price ListGroup associated with contract

Properties

repositoryId: Type: string

Repository Id of the price list group

Nested Schema : terms

Type: object

Terms and Conditions

Properties

repositoryId: Type: string

Repository Id of terms and conditions
terms: Type: string

Terms and Conditions

Nested Schema : abandonedOrders

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : activePromotions

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : allApprovers

Type: array

list of all the approvers

Items

Type: object items

Additional Properties Allowed:

Nested Schema : allCostCenters

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : allCreditCards

Type: object

Nested Schema : allPreferedVenders

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : allSecondaryAddresses

Type: array

List of all shipping addresses associated with profile.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : ancestors

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : approvers

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : businessProcessMarkers

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : comments

Type: array

Items

Type: string

Nested Schema : contract

Type: object

Nested Schema : costCenters

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : creditCards

Type: object

Nested Schema : currentOrganization

Type: object

Items

Type: object items

Additional Properties Allowed:

Nested Schema : derivedBillingAddress

Type: object

Default billing address of the profile

Properties

address1: Type: string

the address1 of the billing address
address2: Type: string

the address2 of the billing address
city: Type: string

the city of the billing address
country: Type: string

the country of the billing address
county: Type: string

the county of the billing address
firstName: Type: string

the first name of the billing address
lastName: Type: string

the last name of the billing address
phoneNumber: Type: string

the phone Number of the billing address
postalCode: Type: string

the postal Code of the billing address
repositoryId: Type: string

the id of the billing address
state: Type: string

the state of the billing address

Nested Schema : derivedCatalog

Type: object

Nested Schema : derivedPriceList

Type: object

Nested Schema : derivedPriceListGroup

Type: object

Nested Schema : derivedSalePriceList

Type: object

The derived sale price list from the user's parent organization

Properties

repositoryId: Type: string

Repository ID

Nested Schema : derivedShippingAddress

Type: array

List of shipping addresses associated with profile.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicPropertyMapBigString

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicPropertyMapDouble

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicPropertyMapLong

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicPropertyMapString

Type: object

Nested Schema : favoriteStores

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : giftlistAddresses

Type: object

Nested Schema : giftlists

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : homeAddress

Type: object

Home address which is set on the profile

Properties

address1: Type: string

the address1 of the billing address
address2: Type: string

the address2 of the billing address
city: Type: string

the city of the billing address
country: Type: string

the country of the billing address
county: Type: string

the county of the billing address
firstName: Type: string

the first name of the billing address
lastName: Type: string

the last name of the billing address
phoneNumber: Type: string

the phone Number of the billing address
postalCode: Type: string

the postal Code of the billing address
repositoryId: Type: string

the id of the billing address
state: Type: string

the state of the billing address

Nested Schema : loyaltyPrograms

Type: array

Loyalty Programs Information

Items

Type: object items

Additional Properties Allowed:

Nested Schema : mailings

Type: array

Items

Type: string

Nested Schema : markers

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : otherGiftlists

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : parentOrganization

Type: object

This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated

Properties

active: Type: boolean

the status of the parent organization. Should be true or false
billingAddress: Type: object billingAddress

Additional Properties Allowed:

Default billing address of the organization
description: Type: string

Description of the Organization
id: Type: string

the id of the parent organization
name: Type: string

the name of the parent organization
repositoryId: Type: string

the id of the parent organization
secondaryAddresses: Type: array secondaryAddresses

Additional Properties Allowed:

List of shipping addresses associated with profile.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

Default shipping address of the organization

Nested Schema : preferredVendors

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceList

Type: object

Nested Schema : priceListGroup

Type: object

The associated price list group for this user

Properties

repositoryId: Type: string

Repository ID

Nested Schema : purchaseLists

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : roles

Type: array

List of user roles.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : salePriceList

Type: object

Nested Schema : scenarioInstances

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : scenarioValues

Type: object

Nested Schema : secondaryAddresses

Type: array

List of shipping addresses associated with profile.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : secondaryOrganizations

Type: array

List of secondary organizations associated to profile. It will be empty always. Secondary Organizations associated to the profile can be fetched using organization endpoints

Items

Type: object items

Additional Properties Allowed:

Nested Schema : sessionOrganization

Type: object

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddresses

Type: object

Default shipping address of the profile

Properties

address1: Type: string

the address1 of the shipping address
address2: Type: string

the address2 of the shipping address
city: Type: string

the city of the shipping address
country: Type: string

the country of the shipping address
county: Type: string

the county of the shipping address
firstName: Type: string

the first name of the shipping address
lastName: Type: string

the last name of the shipping address
phoneNumber: Type: string

the phone Number of the shipping address
postalCode: Type: string

the postal Code of the shipping address
repositoryId: Type: string

the id of the shipping address
state: Type: string

the state of the shipping address

Nested Schema : shippingSurchargePriceList

Type: object

The shipping surcharge price list for this user

Properties

repositoryId: Type: string

Repository ID

Nested Schema : siteProperties

Type: object

Nested Schema : slotInstances

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : usedPromotions

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : wishlist

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Properties

firstName: Type: string

the first name of the approver
lastName: Type: string

the last name of the apporver
middleName: Type: string

the middle name of the approver

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Properties

address1: Type: string

the address1 of the shipping address
address2: Type: string

the address2 of the shipping address
city: Type: string

the city of the shipping address
country: Type: string

the country of the shipping address
county: Type: string

the county of the shipping address
firstName: Type: string

the first name of the shipping address
lastName: Type: string

the last name of the shipping address
phoneNumber: Type: string

the phone Number of the shipping address
postalCode: Type: string

the postal Code of the shipping address
repositoryId: Type: string

the id of the shipping address
state: Type: string

the state of the shipping address

Nested Schema : items

Type: object

Properties

id: Type: string

get the ancestor's organization id

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Properties

id: Type: string

get the current organization id

Nested Schema : items

Type: object

Properties

address1: Type: string

the address1 of the shipping address
address2: Type: string

the address2 of the shipping address
city: Type: string

the city of the shipping address
country: Type: string

the country of the shipping address
county: Type: string

the county of the shipping address
firstName: Type: string

the first name of the shipping address
lastName: Type: string

the last name of the shipping address
phoneNumber: Type: string

the phone Number of the shipping address
postalCode: Type: string

the postal Code of the shipping address
repositoryId: Type: string

the id of the shipping address
state: Type: string

the state of the shipping address

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Properties

membershipId: Type: string

membershipId of the profile.
programId: Type: string

programId of Loyalty Program
programName: Type: string

programName of Loyalty Program
repositoryId: Type: string

repository Id
status: Type: string

status of Enrollment.

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : billingAddress

Type: object

Default billing address of the organization

Properties

address1: Type: string

the address1 of the billing address
address2: Type: string

the address2 of the billing address
city: Type: string

the city of the billing address
country: Type: string

the country of the billing address
county: Type: string

the county of the billing address
firstName: Type: string

the first name of the billing address
lastName: Type: string

the last name of the billing address
phoneNumber: Type: string

the phone Number of the billing address
postalCode: Type: string

the postal Code of the billing address
repositoryId: Type: string

the id of the billing address
state: Type: string

the state of the billing address

Nested Schema : secondaryAddresses

Type: array

List of shipping addresses associated with profile.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

Default shipping address of the organization

Properties

address1: Type: string

the address1 of the shipping address
address2: Type: string

the address2 of the shipping address
city: Type: string

the city of the shipping address
country: Type: string

the country of the shipping address
county: Type: string

the county of the shipping address
firstName: Type: string

the first name of the shipping address
lastName: Type: string

the last name of the shipping address
phoneNumber: Type: string

the phone Number of the shipping address
postalCode: Type: string

the postal Code of the shipping address
repositoryId: Type: string

the id of the shipping address
state: Type: string

the state of the shipping address

Nested Schema : items

Type: object

Properties

address1: Type: string

the address1 of the shipping address
address2: Type: string

the address2 of the shipping address
city: Type: string

the city of the shipping address
country: Type: string

the country of the shipping address
county: Type: string

the county of the shipping address
firstName: Type: string

the first name of the shipping address
lastName: Type: string

the last name of the shipping address
phoneNumber: Type: string

the phone Number of the shipping address
postalCode: Type: string

the postal Code of the shipping address
repositoryId: Type: string

the id of the shipping address
state: Type: string

the state of the shipping address

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Properties

function: Type: string

Function of the role which can be admin or buyer.
relativeTo: Type: object relativeTo

Additional Properties Allowed:

organization ID of the role
repositoryId: Type: string

Repository id of the role.

Nested Schema : relativeTo

Type: object

organization ID of the role

Properties

id: Type: string

Organization ID of the role to be assigned

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Properties

address1: Type: string

the address1 of the shipping address
address2: Type: string

the address2 of the shipping address
city: Type: string

the city of the shipping address
country: Type: string

the country of the shipping address
county: Type: string

the county of the shipping address
firstName: Type: string

the first name of the shipping address
lastName: Type: string

the last name of the shipping address
phoneNumber: Type: string

the phone Number of the shipping address
postalCode: Type: string

the postal Code of the shipping address
repositoryId: Type: string

the id of the shipping address
state: Type: string

the state of the shipping address

Nested Schema : items

Type: object

Properties

active: Type: boolean

the status of the organization. Should be true or false
billingAddress: Type: object billingAddress

Additional Properties Allowed:

Default billing address of the profile
description: Type: string

Description of the organization
name: Type: string

the name of the organization
repositoryId: Type: string

Repository ID
secondaryAddresses: Type: array secondaryAddresses

Additional Properties Allowed:

List of shipping addresses associated with profile.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

Default shipping address of the profile

Nested Schema : billingAddress

Type: object

Default billing address of the profile

Properties

address1: Type: string

the address1 of the billing address
address2: Type: string

the address2 of the billing address
city: Type: string

the city of the billing address
country: Type: string

the country of the billing address
county: Type: string

the county of the billing address
firstName: Type: string

the first name of the billing address
lastName: Type: string

the last name of the billing address
phoneNumber: Type: string

the phone Number of the billing address
postalCode: Type: string

the postal Code of the billing address
repositoryId: Type: string

the id of the billing address
state: Type: string

the state of the billing address

Nested Schema : secondaryAddresses

Type: array

List of shipping addresses associated with profile.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

Default shipping address of the profile

Properties

address1: Type: string

the address1 of the shipping address
address2: Type: string

the address2 of the shipping address
city: Type: string

the city of the shipping address
country: Type: string

the country of the shipping address
county: Type: string

the county of the shipping address
firstName: Type: string

the first name of the shipping address
lastName: Type: string

the last name of the shipping address
phoneNumber: Type: string

the phone Number of the shipping address
postalCode: Type: string

the postal Code of the shipping address
repositoryId: Type: string

the id of the shipping address
state: Type: string

the state of the shipping address

Nested Schema : items

Type: object

Properties

address1: Type: string

the address1 of the shipping address
address2: Type: string

the address2 of the shipping address
city: Type: string

the city of the shipping address
country: Type: string

the country of the shipping address
county: Type: string

the county of the shipping address
firstName: Type: string

the first name of the shipping address
lastName: Type: string

the last name of the shipping address
phoneNumber: Type: string

the phone Number of the shipping address
postalCode: Type: string

the postal Code of the shipping address
repositoryId: Type: string

the id of the shipping address
state: Type: string

the state of the shipping address

Nested Schema : items

Type: object

Properties

id: Type: string

get the organization id

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Properties

discountInfo: Type: array discountInfo

Additional Properties Allowed:

The discount information.
items: Type: array items

Additional Properties Allowed:
priceInfo: Type: object priceInfo

Additional Properties Allowed:

The price information.
recurringChargePriceInfo: Type: string
shippingMethod: Type: object shippingMethod

Additional Properties Allowed:

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

Additional Properties Allowed:

The shipping address details.

Nested Schema : discountInfo

Type: array

The discount information.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

The price information.

Properties

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.
totalWithoutTax: Type: number

The total amount without tax.

Nested Schema : shippingMethod

Type: object

The shipping method details for the order.

Properties

cost: Type: number

The total cost of shipping.
secondaryCurrencyTaxAmount: Type: number

tax amount in secondaryCurrency
shippingMethodDescription: Type: string
shippingTax: Type: number
taxCode: Type: string
value: Type: string

The shipping method applied to the order.

Nested Schema : taxPriceInfo

Type: object

The shipping address details.

Properties

amount: Type: number

The total order amount.
cityTax: Type: number

City Tax
countryTax: Type: number

Country Tax.
countyTax: Type: number

County Tax.
districtTax: Type: number

District Tax.
isTaxIncluded: Type: boolean

If Tax is included?
miscTax: Type: number

Misc Tax.
secondaryCurrencyTaxAmount: Type: number

taxAmount in secondaryCurrency
stateTax: Type: number

State Tax.
valueAddedTax: Type: number

Value Added Tax.

Nested Schema : items

Type: object

Properties

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the configurator.
amount: Type: number

The monetary amount.
availabilityDate: Type: string (date-time)

The availability date for preOrdered/backOrdered quantity.
backOrderQuantity: Type: integer

The back ordered quantity included.
catRefId: Type: string

The catalog ref id.
commerceId: Type: string
commerceItemId: Type: string

The referenced commerce item's internal ID.
detailedItemPriceInfo: Type: array detailedItemPriceInfo

Additional Properties Allowed:
discountAmount: Type: number

The discount amount.
discountInfo: Type: object discountInfo

Additional Properties Allowed:

The discount information.
dynamicProperties: Type: array dynamicProperties

Additional Properties Allowed:

the value of the dynamic Properties
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a third party system.
listPrice: Type: number

The list price.
onSale: Type: number

Is item on sale.
preOrderQuantity: Type: integer

The pre ordered quantity included.
price: Type: number

The price.
productId: Type: string

The ID of the product.
quantity: Type: number

The quantity.
rawTotalPrice: Type: number

The raw total price.
returnedQuantity: Type: number

The returned quantity.
salePrice: Type: number

The sale price.
shippingSurchargeValue: Type: number

Extra handling cost for shipping the product.
stateDetailsAsUser: Type: string

state details.
status: Type: string

status.
unitPrice: Type: number

The unit price.

Nested Schema : detailedItemPriceInfo

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : discountInfo

Type: object

The discount information.

Properties

orderDiscount: Type: integer

The discount.
shippingDiscount: Type: integer

The shipping discount.

Nested Schema : dynamicProperties

Type: array

the value of the dynamic Properties

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

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

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

amount: Type: number
currencyCode: Type: string
detailedUnitPrice: Type: number
discounted: Type: boolean
orderDiscountShare: Type: integer
quantity: Type: integer
tax: Type: number

Nested Schema : items

Type: object

Nested Schema : items

Properties

actionCode: Type: string

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

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

Additional Properties Allowed:

The map values associated with an externalData item.

Nested Schema : values

Type: object

The map values associated with an externalData item.

Properties

key: Type: string

Map key defined by external system.
value: Type: string

Map value defined by external system.

Nested Schema : items

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

catRefId: Type: string
configuratorId: Type: string
description: Type: string
detailedItemPriceInfo: Type: array detailedItemPriceInfo

Additional Properties Allowed:
discountAmount: Type: number
discountInfo: Type: array discountInfo

Additional Properties Allowed:

The discount information.
displayName: Type: string
dynamicProperties: Type: array dynamicProperties

Additional Properties Allowed:

List of dynamic properties at line item level.
externalPrice: Type: number
externalPriceQuantity: Type: integer
id: Type: string
isItemValid: Type: boolean
listPrice: Type: number
onSale: Type: boolean
price: Type: number
primaryThumbImageURL: Type: string
productId: Type: string
quantity: Type: integer
rawTotalPrice: Type: number
salePrice: Type: number
shippingSurchargeValue: Type: integer
unitPrice: Type: number
variant: Type: array variant

Additional Properties Allowed:

List of variants for the product.

Nested Schema : detailedItemPriceInfo

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : discountInfo

Type: array

The discount information.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicProperties

Type: array

List of dynamic properties at line item level.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : variant

Type: array

List of variants for the product.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

amount: Type: number
currencyCode: Type: string
detailedUnitPrice: Type: number
discounted: Type: boolean
orderDiscountShare: Type: integer
quantity: Type: integer
secondaryCurrencyTaxAmount: Type: number

tax amount in secondaryCurrency
tax: Type: number

Nested Schema : items

Type: object

Properties

coupon: Type: string

The coupon ID.
promotionDesc: Type: string

The promotion description.
promotionId: Type: string

The promotion ID.

Nested Schema : items

Type: object

Properties

id: Type: string

The dynamic property id.
label: Type: string

The dynamic property label.
value: Type: string

The dynamic property value.

Nested Schema : items

Type: object

Properties

optionName: Type: string

The variant option name.
optionValue: Type: string

The variant option value.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : checkOrderApprovalWebhook_response

Properties

approvalAction: Type: boolean

This flag will determine if Order has to be moved to pending approval state.
approvalActionReason: Type: string

The reason for which the Order has beeen moved to pending approval state.
error: Type: object error

Additional Properties Allowed:

Nested Schema : error

Type: object

Properties

code: Type: string
message: Type: string