PUT Order/PutCancelOrder

Request Information

URI Parameters

None.

Body Parameters

OrderCancelDto
NameDescriptionTypeAdditional information
OrderId

integer

Required

CancelReason

string

Required

String length: inclusive between 0 and 1000

Request Formats

application/json, text/json

Sample:
{
  "OrderId": 1,
  "CancelReason": "sample string 2"
}

application/xml, text/xml

Sample:
<OrderCancelDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PackageSite.Models.Dto">
  <CancelReason>sample string 2</CancelReason>
  <OrderId>1</OrderId>
</OrderCancelDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderDto
NameDescriptionTypeAdditional information
UserId

string

Required

String length: inclusive between 0 and 128

TransportCompanyId

integer

None.

DelivaryAddress

string

String length: inclusive between 0 and 4000

UserDescription

string

String length: inclusive between 0 and 4000

Comments

string

None.

OrderItems

Collection of OrderItemDto

None.

Response Formats

application/json, text/json

Sample:
{
  "UserId": "sample string 1",
  "TransportCompanyId": 2,
  "DelivaryAddress": "sample string 3",
  "UserDescription": "sample string 4",
  "Comments": "sample string 5",
  "OrderItems": [
    {
      "Quantity": 1,
      "ColorId": 2,
      "ProductId": 3
    },
    {
      "Quantity": 1,
      "ColorId": 2,
      "ProductId": 3
    }
  ]
}

application/xml, text/xml

Sample:
<OrderDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PackageSite.Models.Dto">
  <Comments>sample string 5</Comments>
  <DelivaryAddress>sample string 3</DelivaryAddress>
  <OrderItems>
    <OrderItemDto>
      <ColorId>2</ColorId>
      <ProductId>3</ProductId>
      <Quantity>1</Quantity>
    </OrderItemDto>
    <OrderItemDto>
      <ColorId>2</ColorId>
      <ProductId>3</ProductId>
      <Quantity>1</Quantity>
    </OrderItemDto>
  </OrderItems>
  <TransportCompanyId>2</TransportCompanyId>
  <UserDescription>sample string 4</UserDescription>
  <UserId>sample string 1</UserId>
</OrderDto>