POST Orders/Items

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OrderID	integer	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderID": 1,
  "Lang": "sample string 2",
  "StoreID": 3
}

application/xml, text/xml

Sample:

<OrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Order">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 2</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">3</StoreID>
  <OrderID>1</OrderID>
</OrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of 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:18:36.1024997+01:00",
    "Modified": "2025-12-06T09:18:36.1024997+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"
  },
  {
    "ID": 1,
    "Created": "2025-12-06T09:18:36.1024997+01:00",
    "Modified": "2025-12-06T09:18:36.1024997+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:

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