REST API for Oracle Commerce Cloud December 2017

getOrganization

get

/ccstore/v1/organizations/{id}

Get Organization. This operation is used to get the Organization information of a customer from Oracle Commerce Cloud.Optionally takes the X-CCOrganization header to specify current Organization id of logged in user.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The ID of the requested Organization.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getOrganization_response

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

Additional Properties Allowed:

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

Additional Properties Allowed:

Contract
customerType: Type: string

Customer Type for Organization
delegateApprovalManagement: Type: boolean

This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
derivedBillingAddress: Type: object derivedBillingAddress

Additional Properties Allowed:

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.
derivedPaymentMethods: Type: array derivedPaymentMethods

Additional Properties Allowed:

Derived payment methods associated for organization.
derivedShippingAddress: Type: object derivedShippingAddress

Additional Properties Allowed:

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.
derivedShippingMethods: Type: array derivedShippingMethods

Additional Properties Allowed:

Derived shipping methods associated for organization.
derivedUseAllPaymentMethodsFromSite: Type: boolean

Derived flag to use all the payment methods available for site.
derivedUseAllShippingMethodsFromSite: Type: string

Derived flag to use all the shipping methods available for site.
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
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.
paymentMethods: Type: array paymentMethods

Additional Properties Allowed:

Payment methods associated for organization.
relativeRoles: Type: array relativeRoles

Additional Properties Allowed:

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

Repository Id of the Organization
secondaryAddresses: Type: array secondaryAddresses

Additional Properties Allowed:

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

Additional Properties Allowed:

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.
shippingMethods: Type: array shippingMethods

Additional Properties Allowed:

Shipping methods associated for organization.
taxReferenceNumber: Type: string

Tax Reference number for Organization
type: Type: string

Type for Organization
uniqueId: Type: string

Unique Id of the Organization
useAllPaymentMethodsFromSite: Type: boolean

Flag to use all the payment methods available for site.
useAllShippingMethodsFromSite: Type: string

Flag to use all the shipping methods available for site.
useExternalApprovalWebhook: Type: boolean

Flag to enable/disable Order Approval check from External Webhook
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.

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

Type: object

Contract

Properties

catalog: Type: object catalog

Additional Properties Allowed:

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

Additional Properties Allowed:

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

Additional Properties Allowed:

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.

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

Type: array

Derived payment methods associated for organization.

Items

Type: string

Nested Schema : derivedShippingAddress

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.

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

Type: array

Derived shipping methods associated for organization.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : paymentMethods

Type: array

Payment methods associated for organization.

Items

Type: string

Nested Schema : relativeRoles

Type: array

List of roles associated with an Organization

Items

Type: object items

Additional Properties Allowed:

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

Additional Properties Allowed:

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.

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

Type: array

Shipping methods associated for organization.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : catalog

Type: object

Catalog associated with contract

Properties

repositoryId: Type: string

Repository Id of the catalog

Nested Schema : priceListGroup

Type: object

Price ListGroup associated with contract

Properties

repositoryId: Type: string

Repository Id of the price list group

Nested Schema : terms

Type: object

Terms and Conditions

Properties

repositoryId: Type: string

Repository Id of terms and conditions
terms: Type: string

Terms and Conditions

Nested Schema : items

Type: object

Properties

displayName: Type: string

Repository Id of the shipping method.
id: Type: string

Repository Id of the shipping method.
repositoryId: Type: string

Repository Id of the shipping method.

Nested Schema : items

Type: object

Properties

function: Type: string

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

Repository Id of the role.

Nested Schema : items

Type: object

Properties

address: Type: object address

Additional Properties Allowed:

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

Nested Schema : items

Type: object

Properties

id: Type: string

Repository Id of the shipping method.

Example application/json


{
    "taxReferenceNumber":"REFNUM123",
    "organizationLogo":"/general/hero-image1.jpg",
    "description":null,
    "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",
    "derivedBillingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"180003",
        "state":"AL"
    },
    "customerType":"Standard",
    "derivedShippingMethods":[
        {
            "displayName":"Shipping Method Name",
            "repositoryId":"shippingMethodId1",
            "id":"shippingMethodId1"
        }
    ],
    "organizationLogoURL":"http://localhost:9080/file/general/hero-image1.jpg",
    "members":[
        {
            "repositoryId":"110001"
        }
    ],
    "paymentMethods":[
        "card",
        "cash"
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/organizations/2100003"
        }
    ],
    "id":"2100003",
    "dunsNumber":"123456789",
    "relativeRoles":[
        {
            "function":"admin"
        },
        {
            "function":"buyer"
        }
    ],
    "shippingMethods":[
        {
            "id":"shippingMethodId1"
        }
    ],
    "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":{
            "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,
    "vatReferenceNumber":"Vat123123",
    "orderPriceLimit":"1000",
    "dynamicProperty":"dynamicProperty value",
    "derivedShippingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"180003",
        "state":"AL"
    },
    "useAllShippingMethodsFromSite":false,
    "derivedUseAllShippingMethodsFromSite":false,
    "approvalRequired":true,
    "useAllPaymentMethodsFromSite":false,
    "derivedPaymentMethods":[
        "card",
        "cash"
    ],
    "repositoryId":"2100003",
    "name":"Oracle",
    "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"
    },
    "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| |------------------|------------------| |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

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:

{
  "taxReferenceNumber": "REFNUM123",
  "organizationLogo": "/general/hero-image1.jpg",
  "description": null,
  "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",
  "derivedBillingAddress": {
    "country": "US",
    "phoneNumber": "973-974-1234",
    "address2": "Street 2",
    "city": "Montgomery",
    "address1": "600 Dexter Avenue",
    "postalCode": "36130",
    "companyName": "Oracle",
    "repositoryId": "180003",
    "state": "AL"
  },
  "customerType": "Standard",
  "derivedShippingMethods": [{
    "displayName": "Shipping Method Name",
    "repositoryId": "shippingMethodId1",
    "id": "shippingMethodId1"
  }],
  "organizationLogoURL": "http://localhost:9080/file/general/hero-image1.jpg",
  "members": [{"repositoryId": "110001"}],
  "paymentMethods": [
    "card",
    "cash"
  ],
  "links": [{
    "rel": "self",
    "href": "http://localhost:8080/ccstore/v1/organizations/2100003"
  }],
  "id": "2100003",
  "dunsNumber": "123456789",
  "relativeRoles": [
    {"function": "admin"},
    {"function": "buyer"}
  ],
  "shippingMethods": [{"id": "shippingMethodId1"}],
  "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": {"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,
  "vatReferenceNumber": "Vat123123",
  "orderPriceLimit": "1000",
  "dynamicProperty": "dynamicProperty value",
  "derivedShippingAddress": {
    "country": "US",
    "phoneNumber": "973-974-1234",
    "address2": "Street 2",
    "city": "Montgomery",
    "address1": "600 Dexter Avenue",
    "postalCode": "36130",
    "companyName": "Oracle",
    "repositoryId": "180003",
    "state": "AL"
  },
  "useAllShippingMethodsFromSite": false,
  "derivedUseAllShippingMethodsFromSite": false,
  "approvalRequired": true,
  "useAllPaymentMethodsFromSite": false,
  "derivedPaymentMethods": [
    "card",
    "cash"
  ],
  "repositoryId": "2100003",
  "name": "Oracle",
  "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"
  },
  "uniqueId": "TestIDNumber"
}