GIA Receipts Report

Retrieve Goods In Advice (GIA) receipt records for a specified time range to support stock reconciliation processes.

HTTP Method GET

Path /inbound/v2/gia-receipt

Query Parameters

• startTime (string, required) - Start time in ISO 8601 format (e.g., “2024-01-01T00:00:00Z”)
• endTime (string, required) - End time in ISO 8601 format (e.g., “2024-01-31T23:59:59Z”)
• startIndex (integer, optional) - Starting index for pagination (default: 0)
• endIndex (integer, optional) - Ending index for pagination (default: 1000)

Response Codes

200: GIA receipts retrieved successfully

400: Invalid query parameters

401: Authentication required

Success Response (200)

{
  "success": true,
  "totalRecords": 150,
  "startIndex": 0,
  "endIndex": 50,
  "hasMore": true,
  "data": [
    {
      "giaReceiptId": "GIA-RCP-2024-001234",
      "giaReference": "GIA-2024-001234",
      "supplierId": "SUPPLIER-001",
      "supplierName": "Premium Coffee Suppliers Ltd",
      "warehouseId": "WH-001",
      "stockOwner": "STOCK-OWNER-001",
      "receivedAt": "2024-01-15T14:30:00Z",
      "status": "COMPLETED",
      "lines": [
        {
          "lineNumber": 1,
          "productId": "PROD-ABC123",
          "sku": "COFFEE-BEANS-1KG",
          "expectedQuantity": 100,
          "receivedQuantity": 98,
          "unitOfMeasure": "EACH",
          "lotNumber": "LOT-2024-001",
          "expiryDate": "2025-01-15T00:00:00Z",
          "location": "A-01-02-03",
          "receiptStatus": "RECEIVED"
        }
      ],
      "receivedBy": "OPERATOR-001",
      "qualityCheckedBy": "QC-INSPECTOR-002",
      "totalExpectedItems": 100,
      "totalReceivedItems": 98,
      "varianceItems": -2,
      "varianceReason": "DAMAGED_IN_TRANSIT",
      "documents": [
        {
          "type": "DELIVERY_NOTE",
          "documentId": "DN-2024-001234",
          "uploadedAt": "2024-01-15T14:35:00Z"
        }
      ]
    }
  ],
  "summary": {
    "totalGiaReceipts": 150,
    "totalExpectedItems": 15000,
    "totalReceivedItems": 14950,
    "totalVarianceItems": -50,
    "averageReceiptTime": "00:25:30"
  }
}

Error Response (400)

{
  "success": false,
  "error": "INVALID_PARAMETERS",
  "message": "Invalid query parameters",
  "details": [
    {
      "parameter": "startTime",
      "message": "Start time must be in ISO 8601 format"
    },
    {
      "parameter": "endTime",
      "message": "End time cannot be before start time"
    }
  ]
}

Example Usage

curl -X GET \
  "https://api.wms.example.com/inbound/v2/gia-receipt?startTime=2024-01-01T00:00:00Z&endTime=2024-01-31T23:59:59Z&startIndex=0&endIndex=100" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Receipt Status Values

• PENDING - GIA received, awaiting delivery
• IN_PROGRESS - Currently receiving goods
• COMPLETED - All expected goods received
• PARTIALLY_RECEIVED - Some items received, with variances
• CANCELLED - Receipt cancelled

Pagination

Results are paginated using startIndex and endIndex parameters:

• Maximum of 1000 records per request
• Use hasMore field to determine if additional pages are available
• Increment startIndex by the number of records returned for the next page