BigCommerce · Schema

ShippingConsignment

Shipping consignment

E-CommerceRetailCatalogOrderCheckoutPaymentsSoftware-as-a-Service

Properties

Name	Type	Description
lineItems	array
shippingAddressId	integer
firstName	string
lastName	string
company	string
address1	string
address2	string
city	string
stateOrProvince	string
postalCode	string
country	string
countryCode	string
email	string
phone	string
itemsTotal	integer
itemsShipped	integer
shippingMethod	string
baseCost	number
costExTax	number
costIncTax	number
costTax	number
costTaxClassId	integer
baseHandlingCost	number
handlingCostExTax	number
handlingCostIncTax	number
handlingCostTax	number
handlingCostTaxClassId	integer
shippingZoneId	number
shippingZoneName	string
customFields	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ShippingConsignment",
  "title": "ShippingConsignment",
  "type": "object",
  "properties": {
    "lineItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConsignmentLineItem"
      }
    },
    "shippingAddressId": {
      "type": "integer",
      "example": 1
    },
    "firstName": {
      "type": "string",
      "example": "first1"
    },
    "lastName": {
      "type": "string",
      "example": "last1"
    },
    "company": {
      "type": "string",
      "example": "company1"
    },
    "address1": {
      "type": "string",
      "example": "2802 Skyway Cir"
    },
    "address2": {
      "type": "string",
      "example": "Balcony"
    },
    "city": {
      "type": "string",
      "example": "Austin"
    },
    "stateOrProvince": {
      "type": "string",
      "example": "Texas"
    },
    "postalCode": {
      "type": "string",
      "example": "78704"
    },
    "country": {
      "type": "string",
      "example": "United States"
    },
    "countryCode": {
      "type": "string",
      "example": "US"
    },
    "email": {
      "type": "string",
      "example": "first1@bigcommerce.com"
    },
    "phone": {
      "type": "string",
      "example": "0410123452"
    },
    "itemsTotal": {
      "type": "integer",
      "example": 1
    },
    "itemsShipped": {
      "type": "integer",
      "example": 0
    },
    "shippingMethod": {
      "type": "string",
      "example": "Flat Rate"
    },
    "baseCost": {
      "type": "number",
      "example": 15.5
    },
    "costExTax": {
      "type": "number",
      "example": 15.5
    },
    "costIncTax": {
      "type": "number",
      "example": 16.7
    },
    "costTax": {
      "type": "number",
      "example": 1.2
    },
    "costTaxClassId": {
      "type": "integer",
      "example": 2
    },
    "baseHandlingCost": {
      "type": "number",
      "example": 0
    },
    "handlingCostExTax": {
      "type": "number",
      "example": 0
    },
    "handlingCostIncTax": {
      "type": "number",
      "example": 0
    },
    "handlingCostTax": {
      "type": "number",
      "example": 0
    },
    "handlingCostTaxClassId": {
      "type": "integer",
      "example": 2
    },
    "shippingZoneId": {
      "type": "number",
      "example": 1
    },
    "shippingZoneName": {
      "type": "string",
      "example": "United States"
    },
    "customFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConsignmentFormField"
      }
    }
  },
  "description": "Shipping consignment",
  "x-examples": {
    "example-1": {
      "lineItems": [
        {
          "id": 4
        }
      ],
      "shippingAddressId": 1,
      "firstName": "first1",
      "lastName": "last1",
      "company": "company1",
      "address1": "2802 Skyway Cir",
      "address2": "Balcony",
      "city": "Austin",
      "stateOrProvince": "Texas",
      "postalCode": "78704",
      "country": "United States",
      "countryCode": "US",
      "email": "first1@bigcommerce.com",
      "phone": "0410123452",
      "itemsTotal": 1,
      "itemsShipped": 0,
      "shippingMethod": "Flat Rate",
      "baseCost": 15.5,
      "costExTax": 15.5,
      "costIncTax": 16.7,
      "costTax": 1.2,
      "costTaxClassId": 2,
      "baseHandlingCost": 0,
      "handlingCostExTax": 0,
      "handlingCostIncTax": 0,
      "handlingCostTax": 0,
      "handlingCostTaxClassId": 2,
      "shippingZoneId": 1,
      "shippingZoneName": "United States",
      "customFields": [
        {
          "name": "special note",
          "value": "super rare"
        }
      ]
    }
  },
  "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-shippingconsignment"

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.

GitHub Google LinkedIn

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