Webflow API and Documentation · Example Payload

Webflow Api And Documentation Webflow List Products Example

CMSContent ManagementEcommerceNo-CodePublishingWeb Development

Webflow Api And Documentation Webflow List Products Example is an example object payload from Webflow API and Documentation, 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": "list-products",
  "method": "GET",
  "path": "/sites/{site_id}/products",
  "summary": "Webflow List Products & SKUs",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "code": "validation_error",
        "message": "Validation Error: Provided ID is invalid",
        "externalReference": null,
        "details": []
      }
    },
    {
      "status": "401",
      "contentType": "application/json",
      "example": {
        "code": "not_authorized",
        "message": "Request not authorized",
        "externalReference": null,
        "details": []
      }
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": {
        "code": "missing_scopes",
        "message": "OAuthForbidden: You are missing the following scopes - components:write",
        "externalReference": null,
        "details": []
      }
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": {
        "code": "resource_not_found",
        "message": "Requested resource not found: The site cannot be found",
        "externalReference": null,
        "details": []
      }
    },
    {
      "status": "409",
      "contentType": "application/json",
      "example": {
        "code": "ecommerce_not_enabled",
        "message": "Ecommerce is not yet initialized",
        "externalReference": null,
        "details": []
      }
    },
    {
      "status": "429",
      "contentType": "application/json",
      "example": {
        "code": "too_many_requests",
        "message": "Too many requests",
        "externalReference": null,
        "details": []
      }
    },
    {
      "status": "500",
      "contentType": "application/json",
      "example": {
        "code": "internal_error",
        "message": "An Internal Error occurred",
        "externalReference": null,
        "details": []
      }
    }
  ]
}