Headers

• Authorization string Required

  Authorize your API calls with an Arta API token

Path parameters

• request_id string Required

  request_id parameter

Responses

• 200 application/json

  Successful Request get response

  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

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

  • bookable object
    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

  • created_at string

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

  • currency string

    ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

    Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

  • destination object
    Hide destination attributes Show destination attributes object

    • access_restrictions array[string] Deprecated

      Id of location restriction type

    • address_line_1 string

      First line of address

    • address_line_2 string | null

      Second line of address

    • address_line_3 string | null

      Third line of address

    • city string

      City

    • contacts array[object]

      A list of contacts at the location

      Hide contacts attributes Show contacts attributes object

      • email_address string
      • name string Required
      • phone_number string
    • country string Required

      The ISO 3166-1 alpha-2 country code of the current or last known location if available

      Minimum length is 2, maximum length is 2.

    • postal_code string

      The postal code

    • region string

      Political region name, for US states and Canada provinces, use 2 letter abbreviations

    • title string

      The title or name of the location

  • disqualifications array[object]

    The list of reasons for which particular quote types were disqulified

    The disqualifcation reason

    Hide disqualifications attributes Show disqualifications attributes object

    • quote_types array[string]

      The list of quote types disqualified with this reason

    • reason string

      A brief explanation of the disqualification

    • reason_code string

      An ID for the disqualification

  • hosted_session_id integer | null

    The ID of the HostedSession through which this shipment was created

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

  • log_request_id string

    The request ID for the API call that created the resource. This request ID maps to the Log resource's "request_id" field

  • object_count number

    The count of objects included in the initial request payload

  • objects array[object]

    A list of objects to be shipped

    Hide objects attributes Show objects attributes object

    • components array[object]

      A list of components in the object. Should be used only with a prepacked_box object subtype.

      When components are present, the object value must equal the sum of component values.

      Hide components attributes Show components attributes object

      • customs object
        Hide customs attributes Show customs attributes object

        • country_of_origin string

          The ISO 3166-1 alpha-2 country code where the object was made or manufactured

          Minimum length is 2, maximum length is 2.

        • hs_code string

          The Harmonized System code for the object. This is a 6-10 digit code used to classify traded products

        • medium string

          The medium of the object. This is a description of the material or materials used to create the object

        • temporary_admission boolean

          Select true if the goods are currently in the country under a temporary admission declaration

      • details object
        Hide details attributes Show details attributes object

        • creation_date string

          Details about the timing in which an object was created

        • creator string

          The creator of the object

        • notes string

          Any notes about the item

        • title string

          The object title

      • id string(uuid)

        The id of the component in UUID format

      • internal_reference string

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

        Maximum length is 255.

      • public_reference string

        A client defined name for the object. The value provided for public_reference may be presented in notification emails and on shipment detail pages

        Maximum length is 255.

      • type string

        The object component type ID. Options are defined in the Object Component types metadata endpoint

        Format should match the following pattern: ^[0-9a-z_]{1,56}$.

      • value string

        Format should match the following pattern: ^(0|([1-9]+[0-9]*))(\.[0-9]{1,2})?$.

      • value_currency string

        ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

    • current_packing array[string]

      A list of packing subtype IDs describing how the item is currently packed

    • customs object
      Hide customs attributes Show customs attributes object

      • country_of_origin string

        The ISO 3166-1 alpha-2 country code where the object was made or manufactured

        Minimum length is 2, maximum length is 2.

      • hs_code string

        The Harmonized System code for the object. This is a 6-10 digit code used to classify traded products

      • medium string

        The medium of the object. This is a description of the material or materials used to create the object

      • temporary_admission boolean

        Select true if the goods are currently in the country under a temporary admission declaration

    • depth string

      The depth of the object

    • details object
      Hide details attributes Show details attributes object

      • creation_date string

        Details about the timing in which an object was created

      • creator string

        The creator of the object

      • is_cites boolean

        Set to true if the object is governed by the Convention on International Trade in Endangered Species of Wild Fauna and Flora

        Default value is false.

      • is_fragile boolean

        Set this flag to true is the item is fragile. This may effect packing and handling costs

        Default value is false.

      • materials array[string] Deprecated

        A list of IDs describing the types of materials used

      • notes string

        Any notes about the item

      • title string

        The object title

    • height string

      The height of the object

    • id integer(int64)
    • images array[string(uri)]

      A list image urls of the object

    • internal_reference string

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

      Maximum length is 255.

    • public_reference string

      A client defined name for the object. The value provided for public_reference may be presented in notification emails and on shipment detail pages

      Maximum length is 255.

    • subtype string

      The object subtype ID. Options are defined in the Object types metadata endpoint

      Format should match the following pattern: ^[0-9a-z_]{1,56}$.

    • type string

      The object type id

      Format should match the following pattern: ^[0-9a-z_]{1,56}$.

    • unit_of_measurement string

      Values are in or cm.

    • value string

      Format should match the following pattern: ^(0|([1-9]+[0-9]*))(\.[0-9]{1,2})?$.

    • value_currency string

      ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

      Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

    • weight string

      The weight of the object

    • weight_unit string

      The unit of the object

      Values are lb or kg.

    • width string

      The width of the object

  • origin object
    Hide origin attributes Show origin attributes object

    • access_restrictions array[string] Deprecated

      Id of location restriction type

    • address_line_1 string

      First line of address

    • address_line_2 string | null

      Second line of address

    • address_line_3 string | null

      Third line of address

    • city string

      City

    • contacts array[object]

      A list of contacts at the location

      Hide contacts attributes Show contacts attributes object

      • email_address string
      • name string Required
      • phone_number string
    • country string Required

      The ISO 3166-1 alpha-2 country code of the current or last known location if available

      Minimum length is 2, maximum length is 2.

    • postal_code string

      The postal code

    • region string

      Political region name, for US states and Canada provinces, use 2 letter abbreviations

    • title string

      The title or name of the location

  • payment_process string

    The primary method by which payment to Arta will be handled for any shipment booked from this request

    Maximum length is 255. Values are checkout or invoicing.

  • 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 quote request

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

  • quote_types array[string]

    The list of quote types returned as part of the quotes in this quote request

  • quotes array[object]

    The list of quotes returned for the request

    Hide quotes attributes Show quotes attributes object

    • id integer
    • included_insurance_policy object | null
      Hide included_insurance_policy attributes Show included_insurance_policy attributes object | null

      • amount string

        Format should match the following pattern: ^(0|([1-9]+[0-9]*))(\.[0-9]{1,2})?$.

      • amount_currency string

        ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

      • id string
      • insured_value string

        Format should match the following pattern: ^(0|([1-9]+[0-9]*))(\.[0-9]{1,2})?$.

      • insured_value_currency string

        ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

    • included_services array[object]
      Hide included_services attributes Show included_services attributes object

      • amount string

        Format should match the following pattern: ^(0|([1-9]+[0-9]*))(\.[0-9]{1,2})?$.

      • amount_currency string

        ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

      • included_services array[object]
        Hide included_services attributes Show included_services attributes object

        • name string
        • sub_subtype string
        • subtype string
        • type string
      • is_requested boolean
      • is_required boolean
      • metadata object

        Additional data about the service. For services with a type value of "transport" generated through instant quoting, metadata may include reference_rate.provider and reference_rate.service_level fields that indicate the carrier and mode of transport used to price this service

      • name string
      • sub_subtype string
      • subtype string
      • type string
    • optional_services array[object]
      Hide optional_services attributes Show optional_services attributes object

      • amount string

        Format should match the following pattern: ^(0|([1-9]+[0-9]*))(\.[0-9]{1,2})?$.

      • amount_currency string

        ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

      • included_services array[object]
        Hide included_services attributes Show included_services attributes object

        • name string
        • sub_subtype string
        • subtype string
        • type string
      • name string
      • sub_subtype string
      • subtype string
      • type string
    • quote_type string
    • status string
    • 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.

    • total string

      Format should match the following pattern: ^(0|([1-9]+[0-9]*))(\.[0-9]{1,2})?$.

    • total_currency string

      ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

      Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

  • quoting_strategy string

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

  • 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 request resource

  • status string

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

  • updated_at string

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

• 404 application/json

  Not Found

  Hide headers attributes Show headers attributes

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

    A unique identifier for the Arta API call

  Hide response attribute Show response attribute object

  • errors object
    Hide errors attribute Show errors attribute object

    • detail string