Oracle Commerce Cloud October 2017 - getOrganization

Previous Next JavaScript must be enabled to correctly display this content

getOrganization

get

/ccadmin/v1/organizations/{id}

Get Organization. This operation is used to get the Organization information of a customer from Oracle Commerce Cloud.Few properties are site specific so they will be fetched from default site mapping, however if 'x-ccsite' header is sent then site specific properties will be fetched from the corresponding site mappning.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The ID of the requested Organization.

Query Parameters

expand: Type: string

Expand query param : currently used to expand priceListGroup to display its currency information. It can also be used to specify loading few properties only. Like contract only properties and approvals only properties. Possible values for this query parameter is 'priceListGroup','general','contract','approvals','addresses' and 'shippingPayments'

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getOrganization_response

active: Type: boolean

Active status of an Organization. Should be true or false. By default the value is set to true
approvalRequired: Type: 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
billingAddress: Type: 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: Type: object contract

Contract
customerType: Type: string

Customer Type for Organization
delegateApprovalManagement: Type: boolean

This flag indicates if the delegated admin has the provision of approval management.
derivedBillingAddress: Type: 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: Type: string

Then nickname of the billing Address type derived.
derivedContract: Type: object derivedContract

Contract
derivedCustomerType: Type: string

Customer Type for Organization
derivedDescription: Type: string

Description for Organization
derivedDunsNumber: Type: string

DUNS Number for Organization. Should be 9 digit number
derivedOrganizationLogo: Type: string

File path of organization logo.
derivedShippingAddressType: Type: string

Then nickname of the shipping Address type derived.
derivedTaxReferenceNumber: Type: string

Tax Reference number for Organization
derivedUniqueId: Type: string

Unique Id of the Organization
derivedVatReferenceNumber: Type: string

Vat reference number for the organization
description: Type: string

Description for Organization
dunsNumber: Type: string

DUNS Number for Organization. Should be 9 digit number
id: Type: string

Id of the Organization
members: Type: array members

List of contact ids associated with an Organization
name: Type: string

The name for Organization
orderPriceLimit: Type: string

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

File path of organization logo.
organizationLogoURL: Type: string

Full URL of organization logo.
relativeRoles: Type: array relativeRoles

List of roles associated with an Organization
repositoryId: Type: string

Repository Id of the Organization
secondaryAddresses: Type: 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: Type: 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: Type: string

Tax Reference number for Organization
type: Type: string

Type for Organization
uniqueId: Type: string

Unique Id of the Organization
vatReferenceNumber: Type: 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.

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 : contract

Type: object

Contract

catalog: Type: object catalog

Catalog associated with contract
creationDate: Type: string

Contract creation date time stamp
description: Type: string

Description for contract
displayName: Type: string

Display name for contract
endDate: Type: string

Contract end date time stamp
externalContractReference: Type: string

External contract reference
priceListGroup: Type: object priceListGroup

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

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.

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 : derivedContract

Type: object

Contract

catalog: Type: object catalog

Catalog associated with contract
creationDate: Type: string

Contract creation date time stamp
description: Type: string

Description for contract
displayName: Type: string

Display name for contract
endDate: Type: string

Contract end date time stamp
externalContractReference: Type: string

External contract reference
priceListGroup: Type: object priceListGroup

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

Terms and Conditions

Nested Schema : members

Type: array

List of contact ids associated with an Organization

Type: object items

Nested Schema : relativeRoles

Type: array

List of roles associated with an Organization

Type: object items

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

Type: object items

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.

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 : catalog

Type: object

Catalog associated with contract

repositoryId: Type: string

Repository Id of the catalog

Nested Schema : priceListGroup

Type: object

Price ListGroup associated with contract

repositoryId: Type: string

Repository Id of the price list group

Nested Schema : terms

Type: object

Terms and Conditions

repositoryId: Type: string

Repository Id of terms and conditions
terms: Type: string

Terms and Conditions

Nested Schema : catalog

Type: object

Catalog associated with contract

repositoryId: Type: string

Repository Id of the catalog

Nested Schema : priceListGroup

Type: object

Price ListGroup associated with contract

repositoryId: Type: string

Repository Id of the price list group

Nested Schema : terms

Type: object

Terms and Conditions

repositoryId: Type: string

Repository Id of terms and conditions
terms: Type: string

Terms and Conditions

Nested Schema : items

Type: object

repositoryId: Type: string

Contact Id of contact

Nested Schema : items

Type: object

function: Type: string

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

The organization Id with which this profile role is associated with.

Nested Schema : items

Type: object

address: Type: object address

Address created for the Organization.
addressType: Type: 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.

address1: Type: string

The address1 of the secondary address
address2: Type: string

The address2 of the secondary address
city: Type: string

The city of the secondary address
companyName: Type: string

Company name of the secondary address
country: Type: string

The country of the address
phoneNumber: Type: string

Phone Number of the address
postalCode: Type: string

Postal Code of the address
repositoryId: Type: string

repository Id of the address
state: Type: string

The State of the address

Example application/json


{
    "taxReferenceNumber":"REFNUM123",
    "organizationLogo":"/general/hero-image1.jpg",
    "delegateApprovalManagement":false,
    "secondaryAddresses":[
        {
            "address":{
                "country":"US",
                "phoneNumber":"973-974-1234",
                "address2":"Street 2",
                "city":"Montgomery",
                "address1":"600 Dexter Avenue",
                "postalCode":"36130",
                "companyName":"Oracle",
                "repositoryId":"180003",
                "state":"AL"
            },
            "addressType":"Office Address"
        }
    ],
    "type":"none",
    "parentOrganization":{
        "name":"Sample",
        "repositoryId":"100001",
        "active":true,
        "id":"100001"
    },
    "customerType":"Standard",
    "derivedShippingMethods":[
        {
            "id":"shippingMethodId1"
        }
    ],
    "derivedBillingAddressType":"Office Address",
    "members":[
        {
            "repositoryId":"110001"
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/organizations/2100003"
        }
    ],
    "id":"2100003",
    "dunsNumber":"123456789",
    "relativeRoles":[
        {
            "function":"admin",
            "repositoryId":"200004"
        },
        {
            "function":"buyer",
            "repositoryId":"200005"
        },
        {
            "function":"approver",
            "repositoryId":"200006"
        },
        {
            "function":"accountAddressManager",
            "repositoryId":"200007"
        },
        {
            "function":"profileAddressManager",
            "repositoryId":"200008"
        }
    ],
    "dynamicProperty1":"dynamicProperty1 value",
    "derivedTaxReferenceNumber":"REFNUM123",
    "derivedUseAllPaymentMethodsFromSite":false,
    "contract":{
        "terms":{
            "terms":"All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract",
            "repositoryId":"100002"
        },
        "endDate":"2017-10-10T11:44:26.000Z",
        "catalog":{
            "displayName":"Cloud Catalog",
            "repositoryId":"cloudCatalog"
        },
        "displayName":"Us Motor Works Contract",
        "repositoryId":"100003",
        "description":"This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
        "priceListGroup":{
            "displayName":"Default Price Group",
            "repositoryId":"defaultPriceGroup"
        },
        "creationDate":"2016-04-01T09:34:50.000Z",
        "startDate":"2016-10-10T11:44:26.000Z",
        "externalContractReference":"UMWCUS001"
    },
    "derivedCustomerType":"Standard",
    "active":true,
    "vatReferenceNumber":"Vat123123",
    "taxExemptionCode":"TAXUQ12345",
    "derivedType":"none",
    "useAllShippingMethodsFromSite":false,
    "approvalRequired":false,
    "derivedTaxExemptionCode":"TAXUQ12345",
    "derivedVatReferenceNumber":"Vat123123",
    "name":"Oracle",
    "ancestorOrganizations":[
        {
            "name":"Sample",
            "repositoryId":"100001",
            "active":true,
            "id":"100001"
        }
    ],
    "uniqueId":"TestIDNumber",
    "description":null,
    "derivedBillingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"150002",
        "state":"AL"
    },
    "derivedUniqueId":"TestIDNumber",
    "organizationLogoURL":"http://localhost:9080/file/general/hero-image1.jpg",
    "derivedContract":{
        "terms":{
            "terms":"All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract",
            "repositoryId":"100002"
        },
        "endDate":"2017-10-10T11:44:26.000Z",
        "catalog":{
            "displayName":"Cloud Catalog",
            "repositoryId":"cloudCatalog"
        },
        "displayName":"Us Motor Works Contract",
        "repositoryId":"100003",
        "description":"This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
        "priceListGroup":{
            "displayName":"Default Price Group",
            "repositoryId":"defaultPriceGroup"
        },
        "creationDate":"2016-04-01T09:34:50.000Z",
        "startDate":"2016-10-10T11:44:26.000Z",
        "externalContractReference":"UMWCUS001"
    },
    "paymentMethods":[
        "card",
        "cash"
    ],
    "derivedShippingAddressType":"Office Address",
    "shippingMethods":[
        {
            "id":"shippingMethodId1"
        }
    ],
    "derivedDunsNumber":123456789,
    "derivedOrganizationLogo":"/general/hero-image1.jpg",
    "orderPriceLimit":null,
    "___etag___":"eyJoYXNoIjoicnNmZW5BSWVrUS8yVm00L1NsME1LNWlwekNWTHQ1Zy91d293N051L3Zlcz0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL29yZ2FuaXphdGlvbnMvMjEwMDAwMyIsInVzZXIiOiJBbWJlciBBZG1pbiIsInZlcnNpb24iOjF9",
    "derivedShippingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"150002",
        "state":"AL"
    },
    "derivedUseAllShippingMethodsFromSite":false,
    "useAllPaymentMethodsFromSite":false,
    "derivedPaymentMethods":[
        "card",
        "cash"
    ],
    "repositoryId":"2100003",
    "shippingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"180003",
        "state":"AL"
    },
    "useExternalApprovalWebhook":false,
    "billingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"180003",
        "state":"AL"
    },
    "derivedDescription":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| |------------------|------------------| |100000|If input passed is invalid| |100001|If there was no organization found with the given id|

Body

Root Schema : errorModel

Type: object

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Type: object items

Nested Schema : items

Type: object

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "taxReferenceNumber": "REFNUM123",
  "organizationLogo": "/general/hero-image1.jpg",
  "delegateApprovalManagement": false,
  "secondaryAddresses": [{
    "address": {
      "country": "US",
      "phoneNumber": "973-974-1234",
      "address2": "Street 2",
      "city": "Montgomery",
      "address1": "600 Dexter Avenue",
      "postalCode": "36130",
      "companyName": "Oracle",
      "repositoryId": "180003",
      "state": "AL"
    },
    "addressType": "Office Address"
  }],
  "type": "none",
  "parentOrganization": {
    "name": "Sample",
    "repositoryId": "100001",
    "active": true,
    "id": "100001"
  },
  "customerType": "Standard",
  "derivedShippingMethods": [{"id": "shippingMethodId1"}],
  "derivedBillingAddressType": "Office Address",
  "members": [{"repositoryId": "110001"}],
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadmin/v1/organizations/2100003"
  }],
  "id": "2100003",
  "dunsNumber": "123456789",
  "relativeRoles": [
    {
      "function": "admin",
      "repositoryId": "200004"
    },
    {
      "function": "buyer",
      "repositoryId": "200005"
    },
    {
      "function": "approver",
      "repositoryId": "200006"
    },
    {
      "function": "accountAddressManager",
      "repositoryId": "200007"
    },
    {
      "function": "profileAddressManager",
      "repositoryId": "200008"
    }
  ],
  "dynamicProperty1": "dynamicProperty1 value",
  "derivedTaxReferenceNumber": "REFNUM123",
  "derivedUseAllPaymentMethodsFromSite": false,
  "contract": {
    "terms": {
      "terms": "All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract",
      "repositoryId": "100002"
    },
    "endDate": "2017-10-10T11:44:26.000Z",
    "catalog": {
      "displayName": "Cloud Catalog",
      "repositoryId": "cloudCatalog"
    },
    "displayName": "Us Motor Works Contract",
    "repositoryId": "100003",
    "description": "This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
    "priceListGroup": {
      "displayName": "Default Price Group",
      "repositoryId": "defaultPriceGroup"
    },
    "creationDate": "2016-04-01T09:34:50.000Z",
    "startDate": "2016-10-10T11:44:26.000Z",
    "externalContractReference": "UMWCUS001"
  },
  "derivedCustomerType": "Standard",
  "active": true,
  "vatReferenceNumber": "Vat123123",
  "taxExemptionCode": "TAXUQ12345",
  "derivedType": "none",
  "useAllShippingMethodsFromSite": false,
  "approvalRequired": false,
  "derivedTaxExemptionCode": "TAXUQ12345",
  "derivedVatReferenceNumber": "Vat123123",
  "name": "Oracle",
  "ancestorOrganizations": [{
    "name": "Sample",
    "repositoryId": "100001",
    "active": true,
    "id": "100001"
  }],
  "uniqueId": "TestIDNumber",
  "description": null,
  "derivedBillingAddress": {
    "country": "US",
    "phoneNumber": "973-974-1234",
    "address2": "Street 2",
    "city": "Montgomery",
    "address1": "600 Dexter Avenue",
    "postalCode": "36130",
    "companyName": "Oracle",
    "repositoryId": "150002",
    "state": "AL"
  },
  "derivedUniqueId": "TestIDNumber",
  "organizationLogoURL": "http://localhost:9080/file/general/hero-image1.jpg",
  "derivedContract": {
    "terms": {
      "terms": "All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract",
      "repositoryId": "100002"
    },
    "endDate": "2017-10-10T11:44:26.000Z",
    "catalog": {
      "displayName": "Cloud Catalog",
      "repositoryId": "cloudCatalog"
    },
    "displayName": "Us Motor Works Contract",
    "repositoryId": "100003",
    "description": "This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
    "priceListGroup": {
      "displayName": "Default Price Group",
      "repositoryId": "defaultPriceGroup"
    },
    "creationDate": "2016-04-01T09:34:50.000Z",
    "startDate": "2016-10-10T11:44:26.000Z",
    "externalContractReference": "UMWCUS001"
  },
  "paymentMethods": [
    "card",
    "cash"
  ],
  "derivedShippingAddressType": "Office Address",
  "shippingMethods": [{"id": "shippingMethodId1"}],
  "derivedDunsNumber": 123456789,
  "derivedOrganizationLogo": "/general/hero-image1.jpg",
  "orderPriceLimit": null,
  "___etag___": "eyJoYXNoIjoicnNmZW5BSWVrUS8yVm00L1NsME1LNWlwekNWTHQ1Zy91d293N051L3Zlcz0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL29yZ2FuaXphdGlvbnMvMjEwMDAwMyIsInVzZXIiOiJBbWJlciBBZG1pbiIsInZlcnNpb24iOjF9",
  "derivedShippingAddress": {
    "country": "US",
    "phoneNumber": "973-974-1234",
    "address2": "Street 2",
    "city": "Montgomery",
    "address1": "600 Dexter Avenue",
    "postalCode": "36130",
    "companyName": "Oracle",
    "repositoryId": "150002",
    "state": "AL"
  },
  "derivedUseAllShippingMethodsFromSite": false,
  "useAllPaymentMethodsFromSite": false,
  "derivedPaymentMethods": [
    "card",
    "cash"
  ],
  "repositoryId": "2100003",
  "shippingAddress": {
    "country": "US",
    "phoneNumber": "973-974-1234",
    "address2": "Street 2",
    "city": "Montgomery",
    "address1": "600 Dexter Avenue",
    "postalCode": "36130",
    "companyName": "Oracle",
    "repositoryId": "180003",
    "state": "AL"
  },
  "useExternalApprovalWebhook": false,
  "billingAddress": {
    "country": "US",
    "phoneNumber": "973-974-1234",
    "address2": "Street 2",
    "city": "Montgomery",
    "address1": "600 Dexter Avenue",
    "postalCode": "36130",
    "companyName": "Oracle",
    "repositoryId": "180003",
    "state": "AL"
  },
  "derivedDescription": null
}