List Request records

GET /requests

Retrieve a paginated collection of Quote request records 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 Quote Request records

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • items array[object]
      Hide items attributes Show items attributes object
      • bookable object

        Communicates whether the quotes generated for this request may be booked into shipments

        Hide bookable attributes Show bookable attributes
        • missing array[string]

          A list of fields required for the request to be bookable

        • ready boolean

          Returns true if the quotes in this request may be booked

          Default value is true.

      • A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision

      • A minimal representation of the destination address for the request

        Hide destination attributes Show destination attributes
      • hosted_session_id integer | null

        The ID of the HostedSession through which this request was created

      • id string

        The ID for this request

      • insurance string | null

        This field can be used to pass through any character data that you may want returned unaltered for your own later usage

        Values are null or arta_transit_insurance.

      • internal_reference string | null

        This field can be used to pass through any character data that you may want returned unaltered for your own later usage

      • log_request_id string | null

        An identifier for the API call that created this resource

      • The count of objects in this request

      • origin object

        A minimal representation of the origin address for the request

        Hide origin attributes Show origin attributes
        • city string | null

          The origin address city

        • country string

          The origin address country in 2-digit ISO 3166-1 alpha-2 format

        • postal_code string | null

          The origin address postal code

        • region string | null

          The origin address region

      • 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

      • quote_types array[string]

        The IDs of the quote types generated for this request

        Values are parcel, premium, select, or self_ship.

      • A brief string identifier for this shipment

      • status string

        The status for this shipment

        Values are quoted, in_progress, closed, disqualified, expired, cancelled, or pending.

      • A NaiveDatetime-formatted timestamp describing when the resource was last updated with microsecond precision

    • metadata object
      Hide metadata attributes Show metadata attributes
GET /requests
curl \
 -X GET https://api.arta.io/requests \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200)
{
  "items": [
    {
      "id": "6b12c76a-5217-4cd6-82d8-7aa5265ebaad",
      "origin": {
        "city": "New York",
        "region": "NY",
        "country": "US",
        "postal_code": "10019"
      },
      "status": "closed",
      "bookable": {
        "ready": true,
        "missing": []
      },
      "insurance": null,
      "shortcode": "DEMO-R29NAW",
      "created_at": "2021-01-21T21:00:29.568665",
      "updated_at": "2021-01-21T21:00:58.484566",
      "destination": {
        "city": "New York",
        "region": "NY",
        "country": "US",
        "postal_code": "11249"
      },
      "quote_types": [
        "parcel",
        "select",
        "premium"
      ],
      "object_count": 1,
      "public_reference": null,
      "hosted_session_id": 724,
      "internal_reference": null
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "total_count": 1
  }
}