Overview

HTTP Method: PUT

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

Authentication: Required

Response Format: JSON

Description

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

• Response Code
• Message

Request

Path Parameter

• Shipment Docs ID (shipmentdocs_id): The identifier generated during the creation of a new Shipment. Retrieve this ID from the response of the POST Shipment API.

Main Fields

• Shipment Status (shipment_status): This field defines the status of Shipment. When creating, pass the default value "Created."
• 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'.
• Document (document): This field defines document that will be created and linked with shipment.
• Document Name (document_name): This specifies the name that the user wishes to assign to the document being created.
• Output Type (output_type): This specifies the output type of the document being created.

Example Path Parameter

https://coreapi.impexdocs.com/api/v1/documents/your_shipmentdocs_id

Example Request

Ensure to include the Shipment Docs ID in the path and provide any additional fields that need modification in the request JSON.

Response

The API will respond with a JSON object containing:

• Response Code
• Message

Example Response JSON

{
  "response_code": 200,
  "message": "Document modified successfully"
}

Note

• Ensure proper authentication before making the request.
• Use the Shipment Docs ID obtained during the creation of the Shipment for the path parameter.
• Provide the necessary fields to be modified in the request JSON.