JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/artashippinginc/main/json-schema/artashippinginc-hosted-session-create-schema.json",
"title": "HostedSessionCreate",
"x-generated": "2026-09-26",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/arta-openapi.json#/components/schemas/HostedSessionCreate",
"oneOf": [
{
"additionalProperties": false,
"description": "Create hosted booking session",
"properties": {
"hosted_session": {
"properties": {
"additional_services": {
"description": "Any desired services, such as unpacking, installation, etc. can be sent through in the request and will be treated as if that requested service is required, meaning this may disqualify certain segments of shipping services we offer.",
"items": {
"description": "The id of a service.",
"type": "string",
"x-struct": null,
"x-validate": null
},
"type": "array",
"x-struct": null,
"x-validate": null
},
"cancel_url": {
"description": "The URL the user will be redirected to after a Arta Booking session is cancelled",
"type": "string",
"x-struct": null,
"x-validate": null
},
"customs_end_use": {
"default": "not_for_resale",
"description": "The intended end use of the items being shipped for customs purposes",
"enum": [
"for_resale",
"not_for_resale"
],
"type": "string",
"x-struct": null,
"x-validate": null
},
"customs_process": {
"default": "ddu",
"description": "The customs process for the shipment. \"ddu\" (Delivery Duties Unpaid) means the receiver is responsible for paying duties and taxes. \"ddp\" (Delivery Duties Paid) means the sender prepays duties and taxes. \"ddp_optional\" means the receiver will decide whether to pay estimated duties, fees, and taxes prior to fulfillment",
"enum": [
"ddu",
"ddp",
"ddp_optional"
],
"type": "string",
"x-struct": null,
"x-validate": null
},
"destination": {
"properties": {
"access_restrictions": {
"deprecated": true,
"items": {
"description": "Id of location restriction type",
"type": "string",
"x-struct": null,
"x-validate": null
},
"type": "array",
"x-struct": null,
"x-validate": null
},
"address_line_1": {
"description": "First line of address",
"type": "string",
"x-struct": null,
"x-validate": null
},
"address_line_2": {
"description": "Second line of address",
"type": [
"string",
"null"
],
"x-struct": null,
"x-validate": null
},
"address_line_3": {
"description": "Third line of address",
"type": [
"string",
"null"
],
"x-struct": null,
"x-validate": null
},
"city": {
"description": "City",
"type": "string",
"x-struct": null,
"x-validate": null
},
"contacts": {
"description": "A list of contacts at the location",
"items": {
"properties": {
"email_address": {
"type": "string",
"x-struct": null,
"x-validate": null
},
"name": {
"type": "string",
"x-struct": null,
"x-validate": null
},
"phone_number": {
"type": "string",
"x-struct": null,
"x-validate": null
}
},
"required": [
"name"
],
"type": "object",
"x-struct": null,
"x-validate": null
},
"type": "array",
"x-struct": null,
"x-validate": null
},
"country": {
"description": "The ISO 3166-1 alpha-2 country code of the current or last known location if available",
"maxLength": 2,
"minLength": 2,
"required": true,
"type": "string",
"x-struct": null,
"x-validate": null
},
"postal_code": {
"description": "The postal code",
"type": "string",
"x-struct": null,
"x-validate": null
},
"region": {
"description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations",
"type": "string",
"x-struct": null,
"x-validate": null
},
"title": {
"description": "The title or name of the location",
"type": "string",
"x-struct": null,
"x-validate": null
}
},
"type": "object",
"x-struct": null,
"x-validate": null
},
"insurance": {
"description": "The ID of the requested Arta insurance type. Options are defined in the Insurances metadata endpoint",
"type": "string",
"x-struct": null,
"x-validate": null
},
"internal_reference": {
"description": "This field can be used to pass through any data that you may want returned unaltered for your own later usage",
"maxLength": 255,
"type": "string",
"x-struct": null,
"x-validate": null
},
"objects": {
"items": {
"properties": {
"components": {
"description": "A list of components in the object. Should be used only with a `prepacked_box` object subtype.\n\nWhen components are present, the object value must equal the sum of component values.",
"items": {
"properties": {
"customs": {
"properties": {
"country_of_origin": {
"description": "The ISO 3166-1 alpha-2 country code where the object was made or manufactured",
"maxLength": 2,
"minLength": 2,
"type": "string",
"x-struct": null,
"x-validate": null
},
"hs_code": {
"description": "The Harmonized System code for the object. This is a 6-10 digit code used to classify traded products",
"type": "string",
"x-struct": null,
"x-validate": null
},
"medium": {
"description": "The medium of the object. This is a description of the material or materials used to create the object",
"type": "string",
"x-struct": null,
"x-validate": null
},
"temporary_admission": {
"description": "Select true if the goods are currently in the country under a temporary admission declaration",
"type": "boolean",
"x-struct": null,
"x-validate": null
}
},
"type": "object",
"x-struct": null,
"x-validate": null
},
"details": {
"properties": {
"creation_date": {
"description": "Details about the timing in which an object was created",
"type": "string",
"x-struct": null,
"x-validate": null
},
"creator": {
"description": "The creator of the object",
"type": "string",
"x-struct": null,
"x-validate": null
},
"notes": {
"description": "Any notes about the item",
"type": "string",
"x-struct": null,
"x-validate": null
},
"title": {
"description": "The object title",
"type": "string",
"x-struct": null,
"x-validate": null
}
},
"type": "object",
"x-struct": null,
"x-validate": null
},
"internal_reference": {
"description": "This field can be used to pass through any data that you may want returned unaltered for your own later usage",
"maxLength": 255,
"type": "string",
"x-struct": null,
"x-validate": null
},
"public_reference": {
"description": "A client defined name for the object. The value provided for public_reference may be presented in notification emails and on shipment detail pages",
"maxLength": 255,
"type": "string",
"x-struct": null,
"x-validate": null
},
"type": {
"description": "The object component type ID. Options are defined in the Object Component types metadata endpoint",
"pattern": "^[0-9a-z_]{1,56}$",
"type": "string",
"x-struct": null,
"x-validate": null
},
"value": {
"$ref": "#/$defs/MonetaryAmount"
},
"value_currency": {
"$ref": "#/$defs/Currency"
}
},
"required": [
"type",
"value"
],
"type": "object",
"x-struct": null,
"x-validate": null
},
"type": "array",
"x-struct": null,
"x-validate": null
},
"current_packing": {
"description": "A list of packing subtype IDs describing how the item is currently packed",
"items": {
"type": "string",
"x-struct": null,
"x-validate": null
},
"type": "array",
"x-struct": null,
"x-validate": null
},
"customs": {
"properties": {
"country_of_origin": {
"description": "The ISO 3166-1 alpha-2 country code where the object was made or manufactured",
"maxLength": 2,
"minLength": 2,
"type": "string",
"x-struct": null,
"x-validate": null
},
"hs_code": {
"description": "The Harmonized System code for the object. This is a 6-10 digit code used to classify traded products",
"type": "string",
"x-struct": null,
"x-validate": null
},
"medium": {
"description": "The medium of the object. This is a description of the material or materials used to create the object",
"type": "string",
"x-struct": null,
"x-validate": null
},
"temporary_admission": {
"description": "Select true if the goods are currently in the country under a temporary admission declaration",
"type": "boolean",
"x-struct": null,
"x-validate": null
}
},
"type": "object",
"x-struct": null,
"x-validate": null
},
"depth": {
"description": "The depth of the object",
"type": "string",
"x-struct": null,
"x-validate": null
},
"details": {
"properties": {
"creation_date": {
"description": "Details about the timing in which an object was created",
"type": "string",
"x-struct": null,
"x-validate": null
},
"creator": {
"description": "The creator of the object",
"type": "string",
"x-struct": null,
"x-validate": null
},
"is_cites": {
"default": false,
"description": "Set to true if the object is governed by the Convention on International Trade in Endangered Species of Wild Fauna and Flora",
"type": "boolean",
"x-struct": null,
"x-validate": null
},
"is_fragile": {
"default": false,
"description": "Set this flag to true is the item is fragile. This may effect packing and handling costs",
"type": "boolean",
"x-struct": null,
"x-validate": null
},
"materials": {
"deprecated": true,
"description": "A list of IDs describing the types of materials used",
"items": {
"type": "string",
"x-struct": null,
"x-validate": null
},
"type": "array",
"x-struct": null,
"x-validate": null
},
"notes": {
"description": "Any notes about the item",
"type": "string",
"x-struct": null,
"x-validate": null
},
"title": {
"description": "The object title",
"type": "string",
"x-struct": null,
"x-validate": null
}
},
"type": "object",
"x-struct": null,
"x-validate": null
},
"height": {
"description": "The height of the object",
"type": "string",
"x-struct": null,
"x-validate": null
},
"images": {
"description": "A list image urls of the object",
"items": {
"format": "uri",
"type": "string",
"x-struct": null,
"x-validate": null
},
"type": "array",
"x-struct": null,
"x-validate": null
},
"internal_reference": {
"description": "This field can be used to pass through any data that you may want returned unaltered for your own later usage",
"maxLength": 255,
"type": "string",
"x-struct": null,
"x-validate": null
},
"public_reference": {
"description": "A client defined name for the object. The value provided for public_reference may be presented in notification emails and on shipment detail pages",
"maxLength": 255,
"type": "string",
"x-struct": null,
"x-validate": null
},
"subtype": {
"description": "The object subtype ID. Options are defined in the Object types metadata endpoint",
"pattern": "^[0-9a-z_]{1,56}$",
"type": "string",
"x-struct": null,
"x-validate": null
},
"unit_of_measurement": {
"enum": [
"in",
"cm"
],
"type": "string",
"x-struct": null,
"x-validate": null
},
"value": {
"$ref": "#/$defs/MonetaryAmount"
},
"value_currency": {
"$ref": "#/$defs/Currency"
},
"weight": {
"description": "The weight of the object",
"type": "string",
"x-struct": null,
"x-validate": null
},
"weight_unit": {
"description": "The unit of the object",
"enum": [
"lb",
"kg"
],
"type": "string",
"x-struct": null,
"x-validate": null
},
"width": {
"description": "The width of the object",
"type": "string",
"x-struct": null,
"x-validate": null
}
},
"required": [
"depth",
"height",
"subtype",
"width",
"unit_of_measurement",
"weight_unit",
"value",
"value_currency"
],
"type": "object",
"x-struct": null,
"x-validate": null
},
"type": "array",
"x-struct": null,
"x-validate": null
},
"origin": {
"properties": {
"access_restrictions": {
"deprecated": true,
"items": {
"description": "Id of location restriction type",
"type": "string",
"x-struct": null,
"x-validate": null
},
"type": "array",
"x-struct": null,
"x-validate": null
},
"address_line_1": {
"description": "First line of address",
"type": "string",
"x-struct": null,
"x-validate": null
},
"address_line_2": {
"description": "Second line of address",
"type": [
"string",
"null"
],
"x-struct": null,
"x-validate": null
},
"address_line_3": {
"description": "Third line of address",
"type": [
"string",
"null"
],
"x-struct": null,
"x-validate": null
},
"city": {
"description": "City",
"type": "string",
"x-struct": null,
"x-validate": null
},
"contacts": {
"description": "A list of contacts at the location",
"items": {
"properties": {
"email_address": {
"type": "string",
"x-struct": null,
"x-validate": null
},
"name": {
"type": "string",
"x-struct": null,
"x-validate": null
},
"phone_number": {
"type": "string",
"x-struct": null,
"x-validate": null
}
},
"required": [
"name"
],
"type": "object",
"x-struct": null,
"x-validate": null
},
"type": "array",
"x-struct": null,
"x-validate": null
},
"country": {
"description": "The ISO 3166-1 alpha-2 country code of the current or last known location if available",
"maxLength": 2,
"minLength": 2,
"required": true,
"type": "string",
"x-struct": null,
"x-validate": null
},
"postal_code": {
"description": "The postal code",
"type": "string",
"x-struct": null,
"x-validate": null
},
"region": {
"description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations",
"type": "string",
"x-struct": null,
"x-validate": null
},
"title": {
"description": "The title or name of the location",
"type": "string",
"x-struct": null,
"x-validate": null
}
},
"type": "object",
"x-struct": null,
"x-validate": null
},
"preferred_parcel_transport_services": {
"description": "Optionally instruct the Arta API to filter Parcel and Self Ship quotes for specific transport services. For example, if you would prefer to only return `ground` quotes, you can set this field to `[\"ground\"]` The list of valid transport service IDs is available at the /metadata/parcel_transport_services endpoint.",
"items": {
"type": "string",
"x-struct": null,
"x-validate": null
},
"type": [
"array",
"null"
],
"x-struct": null,
"x-validate": null
},
"preferred_quote_types": {
"description": "Optionally instruct the Arta API to return a subset of quote types for the requests generated through this hosted session. For example if you would prefer to only return Select quotes, you can set this field to `[\"select\"]` The list valid quote type IDs are available at the /metadata/quotes endpoint.",
"items": {
"type": "string",
"x-struct": null,
"x-validate": null
},
"type": [
"array",
"null"
],
"x-struct": null,
"x-validate": null
},
"public_instructions_booking_review": {
"description": "A client defined multi-line block of text presented to users in the quote review modal window prior to booking a shipment for booking, shared request, and inbound booking sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup",
"type": "string",
"x-struct": null,
"x-validate": null
},
"public_instructions_confirmation": {
"description": "A client defined multi-line block of text presented to users on the post-shipment booking confirmation view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup",
"type": "string",
"x-struct": null,
"x-validate": null
},
"public_instructions_location_quotes": {
"description": "A client defined multi-line block of text presented to users on the location and quote selection view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup",
"type": "string",
"x-struct": null,
"x-validate": null
},
"public_instructions_payment": {
"description": "A client defined multi-line block of text presented to users on the post-shipment booking payment view when required for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup",
"type": "string",
"x-struct": null,
"x-validate": null
},
"public_reference": {
"description": "A client defined name for the request. The value provided for the public_reference field may appear in notification emails and shipment detail pages",
"maxLength": 255,
"type": "string",
"x-struct": null,
"x-validate": null
},
"quoting_strategy": {
"default": "best_rate",
"description": "The quoting strategy used when creating quote requests for this booking session. Determines whether the API returns a single best-rate option per transport speed or multiple carrier options for comparison",
"enum": [
"best_rate",
"compare_carriers"
],
"maxLength": 255,
"type": "string",
"x-struct": null,
"x-validate": null
},
"shipping_notes": {
"description": "This field can be used to pass through any notes to Arta that a customer might want to provide about the request",
"type": "string",
"x-struct": null,
"x-validate": null
},
"success_url": {
"description": "The URL the user will be redirected to after a Arta Booking session is completed",
"type": "string",
"x-struct": null,
"x-validate": null
},
"tags": {
"description": "A list of tags to associate with this hosted session",
"items": {
"description": "The name of an active tag belonging to your organization.",
"type": "string",
"x-struct": null,
"x-validate": null
},
"type": "array",
"x-struct": null,
"x-validate": null
},
"type": {
"default": "booking",
"description": "The type of the hosted session",
"enum": [
"booking"
],
"type": "string",
"x-struct": null,
"x-validate": null
}
},
"required": [
"objects",
"origin"
],
"type": "object",
"x-struct": null,
"x-validate": null
}
},
"required": [
"hosted_session"
],
"title": "BookingSession",
"type": "object",
"x-struct": null,
"x-validate": null
},
{
"additionalProperties": false,
"description": "Create hosted booking session from an existing quote request",
"properties": {
"hosted_session": {
"properties": {
"request_id": {
"description": "The ID of an existing Request to be shared.",
"required": true,
"type": "string",
"x-struct": null,
"x-validate": null
}
},
"type": "object",
"x-struct": null,
"x-validate": null
}
},
"required": [
"hosted_session"
],
"title": "ShareRequest",
"type": "object",
"x-struct": null,
"x-validate": null
},
{
"additionalProperties": false,
"description": "Create hosted inbound booking session",
"properties": {
"hosted_session": {
"properties": {
"additional_services": {
"description": "Any desired services, such as unpacking, installation, etc. can be sent through in the request and will be treated as if that requested service is required, meaning this may disqualify certain segments of shipping services we offer.",
"items": {
"description": "The id of a service.",
"type": "string",
"x-struct": null,
"x-validate": null
},
"type": "array",
"x-struct": null,
"x-validate": null
},
"can_user_confirm_object_dimensions": {
"default": false,
"description": "Determines whether your customer can verify and update
# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/artashippinginc/refs/heads/main/json-schema/artashippinginc-hosted-session-create-schema.json
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/artashippinginc-hosted-session-create"
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.
A second provider on the same verified email joins the account you already have.