Oracle Commerce Cloud October 2017

listOrganizations

get

/ccagent/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. nIt has support for fields also

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.

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":5,
    "totalResults":5,
    "offset":0,
    "limit":20,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/organizations?limit=20&offset=0&q=name%20co%20%22US%22"
        }
    ],
    "sort":[
        {
            "property":"name",
            "order":"asc"
        }
    ],
    "items":[
        {
            "approvalRequired":false,
            "repositoryId":"or-100005",
            "name":"US Motor Works - Wholesale",
            "active":true,
            "description":null,
            "shippingAddress":{
                "country":"US",
                "phoneNumber":"440-780-8425",
                "address2":"Geauga County",
                "city":"Chagrin Falls",
                "address1":"98 Connecticut Ave Nw",
                "companyName":"US Motor Works - Wholesale",
                "postalCode":"44023",
                "repositoryId":"ci-110028",
                "state":"OH"
            },
            "secondaryAddresses":{
                "Address1":{
                    "country":"US",
                    "phoneNumber":"440-780-8425",
                    "address2":"Geauga County",
                    "city":"Chagrin Falls",
                    "address1":"98 Connecticut Ave Nw",
                    "companyName":"US Motor Works - Wholesale",
                    "postalCode":"44023",
                    "repositoryId":"ci-110028",
                    "state":"OH"
                }
            },
            "billingAddress":{
                "country":"US",
                "phoneNumber":"440-780-8425",
                "address2":"Geauga County",
                "city":"Chagrin Falls",
                "address1":"98 Connecticut Ave Nw",
                "companyName":"US Motor Works - Wholesale",
                "postalCode":"44023",
                "repositoryId":"ci-110028",
                "state":"OH"
            },
            "id":"or-100005"
        },
        {
            "approvalRequired":false,
            "repositoryId":"or-100002",
            "name":"US Motor Works, Inc.",
            "active":true,
            "description":"US Motor Works, Inc.",
            "shippingAddress":{
                "country":"US",
                "phoneNumber":"408-752-3500",
                "address2":"Santa Clara County",
                "city":"San Jose",
                "address1":"7 W Jackson Blvd",
                "companyName":"US Motor Works, Inc.",
                "postalCode":"95111",
                "repositoryId":"ci-110029",
                "state":"CA"
            },
            "secondaryAddresses":{
                "Address1":{
                    "country":"US",
                    "phoneNumber":"408-752-3500",
                    "address2":"Santa Clara County",
                    "city":"San Jose",
                    "address1":"7 W Jackson Blvd",
                    "companyName":"US Motor Works, Inc.",
                    "postalCode":"95111",
                    "repositoryId":"ci-110029",
                    "state":"CA"
                }
            },
            "billingAddress":{
                "country":"US",
                "phoneNumber":"408-752-3500",
                "address2":"Santa Clara County",
                "city":"San Jose",
                "address1":"7 W Jackson Blvd",
                "companyName":"US Motor Works, Inc.",
                "postalCode":"95111",
                "repositoryId":"ci-110029",
                "state":"CA"
            },
            "id":"or-100002"
        }
    ]
}

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| |------------------|------------------| |100020|Invalid Input| |100019|Internal Error| |100000|If input passed is invalid| |100001|If there was no organization found with the given id|

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": 5,
  "totalResults": 5,
  "offset": 0,
  "limit": 20,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccagentui/v1/organizations?limit=20&offset=0&q=name%20co%20%22US%22"
  }],
  "sort": [{
    "property": "name",
    "order": "asc"
  }],
  "items": [
    {
      "approvalRequired": false,
      "repositoryId": "or-100005",
      "name": "US Motor Works - Wholesale",
      "active": true,
      "description": null,
      "shippingAddress": {
        "country": "US",
        "phoneNumber": "440-780-8425",
        "address2": "Geauga County",
        "city": "Chagrin Falls",
        "address1": "98 Connecticut Ave Nw",
        "companyName": "US Motor Works - Wholesale",
        "postalCode": "44023",
        "repositoryId": "ci-110028",
        "state": "OH"
      },
      "secondaryAddresses": {"Address1": {
        "country": "US",
        "phoneNumber": "440-780-8425",
        "address2": "Geauga County",
        "city": "Chagrin Falls",
        "address1": "98 Connecticut Ave Nw",
        "companyName": "US Motor Works - Wholesale",
        "postalCode": "44023",
        "repositoryId": "ci-110028",
        "state": "OH"
      }},
      "billingAddress": {
        "country": "US",
        "phoneNumber": "440-780-8425",
        "address2": "Geauga County",
        "city": "Chagrin Falls",
        "address1": "98 Connecticut Ave Nw",
        "companyName": "US Motor Works - Wholesale",
        "postalCode": "44023",
        "repositoryId": "ci-110028",
        "state": "OH"
      },
      "id": "or-100005"
    },
    {
      "approvalRequired": false,
      "repositoryId": "or-100002",
      "name": "US Motor Works, Inc.",
      "active": true,
      "description": "US Motor Works, Inc.",
      "shippingAddress": {
        "country": "US",
        "phoneNumber": "408-752-3500",
        "address2": "Santa Clara County",
        "city": "San Jose",
        "address1": "7 W Jackson Blvd",
        "companyName": "US Motor Works, Inc.",
        "postalCode": "95111",
        "repositoryId": "ci-110029",
        "state": "CA"
      },
      "secondaryAddresses": {"Address1": {
        "country": "US",
        "phoneNumber": "408-752-3500",
        "address2": "Santa Clara County",
        "city": "San Jose",
        "address1": "7 W Jackson Blvd",
        "companyName": "US Motor Works, Inc.",
        "postalCode": "95111",
        "repositoryId": "ci-110029",
        "state": "CA"
      }},
      "billingAddress": {
        "country": "US",
        "phoneNumber": "408-752-3500",
        "address2": "Santa Clara County",
        "city": "San Jose",
        "address1": "7 W Jackson Blvd",
        "companyName": "US Motor Works, Inc.",
        "postalCode": "95111",
        "repositoryId": "ci-110029",
        "state": "CA"
      },
      "id": "or-100002"
    }
  ]
}