1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Admin
  4. Organizations

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
Path Parameters
Query Parameters
  • As an alternative to the fields parameter, which explicitly specifies the properties to include, you can use the exclude parameter to include all properties except the ones specified. For example, to return all of the properties of organization except paymentMethods.
  • 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','shippingPayments' and 'punchout'
  • You can use the fields parameter to restrict the set of properties returned to only those you explicitly specify. The properties are specified as a comma-separated list. For example, id and name properties of organization.
  • Rather than using fields or exclude to explicitly list properties in the URL of a REST call, you can create persistent filters that store the set of properties to include or exclude. You can then specify a filter by name in the URL using the filterKey query parameter. Use Response Filters Admin API to create new persistent filters and use them.
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getOrganization_response
Type: object
Show Source
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
Nested Schema : contract
Type: object
Contract
Show Source
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
Nested Schema : derivedContract
Type: object
Contract
Show Source
Nested Schema : members
Type: array
List of contact ids associated with an Organization
Show Source
Nested Schema : relativeRoles
Type: array
List of roles associated with an Organization
Show Source
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
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : address
Type: object
Address created for the Organization.
Show Source
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":"REFNUM123",
    "organizationLogo":"/general/hero-image1.jpg",
    "delegateApprovalManagement":false,
    "secondaryAddresses":[
        {
            "address":{
                "country":"US",
                "externalAddressId":"EXT_ADDR_1",
                "types":[
                    {
                        "displayName":"Billing",
                        "repositoryId":"ss-10002",
                        "id":"ss-10002"
                    }
                ],
                "phoneNumber":"973-974-1234",
                "address3":"Street 3",
                "address2":"Street 2",
                "city":"Montgomery",
                "address1":"600 Dexter Avenue",
                "postalCode":"36130",
                "companyName":"Oracle",
                "repositoryId":"180003",
                "state":"AL"
            },
            "addressType":"Office Address"
        }
    ],
    "source":null,
    "externalOrganizationId":"externalOrgId1",
    "type":"none",
    "parentOrganization":{
        "name":"Sample",
        "repositoryId":"100001",
        "active":true,
        "id":"100001",
        "externalOrganizationId":"EXT_ORG_1"
    },
    "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,
    "derivedAuthorizationCode":"sadsaxxaASX34567==",
    "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",
    "allowPunchoutShopping":true,
    "useAllShippingMethodsFromSite":false,
    "approvalRequired":false,
    "derivedTaxExemptionCode":"TAXUQ12345",
    "derivedVatReferenceNumber":"Vat123123",
    "derivedAllowPunchoutShopping":true,
    "name":"Oracle",
    "ancestorOrganizations":[
        {
            "name":"Sample",
            "repositoryId":"100001",
            "active":true,
            "id":"100001",
            "externalOrganizationId":"EXT_ORG_1"
        }
    ],
    "uniqueId":"TestIDNumber",
    "authorizationCode":"sadsaxxaASX34567==",
    "description":null,
    "derivedBillingAddress":{
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            {
                "displayName":"Billing",
                "repositoryId":"ss-10002",
                "id":"ss-10002"
            }
        ],
        "phoneNumber":"973-974-1234",
        "address3":"Street 3",
        "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,
    "derivedShippingAddress":{
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            {
                "displayName":"Billing",
                "repositoryId":"ss-10002",
                "id":"ss-10002"
            }
        ],
        "phoneNumber":"973-974-1234",
        "address3":"Street 3",
        "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",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            {
                "displayName":"Billing",
                "repositoryId":"ss-10002",
                "id":"ss-10002"
            }
        ],
        "phoneNumber":"973-974-1234",
        "address3":"Street 3",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"180003",
        "state":"AL"
    },
    "useExternalApprovalWebhook":false,
    "billingAddress":{
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            {
                "displayName":"Billing",
                "repositoryId":"ss-10002",
                "id":"ss-10002"
            }
        ],
        "phoneNumber":"973-974-1234",
        "address3":"Street 3",
        "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
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top