POST v1/api/OrderLineItemModification

Processes Order line item Modification details from Nike to eShopWorld.

Request Information

URI Parameters

None.

Body Parameters

A object containing Order Modification details for eShopWorld to process.

esw.Common.Model.Published.Order.Nike.NikeOrderLineItemModificationRequest

Name	Description	Type	Additional information
Action	The type of Modification action to be performed on the OrderLineItems (e.g. "LINECANCEL") Required: Yes	string	None.
BrandOrderReference	The Nike Order number that needs to be modified. Required: Yes	string	None.
OrderItems	The collection of OrderLineItems with modifications. Required: Yes	esw.Common.Model.Published.Order.Nike.NikeOrderLineItemsContainer	None.
EnterpriseCode	NIKEGS or NIKEXA(Singapore Countries) Required: Yes	string	None.
CancelReason	Reason the Order lines were cancelled. Required: No	string	None.

Request Formats

application/json, text/json

Sample:

{
  "BrandCode": "sample string 1",
  "Action": "sample string 2",
  "BrandOrderReference": "sample string 3",
  "OrderItems": {
    "OrderItem": [
      {
        "OrderItemSequence": 1,
        "RemainingQuantity": 2,
        "Product": {
          "ProductCode": "sample string 1"
        }
      },
      {
        "OrderItemSequence": 1,
        "RemainingQuantity": 2,
        "Product": {
          "ProductCode": "sample string 1"
        }
      }
    ]
  },
  "EnterpriseCode": "sample string 4",
  "CancelReason": "sample string 5"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'esw.Common.Model.Published.Order.Nike.NikeOrderLineItemModificationRequest'.

application/xml, text/xml

Sample:

<Order xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Action="sample string 2" OrderNo="sample string 3" xmlns="http://www.eShopWorld.com/eShopWorld.Nike.Contracts">
  <OrderLines>
    <OrderLine VendorLineNo="1" RemainingQuantity="2">
      <Item CatalogRefId="sample string 1" />
    </OrderLine>
    <OrderLine VendorLineNo="1" RemainingQuantity="2">
      <Item CatalogRefId="sample string 1" />
    </OrderLine>
  </OrderLines>
  <EnterpriseCode>sample string 4</EnterpriseCode>
  <CancelReason>sample string 5</CancelReason>
</Order>

Response Information

Resource Description

An object containing the response object.

esw.Common.Model.Published.Order.Nike.NikeOrderLineItemModificationResponse

Name	Description	Type	Additional information
Action	The type of Modification action to be performed on the OrderLineItems (e.g. "LINECANCEL")	string	None.
BrandOrderReference	The Nike Order number that needs to be modified.	string	None.
OrderPrice	Summary information for updated order	esw.Common.Model.Published.Order.Nike.OrderPrice	None.
OrderItems	The collection of OrderLineItems with modifications.	esw.Common.Model.Published.Order.Nike.NikeOrderLineItemRespContainer	None.

Response Formats

application/json, text/json

Sample:

{
  "Action": "sample string 1",
  "BrandOrderReference": "sample string 2",
  "OrderPrice": {
    "Shipping": {
      "ShippingLocal": "sample string 1",
      "ShippingSettlement": "sample string 2",
      "ShippingActualSettlement": "sample string 3"
    },
    "OrderPriceDiscount": [
      {
        "DiscountType": "sample string 1",
        "DiscountLocal": 2.0,
        "DiscountSettlement": 3.0,
        "PromotionId": "sample string 4",
        "PromotionDescription": "sample string 5"
      },
      {
        "DiscountType": "sample string 1",
        "DiscountLocal": 2.0,
        "DiscountSettlement": 3.0,
        "PromotionId": "sample string 4",
        "PromotionDescription": "sample string 5"
      }
    ],
    "OrderPriceTax": [
      {
        "TaxName": "sample string 1",
        "TaxLocal": 2.0,
        "TaxSettlement": 3.0,
        "TaxActualSettlement": 4.0,
        "TaxPercentage": 5.0
      },
      {
        "TaxName": "sample string 1",
        "TaxLocal": 2.0,
        "TaxSettlement": 3.0,
        "TaxActualSettlement": 4.0,
        "TaxPercentage": 5.0
      }
    ],
    "Fee": {
      "FeeLocal": 1.0,
      "FeeSettlement": 2.0
    }
  },
  "OrderItems": {
    "OrderItem": [
      {
        "OrderItemSequence": 1,
        "RemainingQuantity": 2,
        "Product": {
          "ProductCode": "sample string 1"
        },
        "LinePriceInfo": {
          "ListPriceLocal": 1.0,
          "BasePriceSettlement": 2.0,
          "AmountLocal": 3.0,
          "AmountSettlement": 4.0
        },
        "Discount": [
          {
            "DiscountType": "sample string 1",
            "DiscountPerUnitLocal": 2.0,
            "DiscountPerUnitSettlement": 3.0
          },
          {
            "DiscountType": "sample string 1",
            "DiscountPerUnitLocal": 2.0,
            "DiscountPerUnitSettlement": 3.0
          }
        ],
        "Duty": {
          "DutyPerUnitActualSettlement": 1.0,
          "DutyPerUnitLocal": 2.0,
          "DutyPerUnitSettlement": 3.0
        },
        "Tax": [
          {
            "TaxName": "sample string 1",
            "TaxLocal": 2.0,
            "TaxSettlement": 3.0,
            "TaxInclusive": false,
            "TaxInclusiveString": "N",
            "TaxPerUnitActualSettlement": 6.0
          },
          {
            "TaxName": "sample string 1",
            "TaxLocal": 2.0,
            "TaxSettlement": 3.0,
            "TaxInclusive": false,
            "TaxInclusiveString": "N",
            "TaxPerUnitActualSettlement": 6.0
          }
        ]
      },
      {
        "OrderItemSequence": 1,
        "RemainingQuantity": 2,
        "Product": {
          "ProductCode": "sample string 1"
        },
        "LinePriceInfo": {
          "ListPriceLocal": 1.0,
          "BasePriceSettlement": 2.0,
          "AmountLocal": 3.0,
          "AmountSettlement": 4.0
        },
        "Discount": [
          {
            "DiscountType": "sample string 1",
            "DiscountPerUnitLocal": 2.0,
            "DiscountPerUnitSettlement": 3.0
          },
          {
            "DiscountType": "sample string 1",
            "DiscountPerUnitLocal": 2.0,
            "DiscountPerUnitSettlement": 3.0
          }
        ],
        "Duty": {
          "DutyPerUnitActualSettlement": 1.0,
          "DutyPerUnitLocal": 2.0,
          "DutyPerUnitSettlement": 3.0
        },
        "Tax": [
          {
            "TaxName": "sample string 1",
            "TaxLocal": 2.0,
            "TaxSettlement": 3.0,
            "TaxInclusive": false,
            "TaxInclusiveString": "N",
            "TaxPerUnitActualSettlement": 6.0
          },
          {
            "TaxName": "sample string 1",
            "TaxLocal": 2.0,
            "TaxSettlement": 3.0,
            "TaxInclusive": false,
            "TaxInclusiveString": "N",
            "TaxPerUnitActualSettlement": 6.0
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<Order xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Action="sample string 1" OrderNo="sample string 2" xmlns="http://www.eShopWorld.com/eShopWorld.Nike.Contracts">
  <OrderPrice>
    <Shipping ShippingLocal="sample string 1" ShippingSettlement="sample string 2" ShippingActualSettlement="sample string 3" />
    <Discount DiscountType="sample string 1" DiscountLocal="2" DiscountSettlement="3" PromotionId="sample string 4" PromotionDescription="sample string 5" />
    <Discount DiscountType="sample string 1" DiscountLocal="2" DiscountSettlement="3" PromotionId="sample string 4" PromotionDescription="sample string 5" />
    <Tax TaxName="sample string 1" TaxLocal="2" TaxSettlement="3" TaxActualSettlement="4" TaxPercentage="5" />
    <Tax TaxName="sample string 1" TaxLocal="2" TaxSettlement="3" TaxActualSettlement="4" TaxPercentage="5" />
    <Fee FeeLocal="1" FeeSettlement="2" />
  </OrderPrice>
  <OrderLines>
    <OrderLine VendorLineNo="1" RemainingQuantity="2">
      <Item CatalogRefId="sample string 1" />
      <LinePriceInfo ListPriceLocal="1" BasePriceSettlement="2" AmountLocal="3" AmountSettlement="4" />
      <Discount DiscountType="sample string 1" DiscountPerUnitLocal="2" DiscountPerUnitSettlement="3" />
      <Discount DiscountType="sample string 1" DiscountPerUnitLocal="2" DiscountPerUnitSettlement="3" />
      <Duty DutyPerUnitActualSettlement="1" DutyPerUnitLocal="2" DutyPerUnitSettlement="3" />
      <Tax TaxName="sample string 1" TaxLocal="2" TaxSettlement="3" TaxInclusive="N" TaxPerUnitActualSettlement="6" />
      <Tax TaxName="sample string 1" TaxLocal="2" TaxSettlement="3" TaxInclusive="N" TaxPerUnitActualSettlement="6" />
    </OrderLine>
    <OrderLine VendorLineNo="1" RemainingQuantity="2">
      <Item CatalogRefId="sample string 1" />
      <LinePriceInfo ListPriceLocal="1" BasePriceSettlement="2" AmountLocal="3" AmountSettlement="4" />
      <Discount DiscountType="sample string 1" DiscountPerUnitLocal="2" DiscountPerUnitSettlement="3" />
      <Discount DiscountType="sample string 1" DiscountPerUnitLocal="2" DiscountPerUnitSettlement="3" />
      <Duty DutyPerUnitActualSettlement="1" DutyPerUnitLocal="2" DutyPerUnitSettlement="3" />
      <Tax TaxName="sample string 1" TaxLocal="2" TaxSettlement="3" TaxInclusive="N" TaxPerUnitActualSettlement="6" />
      <Tax TaxName="sample string 1" TaxLocal="2" TaxSettlement="3" TaxInclusive="N" TaxPerUnitActualSettlement="6" />
    </OrderLine>
  </OrderLines>
</Order>