updateRobotsFile

put

/ccadmin/v1/merchant/robots

Update Robots File. Saves robots.txt file served by production storefront. Endpoint takes the robots source as text/plain. Response code of 200 is returned if successful.

• Request
• Response
• Examples

Request

Supported Media Types

• text/plain

Body Parameter

Root Schema : updateRobotsFile_request

Example

curl -H 'Content-type: text/plain' -H 'Authorization: Bearer {Access-Token}' -H PUT https://{www.somehost.com}/ccadmin/v1/merchant/robots --data-binary @- <<EOF
User-agent: *
Disallow: /cart
Disallow: /checkout
Disallow: /profile
Disallow: /searchresults
Disallow: /confirmation
Disallow: /wishlist_settings
Disallow: /wishlist

Sitemap: http://{occs-host}/sitemap.xml
EOF

Properties

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateRobotsFile_response

Properties

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| |------------------|------------------| |30013|Encountered unexpected token 'abc' on line 4 when parsing robots.txt file.|

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

curl -H 'Content-type: text/plain' -H 'Authorization: Bearer {Access-Token}' -H PUT https://{www.somehost.com}/ccadmin/v1/merchant/robots --data-binary @- <<EOF
User-agent: *
Disallow: /cart
Disallow: /checkout
Disallow: /profile
Disallow: /searchresults
Disallow: /confirmation
Disallow: /wishlist_settings
Disallow: /wishlist

Sitemap: http://{occs-host}/sitemap.xml
EOF