Oracle Commerce Cloud October 2017

listOrganizations

get

/ccadmin/v1/organizations

List Organizations. This operation is used to get the collection of customer organizations from Oracle Commerce Cloud. It can also be used to return the list on a searched string and in a sorted order against various properties of organization.

Request

Supported Media Types

application/json

Query Parameters

limit: Type: string

This is the field to determine number of records to be fetched per REST call.
offset: Type: string

This field determines the offset/starting index from which data to be fetched.
q: Type: string

Query string built as per the SCIM standards that helps to search entered string across account properties like 'name'.
sort: Type: string

This field determines the sort order of the list to be fetched.
useAdvancedQParser: Type: boolean

This field determines the parser to be used. Default parser has limitations and nested queries or complex queries cannot be executed using this default parser. It is recommended to use this flag as true.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listOrganizations_response

Properties

items: Type: array items

list of organizations
limit: Type: string

Number of records to be fetched.
offset: Type: string

The offset provided.
total: Type: string

Total number of records present in database matching the searched string.
totalResults: Type: string

Total number of records present in database matching the searched string.

Nested Schema : items

Type: array

list of organizations

Items

Type: object items

Nested Schema : items

Type: object

Properties

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
billingAddress: Type: 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.
description: Type: string

Description for Organization
id: Type: string

Id of the Organization
name: Type: string

The name for Organization
organizationLogo: Type: string

File path of organization logo.
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 come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute.

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

Items

Type: object items

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.

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

Type: object

Properties

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.

Properties

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


{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/organizations"
        }
    ],
    "items":[
        {
            "taxReferenceNumber":"REFNUM123",
            "organizationLogo":"/general/hero-image1.jpg",
            "description":null,
            "delegateApprovalManagement":false,
            "secondaryAddresses":[
                {
                    "address":{
                        "country":"US",
                        "phoneNumber":"973-974-1234",
                        "address2":"Street 2",
                        "city":"Montgomery",
                        "address1":"600 Dexter Avenue",
                        "postalCode":"36130",
                        "companyName":"Oracle",
                        "repositoryId":"190001",
                        "state":"AL"
                    },
                    "addressType":"Office Address"
                }
            ],
            "type":"none",
            "parentOrganization":{
                "name":"Oracle Sample",
                "repositoryId":"100001",
                "active":true,
                "id":"100001"
            },
            "customerType":"Standard",
            "organizationLogoURL":"http://localhost:9080/file/general/hero-image1.jpg",
            "members":[
                {
                    "repositoryId":"110001",
                    "id":"110001"
                }
            ],
            "id":"2200002",
            "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",
            "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":{
                    "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":{
                    "repositoryId":"defaultPriceGroup"
                },
                "creationDate":"2016-04-01T09:34:50.000Z",
                "startDate":"2016-10-10T11:44:26.000Z",
                "externalContractReference":"UMWCUS001"
            },
            "active":true,
            "taxExemptionCode":"TAXUQ12345",
            "vatReferenceNumber":"Vat123123",
            "orderPriceLimit":null,
            "approvalRequired":false,
            "repositoryId":"2200002",
            "name":"Oracle",
            "shippingAddress":{
                "country":"US",
                "phoneNumber":"973-974-1234",
                "address2":"Street 2",
                "city":"Montgomery",
                "address1":"600 Dexter Avenue",
                "postalCode":"36130",
                "companyName":"Oracle",
                "repositoryId":"190001",
                "state":"AL"
            },
            "ancestorOrganizations":[
                {
                    "name":"Oracle Sample",
                    "repositoryId":"100001",
                    "active":true,
                    "id":"100001"
                }
            ],
            "useExternalApprovalWebhook":false,
            "billingAddress":{
                "country":"US",
                "phoneNumber":"973-974-1234",
                "address2":"Street 2",
                "city":"Montgomery",
                "address1":"600 Dexter Avenue",
                "postalCode":"36130",
                "companyName":"Oracle",
                "repositoryId":"190001",
                "state":"AL"
            },
            "uniqueId":"TestIDNumber"
        }
    ],
    "___etag___":"eyJoYXNoIjoiaS92RnVXRHZsakhtZW9DZDBMWnQvZTRDZUMxT3dnOUhZQWxtVGwxaTNsZz0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL29yZ2FuaXphdGlvbnMiLCJ2ZXJzaW9uIjowfQ=="
}

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| |------------------|------------------| |100070|Invalid Query Expression.| |10002|The value x for parameter 'y' is invalid. 'y' can be 'limit', 'offset' or 'sort'.| |100018|If invalid input is passed.| |100019|If there was any internal error while getting organizations list.|

Body

Root Schema : errorModel

Type: object

Properties

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

Items

Type: object items

Nested Schema : items

Type: object

Properties

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:

{
  "total": 1,
  "totalResults": 1,
  "offset": 0,
  "limit": 1,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadmin/v1/organizations"
  }],
  "items": [{
    "taxReferenceNumber": "REFNUM123",
    "organizationLogo": "/general/hero-image1.jpg",
    "description": null,
    "delegateApprovalManagement": false,
    "secondaryAddresses": [{
      "address": {
        "country": "US",
        "phoneNumber": "973-974-1234",
        "address2": "Street 2",
        "city": "Montgomery",
        "address1": "600 Dexter Avenue",
        "postalCode": "36130",
        "companyName": "Oracle",
        "repositoryId": "190001",
        "state": "AL"
      },
      "addressType": "Office Address"
    }],
    "type": "none",
    "parentOrganization": {
      "name": "Oracle Sample",
      "repositoryId": "100001",
      "active": true,
      "id": "100001"
    },
    "customerType": "Standard",
    "organizationLogoURL": "http://localhost:9080/file/general/hero-image1.jpg",
    "members": [{
      "repositoryId": "110001",
      "id": "110001"
    }],
    "id": "2200002",
    "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",
    "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": {"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": {"repositoryId": "defaultPriceGroup"},
      "creationDate": "2016-04-01T09:34:50.000Z",
      "startDate": "2016-10-10T11:44:26.000Z",
      "externalContractReference": "UMWCUS001"
    },
    "active": true,
    "taxExemptionCode": "TAXUQ12345",
    "vatReferenceNumber": "Vat123123",
    "orderPriceLimit": null,
    "approvalRequired": false,
    "repositoryId": "2200002",
    "name": "Oracle",
    "shippingAddress": {
      "country": "US",
      "phoneNumber": "973-974-1234",
      "address2": "Street 2",
      "city": "Montgomery",
      "address1": "600 Dexter Avenue",
      "postalCode": "36130",
      "companyName": "Oracle",
      "repositoryId": "190001",
      "state": "AL"
    },
    "ancestorOrganizations": [{
      "name": "Oracle Sample",
      "repositoryId": "100001",
      "active": true,
      "id": "100001"
    }],
    "useExternalApprovalWebhook": false,
    "billingAddress": {
      "country": "US",
      "phoneNumber": "973-974-1234",
      "address2": "Street 2",
      "city": "Montgomery",
      "address1": "600 Dexter Avenue",
      "postalCode": "36130",
      "companyName": "Oracle",
      "repositoryId": "190001",
      "state": "AL"
    },
    "uniqueId": "TestIDNumber"
  }],
  "___etag___": "eyJoYXNoIjoiaS92RnVXRHZsakhtZW9DZDBMWnQvZTRDZUMxT3dnOUhZQWxtVGwxaTNsZz0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL29yZ2FuaXphdGlvbnMiLCJ2ZXJzaW9uIjowfQ=="
}