POST api/external-orders/{externalOrderID}/cancel

Request Information

URI Parameters

Name	Description	Type	Additional information
externalOrderID		integer	Required

Body Parameters

None.

Response Information

Resource Description

ExternalOrderDeepData

Name	Type	Additional information
Items	Collection of ExternalOrderItemData	None.
Date	date	None.
DateArg	date	None.
EcommerceID	integer	None.
EcommerceCode	string	None.
EcommerceName	string	None.
FullName	string	None.
FullStreetName	string	None.
Phone	string	None.
City	string	None.
Description	string	None.
Status	string	None.
TotalAmount	decimal number	None.
ExternalUserID	integer	None.
UserSellerID	globally unique identifier	None.
UserSellerDisplayName	string	None.
PriceListID	integer	None.
ClientID	integer	None.
ID	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Items": [
    {
      "OrderID": 1,
      "EcommerceItemID": 1,
      "TransactionableID": 1,
      "TransactionableCode": "sample string 1",
      "TransactionableName": "sample string 2",
      "MainImageUrl": "sample string 3",
      "Quantity": 1.0,
      "UnitAmount": 1.0,
      "ID": 1
    },
    {
      "OrderID": 1,
      "EcommerceItemID": 1,
      "TransactionableID": 1,
      "TransactionableCode": "sample string 1",
      "TransactionableName": "sample string 2",
      "MainImageUrl": "sample string 3",
      "Quantity": 1.0,
      "UnitAmount": 1.0,
      "ID": 1
    }
  ],
  "Date": "2025-08-02T19:13:35.1817655+00:00",
  "DateArg": "2025-08-02T19:13:35.1817655+00:00",
  "EcommerceID": 1,
  "EcommerceCode": "sample string 1",
  "EcommerceName": "sample string 2",
  "FullName": "sample string 3",
  "FullStreetName": "sample string 4",
  "Phone": "sample string 5",
  "City": "sample string 6",
  "Description": "sample string 7",
  "Status": "sample string 8",
  "TotalAmount": 1.0,
  "ExternalUserID": 1,
  "UserSellerID": "4f8f2e5a-a155-46b8-a6dc-e66943a645cb",
  "UserSellerDisplayName": "sample string 9",
  "PriceListID": 1,
  "ClientID": 1,
  "ID": 1
}

text/xml

Sample:

<ExternalOrderDeepData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data.ExternalUsers">
  <ID xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data">1</ID>
  <City>sample string 6</City>
  <ClientID>1</ClientID>
  <Date>2025-08-02T19:13:35.1817655+00:00</Date>
  <DateArg>2025-08-02T19:13:35.1817655+00:00</DateArg>
  <Description>sample string 7</Description>
  <EcommerceCode>sample string 1</EcommerceCode>
  <EcommerceID>1</EcommerceID>
  <EcommerceName>sample string 2</EcommerceName>
  <ExternalUserID>1</ExternalUserID>
  <FullName>sample string 3</FullName>
  <FullStreetName>sample string 4</FullStreetName>
  <Phone>sample string 5</Phone>
  <PriceListID>1</PriceListID>
  <Status>sample string 8</Status>
  <TotalAmount>1</TotalAmount>
  <UserSellerDisplayName>sample string 9</UserSellerDisplayName>
  <UserSellerID>4f8f2e5a-a155-46b8-a6dc-e66943a645cb</UserSellerID>
  <Items>
    <ExternalOrderItemData>
      <ID xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data">1</ID>
      <EcommerceItemID>1</EcommerceItemID>
      <MainImageUrl>sample string 3</MainImageUrl>
      <OrderID>1</OrderID>
      <Quantity>1</Quantity>
      <TransactionableCode>sample string 1</TransactionableCode>
      <TransactionableID>1</TransactionableID>
      <TransactionableName>sample string 2</TransactionableName>
      <UnitAmount>1</UnitAmount>
    </ExternalOrderItemData>
    <ExternalOrderItemData>
      <ID xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data">1</ID>
      <EcommerceItemID>1</EcommerceItemID>
      <MainImageUrl>sample string 3</MainImageUrl>
      <OrderID>1</OrderID>
      <Quantity>1</Quantity>
      <TransactionableCode>sample string 1</TransactionableCode>
      <TransactionableID>1</TransactionableID>
      <TransactionableName>sample string 2</TransactionableName>
      <UnitAmount>1</UnitAmount>
    </ExternalOrderItemData>
  </Items>
</ExternalOrderDeepData>