Overview

HTTP Method: POST

Endpoint URL: https://coreapi.impexdocs.com/api/v1/documents/{shipmentfolderdetail_id}

Authentication: Required

Response Format: JSON

Description

To create a Document, make a POST request to the specified endpoint with the required information. The response will be a JSON object containing the following:

• Response Code
• Status
• Message
• Shipment ID
• Document Name
• Shipment Docs Id
• Shipment Folder Detail Id

Request

To create a Document, provide the following inputs in the request JSON:

1. Shipment Folder Detail Id (shipmentfolderdetail_no): The identifier generated during the creation of a new Shipment. Retrieve this ID from the response of the POST Shipment API.

2. Shipment Status (shipment_status): This field defines the status of Shipment. When creating, pass the default value "Created."

3. Sequence (sequence): This defines the sequence number of the document attached with shipment. Sequence number for documents should be greater than 1, since sequence of 'Master' document will be either '0' or '1'.

4. Document (document): This field defines document that will be created and linked with shipment.

5. Document Name (document_name): This specifies the name that the user wishes to assign to the document being created.

6. Output Type (output_type): This specifies the output type of the document being created.

Response

The API will respond with a JSON object containing the following:

• Response Code
• Status
• Message
• Shipment ID
• Document Name
• Shipment Docs Id
• Shipment Folder Detail Id

Example Response JSON

{
    "response_code": 0,
    "status": 201,
    "message": "Created",
    "result": [
        {
            "shipment_id": "Impx-Demo-01",
            "document_name": "Health Certificate - Authority",
            "shipmentdocs_id": "8j7270d1-8hth-45fb-a8be-1ad2f099f020",
            "shipmentfolderdetail_id": "95b189uf-245b-4926-b1f6-260803le5fd6"
        }
    ]
}

Note

• Ensure proper authentication before making the request.