POST Orders/AddOrderItem

Creates a new OrderItem. To modify, use ModifyOrderItem.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
VariationID		integer	None.
Quantity		decimal number	None.
Observations	Customer observations	string	String length: inclusive between 0 and 500
OrderID		integer	None.
Lang		string	None.
StoreID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "VariationID": 1,
  "Quantity": 2.0,
  "Observations": "sample string 3",
  "OrderID": 4,
  "Lang": "sample string 5",
  "StoreID": 6
}

application/xml, text/xml

Sample:

<AddOrderItemBinding 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 5</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">6</StoreID>
  <OrderID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Order">4</OrderID>
  <Observations>sample string 3</Observations>
  <Quantity>2</Quantity>
  <VariationID>1</VariationID>
</AddOrderItemBinding>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderItem

Name	Description	Type	Additional information
ID		integer	None.
Created		date	None.
Modified		date	None.
OrderID		integer	None.
ProductID	ProductID of a composite products To be used exclusively with composite products	integer	None.
VariationID	For a composite product, use the variationID of a component	integer	None.
PromotionItemID	Applied PromotionItem	integer	None.
CouponID	Applied Coupon	integer	None.
Quantity		decimal number	None.
TaxRateID	The taxRate to apply to this model	integer	None.
AutoAddRemove	This item is automatically added or removed and cannot be modified by the web front	boolean	None.
OriginalPrice	Price Without Discount	PriceBreakdown	None.
Price		PriceBreakdown	None.
Components		Collection of OrderItemComponent	None.
Observations	Customer observations	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Created": "2025-12-06T09:15:05.0967275+01:00",
  "Modified": "2025-12-06T09:15:05.0967275+01:00",
  "OrderID": 4,
  "ProductID": 1,
  "VariationID": 5,
  "PromotionItemID": 1,
  "CouponID": 1,
  "Quantity": 6.0,
  "TaxRateID": 7,
  "AutoAddRemove": true,
  "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
  },
  "Components": [
    {
      "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
      }
    },
    {
      "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
      }
    }
  ],
  "Observations": "sample string 9"
}

application/xml, text/xml

Sample:

<OrderItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Order">
  <AutoAddRemove>true</AutoAddRemove>
  <Components>
    <OrderItemComponent>
      <ComponentID>3</ComponentID>
      <ID>1</ID>
      <OrderItemID>2</OrderItemID>
      <OriginalPrice xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
        <d4p1:Amount>10</d4p1:Amount>
        <d4p1:Base>7</d4p1:Base>
        <d4p1:EquivalenceSurcharge>9</d4p1:EquivalenceSurcharge>
        <d4p1:EquivalenceSurchargePercent>6</d4p1:EquivalenceSurchargePercent>
        <d4p1:Tax>8</d4p1:Tax>
        <d4p1:TaxPercent>5</d4p1:TaxPercent>
        <d4p1:Discount>2</d4p1:Discount>
        <d4p1:DiscountPercent>3</d4p1:DiscountPercent>
        <d4p1:UnitAmount>1</d4p1:UnitAmount>
        <d4p1:UnitBase>4</d4p1:UnitBase>
      </OriginalPrice>
      <Price xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
        <d4p1:Amount>10</d4p1:Amount>
        <d4p1:Base>7</d4p1:Base>
        <d4p1:EquivalenceSurcharge>9</d4p1:EquivalenceSurcharge>
        <d4p1:EquivalenceSurchargePercent>6</d4p1:EquivalenceSurchargePercent>
        <d4p1:Tax>8</d4p1:Tax>
        <d4p1:TaxPercent>5</d4p1:TaxPercent>
        <d4p1:Discount>2</d4p1:Discount>
        <d4p1:DiscountPercent>3</d4p1:DiscountPercent>
        <d4p1:UnitAmount>1</d4p1:UnitAmount>
        <d4p1:UnitBase>4</d4p1:UnitBase>
      </Price>
      <Quantity>5</Quantity>
      <VariationID>4</VariationID>
    </OrderItemComponent>
    <OrderItemComponent>
      <ComponentID>3</ComponentID>
      <ID>1</ID>
      <OrderItemID>2</OrderItemID>
      <OriginalPrice xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
        <d4p1:Amount>10</d4p1:Amount>
        <d4p1:Base>7</d4p1:Base>
        <d4p1:EquivalenceSurcharge>9</d4p1:EquivalenceSurcharge>
        <d4p1:EquivalenceSurchargePercent>6</d4p1:EquivalenceSurchargePercent>
        <d4p1:Tax>8</d4p1:Tax>
        <d4p1:TaxPercent>5</d4p1:TaxPercent>
        <d4p1:Discount>2</d4p1:Discount>
        <d4p1:DiscountPercent>3</d4p1:DiscountPercent>
        <d4p1:UnitAmount>1</d4p1:UnitAmount>
        <d4p1:UnitBase>4</d4p1:UnitBase>
      </OriginalPrice>
      <Price xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
        <d4p1:Amount>10</d4p1:Amount>
        <d4p1:Base>7</d4p1:Base>
        <d4p1:EquivalenceSurcharge>9</d4p1:EquivalenceSurcharge>
        <d4p1:EquivalenceSurchargePercent>6</d4p1:EquivalenceSurchargePercent>
        <d4p1:Tax>8</d4p1:Tax>
        <d4p1:TaxPercent>5</d4p1:TaxPercent>
        <d4p1:Discount>2</d4p1:Discount>
        <d4p1:DiscountPercent>3</d4p1:DiscountPercent>
        <d4p1:UnitAmount>1</d4p1:UnitAmount>
        <d4p1:UnitBase>4</d4p1:UnitBase>
      </Price>
      <Quantity>5</Quantity>
      <VariationID>4</VariationID>
    </OrderItemComponent>
  </Components>
  <CouponID>1</CouponID>
  <Created>2025-12-06T09:15:05.0967275+01:00</Created>
  <ID>1</ID>
  <Modified>2025-12-06T09:15:05.0967275+01:00</Modified>
  <Observations>sample string 9</Observations>
  <OrderID>4</OrderID>
  <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>
  <ProductID>1</ProductID>
  <PromotionItemID>1</PromotionItemID>
  <Quantity>6</Quantity>
  <TaxRateID>7</TaxRateID>
  <VariationID>5</VariationID>
</OrderItem>