Documentation for POST api/order/Order/{orderID}/AddKit

POST api/order/Order/{orderID}/AddKit

Adds a kit product to a party order with fully server-side pricing. No prices should be sent from the client — all amounts are derived from InventoryPrices, KitStepProduct overrides, and promotion rules. Route deliberately breaks out of the OrderDetail prefix via the tilde.

Request Information

URI Parameters

Name	Description	Type	Additional information
orderID		integer	Required

Body Parameters

OrderAddKitRequest

Name	Description	Type	Additional information
KitItem		OrderKitItemRequest	None.

Request Formats

application/xml, text/xml

Sample:

<OrderAddKitRequest>
  <KitItem>
    <ProductID>sample string 1</ProductID>
    <InventoryID>2</InventoryID>
    <KitSteps>
      <OrderKitStepRequest>
        <StepId>1</StepId>
        <StepName>sample string 2</StepName>
        <Selections>
          <OrderKitSelectionRequest>
            <ProductID>sample string 1</ProductID>
            <InventoryID>2</InventoryID>
            <DisplayName>sample string 3</DisplayName>
          </OrderKitSelectionRequest>
          <OrderKitSelectionRequest>
            <ProductID>sample string 1</ProductID>
            <InventoryID>2</InventoryID>
            <DisplayName>sample string 3</DisplayName>
          </OrderKitSelectionRequest>
        </Selections>
      </OrderKitStepRequest>
      <OrderKitStepRequest>
        <StepId>1</StepId>
        <StepName>sample string 2</StepName>
        <Selections>
          <OrderKitSelectionRequest>
            <ProductID>sample string 1</ProductID>
            <InventoryID>2</InventoryID>
            <DisplayName>sample string 3</DisplayName>
          </OrderKitSelectionRequest>
          <OrderKitSelectionRequest>
            <ProductID>sample string 1</ProductID>
            <InventoryID>2</InventoryID>
            <DisplayName>sample string 3</DisplayName>
          </OrderKitSelectionRequest>
        </Selections>
      </OrderKitStepRequest>
    </KitSteps>
  </KitItem>
</OrderAddKitRequest>

application/json, text/json

Sample:

{
  "KitItem": {
    "ProductID": "sample string 1",
    "InventoryID": 2,
    "KitSteps": [
      {
        "StepId": 1,
        "StepName": "sample string 2",
        "Selections": [
          {
            "ProductID": "sample string 1",
            "InventoryID": 2,
            "DisplayName": "sample string 3"
          },
          {
            "ProductID": "sample string 1",
            "InventoryID": 2,
            "DisplayName": "sample string 3"
          }
        ]
      },
      {
        "StepId": 1,
        "StepName": "sample string 2",
        "Selections": [
          {
            "ProductID": "sample string 1",
            "InventoryID": 2,
            "DisplayName": "sample string 3"
          },
          {
            "ProductID": "sample string 1",
            "InventoryID": 2,
            "DisplayName": "sample string 3"
          }
        ]
      }
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'OrderAddKitRequest'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/xml, text/xml, application/json, text/json

Sample:

Sample not available.