POST API/Customer/Order?action={action}

Manage Orders: Add/Place or Update or Cancel an Order. Required parameter(s) for Action(s): "Add" : OrderDetails {ProductId,Quantity,UnitPrice,SubscriptionPlanId,SubscriptionStartDate, SubscriptionEndDate,SubscriptionDates} "Confirm" : OrderId. "OrderPickedUp : OrderId. "Delivered" : OrderId. "Cancel" : OrderId. "Return" : OrderId.

Request Information

URI Parameters

Name	Description	Type	Additional information
action	[Required] Expected Value(s): "Add","Confirm","OrderPickedUp","Delivered","Cancel","Return".	string	Required

Body Parameters

Object objOrder fields : "OrderId","OrderStatusId","UserDeliveryAddressId","OrderDetailList"

Order

Name	Type	Additional information
OrderId	integer	None.
OrderStatusId	integer	None.
UserDeliveryAddressId	integer	None.
ShippingCharges	decimal number	None.
CourierId	integer	None.
OrderDetailList	Collection of OrderDetails	None.
TrackingNumber	string	None.
Comments	string	None.
OrderPk	string	None.
DeliveryBoyId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "orderId": 1,
  "orderStatusId": 1,
  "userDeliveryAddressId": 1,
  "shippingCharges": 1.0,
  "courierId": 2,
  "orderDetailList": [
    {
      "orderId": 1,
      "productId": 1,
      "quantity": 1,
      "unitPrice": 2.0,
      "subscriptionPlanId": 3,
      "subscriptionStartDate": "sample string 4",
      "subscriptionEndDate": "sample string 5",
      "subscriptionDates": "sample string 6"
    },
    {
      "orderId": 1,
      "productId": 1,
      "quantity": 1,
      "unitPrice": 2.0,
      "subscriptionPlanId": 3,
      "subscriptionStartDate": "sample string 4",
      "subscriptionEndDate": "sample string 5",
      "subscriptionDates": "sample string 6"
    }
  ],
  "trackingNumber": "sample string 3",
  "comments": "sample string 4",
  "orderPk": "sample string 5",
  "deliveryBoyId": 6
}

application/xml, text/xml

Sample:

<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrownCow.Customer.EntityLayer">
  <Comments>sample string 4</Comments>
  <CourierId>2</CourierId>
  <DeliveryBoyId>6</DeliveryBoyId>
  <OrderDetailList>
    <OrderDetails>
      <OrderId>1</OrderId>
      <ProductId>1</ProductId>
      <Quantity>1</Quantity>
      <SubscriptionDates>sample string 6</SubscriptionDates>
      <SubscriptionEndDate>sample string 5</SubscriptionEndDate>
      <SubscriptionPlanId>3</SubscriptionPlanId>
      <SubscriptionStartDate>sample string 4</SubscriptionStartDate>
      <UnitPrice>2</UnitPrice>
    </OrderDetails>
    <OrderDetails>
      <OrderId>1</OrderId>
      <ProductId>1</ProductId>
      <Quantity>1</Quantity>
      <SubscriptionDates>sample string 6</SubscriptionDates>
      <SubscriptionEndDate>sample string 5</SubscriptionEndDate>
      <SubscriptionPlanId>3</SubscriptionPlanId>
      <SubscriptionStartDate>sample string 4</SubscriptionStartDate>
      <UnitPrice>2</UnitPrice>
    </OrderDetails>
  </OrderDetailList>
  <OrderId>1</OrderId>
  <OrderPk>sample string 5</OrderPk>
  <OrderStatusId>1</OrderStatusId>
  <ShippingCharges>1</ShippingCharges>
  <TrackingNumber>sample string 3</TrackingNumber>
  <UserDeliveryAddressId>1</UserDeliveryAddressId>
</Order>

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.