BigCommerce · Schema

Update Consignment Request

One or more of these three fields is mandatory. You can update address and line items in one request. You have to update shipping option ID or pickup option ID in a separate request since changing the address or line items can invalidate the previously available shipping options.

E-CommerceRetailCatalogOrderCheckoutPaymentsSoftware-as-a-Service

Properties

Name	Type	Description
shippingAddress	object
address	object
lineItems	array
shippingOptionId	string
pickupOption	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NewUpdateConsignment",
  "title": "Update Consignment Request",
  "type": "object",
  "properties": {
    "shippingAddress": {
      "type": "object",
      "properties": {},
      "x-deprecated": true
    },
    "address": {
      "title": "Address Properties",
      "required": [
        "countryCode"
      ],
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string",
          "description": ""
        },
        "lastName": {
          "type": "string",
          "description": ""
        },
        "email": {
          "type": "string",
          "description": ""
        },
        "company": {
          "type": "string",
          "description": ""
        },
        "address1": {
          "type": "string",
          "description": ""
        },
        "address2": {
          "type": "string",
          "description": ""
        },
        "city": {
          "type": "string",
          "description": ""
        },
        "stateOrProvince": {
          "type": "string",
          "description": "Represents state or province."
        },
        "stateOrProvinceCode": {
          "type": "string",
          "description": ""
        },
        "countryCode": {
          "type": "string",
          "description": "ISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)"
        },
        "postalCode": {
          "type": "string",
          "description": ""
        },
        "phone": {
          "pattern": "^\\+?[1-9]\\d{1,14}(x\\d{1-5})?$",
          "type": "string",
          "description": ""
        },
        "customFields": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "fieldId": {
                "type": "string"
              },
              "fieldValue": {
                "type": "string"
              }
            }
          }
        },
        "shouldSaveAddress": {
          "type": "boolean",
          "description": "Indicates whether we should add this address to the customer address book."
        }
      }
    },
    "lineItems": {
      "type": "array",
      "description": "",
      "items": {
        "title": "Consignment Line Item",
        "required": [
          "itemId",
          "quantity"
        ],
        "type": "object",
        "properties": {
          "itemId": {
            "type": "string",
            "description": ""
          },
          "quantity": {
            "type": "integer",
            "description": "",
            "format": "int32"
          }
        }
      }
    },
    "shippingOptionId": {
      "type": "string",
      "description": ""
    },
    "pickupOption": {
      "type": "object",
      "properties": {
        "pickupMethodId": {
          "type": "integer"
        }
      }
    }
  },
  "description": "One or more of these three fields is mandatory. You can update address and line items in one request. You have to update shipping option ID or pickup option ID in a separate request since changing the address or line items can invalidate the previously available shipping options.",
  "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-newupdateconsignment"

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.