BigCommerce · Schema

Update Consignment Request

One or more of these three fields are mandatory. `address` and `line_items` can be updated in one request. `shipping_option_id` has to be updated in a separate request because changing the address or line items can invalidate the previously available shipping options.

E-CommerceRetailCatalogOrderCheckoutPaymentsSoftware-as-a-Service

Properties

Name	Type	Description
address	object
line_items	array
shipping_option_id	string
pickup_option	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateConsignmentRequest",
  "title": "Update Consignment Request",
  "type": "object",
  "properties": {
    "address": {
      "title": "Address Properties",
      "required": [
        "country_code",
        "email"
      ],
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string",
          "description": ""
        },
        "last_name": {
          "type": "string",
          "description": ""
        },
        "email": {
          "type": "string",
          "description": ""
        },
        "company": {
          "type": "string",
          "description": ""
        },
        "address1": {
          "type": "string",
          "description": ""
        },
        "address2": {
          "type": "string",
          "description": ""
        },
        "city": {
          "type": "string",
          "description": ""
        },
        "state_or_province": {
          "type": "string",
          "description": "Represents state or province."
        },
        "state_or_province_code": {
          "type": "string",
          "description": ""
        },
        "country_code": {
          "type": "string",
          "description": ""
        },
        "postal_code": {
          "type": "string",
          "description": ""
        },
        "phone": {
          "pattern": "^\\+?[1-9]\\d{1,14}(x\\d{1-5})?$",
          "type": "string",
          "description": ""
        },
        "custom_fields": {
          "type": "array",
          "description": "",
          "items": {
            "title": "Custom Field",
            "type": "object",
            "properties": {
              "field_id": {
                "type": "string",
                "description": ""
              },
              "field_value": {
                "type": "string",
                "description": "This can also be an array for fields that need to support a list of values (e.g., a set of check boxes.)"
              }
            }
          }
        }
      }
    },
    "line_items": {
      "type": "array",
      "description": "",
      "items": {
        "title": "Consignment Line Item",
        "required": [
          "item_id",
          "quantity"
        ],
        "type": "object",
        "properties": {
          "item_id": {
            "type": "string",
            "description": "Corresponds to `line_items.physical_items[N].id` value from `GET`checkout response."
          },
          "quantity": {
            "type": "integer",
            "description": "",
            "format": "int32"
          }
        }
      }
    },
    "shipping_option_id": {
      "type": "string",
      "description": ""
    },
    "pickup_option": {
      "type": "object",
      "properties": {
        "pickup_method_id": {
          "type": "integer",
          "example": 1
        }
      }
    }
  },
  "description": "One or more of these three fields are mandatory. `address` and `line_items` can be updated in one request. `shipping_option_id` has to be updated in a separate request because 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-updateconsignmentrequest"

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.