BigCommerce · Example Payload

Bigcommerce Createcartmetafield Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Createcartmetafield 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

{
  "operationId": "createCartMetafield",
  "method": "POST",
  "path": "/carts/{cart_id}/metafields",
  "summary": "BigCommerce Create a Cart Metafield",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "permission_set": "app_only",
        "namespace": "Sales Department",
        "key": "Staff Name",
        "value": "Sam",
        "description": "Name of staff member"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "data": {
          "id": "24",
          "key": "Staff Name",
          "value": "Sam",
          "namespace": "Sales Department",
          "permission_set": "app_only",
          "resource_type": "cart",
          "resource_id": "b810114d-9926-45b7-bba5-7633b251154b",
          "description": "Name of staff member",
          "date_created": "2023-11-15 15:16:35+00:00",
          "date_modified": "2023-11-15 15:16:35+00:00"
        },
        "meta": {}
      }
    },
    {
      "status": "404",
      "contentType": "application/json",
      "name": "example-1",
      "example": {
        "status": 404,
        "title": "There was no order found with ID 1010",
        "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes"
      }
    }
  ]
}