List Shipment Exceptions

GET /shipment_exceptions

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

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

      • A human-readable label for the shipment exception provided when the type is other

      • hold_until string | null

        The optional date a shipment's collection or delivery is being held until. Will be in the YYYY-MM-DD format

      • id string

        The unique ID of the shipment exception

      • package_id integer | null

        The ID of package associated with the shipment exception. Provided only if the shipment exception is associated with a specific package

      • resolution string | null

        A brief description of how a resolved shipment exception was resolved

      • The ID for the shipment associated to the shipment exception

      • source string

        The context in which this shipment exception was created

      • The current resolution status for a shipment exception

        Values are new, in_progress, or resolved.

      • type string

        The type ID for this resource. Options are defined in the Shipment Exception Types metadata endpoint

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

    • metadata object
      Hide metadata attributes Show metadata attributes
GET /shipment_exceptions
curl \
 -X GET https://api.arta.io/shipment_exceptions \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200)
{
  "items": [
    {
      "id": "d686ad3b-33fd-454c-a7aa-94b1ecbc539f",
      "type": "held_at_customs",
      "source": "api",
      "status": "new",
      "created_at": "2023-05-26T19:33:19.693833",
      "hold_until": null,
      "package_id": 4366794,
      "resolution": null,
      "updated_at": "2023-05-26T19:33:19.693833",
      "shipment_id": "a5cbb58c-43ab-4658-9999-98a33b0070d5",
      "exception_type_label": null
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "is_estimate": false,
    "total_count": 1
  }
}