BigCommerce · Example Payload

Bigcommerce Getsiteroutes Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Getsiteroutes 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": "getSiteRoutes",
  "method": "GET",
  "path": "/sites/{site_id}/routes",
  "summary": "BigCommerce Get a Site\u2019s Routes",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "response",
      "example": {
        "data": [
          {
            "id": 1,
            "type": "product",
            "matching": "5",
            "route": "/products?id={id}"
          },
          {
            "id": 2,
            "type": "category",
            "matching": "44",
            "route": "/category/{slug}"
          }
        ],
        "meta": {
          "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 50,
            "current_page": 1,
            "total_pages": 1
          }
        }
      }
    }
  ]
}