POST api/SDKWishMailBag/CancelOrderBag

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CancelOrders		Collection of CancelOrdersBag	None.
LogisticsProviderId		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CancelOrders": [
    {
      "bag_number": "sample string 1",
      "cancel_reason": "sample string 2"
    },
    {
      "bag_number": "sample string 1",
      "cancel_reason": "sample string 2"
    }
  ],
  "LogisticsProviderId": 1
}

application/xml, text/xml

Sample:

<CancelOrderBagReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MS.LPS.Model.WishMail.Bag">
  <LogisticsProviderId xmlns="http://schemas.datacontract.org/2004/07/MS.LPS.Model.WishMail">1</LogisticsProviderId>
  <CancelOrders>
    <CancelOrdersBag>
      <bag_number>sample string 1</bag_number>
      <cancel_reason>sample string 2</cancel_reason>
    </CancelOrdersBag>
    <CancelOrdersBag>
      <bag_number>sample string 1</bag_number>
      <cancel_reason>sample string 2</cancel_reason>
    </CancelOrdersBag>
  </CancelOrders>
</CancelOrderBagReq>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseResultOfCancelOrdersBagRes

Name	Type	Additional information
Status	boolean	None.
ErrorCode	string	None.
ErrorMessage	string	None.
Data	CancelOrdersBagRes	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": true,
  "ErrorCode": "sample string 2",
  "ErrorMessage": "sample string 3",
  "Data": {
    "failed_bags": [
      {
        "fail_code": 1,
        "bag_numbers": [
          "sample string 1",
          "sample string 2"
        ],
        "fail_message": "sample string 2"
      },
      {
        "fail_code": 1,
        "bag_numbers": [
          "sample string 1",
          "sample string 2"
        ],
        "fail_message": "sample string 2"
      }
    ],
    "code": 1,
    "message": "sample string 2",
    "timestamp": "sample string 3",
    "ResponseBody": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<ResponseResultOfCancelOrdersBagRes_PWIItCWP xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Willv.Common">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Willv.Logistics.Standard.Sdk.Logistics.WishMail.BagModel">
    <d2p1:ResponseBody>sample string 4</d2p1:ResponseBody>
    <d2p1:code>1</d2p1:code>
    <d2p1:message>sample string 2</d2p1:message>
    <d2p1:timestamp>sample string 3</d2p1:timestamp>
    <d2p1:failed_bags>
      <d2p1:FailedBag>
        <d2p1:bag_numbers xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:bag_numbers>
        <d2p1:fail_code>1</d2p1:fail_code>
        <d2p1:fail_message>sample string 2</d2p1:fail_message>
      </d2p1:FailedBag>
      <d2p1:FailedBag>
        <d2p1:bag_numbers xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:bag_numbers>
        <d2p1:fail_code>1</d2p1:fail_code>
        <d2p1:fail_message>sample string 2</d2p1:fail_message>
      </d2p1:FailedBag>
    </d2p1:failed_bags>
  </Data>
  <ErrorCode>sample string 2</ErrorCode>
  <ErrorMessage>sample string 3</ErrorMessage>
  <Status>true</Status>
</ResponseResultOfCancelOrdersBagRes_PWIItCWP>