POST api/SubmitKit

A kit request specifying items that are part of a kit.

Parameters

* Required
Property Description
KitList (List)
* A list of kits to submit.
ParentSku (String)
* The sku of the kit that contains items.
KitItemList (List)
* The list of items contained in the kit.
Sku (String)
* The kit item's sku.
Quantity (Int32)
* The quantity of this item in the kit.
Key (Guid)
* Your i-parcel API key (visible in your Dashboard via the Integrate link.)

Request body formats

application/json, text/json

Sample:
{
  "KitList": [
    {
      "ParentSku": "sample string 1",
      "KitItemList": [
        {
          "Sku": "sample string 1",
          "Quantity": 2
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2
        }
      ]
    },
    {
      "ParentSku": "sample string 1",
      "KitItemList": [
        {
          "Sku": "sample string 1",
          "Quantity": 2
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2
        }
      ]
    },
    {
      "ParentSku": "sample string 1",
      "KitItemList": [
        {
          "Sku": "sample string 1",
          "Quantity": 2
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2
        }
      ]
    }
  ],
  "Key": "91bdcb5c-6b69-40ce-ab48-66cbbc4874d6"
}

application/xml, text/xml

Sample:
<KitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Models.WebRequest">
  <Key>91bdcb5c-6b69-40ce-ab48-66cbbc4874d6</Key>
  <KitList>
    <Kit>
      <KitItemList>
        <KitItem>
          <Quantity>2</Quantity>
          <Sku>sample string 1</Sku>
        </KitItem>
        <KitItem>
          <Quantity>2</Quantity>
          <Sku>sample string 1</Sku>
        </KitItem>
        <KitItem>
          <Quantity>2</Quantity>
          <Sku>sample string 1</Sku>
        </KitItem>
      </KitItemList>
      <ParentSku>sample string 1</ParentSku>
    </Kit>
    <Kit>
      <KitItemList>
        <KitItem>
          <Quantity>2</Quantity>
          <Sku>sample string 1</Sku>
        </KitItem>
        <KitItem>
          <Quantity>2</Quantity>
          <Sku>sample string 1</Sku>
        </KitItem>
        <KitItem>
          <Quantity>2</Quantity>
          <Sku>sample string 1</Sku>
        </KitItem>
      </KitItemList>
      <ParentSku>sample string 1</ParentSku>
    </Kit>
    <Kit>
      <KitItemList>
        <KitItem>
          <Quantity>2</Quantity>
          <Sku>sample string 1</Sku>
        </KitItem>
        <KitItem>
          <Quantity>2</Quantity>
          <Sku>sample string 1</Sku>
        </KitItem>
        <KitItem>
          <Quantity>2</Quantity>
          <Sku>sample string 1</Sku>
        </KitItem>
      </KitItemList>
      <ParentSku>sample string 1</ParentSku>
    </Kit>
  </KitList>
</KitRequest>

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
{
  "New": 1,
  "Modified": 2,
  "Failed": 3,
  "FailedKitList": [
    {
      "ParentSku": "sample string 1",
      "HasEmptyItemList": true,
      "NotInCatalogList": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "InvalidQuantityList": [
        {
          "Sku": "sample string 1",
          "Quantity": 2
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2
        }
      ]
    },
    {
      "ParentSku": "sample string 1",
      "HasEmptyItemList": true,
      "NotInCatalogList": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "InvalidQuantityList": [
        {
          "Sku": "sample string 1",
          "Quantity": 2
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2
        }
      ]
    },
    {
      "ParentSku": "sample string 1",
      "HasEmptyItemList": true,
      "NotInCatalogList": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "InvalidQuantityList": [
        {
          "Sku": "sample string 1",
          "Quantity": 2
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<Kit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Models.WebResponse">
  <Failed>3</Failed>
  <FailedKitList>
    <FailedKit>
      <HasEmptyItemList>true</HasEmptyItemList>
      <InvalidQuantityList xmlns:d4p1="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Models.WebRequest">
        <d4p1:KitItem>
          <d4p1:Quantity>2</d4p1:Quantity>
          <d4p1:Sku>sample string 1</d4p1:Sku>
        </d4p1:KitItem>
        <d4p1:KitItem>
          <d4p1:Quantity>2</d4p1:Quantity>
          <d4p1:Sku>sample string 1</d4p1:Sku>
        </d4p1:KitItem>
        <d4p1:KitItem>
          <d4p1:Quantity>2</d4p1:Quantity>
          <d4p1:Sku>sample string 1</d4p1:Sku>
        </d4p1:KitItem>
      </InvalidQuantityList>
      <NotInCatalogList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </NotInCatalogList>
      <ParentSku>sample string 1</ParentSku>
    </FailedKit>
    <FailedKit>
      <HasEmptyItemList>true</HasEmptyItemList>
      <InvalidQuantityList xmlns:d4p1="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Models.WebRequest">
        <d4p1:KitItem>
          <d4p1:Quantity>2</d4p1:Quantity>
          <d4p1:Sku>sample string 1</d4p1:Sku>
        </d4p1:KitItem>
        <d4p1:KitItem>
          <d4p1:Quantity>2</d4p1:Quantity>
          <d4p1:Sku>sample string 1</d4p1:Sku>
        </d4p1:KitItem>
        <d4p1:KitItem>
          <d4p1:Quantity>2</d4p1:Quantity>
          <d4p1:Sku>sample string 1</d4p1:Sku>
        </d4p1:KitItem>
      </InvalidQuantityList>
      <NotInCatalogList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </NotInCatalogList>
      <ParentSku>sample string 1</ParentSku>
    </FailedKit>
    <FailedKit>
      <HasEmptyItemList>true</HasEmptyItemList>
      <InvalidQuantityList xmlns:d4p1="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Models.WebRequest">
        <d4p1:KitItem>
          <d4p1:Quantity>2</d4p1:Quantity>
          <d4p1:Sku>sample string 1</d4p1:Sku>
        </d4p1:KitItem>
        <d4p1:KitItem>
          <d4p1:Quantity>2</d4p1:Quantity>
          <d4p1:Sku>sample string 1</d4p1:Sku>
        </d4p1:KitItem>
        <d4p1:KitItem>
          <d4p1:Quantity>2</d4p1:Quantity>
          <d4p1:Sku>sample string 1</d4p1:Sku>
        </d4p1:KitItem>
      </InvalidQuantityList>
      <NotInCatalogList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </NotInCatalogList>
      <ParentSku>sample string 1</ParentSku>
    </FailedKit>
  </FailedKitList>
  <Modified>2</Modified>
  <New>1</New>
</Kit>