Skip to navigation

Cancel ASN

View as Markdown

Cancel ASN

This endpoint allows the user to cancel an Advanced Shipping Notice (ASN) by providing the ASN ID and any relevant remarks.

Request

  • Method: POST

  • Endpoint: {{host}}/apis/external/asn/cancelAsn/

  • Request Body (JSON):

    • asnId (string): The unique identifier of the ASN that you wish to cancel.

    • remarks (string): Additional comments or information regarding the cancellation.

Example Request Body

{
"asnId": "ASN-KARANDEVENV-000000106",
"remarks": "testing"
}

Response

  • Status Code: 409 (Conflict)

  • Content-Type: application/json

  • Response Body:

    • message (string): A message detailing the result of the cancellation attempt.

    • error (string): Any error information related to the cancellation process.

Example Response

{
"message": "",
"error": ""

Notes

A 409 status code indicates that the request could not be completed due to a conflict with the current state of the resource. Ensure that the ASN ID provided is valid and that the ASN is eligible for cancellation.

Headers

DICE-APP-IDstringOptional
X-CLIENT-IDstringOptional
X-CLIENT-SECRETstringOptional
statusstringOptional

Request

This endpoint expects an object.
asnIdstringRequired
remarksstringRequired

Response

OK