List Hosted Sessions

GET /hosted_sessions

Retrieve a paginated collection of hosted sessions belonging to your organization

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Query parameters

  • page_size integer

    Results per page (max 50)

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses

  • 200 application/json

    A collection of Hosted Sessions

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • items array[object]
      Hide items attributes Show items attributes object
      • additional_services array[string]

        The id of a service.

      • The URL the user will be redirected to after a Arta Booking session is cancelled

      • destination object | null
        Hide destination attributes Show destination attributes
      • 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

        Maximum length is 255.

      • origin object
        Hide origin attributes Show origin attributes
      • The primary method by which payment to Arta will be handled for any shipment booked through this hosted session

        Values are checkout or invoicing.

      • A private access token for this resource. It used to generate the private URL for the hosted session

      • 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

        Maximum length is 255.

      • 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

      • A brief and unique string identifier for the request resource

      • status string
      • The URL the user will be redirected to after a Arta Booking session is completed

      • url string | null

        The Arta Booking web URL for this Hosted Session

      • An optional field presenting the list of quote types the caller instructed Arta to return as part of the hosted session

    • metadata object
      Hide metadata attributes Show metadata attributes
GET /hosted_sessions
curl \
 -X GET https://api.arta.io/hosted_sessions \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200)
{
  "items": [
    {
      "id": 42,
      "url": "https://book.arta.io/b/42/335318bc-f855-4a57-8203-2061930eab1f",
      "origin": {
        "city": "brooklyn",
        "region": "NY",
        "country": "US",
        "postal_code": "11249"
      },
      "status": "new",
      "objects": [
        {
          "type": "art",
          "depth": "2",
          "value": "100.00",
          "width": "36",
          "height": "24",
          "images": [],
          "weight": "1",
          "details": {
            "notes": "notes",
            "title": "It's just jazz",
            "creator": "Robert Irwin",
            "is_cites": false,
            "materials": [],
            "is_fragile": false,
            "creation_date": null
          },
          "subtype": "painting_unframed",
          "weight_unit": "lb",
          "value_currency": "USD",
          "current_packing": [],
          "public_reference": null,
          "internal_reference": null,
          "unit_of_measurement": "in"
        }
      ],
      "insurance": null,
      "shortcode": "DEMO-B2M7JC",
      "cancel_url": "http://example.com/cancel",
      "created_at": "2021-06-23T16:39:10.530122",
      "updated_at": "2021-06-23T16:39:10.530122",
      "destination": null,
      "success_url": "http://example.com/success",
      "private_token": "335318bc-f855-4a57-8203-2061930eab1f",
      "shipping_notes": null,
      "public_reference": null,
      "internal_reference": null,
      "additional_services": []
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "total_count": 1
  }
}