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 integer

    Page number of the results to fetch.

    Default value is 1.

  • page_size integer

    Results per page (max 50)

    Default value is 20.

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

      • shipment_id string(uuid)

        The id of the shipment associated with this exception

      • 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

    • metadata object

      Additional properties are allowed.

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

# Payload
{
  "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,
    "total_count": 1
  }
}