BigCommerce · Example Payload

Bigcommerce Updatepages Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Updatepages 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": "updatePages",
  "method": "PUT",
  "path": "/content/pages",
  "summary": "BigCommerce Update Pages",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "update meta descriptions for two pages",
      "example": {
        "data": [
          {
            "id": 20,
            "channel_id": 1,
            "name": "all about powder detergents",
            "meta_title": "",
            "is_visible": false,
            "parent_id": 0,
            "sort_order": 0,
            "meta_keywords": null,
            "type": "page",
            "meta_description": "cornpone",
            "is_homepage": false,
            "is_customers_only": false,
            "search_keywords": ""
          },
          {
            "id": 19,
            "channel_id": 1,
            "name": "sign up to dream big",
            "meta_title": "",
            "email": "",
            "is_visible": false,
            "parent_id": 0,
            "sort_order": 0,
            "meta_keywords": null,
            "contact_fields": "",
            "type": "contact_form",
            "meta_description": "arugula",
            "is_homepage": false,
            "is_customers_only": false,
            "search_keywords": ""
          }
        ],
        "meta": {}
      }
    },
    {
      "status": "404",
      "contentType": "application/problem+json",
      "name": "example-1",
      "example": {
        "status": 0,
        "title": "string",
        "type": "string"
      }
    },
    {
      "status": "422",
      "contentType": "application/problem+json",
      "name": "missing required field for type raw",
      "example": {
        "status": 422,
        "title": "Input is invalid",
        "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes",
        "detail": "missing the required field: body"
      }
    }
  ]
}