# Get a Hosted Session **GET /hosted_sessions/{hosted_session_id}** Retrieve an existing hosted session resource ## Servers - https://api.arta.io: https://api.arta.io () ## Parameters ### Headers - **Authorization** (string) Authorize your API calls with an Arta API token ### Path parameters - **hosted_session_id** (integer) hosted_session_id parameter ## Responses ### 200 Successful Hosted Session response #### Headers - **content-type** (string) - **x-arta-request-id** (string) A unique identifier for the Arta API call #### Body: application/json (object) - **additional_services** (array[string]) 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. Requested services may disqualify certain segments of shipping services offered by Arta depending on location and object details. - **can_user_confirm_object_dimensions** (boolean) Determines whether your customer can verify and update object dimension information when completing an inbound booking session. - **cancel_url** (string) The URL the user will be redirected to after an Arta Booking session is cancelled - **created_at** (string) - **destination** (object | null) - **id** (integer(int64)) - **insurance** (string | null) The id of an insurance type. If requesting Arta insurance, object values must be provided. - **internal_reference** (string | null) This field can be used to pass through any data about the request you may want returned unaltered for your own later usage - **objects** (array[object]) A list of objects to be shipped - **origin** (object) - **payment_process** (string) The primary method by which payment to Arta will be handled for any shipment booked through this hosted session - **preferred_parcel_transport_services** (array[string] | null) 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. - **preferred_quote_types** (array[string]) An optional field presenting the list of quote types the caller instructed Arta to return as part of the hosted session - **private_token** (string) A private access token for this resource. It is used to generate the private URL for the hosted session - **public_instructions_booking_review** (string) 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. - Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)` - Rendered text supports a maximum of 400 characters not including links and markup - **public_instructions_confirmation** (string) 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. - Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)` - Rendered text supports a maximum of 400 characters not including links and markup - **public_instructions_location_quotes** (string) 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. - Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)` - Rendered text supports a maximum of 400 characters not including links and markup - **public_instructions_object_details** (string) A client defined multi-line block of text presented to users on the object form in inbound booking hosted sessions. - Only visible if `can_user_confirm_object_dimensions` is true - Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)` - Rendered text supports a maximum of 400 characters not including links and markup - **public_instructions_payment** (string) 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. - Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)` - Rendered text supports a maximum of 400 characters not including links and markup - **public_reference** (string | null) A client defined name for the resource. The value provided for the public_reference field may appear in notification emails and public web pages - **quoting_strategy** (string) 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 - **shipping_notes** (string | null) This field can be used to pass through any notes to Arta that a customer might want to provide about the request - **shortcode** (string) A brief and unique string identifier for the resource - **status** (string) - **success_url** (string) The URL the user will be redirected to after an Arta Booking session is completed - **tags** (array[object]) A list of tags associated with this hosted session - **type** (string) The type of the hosted session - **updated_at** (string) - **url** (string | null) The Arta Booking web URL for this Hosted Session ### 404 Not Found #### Headers - **content-type** (string) - **x-arta-request-id** (string) A unique identifier for the Arta API call #### Body: application/json (object) - **errors** (object) [Powered by Bump.sh](https://bump.sh)