Skip to main content

SustainabilityPage

Attributes
statusenumrequired

The sustainability page status which determines whether it is visible to the public.

Enum:
  • enabled
  • disabled

slugstring^[a-z0-9.-]+$required

The sustainability page slug. The slug is used to identify the page publicly and should be unique.


titleenumrequired

The sustainability page title stat format.

Enum:
  • by_volume
  • by_price

description

custom_descriptionstringrequired

The sustainability page custom description. Only displayed when description is set to by_custom_description.


sectionsarray of enumrequired

The sustainability page sections that will be displayed in the page. Only a single instance of each section type is allowed and the order is irrelevant.

  • Endpoints
  • SustainabilityPage
  • {
      "status": "enabled",
      "slug": "acme",
      "title": "by_volume",
      "description": "by_equivalent",
      "custom_description": "This is a custom description",
      "sections": [
        "bundles_breakdown",
        "certificates"
      ]
    }