Headers

• Authorization string Required

  Authorize your API calls with an Arta API token

Query parameters

• page integer

  Page number of the results to fetch.

  Default value is 1.

• page_size integer

  Results per page (max 50)

  Default value is 20.

• search string | null

  An optional structured search query

Responses

• 200 application/json

  A collection of Quote Request records

  Hide headers attributes Show headers attributes

  • content-type string
  • x-arta-request-id string

    A unique identifier for the Arta API call

  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 object

      • 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.

    • created_at string

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

    • destination object

      A minimal representation of the destination address for the request

      Additional properties are NOT allowed.

      Hide destination attributes Show destination attributes object

      • city string | null

        The destination address city

      • country string

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

      • postal_code string | null

        The destination address postal code

      • region string | null

        The destination address region

    • 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

    • object_count integer

      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 object

      • 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.

    • quoting_strategy string

      TThe quoting strategy used when creating quotes for this request. Determines whether the API returns a single best-rate option per transport speed or multiple carrier options for comparison. If not specified, the default strategy (“best_rate”) will be applied.

      Maximum length is 255. Values are best_rate or compare_carriers.

    • shortcode string

      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.

    • tags array[object]

      A list of tags associated with this request

      Hide tags attributes Show tags attributes object

      • color string

        The hexadecimal color code for the tag, without the leading #.

        Minimum length is 6, maximum length is 6. Format should match the following pattern: ^[0-9A-F]{6}$.

      • created_at string(date-time)

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

      • created_by integer(int64) | null

        The user ID associated with the user who created the tag when applicable.

      • description string | null

        An optional, brief description for this tag.

        Maximum length is 255.

      • id string(uuid)

        The id of the tag in UUID format

      • is_active boolean

        Indicates whether or not the tag is active. Inactive tags may not be associated to new resources

      • name string

        The name for the tag. It may contain lower case letters, dashes, and alphanumeric characters only. The maximum character count is 50.

        Maximum length is 50. Format should match the following pattern: ^[a-z0-9-]{1,50}$.

      • updated_at string(date-time)

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

      • updated_by integer(int64) | null

        The user ID associated with the last user to edit the tag when applicable.

    • updated_at string

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

  • metadata object
    Hide metadata attributes Show metadata attributes object

    • page integer(int64)
    • page_size integer(int64)
    • total_count integer(int64)