POST api/TO/PostTOFinalizeShipment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
TO_ID	integer	None.
SCREEN_ID	integer	None.
AR_ID	integer	None.
TO_STATUS	string	None.
BKG_ATTACHMENT	Collection of BKG_ATTACHMENT	None.
TO_ATTACH_FLAG	string	None.
TO_ATTACHMENT	Collection of TO_ATTACHDtls_XML	None.

Request Formats

application/json, text/json

Sample:

{
  "TO_ID": 1,
  "SCREEN_ID": 1,
  "AR_ID": 1,
  "TO_STATUS": "sample string 1",
  "BKG_ATTACHMENT": [
    {
      "BKA_ID": 1,
      "BKA_ATH_NAME": "sample string 1",
      "BKA_FILE_NAME": "sample string 2",
      "BKA_DETAILS": "sample string 3",
      "BKA_USER_ID": 1,
      "BKA_USER_CODE": "sample string 4",
      "BKA_CREATED_ON": "2025-12-06T04:28:54.4103318+00:00",
      "BKA_CP_ID": 1,
      "BKA_CP_CODE": "sample string 5"
    },
    {
      "BKA_ID": 1,
      "BKA_ATH_NAME": "sample string 1",
      "BKA_FILE_NAME": "sample string 2",
      "BKA_DETAILS": "sample string 3",
      "BKA_USER_ID": 1,
      "BKA_USER_CODE": "sample string 4",
      "BKA_CREATED_ON": "2025-12-06T04:28:54.4103318+00:00",
      "BKA_CP_ID": 1,
      "BKA_CP_CODE": "sample string 5"
    }
  ],
  "TO_ATTACH_FLAG": "sample string 2",
  "TO_ATTACHMENT": [
    {
      "BKA_ID": 1,
      "BKA_ATH_NAME": "sample string 1",
      "BKA_FILE_NAME": "sample string 2",
      "BKA_DETAILS": "sample string 3",
      "BKA_USER_ID": 1,
      "BKA_USER_CODE": "sample string 4",
      "BKA_CREATED_ON": "2025-12-06T04:28:54.4103318+00:00",
      "BKA_CP_ID": 1,
      "BKA_CP_CODE": "sample string 5"
    },
    {
      "BKA_ID": 1,
      "BKA_ATH_NAME": "sample string 1",
      "BKA_FILE_NAME": "sample string 2",
      "BKA_DETAILS": "sample string 3",
      "BKA_USER_ID": 1,
      "BKA_USER_CODE": "sample string 4",
      "BKA_CREATED_ON": "2025-12-06T04:28:54.4103318+00:00",
      "BKA_CP_ID": 1,
      "BKA_CP_CODE": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<TOGetFinalizeShipment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZealitAPI.Models">
  <AR_ID>1</AR_ID>
  <BKG_ATTACHMENT>
    <BKG_ATTACHMENT>
      <BKA_ATH_NAME>sample string 1</BKA_ATH_NAME>
      <BKA_CP_CODE>sample string 5</BKA_CP_CODE>
      <BKA_CP_ID>1</BKA_CP_ID>
      <BKA_CREATED_ON>2025-12-06T04:28:54.4103318+00:00</BKA_CREATED_ON>
      <BKA_DETAILS>sample string 3</BKA_DETAILS>
      <BKA_FILE_NAME>sample string 2</BKA_FILE_NAME>
      <BKA_ID>1</BKA_ID>
      <BKA_USER_CODE>sample string 4</BKA_USER_CODE>
      <BKA_USER_ID>1</BKA_USER_ID>
    </BKG_ATTACHMENT>
    <BKG_ATTACHMENT>
      <BKA_ATH_NAME>sample string 1</BKA_ATH_NAME>
      <BKA_CP_CODE>sample string 5</BKA_CP_CODE>
      <BKA_CP_ID>1</BKA_CP_ID>
      <BKA_CREATED_ON>2025-12-06T04:28:54.4103318+00:00</BKA_CREATED_ON>
      <BKA_DETAILS>sample string 3</BKA_DETAILS>
      <BKA_FILE_NAME>sample string 2</BKA_FILE_NAME>
      <BKA_ID>1</BKA_ID>
      <BKA_USER_CODE>sample string 4</BKA_USER_CODE>
      <BKA_USER_ID>1</BKA_USER_ID>
    </BKG_ATTACHMENT>
  </BKG_ATTACHMENT>
  <SCREEN_ID>1</SCREEN_ID>
  <TO_ATTACHMENT>
    <TO_ATTACHDtls_XML>
      <BKA_ATH_NAME>sample string 1</BKA_ATH_NAME>
      <BKA_CP_CODE>sample string 5</BKA_CP_CODE>
      <BKA_CP_ID>1</BKA_CP_ID>
      <BKA_CREATED_ON>2025-12-06T04:28:54.4103318+00:00</BKA_CREATED_ON>
      <BKA_DETAILS>sample string 3</BKA_DETAILS>
      <BKA_FILE_NAME>sample string 2</BKA_FILE_NAME>
      <BKA_ID>1</BKA_ID>
      <BKA_USER_CODE>sample string 4</BKA_USER_CODE>
      <BKA_USER_ID>1</BKA_USER_ID>
    </TO_ATTACHDtls_XML>
    <TO_ATTACHDtls_XML>
      <BKA_ATH_NAME>sample string 1</BKA_ATH_NAME>
      <BKA_CP_CODE>sample string 5</BKA_CP_CODE>
      <BKA_CP_ID>1</BKA_CP_ID>
      <BKA_CREATED_ON>2025-12-06T04:28:54.4103318+00:00</BKA_CREATED_ON>
      <BKA_DETAILS>sample string 3</BKA_DETAILS>
      <BKA_FILE_NAME>sample string 2</BKA_FILE_NAME>
      <BKA_ID>1</BKA_ID>
      <BKA_USER_CODE>sample string 4</BKA_USER_CODE>
      <BKA_USER_ID>1</BKA_USER_ID>
    </TO_ATTACHDtls_XML>
  </TO_ATTACHMENT>
  <TO_ATTACH_FLAG>sample string 2</TO_ATTACH_FLAG>
  <TO_ID>1</TO_ID>
  <TO_STATUS>sample string 1</TO_STATUS>
</TOGetFinalizeShipment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.