POST Orders/AddOrderItemComponent

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OrderItemID	integer	None.
ComponentID	integer	None.
VariationID	integer	None.
Quantity	decimal number	None.
OrderID	integer	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderItemID": 1,
  "ComponentID": 2,
  "VariationID": 3,
  "Quantity": 4.0,
  "OrderID": 5,
  "Lang": "sample string 6",
  "StoreID": 7
}

application/xml, text/xml

Sample:

<OrderItemComponentBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Order">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 6</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">7</StoreID>
  <OrderID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Order">5</OrderID>
  <ComponentID>2</ComponentID>
  <OrderItemID>1</OrderItemID>
  <Quantity>4</Quantity>
  <VariationID>3</VariationID>
</OrderItemComponentBinding>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderItemComponent

Name	Description	Type	Additional information
ID		integer	None.
OrderItemID		integer	None.
ComponentID	For a composite product, use the variationID of a component together with the OrderItemID where the composite variation resides	integer	None.
VariationID	Use the variationID of a component together with the OrderItemID where the composite variation resides	integer	None.
Quantity		decimal number	None.
OriginalPrice	Price Without Discount	PriceBreakdown	None.
Price		PriceBreakdown	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "OrderItemID": 2,
  "ComponentID": 3,
  "VariationID": 4,
  "Quantity": 5.0,
  "OriginalPrice": {
    "UnitAmount": 1.0,
    "Discount": 2.0,
    "DiscountPercent": 3.0,
    "UnitBase": 4.0,
    "TaxPercent": 5.0,
    "EquivalenceSurchargePercent": 6.0,
    "Base": 7.0,
    "Tax": 8.0,
    "EquivalenceSurcharge": 9.0,
    "Amount": 10.0
  },
  "Price": {
    "UnitAmount": 1.0,
    "Discount": 2.0,
    "DiscountPercent": 3.0,
    "UnitBase": 4.0,
    "TaxPercent": 5.0,
    "EquivalenceSurchargePercent": 6.0,
    "Base": 7.0,
    "Tax": 8.0,
    "EquivalenceSurcharge": 9.0,
    "Amount": 10.0
  }
}

application/xml, text/xml

Sample:

<OrderItemComponent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Order">
  <ComponentID>3</ComponentID>
  <ID>1</ID>
  <OrderItemID>2</OrderItemID>
  <OriginalPrice xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
    <d2p1:Amount>10</d2p1:Amount>
    <d2p1:Base>7</d2p1:Base>
    <d2p1:EquivalenceSurcharge>9</d2p1:EquivalenceSurcharge>
    <d2p1:EquivalenceSurchargePercent>6</d2p1:EquivalenceSurchargePercent>
    <d2p1:Tax>8</d2p1:Tax>
    <d2p1:TaxPercent>5</d2p1:TaxPercent>
    <d2p1:Discount>2</d2p1:Discount>
    <d2p1:DiscountPercent>3</d2p1:DiscountPercent>
    <d2p1:UnitAmount>1</d2p1:UnitAmount>
    <d2p1:UnitBase>4</d2p1:UnitBase>
  </OriginalPrice>
  <Price xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
    <d2p1:Amount>10</d2p1:Amount>
    <d2p1:Base>7</d2p1:Base>
    <d2p1:EquivalenceSurcharge>9</d2p1:EquivalenceSurcharge>
    <d2p1:EquivalenceSurchargePercent>6</d2p1:EquivalenceSurchargePercent>
    <d2p1:Tax>8</d2p1:Tax>
    <d2p1:TaxPercent>5</d2p1:TaxPercent>
    <d2p1:Discount>2</d2p1:Discount>
    <d2p1:DiscountPercent>3</d2p1:DiscountPercent>
    <d2p1:UnitAmount>1</d2p1:UnitAmount>
    <d2p1:UnitBase>4</d2p1:UnitBase>
  </Price>
  <Quantity>5</Quantity>
  <VariationID>4</VariationID>
</OrderItemComponent>