BigCommerce · Example Payload

Bigcommerce Getbrand Example

E-CommerceRetailCatalogOrderCheckoutPaymentsSoftware-as-a-Service

Bigcommerce Getbrand 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": "getBrand",
  "method": "GET",
  "path": "/catalog/brands/{brand_id}",
  "summary": "BigCommerce Get a Brand",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "data": {
          "id": 50,
          "name": "Common Good",
          "meta_keywords": [
            "modern",
            "clean",
            "contemporary"
          ],
          "meta_description": "Common Good is a modern brand",
          "image_url": "",
          "search_keywords": "kitchen, laundry, cart, storage",
          "custom_url": {
            "url": "/brands/Common-Good.html",
            "is_customized": false
          }
        },
        "meta": {}
      }
    }
  ]
}