getOrganization
get
/ccagent/v1/organizations/{id}
Get Organization. This operation is used to get the Organization information of a customer from Oracle Commerce Cloud. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the requested Organization.
Header Parameters
-
X-CCAgentContext: string
The Agent Context is a JSON object with shopperProfileId as a property.
-
X-CCAsset-Language(optional): string
The asset language of the request
-
X-CCOrganization(optional): string
The organization Id associated with the shopper profile
-
X-CCSite(optional): string
The site Id to retrieve the site specific organization properties
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getOrganization_response
Type:
Show Source
object
-
active(optional):
boolean
Active status of an Organization. Should be true or false. By default the value is set to true
-
allowPunchoutShopping(optional):
boolean
Allow Punchout Shopping flag
-
ancestorOrganizations(optional):
array ancestorOrganizations
List of ancestors for the Organization
-
approvalRequired(optional):
boolean
Approval flag is required for the organization, by default it is set to false
-
authorizationCode(optional):
string
Authorization code of the organization.
-
billingAddress(optional):
object billingAddress
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.
-
contract(optional):
object contract
Contract
-
customerType(optional):
string
Customer Type for Organization
-
delegateApprovalManagement(optional):
boolean
This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
-
derivedAllowPunchoutShopping(optional):
boolean
Derived Allow Punchout Shopping flag
-
derivedAuthorizationCode(optional):
string
Derived Authorization code of the organization.
-
derivedBillingAddress(optional):
object derivedBillingAddress
The derived default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default billing address.
-
derivedBillingAddressType(optional):
string
Address type for derived billing address
-
derivedContract(optional):
object derivedContract
Derived Contract
-
derivedCustomerType(optional):
string
Derived customer type of the Organization
-
derivedDescription(optional):
string
Derived description of the Organization
-
derivedDunsNumber(optional):
string
Derived dunsNumber of the Organization
-
derivedOrganizationLogo(optional):
string
Derived organizationLogo of the Organization
-
derivedPaymentMethods(optional):
array derivedPaymentMethods
Derived payment methods associated for organization.
-
derivedShippingAddress(optional):
object derivedShippingAddress
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.
-
derivedShippingAddressType(optional):
string
Address type for derived shipping address
-
derivedShippingMethods(optional):
array derivedShippingMethods
Derived shipping methods associated for organization.
-
derivedTaxExemptionCode(optional):
string
Derived taxExemptionCode of the Organization
-
derivedTaxReferenceNumber(optional):
string
Derived taxReferenceNumber of the Organization
-
derivedType(optional):
string
Derived type of the Organization
-
derivedUniqueId(optional):
string
Unique Id of the Organization
-
derivedUseAllPaymentMethodsFromSite(optional):
boolean
Derived flag to use all the payment methods available for site.
-
derivedUseAllShippingMethodsFromSite(optional):
string
Derived flag to use all the shipping methods available for site.
-
derivedVatReferenceNumber(optional):
string
Derived vatReferenceNumber of the Organization
-
description(optional):
string
Description for Organization
-
dunsNumber(optional):
string
DUNS Number for Organization. Should be 9 digit number
-
dynamicProperty(optional):
object dynamicProperty
The value of the dynamic Property
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
Id of the Organization
-
members(optional):
array members
List of contact ids associated with an Organization
-
name(optional):
string
The name for Organization
-
orderPriceLimit(optional):
number
Its order limit value for the organization, if order limit is more than this value then approval is needed for the order
-
organizationLogo(optional):
string
File path of organization logo.
-
organizationLogoURL(optional):
string
Full URL of organization logo.
-
parentOrganization(optional):
object parentOrganization
Parent organization Info.
-
paymentMethods(optional):
array paymentMethods
Payment methods associated for organization.
-
relativeRoles(optional):
array relativeRoles
List of organization roles.
-
repositoryId(optional):
string
Repository Id of the Organization
-
secondaryAddresses(optional):
array secondaryAddresses
List of all the addresses associated with an Organization, if property like 'isDefaultShippingAddress' or 'isDefaultBillingAddress' is set to 'true', then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'.
-
shippingAddress(optional):
object shippingAddress
The default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute.
-
shippingMethods(optional):
array shippingMethods
Shipping methods associated for organization.
-
source(optional):
string
source of organization.
-
taxExemptionCode(optional):
string
Tax exemption code for Organization
-
taxReferenceNumber(optional):
string
Tax Reference number for Organization
-
type(optional):
string
Type for Organization
-
uniqueId(optional):
string
Unique Id of the Organization
-
useAllPaymentMethodsFromSite(optional):
boolean
Flag to use all the payment methods available for site.
-
useAllShippingMethodsFromSite(optional):
string
Flag to use all the shipping methods available for site.
-
useExternalApprovalWebhook(optional):
boolean
Flag to enable/disable Order Approval check from External Webhook
-
vatReferenceNumber(optional):
string
Vat reference number for the organization
Nested Schema : ancestorOrganizations
Type:
array
List of ancestors for the Organization
Show Source
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.
Show Source
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
address3(optional):
string
the address3 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name of the address
-
country(optional):
string
the country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
the phone Number of the address
-
postalCode(optional):
string
the postal Code of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
the state of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : contract
Type:
object
Contract
Show Source
-
catalog(optional):
object catalog
Catalog associated with contract
-
creationDate(optional):
string
Contract creation date time stamp
-
description(optional):
string
Description for contract
-
displayName(optional):
string
Display name for contract
-
endDate(optional):
string
Contract end date time stamp
-
externalContractReference(optional):
string
External contract reference
-
priceListGroup(optional):
object priceListGroup
Price ListGroup associated with contract
-
repositoryId(optional):
string
Repository Id of the contract
-
startDate(optional):
string
Contract start date time stamp
-
terms(optional):
object terms
Terms and Conditions
Nested Schema : derivedBillingAddress
Type:
object
The derived default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default billing address.
Show Source
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
address3(optional):
string
the address3 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name of the address
-
country(optional):
string
the country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
the phone Number of the address
-
postalCode(optional):
string
the postal Code of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
the state of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : derivedContract
Type:
object
Derived Contract
Show Source
-
catalog(optional):
object catalog
Catalog associated with contract
-
creationDate(optional):
string
Contract creation date time stamp
-
description(optional):
string
Description for contract
-
displayName(optional):
string
Display name for contract
-
endDate(optional):
string
Contract end date time stamp
-
externalContractReference(optional):
string
External contract reference
-
priceListGroup(optional):
object priceListGroup
Price ListGroup associated with contract
-
repositoryId(optional):
string
Repository Id of the contract
-
startDate(optional):
string
Contract start date time stamp
-
terms(optional):
object terms
Terms and Conditions
Nested Schema : derivedPaymentMethods
Type:
array
Derived payment methods associated for organization.
Show Source
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.
Show Source
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
address3(optional):
string
the address3 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name shipping address
-
country(optional):
string
the country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
the phone Number of the company address
-
postalCode(optional):
string
the postal Code of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
the state of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : derivedShippingMethods
Type:
array
Derived shipping methods associated for organization.
Show Source
Nested Schema : dynamicProperty
Type:
object
The value of the dynamic Property
Nested Schema : parentOrganization
Type:
object
Parent organization Info.
Show Source
-
active(optional):
boolean
Active flag of the parent organization.
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
Id of the parent organization.
-
name(optional):
string
Name of the parent organization.
-
repositoryId(optional):
string
Repository Id of the parent organization.
Nested Schema : secondaryAddresses
Type:
array
List of all the addresses associated with an Organization, if property like 'isDefaultShippingAddress' or 'isDefaultBillingAddress' is set to 'true', then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'.
Show Source
Nested Schema : shippingAddress
Type:
object
The default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute.
Show Source
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
address3(optional):
string
the address3 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name shipping address
-
country(optional):
string
the country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
the phone Number of the company address
-
postalCode(optional):
string
the postal Code of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
the state of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : shippingMethods
Type:
array
Shipping methods associated for organization.
Show Source
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
Active flag of the organization.
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
Id of the organization.
-
name(optional):
string
Name of the organization.
-
repositoryId(optional):
string
Repository Id of the organization.
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : catalog
Type:
object
Catalog associated with contract
Show Source
-
displayName(optional):
string
Name of the catalog
-
repositoryId(optional):
string
Repository Id of the catalog
Nested Schema : priceListGroup
Type:
object
Price ListGroup associated with contract
Show Source
-
displayName(optional):
string
Name of the price list group
-
repositoryId(optional):
string
Repository Id of the price list group
Nested Schema : terms
Type:
object
Terms and Conditions
Show Source
-
repositoryId(optional):
string
Repository Id of terms and conditions
-
terms(optional):
string
Terms and Conditions
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : catalog
Type:
object
Catalog associated with contract
Show Source
-
displayName(optional):
string
Name of the catalog
-
repositoryId(optional):
string
Repository Id of the catalog
Nested Schema : priceListGroup
Type:
object
Price ListGroup associated with contract
Show Source
-
displayName(optional):
string
Name of the price list group
-
repositoryId(optional):
string
Repository Id of the price list group
Nested Schema : terms
Type:
object
Terms and Conditions
Show Source
-
repositoryId(optional):
string
Repository Id of terms and conditions
-
terms(optional):
string
Terms and Conditions
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
Repository Id of the shipping method.
Nested Schema : items
Type:
Show Source
object
-
function(optional):
string
Function of the role which can be admin, buyer or approver.
-
repositoryId(optional):
string
Repository Id of the role.
Nested Schema : items
Type:
Show Source
object
-
address(optional):
object address
Address created for the Organization.
-
addressType(optional):
string
Address type represents nick name of account if present else repository ID of address item.
Nested Schema : address
Type:
object
Address created for the Organization.
Show Source
-
address1(optional):
string
The address1 of the secondary address
-
address2(optional):
string
The address2 of the secondary address
-
address3(optional):
string
The address3 of the secondary address
-
city(optional):
string
The city of the secondary address
-
companyName(optional):
string
Company name of the secondary address
-
country(optional):
string
The country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
Phone Number of the address
-
postalCode(optional):
string
Postal Code of the address
-
repositoryId(optional):
string
repository Id of the address
-
state(optional):
string
The State of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
Repository Id of the shipping method.
Example Response (application/json)
{
"taxReferenceNumber":"901-70-7000",
"authorizationCode":"sadsaxxaASX34567==",
"organizationLogo":null,
"description":null,
"delegateApprovalManagement":false,
"secondaryAddresses":[
{
"address":{
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"631-748-6479",
"address2":"Suffolk",
"city":"Bohemia",
"address1":"70 Euclid Ave #722",
"companyName":"National Discount Auto Parts",
"postalCode":"11716",
"repositoryId":"ci-110024",
"state":"NY"
},
"addressType":"Address2"
},
{
"address":{
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"907-385-4412",
"address2":null,
"city":"Anchorage",
"address1":"639 Main St",
"companyName":"National Discount Auto Parts",
"postalCode":"99501",
"repositoryId":"ci-110023",
"state":"AZ"
},
"addressType":"Address1"
}
],
"externalOrganizationId":"EXT_ORG_1",
"type":"company",
"derivedBillingAddress":{
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"631-748-6479",
"address2":"Suffolk",
"city":"Bohemia",
"address1":"70 Euclid Ave #722",
"companyName":"National Discount Auto Parts",
"postalCode":"11716",
"repositoryId":"ci-110024",
"state":"NY"
},
"derivedUniqueId":null,
"customerType":"Standard",
"organizationLogoURL":null,
"derivedContract":{
"endDate":null,
"terms":{
"terms":"Terms and Conditions for contract with National Discount Auto Parts organization
",
"repositoryId":"ct-100001"
},
"catalog":{
"displayName":"QA Movie and Games Catalog",
"repositoryId":"cloudLakeCatalog"
},
"displayName":"Contract_NDAP",
"repositoryId":"ct-100001",
"description":"Contract with National Discount Auto Parts",
"priceListGroup":{
"displayName":"Default Price Group",
"repositoryId":"defaultPriceGroup"
},
"creationDate":"2016-05-04T02:41:00.000Z",
"externalContractReference":"Test",
"startDate":null
},
"members":[
{
"repositoryId":"bb-110032"
},
{
"repositoryId":"bb-110000"
},
{
"repositoryId":"bb-110033"
},
{
"repositoryId":"bb-110023"
},
{
"repositoryId":"bb-110034"
},
{
"repositoryId":"bb-110006"
}
],
"derivedBillingAddressType":"Address2",
"links":[
{
"rel":"self",
"href":"http://agent.example.com:9080/ccagentui/v1/organizations/or-100001"
}
],
"id":"or-100001",
"relativeRoles":[
{
"relativeTo":null,
"function":"admin",
"repositoryId":"100001"
},
{
"relativeTo":null,
"function":"buyer",
"repositoryId":"100002"
},
{
"relativeTo":null,
"function":"approver",
"repositoryId":"200001"
}
],
"dunsNumber":"213456178",
"derivedShippingAddressType":"Address2",
"derivedDunsNumber":"213456178",
"derivedTaxReferenceNumber":"901-70-7000",
"derivedAuthorizationCode":"sadsaxxaASX34567==",
"contract":{
"endDate":null,
"terms":{
"terms":"Terms and Conditions for contract with National Discount Auto Parts organization
",
"repositoryId":"ct-100001"
},
"catalog":{
"displayName":"QA Movie and Games Catalog",
"repositoryId":"cloudLakeCatalog"
},
"displayName":"Contract_NDAP",
"repositoryId":"ct-100001",
"description":"Contract with National Discount Auto Parts",
"priceListGroup":{
"displayName":"Default Price Group",
"repositoryId":"defaultPriceGroup"
},
"creationDate":"2016-05-04T02:41:00.000Z",
"externalContractReference":"Test",
"startDate":null
},
"derivedCustomerType":"Standard",
"active":true,
"derivedOrganizationLogo":null,
"vatReferenceNumber":null,
"orderPriceLimit":50,
"dynamicProperty":"dynamicProperty value",
"derivedShippingAddress":{
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"631-748-6479",
"address2":"Suffolk",
"city":"Bohemia",
"address1":"70 Euclid Ave #722",
"companyName":"National Discount Auto Parts",
"postalCode":"11716",
"repositoryId":"ci-110024",
"state":"NY"
},
"derivedType":"company",
"allowPunchoutShopping":true,
"approvalRequired":true,
"derivedVatReferenceNumber":null,
"derivedAllowPunchoutShopping":true,
"name":"National Discount Auto Parts",
"punchoutUserId":"100012",
"shippingAddress":{
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"631-748-6479",
"address2":"Suffolk",
"city":"Bohemia",
"address1":"70 Euclid Ave #722",
"companyName":"National Discount Auto Parts",
"postalCode":"11716",
"repositoryId":"ci-110024",
"state":"NY"
},
"billingAddress":{
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"631-748-6479",
"address2":"Suffolk",
"city":"Bohemia",
"address1":"70 Euclid Ave #722",
"companyName":"National Discount Auto Parts",
"postalCode":"11716",
"repositoryId":"ci-110024",
"state":"NY"
},
"derivedDescription":null,
"uniqueId":null
}
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|
|------------------|------------------|
|22010|If the profile id passed is not associated to the account of the profileId passed in the AgentContext header.|
|100000|If input passed is invalid|
|100001|If there was no organization found with the given id|
|100000|If input passed is invalid|
|100001|If there was no organization found with the given id|
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