Content

On this page, we’ll dive into all the content related endpoints i.e. get FAQs, get site nav menu, get redirection rules, etc.

GET/api/v2/content/nav

This endpoint retrieves all the nav menu.

Developers - API Operations:

Operation	Endpoint	Response
Site nav menu	`/api/v2/content/nav`	Get site nav menu

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
header
Type
array
Description
Array containing various attributes for the navbar
Name
value
Type
string
Description
Value content of the attribute
Name
recordId
Type
string
Description
String containg the recordId value
Name
caption
Type
string
Description
Caption content value
Name
navPosition
Type
number
Description
The position of nav value
Name
widthPct
Type
number
Description
Width content value
Name
alignmentType
Type
number
Description
Type of alignment value
Name
displayOrder
Type
number
Description
Order of the display associated with the entity
Name
columnCount
Type
number
Description
Count of column value
Name
isTopNav
Type
boolean
Description
Flag to check is it top nav
Name
headerContent
Type
string
Description
Contents of the header
Name
footerContent
Type
string
Description
Contents of the footer
Name
htmlAttrinutes
Type
string
Description
Html attributes for the entity
Name
hyperLink
Type
string
Description
Hyperlink associated with the entity
Name
navBlocks
Type
string
Description
NavBlock associated with the entity

Request

GET

/api/v2/content/nav

curl --location --request GET 'https://api20.bettercommerce.io/api/v2/content/nav' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
"statusCode": 200,
"status": "aute aliquip ex",
"errors": [
    "ea"
],
"success": false,
"message": "sunt exercitation consequat reprehenderit officia",
"messageCode": "voluptate",
"result": {
"header": [
    {
        "recordId": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "caption": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "navPosition": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "widthPct": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "alignmentType": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "displayOrder": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "columnCount": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "isTopNav": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "headerContent": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "footerCotent": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "htmlAttrinutes": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "hyperlink": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "channels": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "navBlocks": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        }
    }
],
"footer": [
    {
        "recordId": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "caption": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "navPosition": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "widthPct": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "alignmentType": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "displayOrder": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "columnCount": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "isTopNav": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "headerContent": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "footerCotent": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "htmlAttrinutes": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "hyperlink": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "channels": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "navBlocks": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
        }
    }
]
}
}

GET/api/v2/content/feed?slug={{slug}}

Get product feed based on slug

This endpoint retrieves the product feed based on the slug passed.

Developers - API Operations:

Operation	Endpoint	Response
Product feed based on slug	`/api/v2/content/feed?slug={{slug}}`	Get product feed based on slug

Required attributes

Name
slug
Type
string
Description
Unique slug for each product.

Response attributes

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
id
Type
string
Description
Id of the category
Name
feedName
Type
string
Description
Name of the feed content
Name
slug
Type
string
Description
Unique slug for each entity.
Name
blobPath
Type
string
Description
Blob path content of the feed
Name
downloadLink
Type
string
Description
Downloadable link for the entity

Request

GET

/api/v2/content/feed?slug={{slug}}

curl --location --request GET 'https://api20.bettercommerce.io/api/v2/content/feed?slug=proident culpa anim nisi aliquip' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
"statusCode": 407,
"status": "id ullamco",
"errors": [
"reprehenderit ea aliqua",
"incididunt"
],
"success": true,
"message": "dolore",
"messageCode": "et",
"result": {
"id": "00000000-0000-0000-0000-000000000000",
"feedName": "et exercitation officia",
"slug": "voluptate nulla nisi",
"blobPath": "cillum laboris deserunt sit",
"downloadLink": "eu tempor laborum Ut"
}
}

GET/api/v2/content/redirects

Get redirection rules

This endpoint enables the user to get all the redirection rules.

Developers - API Operations:

Operation	Endpoint	Response
Redirection rules	`/api/v2/content/redirects`	Get redirection rules

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
oldUrl
Type
string
Description
Old url of the entity
Name
newUrl
Type
string
Description
New url of the entity
Name
redirectTypeValue
Type
string
Description
Redirect type value of the entity

Request

GET

/api/v2/content/redirects

curl --location --request GET 'https://api20.bettercommerce.io/api/v2/content/redirects' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
 "statusCode": 415,
 "status": "cillum occaecat nostrud",
 "errors": [
  "labore culpa"
 ],
 "success": false,
 "message": "officia adipisicing amet veniam",
 "messageCode": "aute amet labore",
 "result": [
  {
   "oldUrl": "non",
   "newUrl": "incididunt",
   "redirectTypeValue": 26253288
  }
 ]
}

GET/api/v2/content/masterdata/:id

Get masterdata based on table Id

This endpoint enables the user to retrieve the masterdata based on the table id passed.

Developers - API Operations:

Operation	Endpoint	Response
Masterdata based on id	`/api/v2/content/masterdata/:id`	Get masterdata based on table id

Required attributes

Name
id
Type
string
Description
Unique identifier for the attachment.

Response attributes

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
table
Type
number
Description
Table number value
Name
itemValue
Type
string
Description
The value of item.
Name
isActive
Type
boolean
Description
Flag to check is product active
Name
itemText
Type
string
Description
The text related to item.
Name
displayOrder
Type
number
Description
The result of display Order.
Name
parentItemValue
Type
string
Description
The result of parent Item Value.
Name
customField1
Type
string
Description
String containing customField1 values
Name
customField2
Type
string
Description
String containing customField2 values
Name
customField3
Type
string
Description
String containing customField3 values
Name
customField4
Type
string
Description
String containing customField4 values
Name
isDefault
Type
boolean
Description
Flag to check isDefault.

Request

GET

/api/v2/content/masterdata/:id

curl --location --request GET 'https://api20.bettercommerce.io/api/v2/content/masterdata/1033' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
"statusCode": 304,
"status": "culpa voluptate sint E",
"errors": [
"reprehenderit"
],
"success": true,
"message": "aliquip",
"messageCode": "elit fugiat officia cillum",
"result": [
{
"table": 1039,
"itemValue": "eiusmod adipisicing incididunt exercitation s",
"itemText": "deserunt amet reprehenderit in",
"displayOrder": -97872487,
"parentItemValue": "enim qui",
"isActive": false,
"customField1": "pariatur sed eu mollit",
"customField2": "incidid",
"customField3": "Excepteur",
"customField4": "elit eu",
"isDefault": true
}
]
}

GET/api/v2/content/microsite/all

Get list of active microsites

This endpoint enables the user to retrieve a list of active microsites.

Developers - API Operations:

Operation	Endpoint	Response
Active microsites	`/api/v2/content/microsite/all`	Get a list of active microsites

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
id
Type
string
Description
Id of the entity
Name
name
Type
string
Description
Name of the entity
Name
code
Type
string
Description
Code value of the entity
Name
slug
Type
string
Description
Slug to be passed to retrive details
Name
logo
Type
string
Description
URL of the Logo Image
Name
isPrimary
Type
boolean
Description
Flag to check isPrimary or not
Name
priority
Type
number
Description
Priority value of the entity
Name
displayOrder
Type
number
Description
DisplayOrder value of the entity
Name
siteType
Type
number
Description
SiteType value of the entity
Name
countryCode
Type
string
Description
Country code provided in the attribute
Name
defaultLangCode
Type
string
Description
Default language code content
Name
defaultLangCulture
Type
string
Description
Default language culture content
Name
defaultCurrencyCode
Type
string
Description
Default currency code content
Name
isActive
Type
boolean
Description
Flag to check is product active
Name
disableAccess
Type
boolean
Description
Flag to check if access is disabled

Request

GET

/api/v2/content/microsite/all

curl --location --request GET 'https://api20.bettercommerce.io/api/v2/content/microsite/all' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
 "statusCode": 304,
 "status": "Duis occaecat nostrud officia",
 "errors": [
  "amet ex occaecat dolore ut"
 ],
 "success": false,
 "message": "id laboris elit in",
 "messageCode": "consectetur officia tempor sunt",
 "result": [
  {
   "id": "magna id proident deserunt dolore",
   "name": "ipsum magna velit amet",
   "code": "in",
   "slug": "anim Lorem cillum",
   "logo": "id",
   "isPrimary": false,
   "priority": -22570779,
   "displayOrder": 14485262,
   "siteType": -2089602,
   "countryCode": "dolor labore cupidatat exercitat",
   "defaultLangCode": "irure sed",
   "defaultLangCulture": "sed deserunt mollit",
   "defaultCurrencyCode": "sed Lorem anim",
   "isActive": true,
   "disableAccess": false
  }
 ]
}

Content

Get site nav menu

Developers - API Operations:

Request

Response

Get product feed based on slug

Developers - API Operations:

Required attributes

Response attributes

Request

Response

Get redirection rules

Developers - API Operations:

Request

Response

Get masterdata based on table Id

Developers - API Operations:

Required attributes

Response attributes

Request

Response

Get list of active microsites

Developers - API Operations:

Request

Response