REST API for Oracle Commerce Cloud December 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' and also dynamic account properties.
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

Additional Properties Allowed:

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

Additional Properties Allowed:

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
id: Type: string

Id of the Organization
name: Type: string

The name for Organization
repositoryId: Type: string

repository Id of the Organization

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"
        }
    ]
}

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

Additional Properties Allowed:

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

Additional Properties Allowed:

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"
  }]
}