Jump to

• Request
• Response

getSite

get

/ccagent/v1/sites/{id}

Get Site. Get a site by ID. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  The ID of the site.

Header Parameters

• X-CCAsset-Language: string
  The asset language of the request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getSite_response

Type: object

Show Source

• additionalLocaleIds: array additionalLocaleIds
  Additional locale IDs.
• allowAlternateCurrency: boolean
  Allows the order to be paid in mixed currencies
• defaultBillingCountryId: string
  Default Billing Country ID.
• defaultCatalog: string
  Default catalog id.
• defaultLocaleId: string
  The default locale ID.
• defaultPriceListGroup: string
  Default price list group id.
• defaultShippingCountryId: string
  Default Shipping Country ID.
• defaultSite: boolean
  Indicates if the site is a default site
• description: string
  Site description.
• enabled: boolean
  Indicates if the site is enabled
• id: string
  ID of the site.
• inventoryLocationId: string
  Defines which inventory this site should use by default.
• inventoryLocations: array inventoryLocations
  The "inventoryLocations" field, defined as an array, enables users to link multiple inventory locations to a site. If the "inventoryLocations" array includes at least one element, the "inventoryLocationId" field is not considered.
• longDescription: string
  Long site description.
• name: string
  Site name.
• noimage: string
  Site specific no-image image
• payShippingInSecondaryCurrency: boolean
  Pay shipping charges in secondary currency
• payTaxInSecondaryCurrency: boolean
  Pay tax in secondary currency
• priceListGroupList: array priceListGroupList
  List of Price List Groups associated with the site including default Price List Group
• productionURL: string
  The production base url for storefront. If set, this base url will be used for any absolute generated links e.g. sitemap urls
• recommendationsHost: string
  The host name of the recommendations server.
• recommendationsPort: string
  The port of the recommendations server
• repositoryId: string
  Repository ID of the site.
• secondaryCurrency: string
  Currency used for calculating shipping and tax for loyalty.
• siteTypes: array siteTypes
  List of site types supported by this site. Each site type has has to be one of the allowed siteType options (case sensitive).

{
    "properties":{
        "longDescription":{
            "description":"Long site description.",
            "type":"string"
        },
        "priceListGroupList":{
            "description":"List of Price List Groups associated with the site including default Price List Group",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The priceListGroup id associated with the site.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The priceListGroup id associated with site.",
                        "type":"string"
                    }
                }
            }
        },
        "inventoryLocationId":{
            "description":"Defines which inventory this site should use by default.",
            "type":"string"
        },
        "productionURL":{
            "description":"The production base url for storefront. If set, this base url will be used for any absolute generated links e.g. sitemap urls",
            "type":"string"
        },
        "description":{
            "description":"Site description.",
            "type":"string"
        },
        "secondaryCurrency":{
            "description":"Currency used for calculating shipping and tax for loyalty.",
            "type":"string"
        },
        "defaultCatalog":{
            "description":"Default catalog id.",
            "type":"string"
        },
        "defaultBillingCountryId":{
            "description":"Default Billing Country ID.",
            "type":"string"
        },
        "enabled":{
            "description":"Indicates if the site is enabled",
            "type":"boolean"
        },
        "defaultShippingCountryId":{
            "description":"Default Shipping Country ID.",
            "type":"string"
        },
        "payTaxInSecondaryCurrency":{
            "description":"Pay tax in secondary currency",
            "type":"boolean"
        },
        "defaultLocaleId":{
            "description":"The default locale ID.",
            "type":"string"
        },
        "inventoryLocations":{
            "description":"The \"inventoryLocations\" field, defined as an array, enables users to link multiple inventory locations to a site. If the \"inventoryLocations\" array includes at least one element, the \"inventoryLocationId\" field is not considered.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "id":{
            "description":"ID of the site.",
            "type":"string"
        },
        "defaultSite":{
            "description":"Indicates if the site is a default site",
            "type":"boolean"
        },
        "additionalLocaleIds":{
            "description":"Additional locale IDs.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "recommendationsHost":{
            "description":"The host name of the recommendations server.",
            "type":"string"
        },
        "allowAlternateCurrency":{
            "description":"Allows the order to be paid in mixed currencies",
            "type":"boolean"
        },
        "noimage":{
            "description":"Site specific no-image image",
            "type":"string"
        },
        "defaultPriceListGroup":{
            "description":"Default price list group id.",
            "type":"string"
        },
        "payShippingInSecondaryCurrency":{
            "description":"Pay shipping charges in secondary currency",
            "type":"boolean"
        },
        "siteTypes":{
            "description":"List of site types supported by this site. Each site type has has to be one of the allowed siteType options (case sensitive).",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "recommendationsPort":{
            "description":"The port of the recommendations server",
            "type":"string"
        },
        "name":{
            "description":"Site name.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the site.",
            "type":"string"
        }
    }
}

Nested Schema : additionalLocaleIds

Type: array

Additional locale IDs.

Show Source

• Array of: string

{
    "description":"Additional locale IDs.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : inventoryLocations

Type: array

The "inventoryLocations" field, defined as an array, enables users to link multiple inventory locations to a site. If the "inventoryLocations" array includes at least one element, the "inventoryLocationId" field is not considered.

Show Source

• Array of: string

{
    "description":"The \"inventoryLocations\" field, defined as an array, enables users to link multiple inventory locations to a site. If the \"inventoryLocations\" array includes at least one element, the \"inventoryLocationId\" field is not considered.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : priceListGroupList

Type: array

List of Price List Groups associated with the site including default Price List Group

Show Source

• Array of: object items

{
    "description":"List of Price List Groups associated with the site including default Price List Group",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The priceListGroup id associated with the site.",
                "type":"string"
            },
            "id":{
                "description":"The priceListGroup id associated with site.",
                "type":"string"
            }
        }
    }
}

Nested Schema : siteTypes

Type: array

List of site types supported by this site. Each site type has has to be one of the allowed siteType options (case sensitive).

Show Source

• Array of: string

{
    "description":"List of site types supported by this site. Each site type has has to be one of the allowed siteType options (case sensitive).",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The priceListGroup id associated with the site.",
            "type":"string"
        },
        "id":{
            "description":"The priceListGroup id associated with site.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "longDescription":null,
    "priceListGroupList":[
        {
            "repositoryId":"defaultPriceGroup",
            "id":"defaultPriceGroup"
        }
    ],
    "inventoryLocationId":"SiteUS-GlenAllen187",
    "productionURL":"localhostSiteUS:8080",
    "description":"Commerce Cloud Site",
    "secondaryCurrency":"USD",
    "defaultCatalog":{
        "repositoryId":"cloudLakeCatalog"
    },
    "defaultBillingCountryId":null,
    "defaultShippingCountryId":null,
    "enabled":true,
    "payTaxInSecondaryCurrency":true,
    "defaultLocaleId":"1",
    "inventoryLocations":[
        "SiteUS-GlenAllen187",
        "SiteUS-GlenAllen188"
    ],
    "loyaltyPrograms":[
        {
            "programName":"Movie rewards",
            "repositoryId":"siteUS_LP0001",
            "associationDate":"2017-07-05T14:15:37.000Z",
            "programId":"LP0001"
        }
    ],
    "additionalProductionURLs":[
    ],
    "id":"siteUS",
    "defaultSite":true,
    "additionalLocaleIds":[
    ],
    "recommendationsHost":"recs.atgsvcs.example.com",
    "allowAlternateCurrency":true,
    "noimage":"/file/v3496256495527410201/general/19417364_10155381677403926_746513040903355218_o.jpg",
    "defaultPriceListGroup":{
        "repositoryId":"defaultPriceGroup",
        "id":"defaultPriceGroup"
    },
    "payShippingInSecondaryCurrency":true,
    "siteTypes":[
        "commerce"
    ],
    "recommendationsPort":"8080",
    "repositoryId":"siteUS",
    "name":"Commerce Cloud Site"
}

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| |------------------|------------------| |30012|Could not get site for the id| |30011|Given Site id does not exist| |30016|Site internal error.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top