Skip to main content

Delete Trade Tracking Entry

DELETE /api/v1/trade-trackings/{trackingId}

Description

Deletes a specific trade tracking entry from the system. This endpoint is used to remove outdated or no longer needed tracking information, helping to maintain the cleanliness and relevance of data within the trade tracking system.

URL Parameters:

  • trackingId (required): The unique identifier of the trade tracking entry to be deleted. This must be included in the URL path.

Headers:

  • tenantId (required): The tenant ID under which the trade tracking is registered. This header identifies the specific tenant environment and should be included.
  • userId (required): The user ID of the individual responsible for deleting the trade tracking. This header is used for authentication and authorization.

Example Request:

curl -X DELETE "http://[base_url]/api/v1/trade-trackings/{trackingId}" \
-H "Authorization: Bearer [access_token]" \
-H "tenantId: TEN123" \
-H "userId: USR456"

Responses:

  • 200 OK: Successfully deleted the trade tracking entry. The response typically includes a confirmation message stating that the tracking has been removed.

Example Response:

{
"message": "Trade tracking deleted successfully."
}

Error Responses:

  • 400 Bad Request: Incorrect parameters provided.
  • 404 Not Found: No tracking found with the provided trackingId.
  • 403 Forbidden: The user does not have permission to delete the tracking.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request DELETE \ 
--url /api/v1/trade-trackings/{trackingId} \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!