Delete Document from Shipment

Overview

HTTP Method: PUT

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

Authentication: Required

Response Format: JSON

Description

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

  • Response Code
  • Message

Request

Path Parameter

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

Example Path Parameter

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

Example Request

Ensure to include the Shipment Folder Detail ID in the path.

Response

The API will respond with a JSON object containing:

  • Response Code
  • Message

Example Response JSON

{
  "response_code": 200,
  "message": "Document deleted 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.
Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!