POST Sales/OrderShipment/Delivered

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
StoreId	integer	None.
OrderId	integer	None.
ShipmentNo	integer	None.
TrackingNumber	string	None.
AdminComment	string	None.
TotalWeight	decimal number	None.
DateShipped	date	None.
DateDelivered	date	None.
ShipmentDetails	Collection of ShipmentDetailViewModel	None.
ModifiedBy	string	None.
ModifiedDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "StoreId": 1,
  "OrderId": 2,
  "ShipmentNo": 3,
  "TrackingNumber": "sample string 4",
  "AdminComment": "sample string 5",
  "TotalWeight": 6.0,
  "DateShipped": "2025-04-26T16:42:32.1737219+01:00",
  "DateDelivered": "2025-04-26T16:42:32.1737219+01:00",
  "ShipmentDetails": [
    {
      "Id": 1,
      "StoreId": 1,
      "ShipmentId": 2,
      "ProductId": 3,
      "ProductName": "sample string 4",
      "ProductShippingEnabled": true,
      "ProductWeight": 6.0,
      "ProductLength": 7.0,
      "ProductWidth": 8.0,
      "ProductHeight": 9.0,
      "QuantityOrdered": 10.0,
      "QuantityShiped": 11.0,
      "QuantityToShiped": 12.0,
      "ModifiedBy": "sample string 13",
      "ModifiedDate": "2025-04-26T16:42:32.1737219+01:00"
    },
    {
      "Id": 1,
      "StoreId": 1,
      "ShipmentId": 2,
      "ProductId": 3,
      "ProductName": "sample string 4",
      "ProductShippingEnabled": true,
      "ProductWeight": 6.0,
      "ProductLength": 7.0,
      "ProductWidth": 8.0,
      "ProductHeight": 9.0,
      "QuantityOrdered": 10.0,
      "QuantityShiped": 11.0,
      "QuantityToShiped": 12.0,
      "ModifiedBy": "sample string 13",
      "ModifiedDate": "2025-04-26T16:42:32.1737219+01:00"
    }
  ],
  "ModifiedBy": "sample string 9",
  "ModifiedDate": "2025-04-26T16:42:32.1737219+01:00"
}

application/xml, text/xml

Sample:

<ShipmentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ECommerce.Service.Sales.ViewModel">
  <AdminComment>sample string 5</AdminComment>
  <DateDelivered>2025-04-26T16:42:32.1737219+01:00</DateDelivered>
  <DateShipped>2025-04-26T16:42:32.1737219+01:00</DateShipped>
  <Id>1</Id>
  <ModifiedBy>sample string 9</ModifiedBy>
  <ModifiedDate>2025-04-26T16:42:32.1737219+01:00</ModifiedDate>
  <OrderId>2</OrderId>
  <ShipmentDetails>
    <ShipmentDetailViewModel>
      <Id>1</Id>
      <ModifiedBy>sample string 13</ModifiedBy>
      <ModifiedDate>2025-04-26T16:42:32.1737219+01:00</ModifiedDate>
      <ProductHeight>9</ProductHeight>
      <ProductId>3</ProductId>
      <ProductLength>7</ProductLength>
      <ProductName>sample string 4</ProductName>
      <ProductShippingEnabled>true</ProductShippingEnabled>
      <ProductWeight>6</ProductWeight>
      <ProductWidth>8</ProductWidth>
      <QuantityOrdered>10</QuantityOrdered>
      <QuantityShiped>11</QuantityShiped>
      <QuantityToShiped>12</QuantityToShiped>
      <ShipmentId>2</ShipmentId>
      <StoreId>1</StoreId>
    </ShipmentDetailViewModel>
    <ShipmentDetailViewModel>
      <Id>1</Id>
      <ModifiedBy>sample string 13</ModifiedBy>
      <ModifiedDate>2025-04-26T16:42:32.1737219+01:00</ModifiedDate>
      <ProductHeight>9</ProductHeight>
      <ProductId>3</ProductId>
      <ProductLength>7</ProductLength>
      <ProductName>sample string 4</ProductName>
      <ProductShippingEnabled>true</ProductShippingEnabled>
      <ProductWeight>6</ProductWeight>
      <ProductWidth>8</ProductWidth>
      <QuantityOrdered>10</QuantityOrdered>
      <QuantityShiped>11</QuantityShiped>
      <QuantityToShiped>12</QuantityToShiped>
      <ShipmentId>2</ShipmentId>
      <StoreId>1</StoreId>
    </ShipmentDetailViewModel>
  </ShipmentDetails>
  <ShipmentNo>3</ShipmentNo>
  <StoreId>1</StoreId>
  <TotalWeight>6</TotalWeight>
  <TrackingNumber>sample string 4</TrackingNumber>
</ShipmentViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.