1. REST API for Oracle Commerce Cloud 21B
  2. Tasks
  3. Admin
  4. Locations

createLocation

post

/ccadmin/v1/locations

Create Location. Create a location.

Request

Supported Media Types
Body ()
Root Schema : createLocation_request
Type: object
Show Source
Example:
{
    "country":"USA",
    "hours":"9:00am - 5:00pm",
    "address3":null,
    "endDate":"2017-04-25",
    "address2":"Suite 101",
    "city":"Glen Allen",
    "address1":"4870 Sadler Rd.",
    "latitude":37.6659833,
    "postalCode":"23060",
    "county":"Henrico",
    "stateAddress":"VA",
    "sites":[
        {
            "id":"siteUS"
        },
        {
            "id":"siteCA"
        }
    ],
    "type":"store",
    "externalLocationId":"187",
    "phoneNumber":"(617) 386-1200",
    "siteGroups":[
        {
            "id":"siteGroup1"
        },
        {
            "id":"siteGroup2"
        }
    ],
    "locationId":"CRSHome-GlenAllen187",
    "name":"CRS Home - Glen Allen #187",
    "faxNumber":"(617) 386-1200",
    "startDate":"2016-04-25",
    "email":"store187@example.com",
    "longitude":-77.5063697
}
Nested Schema : siteGroups
Type: array
List of site groups. A location can be constrained to a list of site groups. If no site group is defined, the location is available on all sites.
Show Source
Nested Schema : sites
Type: array
List of sites. A location can be constrained to a list of sites. If no site is defined, the location is available on all sites.
Show Source
Nested Schema : items
Type: object
Show Source
  • The site group ID to associate this location with. The site group must already exist.
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : createLocation_response
Type: object
Show Source
Nested Schema : siteGroups
Type: array
List of site groups. A location can be constrained to a list of site groups. If no site group is defined, the location is available on all sites.
Show Source
Nested Schema : sites
Type: array
List of sites. A location can be constrained to a list of sites. If no site is defined, the location is available on all sites.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "country":"USA",
    "distance":null,
    "endDate":"2017-04-25T00:00:00.000Z",
    "city":"Glen Allen",
    "latitude":37.6659833,
    "postalCode":"23060",
    "county":"Henrico",
    "stateAddress":"VA",
    "sites":[
        {
            "repositoryId":"siteUS",
            "id":"siteUS"
        },
        {
            "repositoryId":"siteCA",
            "id":"siteCA"
        }
    ],
    "type":"store",
    "locationId":"CRSHome-GlenAllen187",
    "links":[
        {
            "rel":"self",
            "href":"https://www.example.com/ccadminui/v1/locations"
        }
    ],
    "email":"store187@example.com",
    "longitude":-77.5063697,
    "hours":"9:00am - 5:00pm",
    "address3":null,
    "address2":"Suite 101",
    "address1":"4870 Sadler Rd.",
    "externalLocationId":"187",
    "phoneNumber":"(617) 386-1200",
    "siteGroups":[
        {
            "repositoryId":"siteGroup1"
        },
        {
            "repositoryId":"siteGroup2"
        }
    ],
    "repositoryId":"4000345",
    "name":"CRS Home - Glen Allen #187",
    "faxNumber":"(617) 386-1200",
    "startDate":"2016-04-25T00:00:00.000Z"
}

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| |------------------|------------------| |51120|Location id string value required.| |51111|Failed to create location.| |51110|An internal error occurred while processing the request to create location.| |51113|Location record already exists.| |51112|No properties passed in to create location.| |51115|Invalid location site property.| |51114|Invalid location type, must be 'store' or 'location'.| |51117|Invalid location date property (endDate and/or startDate).| |51116|Invalid location site group property.| |51119|Location name string value required.| |51118|Invalid location coordinate property (latitude and/or longitude).|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top