REST API for Oracle Commerce Cloud December 2017

getSites

get

/ccagent/v1/sites

Get Sites. Get the list of all sites.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getSites_response

Properties

items: Type: array items

Additional Properties Allowed:

The list of available sites
startingIndex: Type: integer

The starting index
totalNumberOfItems: Type: integer

The total number of items.

Nested Schema : items

Type: array

The list of available sites

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

additionalLocaleIds: Type: array additionalLocaleIds

Additional Properties Allowed:

IDs of additional locales.
additionalProductionURLs: Type: array additionalProductionURLs

Additional Properties Allowed:

A list of additional production URLs (without schema). Currently, only plain hostnames are supported.
defaultBillingCountryId: Type: string

The default billing country ID.
defaultCatalog: Type: object defaultCatalog

Additional Properties Allowed:

The default catalog for the site.
defaultLocaleId: Type: string

The ID for the default locale of the site.
defaultShippingCountryId: Type: string

The default shipping country ID.
defaultSite: Type: boolean

Indicates is the site is a default site.
description: Type: string

A description of the site.
enabled: Type: boolean

Indicates whether the site is enabled.
id: Type: string

The repository ID of the site.
longDescription: Type: string

A long description of the site.
loyaltyPrograms: Type: array loyaltyPrograms

Additional Properties Allowed:

List of loyalty programs associated with site.
name: Type: string

The name of the site.
noimage: Type: string

Site specific no-image image
priceListGroupList: Type: array priceListGroupList

Additional Properties Allowed:

List of priceListGroups to be associated with site.
productionURL: Type: string

The production URL (without the scheme) of the server. Currently, only hostnames are support.
recommendationsHost: Type: string

The host name of the recommendations server.
recommendationsPort: Type: string

The port of the recommendations server.
repositoryId: Type: string

The repository ID of the site.
secondaryCurrency: Type: string

Currency used for calculating shipping and tax for loyalty.
siteTypes: Type: array siteTypes

Additional Properties Allowed:

The list of site types.

Nested Schema : additionalLocaleIds

Type: array

IDs of additional locales.

Items

Type: string

Nested Schema : additionalProductionURLs

Type: array

A list of additional production URLs (without schema). Currently, only plain hostnames are supported.

Items

Type: string

Nested Schema : defaultCatalog

Type: object

The default catalog for the site.

Properties

repositoryId: Type: string

The ID of the default catalog for the site.

Nested Schema : loyaltyPrograms

Type: array

List of loyalty programs associated with site.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceListGroupList

Type: array

List of priceListGroups to be associated with site.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : siteTypes

Type: array

The list of site types.

Items

Type: string

Nested Schema : items

Type: object

Properties

associationDate: Type: string

Association date of loyalty program to site.
programId: Type: string

Loyalty Program Id.
programName: Type: string

Name for loyalty program.
repositoryId: Type: string

The loyalty program id associated with the site.

Nested Schema : items

Type: object

Properties

id: Type: string

The priceListGroup id associated with the site.
repositoryId: Type: string

The priceListGroup id associated with the site.

Example application/json


{
    "endingIndex":250,
    "totalResultsParam":true,
    "sort":{
        "collator":null,
        "numDirectives":1,
        "empty":false
    },
    "items":[
        {
            "longDescription":"Site to test agent flows",
            "priceListGroupList":[
                {
                    "repositoryId":"defaultPriceGroup",
                    "id":"defaultPriceGroup"
                },
                {
                    "repositoryId":"JPYSiteA",
                    "id":"JPYSiteA"
                }
            ],
            "productionURL":"localhost:8080",
            "recommendationsHost":"pt-recs-app1.us.oracle.com",
            "noimage":null,
            "description":"New Site A",
            "defaultPriceListGroup":{
                "repositoryId":"JPYSiteA",
                "id":"JPYSiteA"
            },
            "defaultCatalog":{
                "repositoryId":"SiteACatalog"
            },
            "defaultBillingCountryId":null,
            "defaultShippingCountryId":null,
            "enabled":true,
            "siteTypes":[
                "commerce"
            ],
            "recommendationsPort":"8080",
            "defaultLocaleId":"1",
            "repositoryId":"SiteA",
            "name":"Site Agent",
            "additionalProductionURLs":[
            ],
            "id":"SiteA",
            "defaultSite":false,
            "additionalLocaleIds":[
            ]
        },
        {
            "longDescription":null,
            "priceListGroupList":[
                {
                    "repositoryId":"defaultPriceGroup",
                    "id":"defaultPriceGroup"
                }
            ],
            "productionURL":"localhostSiteUS:8080",
            "recommendationsHost":"pt-recs-app1.us.oracle.com",
            "noimage":"/file/v3496256495527410201/general/19417364_10155381677403926_746513040903355218_o.jpg",
            "description":"Commerce Cloud Site",
            "secondaryCurrency":"USD",
            "defaultPriceListGroup":{
                "repositoryId":"defaultPriceGroup",
                "id":"defaultPriceGroup"
            },
            "defaultCatalog":{
                "repositoryId":"cloudLakeCatalog"
            },
            "defaultBillingCountryId":null,
            "defaultShippingCountryId":null,
            "enabled":true,
            "siteTypes":[
                "commerce"
            ],
            "recommendationsPort":"8080",
            "defaultLocaleId":"1",
            "repositoryId":"siteUS",
            "name":"Commerce Cloud Site",
            "additionalProductionURLs":[
            ],
            "id":"siteUS",
            "defaultSite":true,
            "additionalLocaleIds":[
            ]
        }
    ],
    "startingIndex":0,
    "totalNumberOfItems":2
}

Default Response

The error response

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:

{
  "endingIndex": 250,
  "totalResultsParam": true,
  "sort": {
    "collator": null,
    "numDirectives": 1,
    "empty": false
  },
  "items": [
    {
      "longDescription": "Site to test agent flows",
      "priceListGroupList": [
        {
          "repositoryId": "defaultPriceGroup",
          "id": "defaultPriceGroup"
        },
        {
          "repositoryId": "JPYSiteA",
          "id": "JPYSiteA"
        }
      ],
      "productionURL": "localhost:8080",
      "recommendationsHost": "pt-recs-app1.us.oracle.com",
      "noimage": null,
      "description": "New Site A",
      "defaultPriceListGroup": {
        "repositoryId": "JPYSiteA",
        "id": "JPYSiteA"
      },
      "defaultCatalog": {"repositoryId": "SiteACatalog"},
      "defaultBillingCountryId": null,
      "defaultShippingCountryId": null,
      "enabled": true,
      "siteTypes": ["commerce"],
      "recommendationsPort": "8080",
      "defaultLocaleId": "1",
      "repositoryId": "SiteA",
      "name": "Site Agent",
      "additionalProductionURLs": [],
      "id": "SiteA",
      "defaultSite": false,
      "additionalLocaleIds": []
    },
    {
      "longDescription": null,
      "priceListGroupList": [{
        "repositoryId": "defaultPriceGroup",
        "id": "defaultPriceGroup"
      }],
      "productionURL": "localhostSiteUS:8080",
      "recommendationsHost": "pt-recs-app1.us.oracle.com",
      "noimage": "/file/v3496256495527410201/general/19417364_10155381677403926_746513040903355218_o.jpg",
      "description": "Commerce Cloud Site",
      "secondaryCurrency": "USD",
      "defaultPriceListGroup": {
        "repositoryId": "defaultPriceGroup",
        "id": "defaultPriceGroup"
      },
      "defaultCatalog": {"repositoryId": "cloudLakeCatalog"},
      "defaultBillingCountryId": null,
      "defaultShippingCountryId": null,
      "enabled": true,
      "siteTypes": ["commerce"],
      "recommendationsPort": "8080",
      "defaultLocaleId": "1",
      "repositoryId": "siteUS",
      "name": "Commerce Cloud Site",
      "additionalProductionURLs": [],
      "id": "siteUS",
      "defaultSite": true,
      "additionalLocaleIds": []
    }
  ],
  "startingIndex": 0,
  "totalNumberOfItems": 2
}