Documentation for POST api/order/OnlineOrder/AddKit

POST api/order/OnlineOrder/AddKit

PD-6563: Adds a kit to the online order

Request Information

URI Parameters

None.

Body Parameters

Kit item request containing kit details and selections

Name	Type	Additional information
OnlineOrderID	integer	None.
KitItem	KitItemRequest	None.
RepDID	string	None.
CustomerDID	string	None.
Country	string	None.
CartConfigurationId	integer	None.

Request Formats

application/xml, text/xml

Sample:

<AddKitRequest>
  <OnlineOrderID>1</OnlineOrderID>
  <KitItem>
    <ProductID>sample string 1</ProductID>
    <InventoryID>2</InventoryID>
    <KitSteps>
      <KitStepRequest>
        <StepId>1</StepId>
        <StepName>sample string 2</StepName>
        <Selections>
          <KitSelectionRequest>
            <ProductID>sample string 1</ProductID>
            <InventoryID>2</InventoryID>
            <DisplayName>sample string 3</DisplayName>
            <Variants>
              <KitVariantRequest>
                <PropertyKey>sample string 1</PropertyKey>
                <Value>sample string 2</Value>
                <DisplayName>sample string 3</DisplayName>
              </KitVariantRequest>
              <KitVariantRequest>
                <PropertyKey>sample string 1</PropertyKey>
                <Value>sample string 2</Value>
                <DisplayName>sample string 3</DisplayName>
              </KitVariantRequest>
            </Variants>
          </KitSelectionRequest>
          <KitSelectionRequest>
            <ProductID>sample string 1</ProductID>
            <InventoryID>2</InventoryID>
            <DisplayName>sample string 3</DisplayName>
            <Variants>
              <KitVariantRequest>
                <PropertyKey>sample string 1</PropertyKey>
                <Value>sample string 2</Value>
                <DisplayName>sample string 3</DisplayName>
              </KitVariantRequest>
              <KitVariantRequest>
                <PropertyKey>sample string 1</PropertyKey>
                <Value>sample string 2</Value>
                <DisplayName>sample string 3</DisplayName>
              </KitVariantRequest>
            </Variants>
          </KitSelectionRequest>
        </Selections>
      </KitStepRequest>
      <KitStepRequest>
        <StepId>1</StepId>
        <StepName>sample string 2</StepName>
        <Selections>
          <KitSelectionRequest>
            <ProductID>sample string 1</ProductID>
            <InventoryID>2</InventoryID>
            <DisplayName>sample string 3</DisplayName>
            <Variants>
              <KitVariantRequest>
                <PropertyKey>sample string 1</PropertyKey>
                <Value>sample string 2</Value>
                <DisplayName>sample string 3</DisplayName>
              </KitVariantRequest>
              <KitVariantRequest>
                <PropertyKey>sample string 1</PropertyKey>
                <Value>sample string 2</Value>
                <DisplayName>sample string 3</DisplayName>
              </KitVariantRequest>
            </Variants>
          </KitSelectionRequest>
          <KitSelectionRequest>
            <ProductID>sample string 1</ProductID>
            <InventoryID>2</InventoryID>
            <DisplayName>sample string 3</DisplayName>
            <Variants>
              <KitVariantRequest>
                <PropertyKey>sample string 1</PropertyKey>
                <Value>sample string 2</Value>
                <DisplayName>sample string 3</DisplayName>
              </KitVariantRequest>
              <KitVariantRequest>
                <PropertyKey>sample string 1</PropertyKey>
                <Value>sample string 2</Value>
                <DisplayName>sample string 3</DisplayName>
              </KitVariantRequest>
            </Variants>
          </KitSelectionRequest>
        </Selections>
      </KitStepRequest>
    </KitSteps>
  </KitItem>
  <RepDID>sample string 2</RepDID>
  <CustomerDID>sample string 3</CustomerDID>
  <Country>sample string 4</Country>
  <CartConfigurationId>5</CartConfigurationId>
</AddKitRequest>

application/json, text/json

Sample:

{
  "OnlineOrderID": 1,
  "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",
            "Variants": [
              {
                "PropertyKey": "sample string 1",
                "Value": "sample string 2",
                "DisplayName": "sample string 3"
              },
              {
                "PropertyKey": "sample string 1",
                "Value": "sample string 2",
                "DisplayName": "sample string 3"
              }
            ]
          },
          {
            "ProductID": "sample string 1",
            "InventoryID": 2,
            "DisplayName": "sample string 3",
            "Variants": [
              {
                "PropertyKey": "sample string 1",
                "Value": "sample string 2",
                "DisplayName": "sample string 3"
              },
              {
                "PropertyKey": "sample string 1",
                "Value": "sample string 2",
                "DisplayName": "sample string 3"
              }
            ]
          }
        ]
      },
      {
        "StepId": 1,
        "StepName": "sample string 2",
        "Selections": [
          {
            "ProductID": "sample string 1",
            "InventoryID": 2,
            "DisplayName": "sample string 3",
            "Variants": [
              {
                "PropertyKey": "sample string 1",
                "Value": "sample string 2",
                "DisplayName": "sample string 3"
              },
              {
                "PropertyKey": "sample string 1",
                "Value": "sample string 2",
                "DisplayName": "sample string 3"
              }
            ]
          },
          {
            "ProductID": "sample string 1",
            "InventoryID": 2,
            "DisplayName": "sample string 3",
            "Variants": [
              {
                "PropertyKey": "sample string 1",
                "Value": "sample string 2",
                "DisplayName": "sample string 3"
              },
              {
                "PropertyKey": "sample string 1",
                "Value": "sample string 2",
                "DisplayName": "sample string 3"
              }
            ]
          }
        ]
      }
    ]
  },
  "RepDID": "sample string 2",
  "CustomerDID": "sample string 3",
  "Country": "sample string 4",
  "CartConfigurationId": 5
}

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 'AddKitRequest'.

Response Information

Resource Description

Result with the created OnlineOrderDetailID

AddKitResponse

Name	Type	Additional information
IsSuccessful	boolean	None.
OnlineOrderDetailID	integer	None.
OnlineOrderID	integer	None.
InventoryID	integer	None.
ErrorMessage	string	None.

Response Formats

application/xml, text/xml

Sample:

<AddKitResponse>
  <IsSuccessful>True</IsSuccessful>
  <OnlineOrderDetailID>2</OnlineOrderDetailID>
  <OnlineOrderID>3</OnlineOrderID>
  <InventoryID>4</InventoryID>
  <ErrorMessage>sample string 5</ErrorMessage>
</AddKitResponse>

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "OnlineOrderDetailID": 2,
  "OnlineOrderID": 3,
  "InventoryID": 4,
  "ErrorMessage": "sample string 5"
}