Item group members

An item group categorizes item dimension records, mainly for the purpose of structuring financial reporting. This object contains member items of an item group.

List item group members

get/objects/inventory-control/item-group-member

Returns up to 100 item group members from the collection with a key, ID, and link for each member. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "17",
      • "id": "17",
      • "href": "/objects/inventory-control/item-group-member/17"
      },
    • {
      • "key": "15",
      • "id": "15",
      • "href": "/objects/inventory-control/item-group-member/15"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get an item group member

get/objects/inventory-control/item-group-member/{key}

Returns detailed information for a specified item group member.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the item group member.

Example: 9
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "10",
    • "id": "10",
    • "itemGroup": {
      • "key": "4",
      • "id": "3rd Level Items",
      • "href": "/objects/inventory-control/item-group/4"
      },
    • "item": {
      • "key": "9",
      • "id": "MCOM",
      • "name": "Mobile Components",
      • "status": "active",
      • "href": "/objects/inventory-control/item/9"
      },
    • "sortOrder": 1,
    • "audit": {
      • "createdDateTime": "2017-04-27T17:46:10Z",
      • "modifiedDateTime": "2017-04-27T17:46:10Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/inventory-control/item-group-member/10"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete an item group member

delete/objects/inventory-control/item-group-member/{key}

Deletes a member from an item group.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the item group member.

Example: 9
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 item group members

post/services/core/query

Use the query service to find item group members that meet certain criteria and to specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

Request samples