{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-update-shipping-address-request-schema.json",
  "title": "UpdateShippingAddressRequest",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/qualpay-customer-vault-api-openapi.yml#/components/schemas/UpdateShippingAddressRequest",
  "required": [
    "shipping_first_name",
    "shipping_id",
    "shipping_last_name"
  ],
  "type": "object",
  "properties": {
    "shipping_id": {
      "type": "integer",
      "description": "<strong>Format: </strong>Variable length, up to 10 N<br><strong>Description: </strong>The ID of the shipping address you want to set as the primary shipping address, returned as the `shipping_id` value for an 'Add a Customer' request. The shipping ID should be associated with the provided `customer_id`.",
      "format": "int64"
    },
    "shipping_first_name": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Shipping first name."
    },
    "shipping_last_name": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Shipping last name."
    },
    "shipping_firm_name": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>Shipping address business name, if applicable. "
    },
    "shipping_addr1": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong>Shipping address line 1."
    },
    "shipping_addr2": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong>Shipping address line 2."
    },
    "shipping_city": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>Shipping city."
    },
    "shipping_state": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 3 AN<br><strong>Description: </strong>Shipping state."
    },
    "shipping_country": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong>Shipping country."
    },
    "shipping_country_code": {
      "type": "string",
      "description": "<strong>Format: </strong>Fixed length, 3 AN<br><strong>Description: </strong>ISO numeric country code for the shipping address. Refer to <a href=\"/docs/references\" target=\"_blank\">Country Codes</a> for a list of country codes."
    },
    "shipping_zip": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 10 AN<br><strong>Description: </strong>Shipping zip code."
    },
    "shipping_zip4": {
      "type": "string",
      "description": "<strong>Format: </strong>Fixed length, 4 N<br><strong>Description: </strong>Shipping zip+4 code, if applicable."
    },
    "primary": {
      "type": "boolean",
      "description": "<strong>Description: </strong>Set this field to `true` if this should be the default address. <br><strong>Default: </strong>false"
    },
    "merchant_id": {
      "type": "integer",
      "description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on behalf of another merchant.<br><strong>Conditional Requirement: </strong>Required if this request is on behalf of another merchant.",
      "format": "int64"
    }
  }
}