BigCommerce · Example Payload

Bigcommerce Getallcategories Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Getallcategories 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": "getAllCategories",
  "method": "GET",
  "path": "/catalog/trees/categories",
  "summary": "BigCommerce Get All Categories",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Get Category 12",
      "example": {
        "data": [
          {
            "category_id": 12,
            "category_uuid": "d1964756-5e1d-4c72-9fa0-e1a3f7be4a34",
            "parent_id": 2,
            "name": "Bath",
            "description": "<p>We offer a wide variety of products perfect for relaxing</p>",
            "views": 1050,
            "sort_order": 3,
            "page_title": "Bath",
            "meta_keywords": [
              "string"
            ],
            "meta_description": "string",
            "layout_file": "category.html",
            "image_url": "https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png",
            "is_visible": true,
            "search_keywords": "string",
            "default_product_sort": "use_store_settings",
            "url": {
              "path": "string",
              "is_customized": true
            }
          }
        ],
        "meta": {
          "pagination": {
            "total": 246,
            "count": 5,
            "per_page": 5,
            "current_page": 1,
            "total_pages": 50,
            "links": {
              "previous": "?limit=5&page=1",
              "current": "?limit=5&page=2",
              "next": "?limit=5&page=3"
            }
          }
        }
      }
    }
  ]
}