BigCommerce · Example Payload

Bigcommerce Createbrandmetafield Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Createbrandmetafield 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": "createBrandMetafield",
  "method": "POST",
  "path": "/catalog/brands/{brand_id}/metafields",
  "summary": "BigCommerce Create a Brand Metafield",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "example-1",
      "example": {
        "data": {
          "id": 4,
          "key": "location_id",
          "value": "Shelf 3, Bin 5",
          "namespace": "App Namespace",
          "permission_set": "app_only",
          "resource_type": "brand",
          "resource_id": 137,
          "description": "Where products are located",
          "date_created": "2021-08-06T19:15:35+00:00",
          "date_modified": "2021-08-06T19:15:35+00:00"
        },
        "meta": {}
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "example-2",
      "example": {
        "data": {
          "id": 6,
          "key": "Location",
          "value": "4HG",
          "namespace": "Warehouse Locations",
          "permission_set": "app_only",
          "resource_type": "category",
          "resource_id": 111,
          "description": "Location in the warehouse.",
          "date_created": "2018-05-07T20:14:17+00:00",
          "date_modified": "2018-05-07T20:14:17+00:00"
        },
        "meta": {}
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "example-3",
      "example": {
        "data": {
          "id": 4,
          "key": "location_id",
          "value": "Shelf 3, Bin 5",
          "namespace": "App Namespace",
          "permission_set": "app_only",
          "resource_type": "brand",
          "resource_id": 137,
          "description": "Where products are located.",
          "date_created": "2021-08-06T19:15:35+00:00",
          "date_modified": "2021-08-06T19:15:35+00:00"
        },
        "meta": {}
      }
    }
  ]
}