Fulcrumpro Item Routing API
The Item Routing API from Fulcrumpro — 19 operation(s) for item routing.
The Item Routing API from Fulcrumpro — 19 operation(s) for item routing.
openapi: 3.0.4
info:
title: Fulcrum Public Accounting Code Item Routing API
version: v1
servers:
- url: https://api.fulcrumpro.com
tags:
- name: Item Routing
paths:
/api/items/{itemId}/routing:
get:
tags:
- Item Routing
summary: Get a specific item routing input item
operationId: ItemRoutingGet
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
responses:
'200':
description: Input item for an item's routing matching id
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingDto'
application/problem+json:
schema:
$ref: '#/components/schemas/ItemRoutingDto'
'204':
description: Input item id provided was not found on this item
'404':
description: Item id provided is not present in the system
x-c4-required-permissions:
- ItemsAndInventory-Items-View Item
post:
tags:
- Item Routing
summary: Update a specific item's routing
operationId: ItemRoutingUpdate
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ItemRoutingUpdateDto'
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/ItemRoutingUpdateDto'
application/*+json:
schema:
$ref: '#/components/schemas/ItemRoutingUpdateDto'
required: true
responses:
'200':
description: Successful update of the input item
'204':
description: Input item id provided was not found on this item
'400':
description: Validation issue with input
'404':
description: Item id provided is not present in the system
/api/items/{itemId}/routing/input-items:
post:
tags:
- Item Routing
summary: Adds an input item to an item's routing
operationId: ItemRoutingInputItemCreate
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemCreateDto'
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemCreateDto'
text/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemCreateDto'
application/*+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemCreateDto'
required: true
responses:
'200':
description: An input item was added to the item's routing
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedResponseDto'
application/problem+json:
schema:
$ref: '#/components/schemas/CreatedResponseDto'
'400':
description: Validation issue with input
'404':
description: An item was not found matching the item id
/api/items/{itemId}/routing/input-items/batch:
post:
tags:
- Item Routing
summary: Add multiple input items to an item's routing
operationId: ItemRoutingInputItemCreateBatch
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/SalesOrderPartLineItemInputItemCreateBatchDto'
application/json:
schema:
$ref: '#/components/schemas/SalesOrderPartLineItemInputItemCreateBatchDto'
text/json:
schema:
$ref: '#/components/schemas/SalesOrderPartLineItemInputItemCreateBatchDto'
application/*+json:
schema:
$ref: '#/components/schemas/SalesOrderPartLineItemInputItemCreateBatchDto'
required: true
responses:
'200':
description: Input item(s) were added to the item's routing
content:
application/json:
schema:
$ref: '#/components/schemas/BatchCreatedResponseDto'
application/problem+json:
schema:
$ref: '#/components/schemas/BatchCreatedResponseDto'
'400':
description: Validation issue with input
'404':
description: An item was not found matching the item id
/api/items/{itemId}/routing/input-items/{inputItemId}:
delete:
tags:
- Item Routing
summary: Deletes an input item from an item's routing
operationId: ItemRoutingInputItemDelete
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: inputItemId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
responses:
'200':
description: An input item was deleted from the item's routing
'204':
description: Input item id provided was not found on this item
'404':
description: Item id provided is not present in the system
get:
tags:
- Item Routing
summary: Get a specific item routing input item
operationId: ItemRoutingInputItemGet
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: inputItemId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
responses:
'200':
description: Input item for an item's routing matching id
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemDto'
application/problem+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemDto'
'204':
description: Input item id provided was not found on this item
'404':
description: Item id provided is not present in the system
x-c4-required-permissions:
- ItemsAndInventory-Items-View Item
post:
tags:
- Item Routing
summary: Update an input item for a specific item's routing
operationId: ItemRoutingInputItemUpdate
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: inputItemId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemUpdateDto'
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemUpdateDto'
application/*+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemUpdateDto'
required: true
responses:
'200':
description: Successful update of the input item
'204':
description: Input item id provided was not found on this item
'400':
description: Validation issue with input
'404':
description: Item id provided is not present in the system
/api/items/{itemId}/routing/input-items/list:
post:
tags:
- Item Routing
summary: Lists the input items for an item's routing
operationId: ItemRoutingInputItemList
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: skip
in: query
schema:
minimum: 0
type: integer
format: int32
default: 0
- name: take
in: query
schema:
maximum: 5000
minimum: 0
type: integer
format: int32
default: 50
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/RoutingRequestItemFindParameters'
application/json:
schema:
$ref: '#/components/schemas/RoutingRequestItemFindParameters'
text/json:
schema:
$ref: '#/components/schemas/RoutingRequestItemFindParameters'
application/*+json:
schema:
$ref: '#/components/schemas/RoutingRequestItemFindParameters'
responses:
'200':
description: List of input items matching the filters
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRoutingInputItemDto'
application/problem+json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRoutingInputItemDto'
x-c4-required-permissions:
- ItemsAndInventory-Items-View Item
/api/items/{itemId}/routing/input-materials:
post:
tags:
- Item Routing
summary: Adds an input material to an item's routing
operationId: ItemRoutingInputMaterialCreate
parameters:
- name: itemId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialCreateDto'
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialCreateDto'
text/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialCreateDto'
application/*+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialCreateDto'
required: true
responses:
'200':
description: An input material was created on the item's routing
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedResponseDto'
application/problem+json:
schema:
$ref: '#/components/schemas/CreatedResponseDto'
'400':
description: Validation issue with input
'404':
description: A material was not found matching the material id
/api/items/{itemId}/routing/input-materials/{materialId}:
delete:
tags:
- Item Routing
summary: Deletes an input material from an item's routing
operationId: ItemRoutingInputMaterialDelete
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: materialId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: An input material was deleted from the item's routing
'204':
description: Input material id provided was not found on this item
'404':
description: Item id provided is not present in the system or a material was not found matching the material id
/api/items/{itemId}/routing/input-materials/list:
post:
tags:
- Item Routing
summary: Lists the input materials for an item's routing
operationId: ItemRoutingInputMaterialList
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
responses:
'200':
description: List of input materials matching the filters
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRoutingInputMaterialDto'
application/problem+json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRoutingInputMaterialDto'
x-c4-required-permissions:
- ItemsAndInventory-Items-View Item
/api/items/{itemId}/routing/input-materials/{materialId}/nesting:
post:
tags:
- Item Routing
summary: Adds an input material nesting to an item's routing material
operationId: ItemRoutingInputMaterialNestingCreate
parameters:
- name: itemId
in: path
required: true
schema:
type: string
- name: materialId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialNestingCreateDto'
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialNestingCreateDto'
text/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialNestingCreateDto'
application/*+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialNestingCreateDto'
required: true
responses:
'200':
description: An input material nesting was added to the item's routing nesting
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedResponseDto'
application/problem+json:
schema:
$ref: '#/components/schemas/CreatedResponseDto'
'400':
description: Validation issue with input
'404':
description: A material was not found matching the material id
/api/items/{itemId}/routing/input-materials/{materialId}/nesting/{nestingId}:
delete:
tags:
- Item Routing
summary: Removes an input material nesting on an item's routing material
operationId: ItemRoutingInputMaterialNestingDelete
parameters:
- name: itemId
in: path
required: true
schema:
type: string
- name: materialId
in: path
required: true
schema:
type: string
format: uuid
- name: nestingId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: An input material nesting was added to the item's routing nesting
'400':
description: Validation issue with input
'404':
description: A material was not found matching the material id
/api/items/{itemId}/routing/input-materials/{inputMaterialId}:
put:
tags:
- Item Routing
summary: Update an input material on an item's routing
operationId: ItemRoutingInputMaterialUpdate
parameters:
- name: itemId
in: path
required: true
schema:
type: string
- name: inputMaterialId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialUpdateDto'
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialUpdateDto'
application/*+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialUpdateDto'
required: true
responses:
'200':
description: An input material was updated on the item's routing
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialDto'
application/problem+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputMaterialDto'
'400':
description: Validation issue with input
'404':
description: An input material was not found matching the input material id
/api/items/{itemId}/routing/operations/batch:
post:
tags:
- Item Routing
summary: Bulk reorganize routing operations for a specific item.
operationId: ItemRoutingOperationBatch
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRoutingOperationCreateDto'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRoutingOperationCreateDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRoutingOperationCreateDto'
application/*+json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRoutingOperationCreateDto'
required: true
responses:
'200':
description: Created operation id
content:
application/json:
schema:
$ref: '#/components/schemas/BatchCreatedResponseDto'
application/problem+json:
schema:
$ref: '#/components/schemas/BatchCreatedResponseDto'
'400':
description: Validation issue with input
'404':
description: Item id not present in the system
/api/items/{itemId}/routing/operations:
post:
tags:
- Item Routing
summary: Create a routing operation for a specific item
operationId: ItemRoutingOperationCreate
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ItemRoutingOperationCreateDto'
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingOperationCreateDto'
text/json:
schema:
$ref: '#/components/schemas/ItemRoutingOperationCreateDto'
application/*+json:
schema:
$ref: '#/components/schemas/ItemRoutingOperationCreateDto'
required: true
responses:
'200':
description: Created operation id
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedResponseDto'
application/problem+json:
schema:
$ref: '#/components/schemas/CreatedResponseDto'
'400':
description: Validation issue with input
'404':
description: Item id not present in the system
/api/items/{itemId}/routing/operations/{operationId}:
delete:
tags:
- Item Routing
summary: Delete a specific item routing operation
operationId: ItemRoutingOperationDelete
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: operationId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
responses:
'200':
description: List of operations matching the filters
'204':
description: Operation id provided was not found on this item
'404':
description: Item id provided is not present in the system
get:
tags:
- Item Routing
summary: Get a specific item routing operation
operationId: ItemRoutingOperationGet
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: operationId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
responses:
'200':
description: Operation matching id
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingOperationDto'
application/problem+json:
schema:
$ref: '#/components/schemas/ItemRoutingOperationDto'
'404':
description: Item id or operation id provided are not present in the system
x-c4-required-permissions:
- ItemsAndInventory-Items-View Item
put:
tags:
- Item Routing
summary: Update a routing operation for a specific item
operationId: ItemRoutingOperationUpdate
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: operationId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ItemRoutingOperationUpdateDto'
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingOperationUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/ItemRoutingOperationUpdateDto'
application/*+json:
schema:
$ref: '#/components/schemas/ItemRoutingOperationUpdateDto'
required: true
responses:
'200':
description: Successful update of the operation
'204':
description: Operation id provided was not found on this item
'400':
description: Validation issue with input
'404':
description: Item id not present in the system
/api/items/{itemId}/routing/operations/{operationId}/items:
post:
tags:
- Item Routing
summary: Adds an operation item to an item's routing
operationId: ItemRoutingOperationItemCreate
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: operationId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemCreateDto'
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemCreateDto'
text/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemCreateDto'
application/*+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemCreateDto'
required: true
responses:
'200':
description: An operation item was added to the item's routing
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedResponseDto'
application/problem+json:
schema:
$ref: '#/components/schemas/CreatedResponseDto'
'204':
description: Operation id provided was not found on this item
'400':
description: Validation issue with input
'404':
description: An item was not found matching the itemId
/api/items/{itemId}/routing/operations/{operationId}/items/{operationItemId}:
delete:
tags:
- Item Routing
summary: Deletes an operation item from an item's routing
operationId: ItemRoutingOperationItemDelete
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: operationId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
- name: operationItemId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
responses:
'200':
description: An operation item was deleted from the item's routing
'204':
description: Operation or operation item id provided was not found on this item
'404':
description: An item was not found matching the itemId
get:
tags:
- Item Routing
summary: Get a specific item routing operation item
operationId: ItemRoutingOperationItemGet
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: operationId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
- name: operationItemId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
responses:
'200':
description: Operation item for an item's routing matching id
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemDto'
application/problem+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemDto'
'204':
description: Operation or operation item id provided was not found on this item
'404':
description: An item was not found matching the itemId
x-c4-required-permissions:
- ItemsAndInventory-Items-View Item
post:
tags:
- Item Routing
summary: Update an operation item for a specific item's routing
operationId: ItemRoutingOperationItemUpdate
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: operationId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
- name: operationItemId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemUpdateDto'
application/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemUpdateDto'
application/*+json:
schema:
$ref: '#/components/schemas/ItemRoutingInputItemUpdateDto'
required: true
responses:
'200':
description: Successful update of the input item
'400':
description: Validation issue with input
'404':
description: Item id provided is not present in the system
/api/items/{itemId}/routing/operations/{operationId}/items/list:
post:
tags:
- Item Routing
summary: Lists the operation items for an item's routing
operationId: ItemRoutingOperationItemList
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: operationId
in: path
required: true
schema:
maxLength: 36
minLength: 36
type: string
- name: skip
in: query
schema:
minimum: 0
type: integer
format: int32
default: 0
- name: take
in: query
schema:
maximum: 5000
minimum: 0
type: integer
format: int32
default: 50
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/RoutingRequestItemFindParameters'
application/json:
schema:
$ref: '#/components/schemas/RoutingRequestItemFindParameters'
text/json:
schema:
$ref: '#/components/schemas/RoutingRequestItemFindParameters'
application/*+json:
schema:
$ref: '#/components/schemas/RoutingRequestItemFindParameters'
responses:
'200':
description: List of operation items matching the filters
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRoutingInputItemDto'
application/problem+json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRoutingInputItemDto'
x-c4-required-permissions:
- ItemsAndInventory-Items-View Item
/api/items/{itemId}/routing/operations/list:
post:
tags:
- Item Routing
summary: Lists the operations for an item's routing
operationId: ItemRoutingOperationList
parameters:
- name: itemId
in: path
required: true
schema:
maxLength: 24
minLength: 24
type: string
- name: skip
in: query
schema:
minimum: 0
type: integer
format: int32
default: 0
- name: take
in: query
schema:
maximum: 5000
minimum: 0
type: integer
format: int32
default: 50
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/RoutingRequestOperationFindParameters'
application/json:
schema:
$ref: '#/components/schemas/RoutingRequestOperationFindParameters'
text/json:
schema:
$ref: '#/components/schemas/RoutingRequestOperationFindParameters'
application/*+json:
schema:
$ref: '#/components/schemas/RoutingRequestOperationFindParameters'
responses:
'200':
description: List of operations matching the filters
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRoutingOperationDto'
application/problem+json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRoutingOperationDto'
x-c4-required-permissions:
- ItemsAndInventory-Items-View Item
/api/items/{itemId}/routing/operations/{operationId}/materials/list:
post:
tags:
- Item Routing
summary: Lists the operation materials for an item's routing
o
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fulcrumpro/refs/heads/main/openapi/fulcrumpro-item-routing-api-openapi.yml