Push Pre-Alert Documents

POST

https://your-api-url

Initiated by HLSData from HLS

HLS will actively push Pre-Alert documents data to our customers through this interface.
Therefore, for this solution, you are required to parse the request body and provide the corresponding API endpoint URL to us.

You may determine whether to enable authentication and specify the authentication method, and we will cooperate in the development.

Request

Body Params application/json

Example

{
    "shipment_number": "string",
    "shipment_type": "Master Bill of Lading",
    "associated_files_collection": [
        {
            "blob": "string",
            "blob_filename": "string",
            "description": "string",
            "media_type": "application/pdf",
            "organization_access": true,
            "doc_type": "HBL"
        }
    ],
    "subshipment_collection": [
        {
            "shipment_number": "string",
            "shipment_type": "House Bill of Lading",
            "associated_files_collection": [
                {
                    "blob": "string",
                    "blob_filename": "string",
                    "description": "string",
                    "media_type": "application/pdf",
                    "organization_access": true,
                    "doc_type": "HBL"
                }
            ]
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://your-api-url' \
--header 'Content-Type: application/json' \
--data '{
    "shipment_number": "string",
    "shipment_type": "Master Bill of Lading",
    "associated_files_collection": [
        {
            "blob": "string",
            "blob_filename": "string",
            "description": "string",
            "media_type": "application/pdf",
            "organization_access": true,
            "doc_type": "HBL"
        }
    ],
    "subshipment_collection": [
        {
            "shipment_number": "string",
            "shipment_type": "House Bill of Lading",
            "associated_files_collection": [
                {
                    "blob": "string",
                    "blob_filename": "string",
                    "description": "string",
                    "media_type": "application/pdf",
                    "organization_access": true,
                    "doc_type": "HBL"
                }
            ]
        }
    ]
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "code": 200,
    "success": true,
    "message": "Import successful"
}

🔴500Server Error

Query Pre-Alert Documents