Qualpay · Schema
UpdateShippingAddressRequest
PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization
Properties
| Name | Type | Description |
|---|---|---|
| shipping_id | integer | Format: Variable length, up to 10 N Description: The ID of the shipping address you want to set as the primary shipping address, returned as the `shipping_id` valu |
| shipping_first_name | string | Format: Variable length, up to 32 AN Description: Shipping first name. |
| shipping_last_name | string | Format: Variable length, up to 32 AN Description: Shipping last name. |
| shipping_firm_name | string | Format: Variable length, up to 64 AN Description: Shipping address business name, if applicable. |
| shipping_addr1 | string | Format: Variable length, up to 128 AN Description: Shipping address line 1. |
| shipping_addr2 | string | Format: Variable length, up to 128 AN Description: Shipping address line 2. |
| shipping_city | string | Format: Variable length, up to 64 AN Description: Shipping city. |
| shipping_state | string | Format: Variable length, up to 3 AN Description: Shipping state. |
| shipping_country | string | Format: Variable length, up to 128 AN Description: Shipping country. |
| shipping_country_code | string | Format: Fixed length, 3 AN Description: ISO numeric country code for the shipping address. Refer to Country Codes fo |
| shipping_zip | string | Format: Variable length, up to 10 AN Description: Shipping zip code. |
| shipping_zip4 | string | Format: Fixed length, 4 N Description: Shipping zip+4 code, if applicable. |
| primary | boolean | Description: Set this field to `true` if this should be the default address. Default: false |
| merchant_id | integer | Format: Variable length, up to 16 AN Description: Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on b |
JSON Schema
{
"$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"
}
}
}
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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/qualpay-update-shipping-address-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.