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

    • created_at string(date-time)

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

    • destination object

      A minimal representation of the destination address for the shipment

      Additional properties are 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 shipment was created

    • id string(uuid)

      The id of the shipment in UUID format

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

    • object_count integer(int64)

      The count of objects in this shipment

    • origin object

      A minimal representation of the destination address for the shipment

      Additional properties are allowed.

      Hide origin attributes Show origin 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

    • package_count integer(int64)

      The number of packages in this shipment

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

    • 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[string]

      A list of tags associated with the shipment

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

    • updated_at string(date-time)

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

  • metadata object

    Additional properties are allowed.

    Hide metadata attributes Show metadata attributes object

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