Headers

• Authorization string Required

  Authorize your API calls with an Arta API token

Path parameters

• shipment_id string Required

  shipment_id parameter

Responses

• 200 application/json

  Successful Shipment 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

  • created_at string(date-time)

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

  • destination object

    Additional properties are allowed.

    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

  • eei_form_status string | null

    The status of an associated electronic export information document required for customs clearance. Returns null if the shipment does not have an associated EEI Form

    Values are not_required, required, submitted, approved, or rejected.

  • eei_form_url string | null

    The URL for an associated electronic export information form required for customs clearance. Returns null if the shipment does not have an associated EEI Form

  • emissions string | null

    The estimated CO2 emissions for the shipment

  • emissions_unit string | null

    The unit of measurement for emissions for this shipment. Typically measured in "kg_co2e" or "kilograms of carbon dioxide equivalent"

  • exceptions array[object]

    Shipment exceptions provide context about holds, delays, and other circumstances that may interrupt a shipment's fulfillment

    Hide exceptions attributes Show exceptions attributes object

    • created_at string(date-time)

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

    • exception_type_label string | null

      An additional label providing context about the exception type (optional)

    • hold_until string(date) | null

      The date the shipment will be held until

    • id string(uuid)

      The id of the exception in UUID format

    • package_id integer(int64) | null

      The package associated with this exception (optional)

    • resolution string | null

      A brief description of the method by which this exception was resolved

    • source string

      The source of the exception

    • status string

      The current status for this exception

      Values are new, in_progress, or resolved.

    • type string

      The type of exception

    • updated_at string(date-time)

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

  • hosted_session_id integer | null

    The ID of the HostedSession through which this shipment was created

  • id string(uuid)

    The id of the shipment in UUID format

  • insurance_policy object | null

    Additional properties are allowed.

    Hide insurance_policy attributes Show 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.

  • 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

    Maximum length is 255.

  • log_request_id string | null

    A string identifying the API request that created the shipment. This log_request_id may be used to find the Log associated with the source API request

  • object_count integer(int64)

    The count of objects included in the shipment

  • origin object

    Additional properties are allowed.

    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

  • package_count integer(int64)

    The count of packages included in the shipment

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

    • depth string

      The depth of the object

    • eta string | null

      The expected delivery date for this package in the MM/DD/YYYY format

    • handle_with_care boolean

      Set this flag to true if the package should be handled with care

    • height string

      The height of the object

    • id integer(int64)

      The id of the package

    • is_sufficiently_packed boolean

      Set this flag to true if the package is sufficiently packed

    • objects array[object]

      A list of objects in the package

      Hide objects attributes Show objects attributes object

      • current_packing array[string]

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

      • depth string

        The depth of the object

      • details object

        Additional properties are allowed.

        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}$.

      • 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

    • packing_materials array[string]

      The id of a material.

    • status string | null

      The status of the package

    • unit_of_measurement string

      Values are in or cm.

    • 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

  • payment_process string

    The primary method by which payment to Arta will be handled for any shipment booked through this hosted session

    Values are checkout or invoicing.

  • 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_type string

    The ID of the quote type associated with this shipment

    Values are premium, select, parcel, or self_ship.

  • schedule object

    The schedule for the shipment

    Additional properties are allowed.

    Hide schedule attributes Show schedule attributes object

    • delivery_end string(date) | null
    • delivery_start string(date) | null
    • delivery_window_modifier string

      A qualifying word indicating how delivery_start and delivery_end together shape the delivery window. When present, values may be "after", "by", "on", or "between"

    • pickup_end string(date) | null
    • pickup_start string(date) | null
    • pickup_window_modifier string

      A qualifying word indicating how delivery_start and delivery_end together shape the delivery window. When present, values may be "after", "by", "on", or "between"

  • services array[object]

    A list of services included in the shipment

    Hide services attributes Show 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]

      A list of service IDs that are included in the service

      Hide included_services attributes Show included_services attributes object

      • name string

        The name of the service

      • sub_subtype string

        The service subsubtype ID. Options are defined in the Service types metadata endpoint

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

      • subtype string

        The service subtype ID. Options are defined in the Service types metadata endpoint

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

      • type string

        The service type ID. Options are defined in the Service types metadata endpoint

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

    • is_requested boolean

      Set this flag to true if the service is requested

    • is_required boolean

      Set this flag to true if the service is required

    • name string

      The name of the service

    • sub_subtype string

      The service subsubtype ID. Options are defined in the Service types metadata endpoint

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

    • subtype string

      The service subtype ID. Options are defined in the Service types metadata endpoint

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

    • type string

      The service type ID. Options are defined in the Service types metadata endpoint

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

  • shipping_notes string | null

    Any additional unstructured notes to Arta about the shipment

    Maximum length is 255.

  • shortcode string

    A brief identifier for this shipment

  • status string

    The status for this shipment

    Maximum length is 255. Values are pending, confirmed, collected, in_transit, completed, or cancelled.

  • tags array[object]

    A list of tags associated with the shipment

    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.

  • tracking array[object]

    A list of tracking details for the packages in a shipment

    Hide tracking attributes Show tracking attributes object

    • carrier_name string

      The name of the carrier providing transport services for a specific package

    • label_url string | null

      A URL at which parcel package shipping labels may be downladed and printed

    • package_id integer(int64)

      The ID associated with the tracking detail's corresponding package

    • tracking_number string

      The carrier-providing tracking number for this package

    • url string

      A carrier-provided URL for fetching delivery events related to this package's transport

  • updated_at string(date-time)

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

  • url string

    The track URL for this shipment on the Arta web platform

• 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

    Additional properties are allowed.

    Hide errors attribute Show errors attribute object

    • detail string