Kit articles and sub order lines

Table of contents

• Introduction
• Creating kit articles
• Booking kit articles on orders
  • Booking the kit directly
  • Using sub order lines to make changes to a kit on the fly

Introduction

There is occasionally a need to define an article in terms of other articles. This kind of article is called a kit article or structure article. For instance, let's say you have two physical articles:

• A football.
• A football pump.

The API allows you to create both the basic articles (the football and the pump), as well as the kit.

Creating kit articles

In ProcessArticle there is a tag called ArticleStructureSpecification which is used when creating a kit article.

The ArticleStructureSpecification is a list of StructureArticleDefinition tags which represent the articles which make up the kit. For each article which the kit contains, you will need to specify two things:

• NumberOfItems - How many of this article which is contained in the kit.
• SubArticleDefinition - The definition of the contained article. This tag is also an ArticleDefinition, just like the tag defining the kit article. The definition of the kit article is thus recursive in some sense.

Returning to the example of the football and the pump, to create a kit consisting of them both together, you would send in a ProcessArticle request for the kit along these lines:

1. Specify ArticleNumber = Football and pump or something similar.
2. The ArticleStructureSpecification list should have two elements of type StructureArticleDefinition. The first element would be defined like this:
   • NumberOfItems = 1.
   • SubArticleDefinition = the article definition of the football.
3. And the second element would be defined like this:
   • NumberOfItems = 1.
   • SubArticleDefinition = the article definition of the football pump.
4. In ArticleStructureSpecification, specify ArticleStructureType = StructureArticle.

Example on how to use the ArticleStructureSpecification tag

  {
  <ProcessArticle xmlns="http://ongoingsystems.se/WSI">
    <art>
      <ArticleOperation>CreateOrUpdate</ArticleOperation>
      <ArticleIdentification>SystemId or ArticleNumber or ProductCode or ArticleName</ArticleIdentification>
      <ArticleNumber>Football and pump</ArticleNumber>
      ...

      <ArticleStructureSpecification ArticleStructureType="StructureArticle">
          <StructureArticleDefinition>
            <NumberOfItems>1</NumberOfItems>
            <SubArticleDefinition>
              <ArticleOperation>CreateOrUpdate</ArticleOperation>
              <ArticleIdentification>ArticleNumber</ArticleIdentification>
              <ArticleNumber>Football</ArticleNumber>
            </SubArticleDefinition>
          </StructureArticleDefinition>
          <StructureArticleDefinition>
            <NumberOfItems>1</NumberOfItems>
            <SubArticleDefinition>
              <ArticleOperation>CreateOrUpdate</ArticleOperation>
              <ArticleIdentification>ArticleNumber</ArticleIdentification>
              <ArticleNumber>Pump</ArticleNumber>
            </SubArticleDefinition>
          </StructureArticleDefinition>
      </ArticleStructureSpecification>
      ...

    </art>
  </ProcessArticle>
  }

Booking kit articles on orders