Kit components

Components are items included in a kit. Kits are common combinations of items that can be ordered and invoiced as a single item to simplify data entry. Kits can include inventory items, non-inventory items, and other kits.

List kit components

get/objects/inventory-control/kit-component

Returns a collection with a key, ID, and link for each kit component.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/object/kit-component/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/object/kit-component/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": 101,
    • "previous": null
    }
}
Create a kit component
post/objects/inventory-control/kit-component
Creates a new kit component.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
object
Kit is item of type kit or stockable kit.


 
key
string
System generated Item key


 
 Example:  "27"
id
string
Item unique identifier.


 
 Example:  "Kit_1"
required
object
Components are items to be ordered and invoiced as a single item (i.e. kit or stockable kit).


 
key
string
System generated Item key


 
 Example:  "10"
id
string
Item unique identifier.


 
 Example:  "Prnt_Paper"
numberOfUnits
required
number
Number of component units required in this kit.


 
 Example:  1
revenuePercentage
number  [ 0 .. 100 ] 
When item sold as part of Kit, the revenue part of the each item will calculated based on the given percentage.


 
 Example:  10
defaultDeliveryStatus
string
 Default:  "delivered"
Default that will indicate the most common delivery status of this item when it's sold.


 Enum: "delivered" "undelivered"  
 Example:  "delivered"
defaultDeferralStatus
string
 Default:  "deferUntilItemIsDelivered"
Choose whether to defer until this item is delivered or until the entire bundle is delivered.


 Enum: "deferBundleUntilItemIsDelivered" "deferUntilItemIsDelivered"  
 Example:  "deferUntilItemIsDelivered"
lineNumber
integer
Line number of Kit Component on Kit. If not provided, the system automatically assigns a unique line number. If the user specifies the linenumber already used, the application will push set other lines to unique numbers.


 
 Example:  1
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "kit": {
    • "key": "1"
    },
  • "component": {
    • "key": "2"
    },
  • "revenuePercentage": 90,
  • "defaultDeliveryStatus": "undelivered",
  • "defaultDeferralStatus": "deferUntilItemIsDelivered",
  • "numberOfUnits": 1
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "href": "/objects/inventory-control/kit-component/1"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a kit component
get/objects/inventory-control/kit-component/{key}
Returns detailed information for a specified kit component.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the kit-component.


 
 Example:  5
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "kit": {
      • "key": "27",
      • "id": "Kit_1",
      • "href": "/objects/inventory-control/item/27"
      },
    • "component": {
      • "key": "10",
      • "id": "Prnt_Paper",
      • "name": "Paper for Printer",
      • "costMethod": "standard",
      • "itemType": "inventory",
      • "unitOfMeasure": "10 Pack",
      • "standardCost": "100",
      • "href": "/objects/inventory-control/item/10"
      },
    • "numberOfUnits": 1,
    • "revenuePercentage": 10,
    • "defaultDeliveryStatus": "delivered",
    • "defaultDeferralStatus": "deferUntilItemIsDelivered",
    • "lineNumber": 1,
    • "href": "/objects/inventory-control/kit-component/1"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a kit component
patch/objects/inventory-control/kit-component/{key}
Updates an existing kit component by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the kit-component.


 
 Example:  5
Request Body schema: application/json
object
Kit is item of type kit or stockable kit.


 
key
string
System generated Item key


 
 Example:  "27"
id
string
Item unique identifier.


 
 Example:  "Kit_1"
object
Components are items to be ordered and invoiced as a single item (i.e. kit or stockable kit).


 
key
string
System generated Item key


 
 Example:  "10"
id
string
Item unique identifier.


 
 Example:  "Prnt_Paper"
numberOfUnits
number
Number of component units required in this kit.


 
 Example:  1
revenuePercentage
number  [ 0 .. 100 ] 
When item sold as part of Kit, the revenue part of the each item will calculated based on the given percentage.


 
 Example:  10
defaultDeliveryStatus
string
 Default:  "delivered"
Default that will indicate the most common delivery status of this item when it's sold.


 Enum: "delivered" "undelivered"  
 Example:  "delivered"
defaultDeferralStatus
string
 Default:  "deferUntilItemIsDelivered"
Choose whether to defer until this item is delivered or until the entire bundle is delivered.


 Enum: "deferBundleUntilItemIsDelivered" "deferUntilItemIsDelivered"  
 Example:  "deferUntilItemIsDelivered"
lineNumber
integer
Line number of Kit Component on Kit. If not provided, the system automatically assigns a unique line number. If the user specifies the linenumber already used, the application will push set other lines to unique numbers.


 
 Example:  1
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "component": {
    • "key": "10"
    },
  • "numberOfUnits": 1
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "href": "/objects/inventory-control/kit-component/1"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a kit component
delete/objects/inventory-control/kit-component/{key}
Deletes a kit component.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the kit-component.


 
 Example:  5
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query kit components
post/services/core/query
Use the query service to find kit components that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples