Get a Shipment record

GET /shipments/{shipment_id}

Retrieve an existing Shipment record

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Path parameters

Responses

  • 200 application/json

    Successful Shipment get response

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision

    • Hide destination attributes Show destination attributes
    • 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 null, pending, cleared, approved, rejected, or submitted.

    • 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 amount of projected emissions for this 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
      • A NaiveDatetime-formatted timestamp describing when the exception was created with microsecond precision

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

      • package_id integer | null

        The package associated with this exception (optional)

      • id string
      • resolution string | null

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

      • status string

        The current status for this exception

        Values are new, in_progress, or resolved.

      • type string

        The type of exception

      • 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
    • insurance_policy object | null
      Hide insurance_policy attributes Show insurance_policy attributes
      • amount string
      • The currency of the insurance amount. Formatted as ISO 4217 three-letter alphabetic currency code

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

      • id string
      • The currency of the insurance amount. Formatted as ISO 4217 three-letter alphabetic currency code

        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

    • The count of objects included in the shipment

    • origin object
      Hide origin attributes Show origin attributes
    • The count of packages included in the shipment

    • packages array[object]
      Hide packages attributes Show packages attributes object
      • depth string
      • eta string | null

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

      • height string
      • id integer

        The ID of the package

      • objects array[object]
        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
          Hide details attributes Show details attributes
          • creation_date string | null

            The creation timing for the object

          • creator string

            The creator of the object

          • is_fragile boolean

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

            Default value is false.

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

          • materials array[string]

            A list of ids the types of materials used

          • title string

            The object title

        • height string

          The height of the object

        • id integer

          The system-generated ID for this object

        • images array[string(uri)]

          A list image urls of the object

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

        • public_reference string | null

          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 sub-type id

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

        • Values are in or cm.

        • value string

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

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

          The weight 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 current delivery status for this package

        Values are pending, transit, out_for_delivery, delivered, unknown, notfound, undelivered, exception, or expired.

      • weight string
      • width string
    • The primary method by which payment to Arta will be handled for this shipment

      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.

    • The ID of the quote type associated with this shipment

      Values are parcel, premium, select, self_ship, or track.

    • schedule object
      Hide schedule attributes Show schedule attributes
    • services array[object]
      Hide services attributes Show services attributes object
    • shipping_notes string | null

      Any additional unstructured notes to Arta about the shipment

    • A brief identifier for this shipment

    • status string

      The status for this shipment

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

    • total string

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

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

      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

      A package tracking detail

      • 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

        The ID associated with the tracking detail's corresponding package

      • The carrier-providing tracking number for this package

      • url string

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

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

    • url string(uri)

      The track URL for this shipment on the Arta web platform

  • 404 application/json

    Resource Not Found

    Hide headers attributes Show headers attributes
    Hide response attribute Show response attribute object

    Basic Error

GET /shipments/{shipment_id}
curl \
 -X GET https://api.arta.io/shipments/{shipment_id} \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200)
{
  "id": "6b12c76a-5217-4cd6-82d8-7aa5265ebaad",
  "url": "https://connect.shiparta.com/shipments/6b12c76a-5217-4cd6-82d8-7aa5265egood/5xTRnCvYkdMFdcFFMWUZaCmXz",
  "total": "4",
  "origin": {
    "city": "New York",
    "title": "Warehouse",
    "region": "NY",
    "country": "US",
    "contacts": [
      {
        "name": "Mary Quinn Sullivan",
        "phone_number": "(333) 333-3333",
        "email_address": "mary@example.com"
      }
    ],
    "postal_code": "10019",
    "address_line_1": "11 W 53rd St",
    "address_line_2": null,
    "address_line_3": null,
    "access_restrictions": []
  },
  "status": "pending",
  "packages": [
    {
      "id": 131,
      "eta": "05/09/2022",
      "depth": "6.0",
      "width": "14.0",
      "height": "14.5",
      "status": "pending",
      "weight": "3.5",
      "objects": [
        {
          "id": 620,
          "type": "art",
          "depth": "2",
          "value": "1500",
          "width": "10",
          "height": "10.5",
          "images": [],
          "weight": "3.5",
          "details": {
            "title": "All That Jazz",
            "creator": "Robert Irwin",
            "is_cites": false,
            "materials": [],
            "is_fragile": false,
            "creation_date": null
          },
          "subtype": "painting_unframed",
          "weight_unit": "lb",
          "value_currency": "USD",
          "current_packing": [],
          "public_reference": null,
          "internal_reference": null,
          "unit_of_measurement": "in"
        }
      ],
      "weight_unit": "lb",
      "handle_with_care": false,
      "packing_materials": [
        "strongbox"
      ],
      "is_sufficiently_packed": false
    }
  ],
  "schedule": {
    "pickup_end": null,
    "delivery_end": null,
    "pickup_start": null,
    "delivery_start": null,
    "pickup_window_modifier": "",
    "delivery_window_modifier": ""
  },
  "services": [
    {
      "name": "UPS Next Day Air",
      "type": "transport",
      "amount": "1",
      "subtype": "parcel",
      "is_required": true,
      "sub_subtype": "parcel",
      "is_requested": false,
      "amount_currency": "USD",
      "included_services": []
    },
    {
      "name": "Strongbox",
      "type": "packing",
      "amount": "1",
      "subtype": "packing_materials",
      "is_required": true,
      "sub_subtype": "strongbox",
      "is_requested": false,
      "amount_currency": "USD",
      "included_services": []
    },
    {
      "name": "Collection",
      "type": "location",
      "amount": "1",
      "subtype": "collection",
      "is_required": true,
      "sub_subtype": "collection",
      "is_requested": false,
      "amount_currency": "USD",
      "included_services": []
    },
    {
      "name": "Fuel Surcharge",
      "type": "taxes_duties_fees",
      "amount": "1",
      "subtype": "fees",
      "is_required": true,
      "sub_subtype": "fuel_surcharge",
      "is_requested": false,
      "amount_currency": "USD",
      "included_services": []
    }
  ],
  "tracking": [],
  "emissions": "0.03",
  "shortcode": "MA-452144",
  "created_at": "2021-01-21T21:00:58.403150",
  "exceptions": [],
  "quote_type": "parcel",
  "updated_at": "2021-01-21T21:00:58.579870",
  "destination": {
    "city": "New York",
    "title": "Home",
    "region": "NY",
    "country": "US",
    "contacts": [
      {
        "name": "Alfred Barr",
        "phone_number": "(222) 222-2222",
        "email_address": "al@example.com"
      }
    ],
    "postal_code": "11249",
    "address_line_1": "87 Richardson St",
    "address_line_2": null,
    "address_line_3": null,
    "access_restrictions": []
  },
  "eei_form_url": null,
  "object_count": 1,
  "package_count": 1,
  "emissions_unit": "kg_co2e",
  "shipping_notes": null,
  "total_currency": "USD",
  "eei_form_status": null,
  "payment_process": "invoicing",
  "insurance_policy": null,
  "public_reference": null,
  "internal_reference": null
}
Response examples (404)
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "errors": {
    "detail": "string"
  }
}