BigCommerce · JSON Structure

Bigcommerce Structure

Structural overview of the BigCommerce API surface; extracted from openapi/.

Type: Properties: 0
E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Structure is a JSON Structure definition published by BigCommerce.

Meta-schema:

JSON Structure

Raw ↑
{
  "provider": "BigCommerce",
  "providerId": "bigcommerce",
  "kind": "json-structure",
  "description": "Structural overview of the BigCommerce API surface; extracted from openapi/.",
  "schemaCount": 12,
  "operationCount": 14,
  "schemas": [
    {
      "name": "Checkout",
      "type": "object",
      "propertyCount": 19,
      "required": []
    },
    {
      "name": "Checkout_Put",
      "type": "object",
      "propertyCount": 1,
      "required": [
        "customer_message"
      ]
    },
    {
      "name": "AppliedCoupon",
      "type": "object",
      "propertyCount": 4,
      "required": [
        "code"
      ]
    },
    {
      "name": "AddressProperties",
      "type": "object",
      "propertyCount": 13,
      "required": [
        "country_code",
        "email"
      ]
    },
    {
      "name": "CreateConsignmentRequest",
      "type": "array",
      "propertyCount": 0,
      "required": []
    },
    {
      "name": "UpdateConsignmentRequest",
      "type": "object",
      "propertyCount": 4,
      "required": []
    },
    {
      "name": "CouponCodeRequest",
      "type": "object",
      "propertyCount": 1,
      "required": []
    },
    {
      "name": "Order",
      "type": "object",
      "propertyCount": 1,
      "required": []
    },
    {
      "name": "CheckoutsSettings",
      "type": "object",
      "propertyCount": 4,
      "required": []
    },
    {
      "name": "CheckoutsSettingsRequest",
      "type": "object",
      "propertyCount": 4,
      "required": []
    },
    {
      "name": "PickupOption",
      "type": "object",
      "propertyCount": 1,
      "required": []
    },
    {
      "name": "MetaOpen",
      "type": "object",
      "propertyCount": 0,
      "required": []
    }
  ],
  "operations": [
    {
      "method": "GET",
      "path": "/checkouts/{checkoutId}",
      "operationId": "getCheckout",
      "summary": "BigCommerce Get a Checkout",
      "tags": [
        "Checkout"
      ]
    },
    {
      "method": "PUT",
      "path": "/checkouts/{checkoutId}",
      "operationId": "updateCheckout",
      "summary": "BigCommerce Update Customer Messages",
      "tags": [
        "Checkout"
      ]
    },
    {
      "method": "POST",
      "path": "/checkouts/{checkoutId}/discounts",
      "operationId": "addCheckoutDiscount",
      "summary": "BigCommerce Add Discount to Checkout",
      "tags": [
        "Checkout Discounts"
      ]
    },
    {
      "method": "POST",
      "path": "/checkouts/{checkoutId}/billing-address",
      "operationId": "addCheckoutBillingAddress",
      "summary": "BigCommerce Add Checkout Billing Address",
      "tags": [
        "Checkout Billing Address"
      ]
    },
    {
      "method": "PUT",
      "path": "/checkouts/{checkoutId}/billing-address/{addressId}",
      "operationId": "updateCheckoutBillingAddress",
      "summary": "BigCommerce Update Checkout Billing Address",
      "tags": [
        "Checkout Billing Address"
      ]
    },
    {
      "method": "POST",
      "path": "/checkouts/{checkoutId}/consignments",
      "operationId": "addCheckoutConsignment",
      "summary": "BigCommerce Add Consignment to Checkout",
      "tags": [
        "Checkout Consignments"
      ]
    },
    {
      "method": "PUT",
      "path": "/checkouts/{checkoutId}/consignments/{consignmentId}",
      "operationId": "updateCheckoutConsignment",
      "summary": "BigCommerce Update Checkout Consignment",
      "tags": [
        "Checkout Consignments"
      ]
    },
    {
      "method": "DELETE",
      "path": "/checkouts/{checkoutId}/consignments/{consignmentId}",
      "operationId": "deleteCheckoutConsignment",
      "summary": "BigCommerce Delete Checkout Consignment",
      "tags": [
        "Checkout Consignments"
      ]
    },
    {
      "method": "POST",
      "path": "/checkouts/{checkoutId}/coupons",
      "operationId": "addCheckoutCoupon",
      "summary": "BigCommerce Add Coupon to Checkout",
      "tags": [
        "Checkout Coupons"
      ]
    },
    {
      "method": "DELETE",
      "path": "/checkouts/{checkoutId}/coupons/{couponCode}",
      "operationId": "deleteCheckoutCoupon",
      "summary": "BigCommerce Delete Checkout Coupon",
      "tags": [
        "Checkout Coupons"
      ]
    },
    {
      "method": "POST",
      "path": "/checkouts/{checkoutId}/orders",
      "operationId": "createOrder",
      "summary": "BigCommerce Create an Order",
      "tags": [
        "Checkout Orders"
      ]
    },
    {
      "method": "GET",
      "path": "/checkouts/settings",
      "operationId": "getCheckoutSettings",
      "summary": "BigCommerce Get Checkout Settings",
      "tags": [
        "Checkout Settings"
      ]
    },
    {
      "method": "PUT",
      "path": "/checkouts/settings",
      "operationId": "updateCheckoutSettings",
      "summary": "BigCommerce Update Checkout Settings",
      "tags": [
        "Checkout Settings"
      ]
    },
    {
      "method": "POST",
      "path": "/checkouts/{checkoutId}/token",
      "operationId": "createCheckoutToken",
      "summary": "BigCommerce Create Checkout Token",
      "tags": [
        "Checkout Token"
      ]
    }
  ]
}