List Shipment records

GET /shipments

Retrieve a paginated collection of Shipment 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 Shipment records

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • metadata object
      Hide metadata attributes Show metadata attributes
    • items array[object]
      Hide items attributes Show items attributes object
      • 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 shipment

        Hide destination attributes Show destination attributes
      • hosted_session_id integer | null

        The ID of the HostedSession through which this shipment was created

      • id string

        The ID for this shipment

      • 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

      • object_count integer

        The count of objects in this shipment

      • origin object

        A minimal representation of the origin address for the shipment

        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

      • package_count integer

        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

      • quote_type string

        The ID of the quote type associated with this shipment

        Values are parcel, premium, select, or self_ship.

      • shortcode string

        A brief string identifier for this shipment

      • status string

        The status for this shipment

      • total string

        The total cost of this shipment

      • total_currency string

        The currency of the total. Formatted as ISO 4217 three-letter alphabetic currency code

        Default value is USD.

      • updated_at string

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

GET /shipments 
curl \
 -X GET https://api.arta.io/shipments \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200) 
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "items": [
    {
      "created_at": "2021-01-21T21:00:58.403150",
      "destination": {
        "city": "New York",
        "country": "US",
        "postal_code": "11249",
        "region": "NY"
      },
      "id": "6b12c76a-5217-4cd6-82d8-7aa5265ebaad",
      "hosted_session_id": 724,
      "internal_reference": null,
      "object_count": 1,
      "origin": {
        "city": "New York",
        "country": "US",
        "postal_code": "10019",
        "region": "NY"
      },
      "package_count": 1,
      "public_reference": null,
      "quote_type": "parcel",
      "shortcode": "DYL-452144",
      "status": "pending",
      "total": "4",
      "total_currency": "USD",
      "updated_at": "2021-01-21T21:00:58.579870"
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "total_count": 1
  }
}