Stockable kit document lines

Each stockable kit document line object lists the stockable kits that were built or disassembled and the component items that were included in the kits. These transactions are recorded for inventory management and tracking purposes.

You can create or update document line items by creating or modifying the stockable kit document.

List stockable kit document lines

get/objects/inventory-control/stockable-kit-document-line

Returns a collection with a key, ID, and link for each stockable kit document line. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "3517",
      • "id": "3517",
      • "href": "/objects/inventory-control/stockable-kit-document-line/3517"
      },
    • {
      • "key": "3703",
      • "id": "3703",
      • "href": "/objects/inventory-control/stockable-kit-document-line/3703"
      },
    • {
      • "key": "2751",
      • "id": "2751",
      • "href": "/objects/inventory-control/stockable-kit-document-line/2751"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get a stockable kit document line

get/objects/inventory-control/stockable-kit-document-line/{key}

Returns detailed information for a specified stockable kit document line.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the stockable kit document line.

Example: 112
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "id": "146",
    • "key": "146",
    • "documentHeader": {
      • "documentNumber": "161",
      • "key": "161",
      • "id": "Build Kits-SM002",
      • "documentType": "Build Kits",
      • "href": "/objects/inventory-control/stockable-kit-document/161"
      },
    • "documentType": "Build Kits",
    • "lineNumber": 0,
    • "dimensions": {
      • "item": {
        },
      • "warehouse": {
        },
      • "location": {
        },
      • "department": {
        },
      • "project": {
        },
      • "task": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "class": {
        }
      },
    • "unitOfMeasure": {
      • "id": "Each",
      • "key": "3",
      • "href": "/objects/inventory-control/unit-of-measure/3"
      },
    • "memo": "HAMMERS",
    • "lineDescription": "Hammers",
    • "quantity": "1.0000000000",
    • "quantityConverted": "0.0000000000",
    • "cost": "0.0000000000",
    • "audit": {
      • "modifiedDateTime": "2024-03-14T19:14:56Z",
      • "createdDateTime": "2024-03-14T19:14:21Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": "1"
      },
    • "status": "active",
    • "costMethod": "FIFO",
    • "unitQuantity": "1.0000000000",
    • "unitCost": "0.0000000000",
    • "extendedCost": "0.0000000000",
    • "sourceDocument": {
      • "key": null,
      • "id": null,
      • "documentType": null
      },
    • "sourceDocumentLine": {
      • "id": null,
      • "key": null,
      • "documentType": "Build Kits"
      },
    • "txnCurrency": "USD",
    • "baseCurrency": "USD",
    • "quantityRemaining": "1.0000000000",
    • "trackingDetail": [
      • {
        }
      ],
    • "href": "/objects/inventory-control/stockable-kit-document-line/146"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}