POST Orders/PromotedItems
Request Information
URI Parameters
None.
Body Parameters
OrderRequestName | Description | Type | Additional information |
---|---|---|---|
OrderID | integer |
None. |
|
Token | globally unique identifier |
None. |
|
Lang | string |
None. |
|
StoreID | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "OrderID": 1, "Token": "07e4946c-5966-443b-a2dd-6ad6c4cb7fae", "Lang": "sample string 3", "StoreID": 4 }
application/xml, text/xml
Sample:
<OrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Order"> <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">sample string 3</Lang> <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">4</StoreID> <OrderID>1</OrderID> <Token>07e4946c-5966-443b-a2dd-6ad6c4cb7fae</Token> </OrderRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
VariationPriceName | Description | Type | Additional information |
---|---|---|---|
VariationID | integer |
None. |
|
ProductID | integer |
None. |
|
OriginalPrice | PriceBreakdown |
None. |
|
Price | PriceBreakdown |
None. |
|
Promotions | Collection of PromotionItem |
None. |
Response Formats
application/json, text/json
Sample:
{ "VariationID": 1, "ProductID": 2, "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 }, "Promotions": [ { "ID": 1, "PromotionID": 2, "Base": 3.0, "Amount": 4.0, "Discount": 5.0, "DiscountPercent": 6.0, "MinimumOrderAmount": 7.0, "MinimumQuantity": 8.0, "QuantityStep": 9.0, "MaximumQuantity": 1.0, "ValidFrom": "2024-11-12T21:04:36.4527497+01:00", "Expiration": "2024-11-12T21:04:36.4527497+01:00", "AutoAddRemoveQuantity": 11.0, "Cumulative": true }, { "ID": 1, "PromotionID": 2, "Base": 3.0, "Amount": 4.0, "Discount": 5.0, "DiscountPercent": 6.0, "MinimumOrderAmount": 7.0, "MinimumQuantity": 8.0, "QuantityStep": 9.0, "MaximumQuantity": 1.0, "ValidFrom": "2024-11-12T21:04:36.4527497+01:00", "Expiration": "2024-11-12T21:04:36.4527497+01:00", "AutoAddRemoveQuantity": 11.0, "Cumulative": true } ] }
application/xml, text/xml
Sample:
<VariationPrice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Catalog"> <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>2</ProductID> <Promotions> <PromotionItem> <Amount>4</Amount> <AutoAddRemoveQuantity>11</AutoAddRemoveQuantity> <Base>3</Base> <Cumulative>true</Cumulative> <Discount>5</Discount> <DiscountPercent>6</DiscountPercent> <Expiration>2024-11-12T21:04:36.4527497+01:00</Expiration> <ID>1</ID> <MaximumQuantity>1</MaximumQuantity> <MinimumOrderAmount>7</MinimumOrderAmount> <MinimumQuantity>8</MinimumQuantity> <PromotionID>2</PromotionID> <QuantityStep>9</QuantityStep> <ValidFrom>2024-11-12T21:04:36.4527497+01:00</ValidFrom> </PromotionItem> <PromotionItem> <Amount>4</Amount> <AutoAddRemoveQuantity>11</AutoAddRemoveQuantity> <Base>3</Base> <Cumulative>true</Cumulative> <Discount>5</Discount> <DiscountPercent>6</DiscountPercent> <Expiration>2024-11-12T21:04:36.4527497+01:00</Expiration> <ID>1</ID> <MaximumQuantity>1</MaximumQuantity> <MinimumOrderAmount>7</MinimumOrderAmount> <MinimumQuantity>8</MinimumQuantity> <PromotionID>2</PromotionID> <QuantityStep>9</QuantityStep> <ValidFrom>2024-11-12T21:04:36.4527497+01:00</ValidFrom> </PromotionItem> </Promotions> <VariationID>1</VariationID> </VariationPrice>