BigCommerce · Schema

consignment_Full

This allows us to have multiple shipping addresses. Where there is only one shipping address, this array will contain only one value, with all the items.

E-CommerceRetailCatalogOrderCheckoutPaymentsSoftware-as-a-Service

Properties

Name Type Description
id string
shippingAddress object
address object
selectedPickupOption object
availableShippingOptions array This is available only when "include=consignments.availableShippingOptions" is present in the URL.
selectedShippingOption object
couponDiscounts array List of consignment discounts applied through coupons.
discounts array List of consignment discounts applied through cart level discounts.
shippingCost number The shipping cost for this consignment.
handlingCost number The handling cost of shipping for this consignment.
lineItemIds array
View JSON Schema on GitHub

JSON Schema

bigcommerce-consignment-full-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/consignment_Full",
  "title": "consignment_Full",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": ""
    },
    "shippingAddress": {
      "type": "object",
      "properties": {},
      "x-deprecated": true
    },
    "address": {
      "$ref": "#/components/schemas/address_Full"
    },
    "selectedPickupOption": {
      "$ref": "#/components/schemas/PickupOption"
    },
    "availableShippingOptions": {
      "type": "array",
      "description": "This is available only when \"include=consignments.availableShippingOptions\" is present in the URL.",
      "items": {
        "$ref": "#/components/schemas/consignmentAvailableShippingOptions"
      }
    },
    "selectedShippingOption": {
      "title": "Selected Shipping Option",
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "description": "Read only.",
          "readOnly": true
        },
        "id": {
          "type": "string",
          "description": ""
        },
        "type": {
          "type": "string",
          "description": "Specifies the type of shipping option; for example, flat rate, UPS, etc."
        },
        "imageUrl": {
          "type": "string",
          "description": ""
        },
        "cost": {
          "type": "number",
          "description": "",
          "format": "double"
        },
        "transitTime": {
          "type": "string",
          "description": "An estimate of the arrival time."
        },
        "additionalDescription": {
          "type": "string",
          "description": "Read only. Field used for Shipping Provider API.",
          "readOnly": true
        }
      }
    },
    "couponDiscounts": {
      "type": "array",
      "description": "List of consignment discounts applied through coupons.",
      "items": {
        "title": "Consignment Coupon Discount",
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Coupon code that applied this discount."
          },
          "amount": {
            "type": "number",
            "description": "",
            "format": "double"
          }
        }
      }
    },
    "discounts": {
      "type": "array",
      "description": "List of consignment discounts applied through cart level discounts.",
      "items": {
        "title": "Consignment Discount",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Discount rule ID that applied this discount."
          }
        }
      }
    },
    "shippingCost": {
      "type": "number",
      "description": "The shipping cost for this consignment.",
      "format": "double"
    },
    "handlingCost": {
      "type": "number",
      "description": "The handling cost of shipping for this consignment.",
      "format": "double"
    },
    "lineItemIds": {
      "type": "array",
      "description": "",
      "items": {
        "type": "string"
      }
    }
  },
  "description": "This allows us to have multiple shipping addresses. Where there is only one shipping address, this array will contain only one value, with all the items.",
  "x-internal": false
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/bigcommerce-consignment-full"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.