Shipments

Get validation items

Retrieve all validation items for a shipment with optional filtering.

get/api/v1/external/shipments/{shipmentId}/validation-items

Request

Path parameters

shipmentIdstring required

Unique shipment identifier

Query parameters

statusstring

Filter by validation item status

actionStatus'PENDING' | 'ACCEPTED' | 'IGNORED' | 'OVERRIDDEN'

Filter by validation item action status

Response

Validation items retrieved successfully

successboolean

Example response

{
  "data": [
    {
      "id": "1014810279825727496",
      "fieldName": "invoiceNumber",
      "status": "error",
      "reason": "Invoice numbers do not match across documents",
      "suggestion": "Use invoice number from the commercial invoice"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.