BigCommerce · Example Payload

Bigcommerce Createpage Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Createpage Example is an example object payload from BigCommerce, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "createPage",
  "method": "POST",
  "path": "/pages",
  "summary": "BigCommerce Create a Page",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "parent_id": 5,
        "type": "page",
        "contact_fields": "fullname,companyname,phone,orderno,rma",
        "email": "janedoes@example.com",
        "name": "Contact Form",
        "url": "/contact-us/",
        "meta_description": "string",
        "body": "<p>We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.</p>",
        "mobile_body": "0",
        "has_mobile_version": false,
        "is_visible": true,
        "is_homepage": false,
        "meta_title": "string",
        "layout_file": "page.html",
        "sort_order": 3,
        "search_keywords": "string",
        "meta_keywords": "string",
        "feed": "string",
        "link": "string",
        "content_type": "text/html"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": 6,
        "parent_id": 5,
        "type": "page",
        "contact_fields": "fullname,companyname,phone,orderno,rma",
        "email": "janedoes@example.com",
        "name": "Contact Form",
        "url": "/contact-us/",
        "meta_description": "",
        "body": "We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.",
        "mobile_body": "",
        "has_mobile_version": false,
        "feed": "",
        "link": "",
        "is_visible": true,
        "is_homepage": false,
        "layout_file": "page.html",
        "sort_order": 3,
        "meta_title": "",
        "search_keywords": "",
        "meta_keywords": ""
      }
    }
  ]
}