Create Shipment Exception

POST /shipment_exceptions

Create a Shipment Exception for a Shipment

  • Clients can create shipment exceptions of a single type currently:requested_hold_to_collect

  • A shipment must have a pending or confirmed status to create a requested_hold_to_collect shipment exception.

  • hold_until date cannot be greater than 30 days from the associated shipment's created_at timestamp.

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

application/json

Body

  • Hide shipment_exception attributes Show shipment_exception attributes
    • type Required

      The type ID for this resource. Options are defined in the Shipment Exception Types metadata endpoint. Currently, the only accepted type for client-created shipment exceptions is requested_hold_to_collect.

      Value is requested_hold_to_collect.

    • shipment_id string Required

      The ID for the shipment associated to the shipment exception

    • Optionally provide a date to hold collection for the shipment. Values should be in the YYYY-MM-DD format. Hold until dates must be fewer than 30 days from the shipment's created_at datetime.

Responses

  • 201 application/json

    Successful response

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

    • status string

      The current resolution status for a shipment exception

    • 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

POST /shipment_exceptions
curl \
 -X POST https://api.arta.io/shipment_exceptions \
 -H "Content-Type: application/json" \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
 -d '{"shipment_exception":{"type":"requested_hold_to_collect","hold_until":"2023-08-15","shipment_id":"5baff45a-281d-416e-9310-a4a7c637952e"}}'
Request example
{
  "shipment_exception": {
    "type": "requested_hold_to_collect",
    "hold_until": "2023-08-15",
    "shipment_id": "5baff45a-281d-416e-9310-a4a7c637952e"
  }
}
Response examples (201)
{
  "id": "f45a4526-53af-4c0a-8f1a-b6967dd87c01",
  "type": "requested_hold_to_collect",
  "source": "api",
  "status": "new",
  "created_at": "2023-08-01T17:45:58.515371",
  "package_id": null,
  "resolution": null,
  "updated_at": "2023-08-01T17:45:58.515371",
  "shipment_id": "1961490f-2020-4035-b48b-254ba9900bab",
  "exception_type_label": null
}