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(required): string
The ID of the requested Organization.
Header Parameters
-
X-CCAgentContext(required): string
The Agent Context is a JSON object with shopperProfileId as a property.
-
X-CCAsset-Language: string
The asset language of the request
-
X-CCOrganization: string
The organization Id associated with the shopper profile
-
X-CCSite: 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:
boolean
Active status of an Organization. Should be true or false. By default the value is set to true
-
allowPunchoutShopping:
boolean
Allow Punchout Shopping flag
-
approvalRequired:
boolean
Approval flag is required for the organization, by default it is set to false, if set to true then order price limit becomes mandatory field
-
authorizationCode:
string
Authorization code of the organization. Possible values we can update using this endpoint is null or NO_AUTH_CODE
-
billingAddress:
object billingAddress
The default billing address for the Organization. This a read only attribute. This will be returned if the property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
-
contract:
object contract
Contract
-
customerType:
string
Customer Type for Organization
-
delegateApprovalManagement:
boolean
This flag indicates if the delegated admin has the provision of approval management.
-
derivedAllowPunchoutShopping:
boolean
Derived Allow Punchout Shopping flag
-
derivedAuthorizationCode:
string
Derived Authorization code of the organization.
-
derivedBillingAddress:
object derivedBillingAddress
The default billing address for the Organization. This a read only attribute. This will be returned if the property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
-
derivedBillingAddressType:
string
Then nickname of the billing Address type derived.
-
derivedContract:
object derivedContract
Contract
-
derivedCustomerType:
string
Customer Type for Organization
-
derivedDescription:
string
Description for Organization
-
derivedDunsNumber:
string
DUNS Number for Organization. Should be 9 digit number
-
derivedOrganizationLogo:
string
File path of organization logo.
-
derivedShippingAddressType:
string
Then nickname of the shipping Address type derived.
-
derivedTaxReferenceNumber:
string
Tax Reference number for Organization
-
derivedUniqueId:
string
Unique Id of the Organization
-
derivedVatReferenceNumber:
string
Vat reference number for the organization
-
description:
string
Description for Organization
-
dunsNumber:
string
DUNS Number for Organization. Should be 9 digit number
-
externalOrganizationId:
string
External organization id
-
id:
string
Id of the Organization
-
members:
array members
List of contact ids associated with an Organization
-
name:
string
The name for Organization
-
orderPriceLimit:
string
Its order limit value for the organization, if order limit is more than this value then approval is needed for the order
-
organizationLogo:
string
File path of organization logo.
-
organizationLogoURL:
string
Full URL of organization logo.
-
punchoutUserId:
string
Punchout user Id of organization, read only property.
-
relativeRoles:
array relativeRoles
List of roles associated with an Organization
-
repositoryId:
string
Repository Id of the Organization
-
secondaryAddresses:
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:
object shippingAddress
The default shipping address for the Organization. This a read only attribute. This will be returned if the property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute.
-
taxReferenceNumber:
string
Tax Reference number for Organization
-
type:
string
Type for Organization
-
uniqueId:
string
Unique Id of the Organization
-
vatReferenceNumber:
string
Vat reference number for the organization
Nested Schema : billingAddress
Type:
object
The default billing address for the Organization. This a read only attribute. This will be returned if the property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
Show Source
-
address1:
string
the address1 of the address
-
address2:
string
the address2 of the address
-
city:
string
the city of the address
-
companyName:
string
the company name of the address
-
country:
string
the country of the address
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
externalAddressId:
string
External address id
-
phoneNumber:
string
the phone Number of the address
-
postalCode:
string
the postal Code of the address
-
repositoryId:
string
Repository Id of the address
-
state:
string
the state of the address
Nested Schema : contract
Type:
object
Contract
Show Source
-
catalog:
object catalog
Catalog associated with contract
-
creationDate:
string
Contract creation date time stamp
-
description:
string
Description for contract
-
displayName:
string
Display name for contract
-
endDate:
string
Contract end date time stamp
-
externalContractReference:
string
External contract reference
-
priceListGroup:
object priceListGroup
Price ListGroup associated with contract
-
repositoryId:
string
Repository Id of the contract
-
startDate:
string
Contract start date time stamp
-
terms:
object terms
Terms and Conditions
Nested Schema : derivedBillingAddress
Type:
object
The default billing address for the Organization. This a read only attribute. This will be returned if the property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
Show Source
-
address1:
string
the address1 of the address
-
address2:
string
the address2 of the address
-
city:
string
the city of the address
-
companyName:
string
the company name of the address
-
country:
string
the country of the address
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
externalAddressId:
string
External address id
-
phoneNumber:
string
the phone Number of the address
-
postalCode:
string
the postal Code of the address
-
repositoryId:
string
Repository Id of the address
-
state:
string
the state of the address
Nested Schema : derivedContract
Type:
object
Contract
Show Source
-
catalog:
object catalog
Catalog associated with contract
-
creationDate:
string
Contract creation date time stamp
-
description:
string
Description for contract
-
displayName:
string
Display name for contract
-
endDate:
string
Contract end date time stamp
-
externalContractReference:
string
External contract reference
-
priceListGroup:
object priceListGroup
Price ListGroup associated with contract
-
repositoryId:
string
Repository Id of the contract
-
startDate:
string
Contract start date time stamp
-
terms:
object terms
Terms and Conditions
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 be returned if the property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute.
Show Source
-
address1:
string
the address1 of the address
-
address2:
string
the address2 of the address
-
city:
string
the city of the address
-
companyName:
string
the company name shipping address
-
country:
string
the country of the address
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
externalAddressId:
string
External address id
-
phoneNumber:
string
the phone Number of the company address
-
postalCode:
string
the postal Code of the address
-
repositoryId:
string
Repository Id of the address
-
state:
string
the state of the address
Nested Schema : dynamicProperty
Type:
object
The value of the dynamic Property
Nested Schema : catalog
Type:
object
Catalog associated with contract
Show Source
-
repositoryId:
string
Repository Id of the catalog
Nested Schema : priceListGroup
Type:
object
Price ListGroup associated with contract
Show Source
-
repositoryId:
string
Repository Id of the price list group
Nested Schema : terms
Type:
object
Terms and Conditions
Show Source
-
repositoryId:
string
Repository Id of terms and conditions
-
terms:
string
Terms and Conditions
Nested Schema : dynamicProperty
Type:
object
The value of the dynamic Property
Nested Schema : catalog
Type:
object
Catalog associated with contract
Show Source
-
repositoryId:
string
Repository Id of the catalog
Nested Schema : priceListGroup
Type:
object
Price ListGroup associated with contract
Show Source
-
repositoryId:
string
Repository Id of the price list group
Nested Schema : terms
Type:
object
Terms and Conditions
Show Source
-
repositoryId:
string
Repository Id of terms and conditions
-
terms:
string
Terms and Conditions
Nested Schema : items
Type:
Show Source
object
-
function:
string
Function of the role which can be admin or buyer.
-
relativeTo:
string
The organization Id with which this profile role is associated with.
Nested Schema : items
Type:
Show Source
object
-
address:
object address
Address created for the Organization.
-
addressType:
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:
string
The address1 of the secondary address
-
address2:
string
The address2 of the secondary address
-
city:
string
The city of the secondary address
-
companyName:
string
Company name of the secondary address
-
country:
string
The country of the address
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
externalAddressId:
string
External address id
-
phoneNumber:
string
Phone Number of the address
-
postalCode:
string
Postal Code of the address
-
repositoryId:
string
repository Id of the address
-
state:
string
The State of the address
Nested Schema : dynamicProperty
Type:
object
The value of the dynamic Property
Nested Schema : dynamicProperty
Type:
object
The value of the dynamic Property
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
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
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code