{
  "$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
}