POST api/order/Shipping/{orderId}

Request Information

URI Parameters

Name	Description	Type	Additional information
orderId		integer	Required

Body Parameters

ShippingDTO

Name	Type	Additional information
items	Collection of ShippingItemDTO	None.
tracks	Collection of TrackingDTO	None.
notify	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "order_item_id": 1,
      "qty": 2
    },
    {
      "order_item_id": 1,
      "qty": 2
    }
  ],
  "tracks": [
    {
      "track_number": "sample string 1",
      "title": "sample string 2",
      "carrier_code": "sample string 3"
    },
    {
      "track_number": "sample string 1",
      "title": "sample string 2",
      "carrier_code": "sample string 3"
    }
  ],
  "notify": true
}

application/xml, text/xml

Sample:

<ShippingDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KGIMagentoSync.DTOs">
  <Items>
    <ShippingItemDTO>
      <OrderItemId>1</OrderItemId>
      <Qty>2</Qty>
    </ShippingItemDTO>
    <ShippingItemDTO>
      <OrderItemId>1</OrderItemId>
      <Qty>2</Qty>
    </ShippingItemDTO>
  </Items>
  <Notify>true</Notify>
  <Tracks>
    <TrackingDTO>
      <CarrierCode>sample string 3</CarrierCode>
      <Title>sample string 2</Title>
      <TrackingNumber>sample string 1</TrackingNumber>
    </TrackingDTO>
    <TrackingDTO>
      <CarrierCode>sample string 3</CarrierCode>
      <Title>sample string 2</Title>
      <TrackingNumber>sample string 1</TrackingNumber>
    </TrackingDTO>
  </Tracks>
</ShippingDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.