POST api/{serverType}/Shipment/CancelOrder

Request Information

URI Parameters

Name	Description	Type	Additional information
serverType		string	Required

Body Parameters

CancelOrderRequest

Name	Description	Type	Additional information
DataRequests		Collection of CancelOrderDataRequest	None.
ConfigRequest		ServiceConfig	None.

Request Formats

application/json, text/json

Sample:

{
  "DataRequests": [
    {
      "OrderId": "sample string 1",
      "TrackingNumber": "sample string 2",
      "PackageSN": "sample string 3"
    },
    {
      "OrderId": "sample string 1",
      "TrackingNumber": "sample string 2",
      "PackageSN": "sample string 3"
    }
  ],
  "ConfigRequest": {
    "ServiceName": "sample string 1",
    "LoginName": "sample string 2",
    "Password": "sample string 3",
    "ServiceUrl": "sample string 4",
    "ShipmentAddress": {
      "Name": "sample string 1",
      "CompanyName": "sample string 2",
      "PostCode": "sample string 3",
      "Phone": "sample string 4",
      "Mobile": "sample string 5",
      "Country": "sample string 6",
      "City": "sample string 7",
      "Province": "sample string 8",
      "Email": "sample string 9",
      "Address1": "sample string 10",
      "Address2": "sample string 11",
      "Address3": "sample string 12",
      "CompanyCode": "sample string 13",
      "ClientCode": "sample string 14"
    },
    "BillingAddress": {
      "Name": "sample string 1",
      "CompanyName": "sample string 2",
      "PostCode": "sample string 3",
      "Phone": "sample string 4",
      "Mobile": "sample string 5",
      "Country": "sample string 6",
      "City": "sample string 7",
      "Province": "sample string 8",
      "Email": "sample string 9",
      "Address1": "sample string 10",
      "Address2": "sample string 11",
      "Address3": "sample string 12",
      "CompanyCode": "sample string 13",
      "ClientCode": "sample string 14"
    },
    "ExtraConfigs": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "AdditionalServicesInfo": {
      "PalletCount": 1,
      "NeedLiftgate": true
    },
    "PlatformClientId": "sample string 5"
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CancelOrderRequest'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.