ScanForm

ScanForm Request Object

Attributes Definitions
shipDate Ship Date
labelObjectIds List of label objectIds(returned from create label api) included in this scan form

ScanForm Object

Attributes Definitions
labelObjectIds List of label objectIds(returned from create label api) included in this scan form
success Whether the scan form creation was successful (true/false)
errorMsg Error message if the scan form creation failed
objectId Unique identifier for this scan form
scanFormUrl PDF URL to access the scan form
scanFormNo Scanform No.

Create ScanForm

endpoint : https://ezeeship.com/api/ezeeship-openapi/scanform/create

Create ScanForm sample


POST : https://ezeeship.com/api/ezeeship-openapi/scanform/create
{
  "shipDate": "2025-07-03",
  "labelObjectIds": ["f03b5014e17d11e7aed3035406551f52"]
}

Response :

{
  "result": "OK",
  "message": "",
  "data": [
      {
        "labelObjectIds": ["f03b5014e17d11e7aed3035406551f52"],
        "success": true,
        "errorMsg": null,
        "objectId": "scan123456789",
        "scanFormUrl": "https://ezeeship.com/api/ezeeship-openapi/scanform/print?objectId=scan123456789",
        "scanFormNo": "987654321"
      }
  ]
}

results matching ""

    No results matching ""