POST api/SDKWishMailBag/CancelOrders

Request Information

URI Parameters

None.

Body Parameters

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

Request Formats

application/json, text/json

Sample:

{
  "Orders": [
    {
      "tracking_id": "sample string 1",
      "cancel_reason_code": 2,
      "invalid_reason": "sample string 3"
    },
    {
      "tracking_id": "sample string 1",
      "cancel_reason_code": 2,
      "invalid_reason": "sample string 3"
    }
  ],
  "LogisticsProviderId": 1
}

application/xml, text/xml

Sample:

<CancelOrdersReq 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>
  <Orders>
    <CancelOrders>
      <cancel_reason_code>2</cancel_reason_code>
      <invalid_reason>sample string 3</invalid_reason>
      <tracking_id>sample string 1</tracking_id>
    </CancelOrders>
    <CancelOrders>
      <cancel_reason_code>2</cancel_reason_code>
      <invalid_reason>sample string 3</invalid_reason>
      <tracking_id>sample string 1</tracking_id>
    </CancelOrders>
  </Orders>
</CancelOrdersReq>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CancelOrdersRes

Name	Type	Additional information
is_cancelling_orders	Collection of CancelOrdersSingle	None.
failed_cancel_orders	Collection of CancelOrdersSingle	None.
code	integer	None.
message	string	None.
timestamp	string	None.
ResponseBody	string	None.

Response Formats

application/json, text/json

Sample:

{
  "is_cancelling_orders": [
    {
      "wish_standard_tracking_id": 1,
      "tracking_id": 2,
      "cancel_result_code": 3,
      "cancel_result_message": 4,
      "user_id": 5
    },
    {
      "wish_standard_tracking_id": 1,
      "tracking_id": 2,
      "cancel_result_code": 3,
      "cancel_result_message": 4,
      "user_id": 5
    }
  ],
  "failed_cancel_orders": [
    {
      "wish_standard_tracking_id": 1,
      "tracking_id": 2,
      "cancel_result_code": 3,
      "cancel_result_message": 4,
      "user_id": 5
    },
    {
      "wish_standard_tracking_id": 1,
      "tracking_id": 2,
      "cancel_result_code": 3,
      "cancel_result_message": 4,
      "user_id": 5
    }
  ],
  "code": 1,
  "message": "sample string 2",
  "timestamp": "sample string 3",
  "ResponseBody": "sample string 4"
}

application/xml, text/xml

Sample:

<CancelOrdersRes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Willv.Logistics.Standard.Sdk.Logistics.WishMail.BagModel">
  <ResponseBody>sample string 4</ResponseBody>
  <code>1</code>
  <message>sample string 2</message>
  <timestamp>sample string 3</timestamp>
  <failed_cancel_orders>
    <CancelOrdersSingle>
      <cancel_result_code>3</cancel_result_code>
      <cancel_result_message>4</cancel_result_message>
      <tracking_id>2</tracking_id>
      <user_id>5</user_id>
      <wish_standard_tracking_id>1</wish_standard_tracking_id>
    </CancelOrdersSingle>
    <CancelOrdersSingle>
      <cancel_result_code>3</cancel_result_code>
      <cancel_result_message>4</cancel_result_message>
      <tracking_id>2</tracking_id>
      <user_id>5</user_id>
      <wish_standard_tracking_id>1</wish_standard_tracking_id>
    </CancelOrdersSingle>
  </failed_cancel_orders>
  <is_cancelling_orders>
    <CancelOrdersSingle>
      <cancel_result_code>3</cancel_result_code>
      <cancel_result_message>4</cancel_result_message>
      <tracking_id>2</tracking_id>
      <user_id>5</user_id>
      <wish_standard_tracking_id>1</wish_standard_tracking_id>
    </CancelOrdersSingle>
    <CancelOrdersSingle>
      <cancel_result_code>3</cancel_result_code>
      <cancel_result_message>4</cancel_result_message>
      <tracking_id>2</tracking_id>
      <user_id>5</user_id>
      <wish_standard_tracking_id>1</wish_standard_tracking_id>
    </CancelOrdersSingle>
  </is_cancelling_orders>
</CancelOrdersRes>