{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/aura-historia-com/json-schema/aura-historia-com-shipping-profile-data-schema.json", "title": "ShippingProfileData", "description": "Protected management detail; retains retired references and site assertions, excludes evidence. Never expose this DTO as public collection addresses.", "x-generated": "2026-10-29", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/_original/aura-historia-com-internal-api-filtered-openapi.yml#/components/schemas/ShippingProfileData", "type": "object", "additionalProperties": false, "required": [ "shippingProfileId", "listingSourceId", "managementRevision", "termsRevision", "lifecycle", "content" ], "properties": { "shippingProfileId": { "type": "string", "pattern": "^shp_[0-7][0-9a-hjkmnp-tv-z]{25}$" }, "listingSourceId": { "type": "string", "pattern": "^ls_[0-7][0-9a-hjkmnp-tv-z]{25}$" }, "managementRevision": { "type": "integer", "minimum": 1, "maximum": 9223372036854775807 }, "termsRevision": { "type": "integer", "minimum": 1, "maximum": 9223372036854775807 }, "lifecycle": { "type": "string", "enum": [ "ACTIVE", "RETIRED" ] }, "content": { "$ref": "#/$defs/ShippingProfileContentData" } }, "$defs": { "AdvertisedDeliveryTermsData": { "type": "object", "additionalProperties": false, "required": [ "schema", "shipping", "collection" ], "properties": { "schema": { "type": "string", "enum": [ "SHIP_TERMS_V1" ] }, "shipping": { "anyOf": [ { "$ref": "#/$defs/ShippingPolicyData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] }, "collection": { "anyOf": [ { "$ref": "#/$defs/ShippingCollectionData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] } }, "description": "Strict versioned advertised terms. All fields, including nullable fields, are required; unknown fields/codes are rejected. Absence, explicit prohibition and retirement have different meanings. This contract supplies no quote." }, "ShippingActorData": { "oneOf": [ { "$ref": "#/$defs/ShippingActorDataListingSource" }, { "$ref": "#/$defs/ShippingActorDataBuyer" }, { "$ref": "#/$defs/ShippingActorDataParty" } ] }, "ShippingActorDataBuyer": { "type": "object", "additionalProperties": false, "required": [ "kind" ], "properties": { "kind": { "type": "string", "enum": [ "BUYER" ] } } }, "ShippingActorDataListingSource": { "type": "object", "additionalProperties": false, "required": [ "kind" ], "properties": { "kind": { "type": "string", "enum": [ "LISTING_SOURCE" ] } } }, "ShippingActorDataParty": { "type": "object", "additionalProperties": false, "required": [ "kind", "party_id" ], "properties": { "kind": { "type": "string", "enum": [ "PARTY" ] }, "party_id": { "type": "string", "pattern": "^pty_[0-7][0-9a-hjkmnp-tv-z]{25}$" } } }, "ShippingApplicabilityData": { "type": "object", "additionalProperties": false, "required": [ "class", "variants", "quantity", "threshold" ], "properties": { "class": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 128 }, "variants": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 64, "minItems": 1 }, "quantity": { "anyOf": [ { "$ref": "#/$defs/ShippingQuantityData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] }, "threshold": { "anyOf": [ { "$ref": "#/$defs/ShippingThresholdData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] } }, "description": "Class and variant codes are scoped to the path ListingSource; absence must be explicit null." }, "ShippingAreaData": { "oneOf": [ { "$ref": "#/$defs/ShippingAreaDataAnywhere" }, { "$ref": "#/$defs/ShippingAreaDataDomestic" }, { "$ref": "#/$defs/ShippingAreaDataCountry" }, { "$ref": "#/$defs/ShippingAreaDataSubdivision" }, { "$ref": "#/$defs/ShippingAreaDataPostal" }, { "$ref": "#/$defs/ShippingAreaDataUnresolved" } ] }, "ShippingAreaDataAnywhere": { "type": "object", "additionalProperties": false, "required": [ "kind" ], "properties": { "kind": { "type": "string", "enum": [ "ANYWHERE" ] } } }, "ShippingAreaDataCountry": { "type": "object", "additionalProperties": false, "required": [ "kind", "code", "reference_release" ], "properties": { "kind": { "type": "string", "enum": [ "COUNTRY" ] }, "code": { "type": "string" }, "reference_release": { "type": "string", "enum": [ "iso-codes-4.20.1" ] } } }, "ShippingAreaDataDomestic": { "type": "object", "additionalProperties": false, "required": [ "kind" ], "properties": { "kind": { "type": "string", "enum": [ "DOMESTIC" ] } } }, "ShippingAreaDataPostal": { "type": "object", "additionalProperties": false, "required": [ "kind", "version", "country", "reference_release", "form" ], "properties": { "kind": { "type": "string", "enum": [ "POSTAL" ] }, "version": { "type": "string", "enum": [ "POSTAL_RULE_V1" ] }, "country": { "type": "string" }, "reference_release": { "type": "string", "enum": [ "iso-codes-4.20.1" ] }, "form": { "$ref": "#/$defs/ShippingPostalFormData" } } }, "ShippingAreaDataSubdivision": { "type": "object", "additionalProperties": false, "required": [ "kind", "code", "reference_release" ], "properties": { "kind": { "type": "string", "enum": [ "SUBDIVISION" ] }, "code": { "type": "string" }, "reference_release": { "type": "string", "enum": [ "iso-codes-4.20.1" ] } } }, "ShippingAreaDataUnresolved": { "type": "object", "additionalProperties": false, "required": [ "kind", "assertion" ], "properties": { "kind": { "type": "string", "enum": [ "UNRESOLVED" ] }, "assertion": { "type": "string", "minLength": 1, "maxLength": 255 } } }, "ShippingCollectionArrangementData": { "oneOf": [ { "$ref": "#/$defs/ShippingCollectionArrangementDataByAppointment" }, { "$ref": "#/$defs/ShippingCollectionArrangementDataContactToArrange" }, { "$ref": "#/$defs/ShippingCollectionArrangementDataWindow" } ] }, "ShippingCollectionArrangementDataByAppointment": { "type": "object", "additionalProperties": false, "required": [ "kind" ], "properties": { "kind": { "type": "string", "enum": [ "BY_APPOINTMENT" ] } } }, "ShippingCollectionArrangementDataContactToArrange": { "type": "object", "additionalProperties": false, "required": [ "kind" ], "properties": { "kind": { "type": "string", "enum": [ "CONTACT_TO_ARRANGE" ] } } }, "ShippingCollectionArrangementDataWindow": { "type": "object", "additionalProperties": false, "required": [ "kind", "duration" ], "properties": { "kind": { "type": "string", "enum": [ "WINDOW" ] }, "duration": { "$ref": "#/$defs/ShippingTimeData" } } }, "ShippingCollectionData": { "type": "object", "additionalProperties": false, "required": [ "applicability", "dependency", "eligibility", "site", "arrangement" ], "properties": { "applicability": { "$ref": "#/$defs/ShippingApplicabilityData" }, "dependency": { "type": "string", "enum": [ "INDEPENDENT", "SHIPPING" ] }, "eligibility": { "type": [ "string", "null" ], "enum": [ "OFFERED", "NOT_OFFERED", "SUBJECT_TO_CONFIRMATION", null ] }, "site": { "anyOf": [ { "$ref": "#/$defs/ShippingSiteData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] }, "arrangement": { "anyOf": [ { "$ref": "#/$defs/ShippingCollectionArrangementData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] } } }, "ShippingCoverageData": { "type": "object", "additionalProperties": false, "required": [ "reference_release", "completeness", "applicability", "exclusions", "zones", "dispatch_origin" ], "properties": { "reference_release": { "type": "string", "enum": [ "iso-codes-4.20.1" ] }, "completeness": { "type": "string", "enum": [ "PARTIAL", "COMPLETE" ] }, "applicability": { "$ref": "#/$defs/ShippingApplicabilityData" }, "exclusions": { "type": "array", "items": { "$ref": "#/$defs/ShippingAreaData" }, "maxItems": 64, "minItems": 0 }, "zones": { "type": "array", "items": { "$ref": "#/$defs/ShippingZoneData" }, "maxItems": 64, "minItems": 0 }, "dispatch_origin": { "anyOf": [ { "$ref": "#/$defs/ShippingSiteData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] } } }, "ShippingCurrencyCode": { "type": "string", "enum": [ "EUR", "GBP", "USD", "AUD", "CAD", "NZD", "CNY", "BRL", "PLN", "TRY", "JPY", "CZK", "RUB", "AED", "SAR", "HKD", "SGD", "CHF", "ZAR", "SEK", "DKK", "NOK", "KRW", "INR", "TWD", "HUF", "RON", "MXN", "THB", "ARS" ] }, "ShippingLeadTimesData": { "type": "object", "additionalProperties": false, "required": [ "handling", "transit", "total" ], "properties": { "handling": { "anyOf": [ { "$ref": "#/$defs/ShippingTimeData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] }, "transit": { "anyOf": [ { "$ref": "#/$defs/ShippingTimeData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] }, "total": { "anyOf": [ { "$ref": "#/$defs/ShippingTimeData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] } } }, "ShippingMoneyData": { "type": "object", "additionalProperties": false, "required": [ "amount_minor", "currency" ], "properties": { "amount_minor": { "type": "integer", "minimum": 0, "maximum": 18446744073709551615 }, "currency": { "$ref": "#/$defs/ShippingCurrencyCode" } }, "description": "Advertised amount in currency minor units; never an authorized quote or checkout total." }, "ShippingPolicyData": { "oneOf": [ { "$ref": "#/$defs/ShippingPolicyDataProhibited" }, { "$ref": "#/$defs/ShippingPolicyDataCoverage" } ] }, "ShippingPolicyDataCoverage": { "type": "object", "additionalProperties": false, "required": [ "kind", "coverage" ], "properties": { "kind": { "type": "string", "enum": [ "COVERAGE" ] }, "coverage": { "$ref": "#/$defs/ShippingCoverageData" } } }, "ShippingPolicyDataProhibited": { "type": "object", "additionalProperties": false, "required": [ "kind" ], "properties": { "kind": { "type": "string", "enum": [ "PROHIBITED" ] } } }, "ShippingPostalFormData": { "oneOf": [ { "$ref": "#/$defs/ShippingPostalFormDataExact" }, { "$ref": "#/$defs/ShippingPostalFormDataGermanPrefix" }, { "$ref": "#/$defs/ShippingPostalFormDataGermanRange" } ] }, "ShippingPostalFormDataExact": { "type": "object", "additionalProperties": false, "required": [ "kind", "code" ], "properties": { "kind": { "type": "string", "enum": [ "EXACT" ] }, "code": { "type": "string", "minLength": 1, "maxLength": 64 } } }, "ShippingPostalFormDataGermanPrefix": { "type": "object", "additionalProperties": false, "required": [ "kind", "prefix" ], "properties": { "kind": { "type": "string", "enum": [ "GERMAN_PREFIX" ] }, "prefix": { "type": "string", "pattern": "^[0-9]{1,4}$" } } }, "ShippingPostalFormDataGermanRange": { "type": "object", "additionalProperties": false, "required": [ "kind", "first", "last" ], "properties": { "kind": { "type": "string", "enum": [ "GERMAN_RANGE" ] }, "first": { "type": "string", "pattern": "^[0-9]{5}$" }, "last": { "type": "string", "pattern": "^[0-9]{5}$" } } }, "ShippingPriceData": { "oneOf": [ { "$ref": "#/$defs/ShippingPriceDataFree" }, { "$ref": "#/$defs/ShippingPriceDataFixed" }, { "$ref": "#/$defs/ShippingPriceDataFrom" }, { "$ref": "#/$defs/ShippingPriceDataEstimatedRange" }, { "$ref": "#/$defs/ShippingPriceDataExternallyCalculated" }, { "$ref": "#/$defs/ShippingPriceDataOnRequest" } ] }, "ShippingPriceDataEstimatedRange": { "type": "object", "additionalProperties": false, "required": [ "kind", "minimum", "maximum" ], "properties": { "kind": { "type": "string", "enum": [ "ESTIMATED_RANGE" ] }, "minimum": { "$ref": "#/$defs/ShippingMoneyData" }, "maximum": { "$ref": "#/$defs/ShippingMoneyData" } } }, "ShippingPriceDataExternallyCalculated": { "type": "object", "additionalProperties": false, "required": [ "kind", "currency" ], "properties": { "kind": { "type": "string", "enum": [ "EXTERNALLY_CALCULATED" ] }, "currency": { "anyOf": [ { "$ref": "#/$defs/ShippingCurrencyCode" }, { "type": [ "object", "null" ], "enum": [ null ] } ] } } }, "ShippingPriceDataFixed": { "type": "object", "additionalProperties": false, "required": [ "kind", "amount" ], "properties": { "kind": { "type": "string", "enum": [ "FIXED" ] }, "amount": { "$ref": "#/$defs/ShippingMoneyData" } } }, "ShippingPriceDataFree": { "type": "object", "additionalProperties": false, "required": [ "kind", "currency" ], "properties": { "kind": { "type": "string", "enum": [ "FREE" ] }, "currency": { "anyOf": [ { "$ref": "#/$defs/ShippingCurrencyCode" }, { "type": [ "object", "null" ], "enum": [ null ] } ] } } }, "ShippingPriceDataFrom": { "type": "object", "additionalProperties": false, "required": [ "kind", "amount" ], "properties": { "kind": { "type": "string", "enum": [ "FROM" ] }, "amount": { "$ref": "#/$defs/ShippingMoneyData" } } }, "ShippingPriceDataOnRequest": { "type": "object", "additionalProperties": false, "required": [ "kind", "currency" ], "properties": { "kind": { "type": "string", "enum": [ "ON_REQUEST" ] }, "currency": { "anyOf": [ { "$ref": "#/$defs/ShippingCurrencyCode" }, { "type": [ "object", "null" ], "enum": [ null ] } ] } } }, "ShippingProfileContentData": { "type": "object", "additionalProperties": false, "required": [ "name", "attributedPartyId", "terms" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "attributedPartyId": { "type": [ "string", "null" ], "pattern": "^pty_[0-7][0-9a-hjkmnp-tv-z]{25}$" }, "terms": { "$ref": "#/$defs/AdvertisedDeliveryTermsData" } } }, "ShippingQuantityData": { "type": "object", "additionalProperties": false, "required": [ "minimum", "maximum" ], "properties": { "minimum": { "type": "integer", "minimum": 1, "maximum": 18446744073709551615 }, "maximum": { "type": "integer", "minimum": 1, "maximum": 18446744073709551615 } }, "description": "Ordered inclusive bounds." }, "ShippingRateData": { "type": "object", "additionalProperties": false, "required": [ "price", "basis", "qualifying_scope", "components" ], "properties": { "price": { "$ref": "#/$defs/ShippingPriceData" }, "basis": { "type": [ "string", "null" ], "enum": [ "PER_ITEM", "PER_LOT", "PER_SHIPMENT", "PER_SELLER_ORDER", null ] }, "qualifying_scope": { "type": [ "string", "null" ], "enum": [ "ITEM", "LOT", "SHIPMENT", "SELLER_ORDER", null ] }, "components": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "INCLUDED", "EXCLUDED" ] }, "description": "Keys: TRANSPORT, PACKING, INSURANCE, HANDLING, INSTALLATION, IMPORT_DUTY, TAX. Unknown keys are rejected." } } }, "ShippingServiceData": { "type": "object", "additionalProperties": false, "required": [ "code", "applicability", "eligibility", "rate", "lead_times", "features", "arranger", "performer" ], "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 128 }, "applicability": { "$ref": "#/$defs/ShippingApplicabilityData" }, "eligibility": { "type": [ "string", "null" ], "enum": [ "OFFERED", "NOT_OFFERED", "SUBJECT_TO_CONFIRMATION", null ] }, "rate": { "anyOf": [ { "$ref": "#/$defs/ShippingRateData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] }, "lead_times": { "$ref": "#/$defs/ShippingLeadTimesData" }, "features": { "type": "array", "items": { "type": "string", "enum": [ "TRACKING", "INSURED", "WHITE_GLOVE", "INSTALLATION", "PACKING" ] }, "maxItems": 5, "minItems": 0, "uniqueItems": true }, "arranger": { "anyOf": [ { "$ref": "#/$defs/ShippingActorData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] }, "performer": { "anyOf": [ { "$ref": "#/$defs/ShippingActorData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] } } }, "ShippingSiteData": { "oneOf": [ { "$ref": "#/$defs/ShippingSiteDataPartyLocation" }, { "$ref": "#/$defs/ShippingSiteDataAsserted" } ] }, "ShippingSiteDataAsserted": { "type": "object", "additionalProperties": false, "required": [ "kind", "geography", "position" ], "properties": { "kind": { "type": "string", "enum": [ "ASSERTED" ] }, "geography": { "anyOf": [ { "$ref": "#/$defs/ShippingSiteGeographyData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] }, "position": { "anyOf": [ { "$ref": "#/$defs/ShippingSitePositionData" }, { "type": [ "object", "null" ], "enum": [ null ] } ] } } }, "ShippingSiteDataPartyLocation": { "type": "object", "additionalProperties": false, "required": [ "kind", "party_location_id" ], "properties": { "kind": { "type": "string", "enum": [ "PARTY_LOCATION" ] }, "party_location_id": { "type": "string", "pattern": "^ploc_[0-7][0-9a-hjkmnp-tv-z]{25}$" } } }, "ShippingSiteGeographyData": { "type": "object", "additionalProperties": false, "required": [ "reference_release", "address_text", "country", "subdivision", "postal_code" ], "properties": { "reference_release": { "type": "string", "enum": [ "iso-codes-4.20.1" ] }, "address_text": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "subdivision": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "description": "One whole advertised site assertion. ISO geography constructors validate codes, release and compatibility. Confidential assertions are protected management data." }, "ShippingSitePointData": { "type": "object", "additionalProperties": false, "required": [ "latitude_degrees", "longitude_degrees" ], "properties": { "latitude_degrees": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude_degrees": { "type": "number", "minimum": -180, "maximum": 180 } } }, "ShippingSitePositionData": { "type": "object", "additionalProperties": false, "required": [ "point", "precision", "accuracy_metres" ], "properties": { "point": { "$ref": "#/$defs/ShippingSitePointData" }, "precision": { "type": "string", "enum": [ "PREMISES", "STREET", "LOCALITY", "REPRESENTATIVE" ] }, "accuracy_metres": { "type": [ "number", "null" ], "minimum": 0 } } }, "ShippingThresholdData": { "type": "object", "additionalProperties": false, "required": [ "minimum", "scope" ], "properties": { "minimum": { "$ref": "#/$defs/ShippingMoneyData" }, "scope": { "type": "string", "enum": [ "ITEM", "LOT", "SHIPMENT", "SELLER_ORDER" ] } } }, "ShippingTimeData": { "type": "object", "additionalProperties": false, "required": [ "minimum", "maximum", "unit", "basis", "trigger" ], "properties": { "minimum": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "maximum": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "unit": { "type": "string", "enum": [ "HOURS", "DAYS", "WEEKS" ] }, "basis": { "type": [ "string", "null" ], "enum": [ "CALENDAR", "BUSINESS", null ] }, "trigger": { "type": [ "string", "null" ], "enum": [ "ORDER", "ORDER_CONFIRMATION", "PAYMENT", "DISPATCH", "READY_FOR_COLLECTION", null ] } }, "description": "Ordered duration bounds; handling, transit and total are independent assertions." }, "ShippingZoneData": { "type": "object", "additionalProperties": false, "required": [ "areas", "applicability", "services" ], "properties": { "areas": { "type": "array", "items": { "$ref": "#/$defs/ShippingAreaData" }, "maxItems": 64, "minItems": 1 }, "applicability": { "$ref": "#/$defs/ShippingApplicabilityData" }, "services": { "type": "array", "items": { "$ref": "#/$defs/ShippingServiceData" }, "maxItems": 64, "minItems": 1 } }, "description": "Zones are ordered; service codes are unique within each zone." } } }