Inbound (Inventory)
Endpoints to create, update, and read inbound processes and receipts.
25Example: 250190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fMatches partial values; The queries terms and therefore the result set of the query can change in the future:
- tenantInboundProcessId
- scannableCodes
- receipts.receivedItems.tenantArticleId
- purchaseOrder.requestedItems.tenantArticleId
- purchaseOrder.supplier.name
- values of related listings
- listing.title
- listing.scannableCodes
Only matches complete values; The queries terms and therefore the result set of the query can change in the future:
- tenantInboundProcessId
- scannableCodes
- receipts.receivedItems.tenantArticleId
- purchaseOrder.requestedItems.tenantArticleId
- purchaseOrder.supplier.name
- values of related listings
- listing.title
- listing.scannableCodes
Paginated result containing the matching Inbound Process entities
InboundProcessPaginatedResult
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
GET /api/inboundprocesses HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"inboundProcesses": [
{
"anonymized": true,
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"facilityRef": "text",
"id": "text",
"inboundDate": "2026-06-17T12:00:00.000Z",
"lastModified": "2026-01-01T00:00:00.000Z",
"onHold": true,
"origin": [
{
"name": "text"
}
],
"purchaseOrder": {
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"id": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"transfer": {
"id": "text"
}
},
"receipts": [
{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN"
}
],
"scannableCodes": [
"text"
],
"status": "OPEN",
"tenantInboundProcessId": "text",
"version": 1
}
],
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1
}InboundProcessForCreation
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
Facility in which the inbound process takes place
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fIndicates if the inbound process is on hold and will not be processed further
scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note
Identifier of the process provided by the tenant system. It is recommended to be unique
MY_INBOUNDPROCESS_IDCreated Inbound Process entity
InboundProcess
Indicates the inbound process was anonymized acording to configured GDPR retention time.
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
Aggregated dates from sources which advise incoming stock. Currently that is "purchaseOrder"
2026-06-17T12:00:00.000ZIndicates if the inbound process is on hold and will not be processed further
scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
POST /api/inboundprocesses HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1040
{
"customAttributes": {},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"onHold": true,
"purchaseOrder": {
"customAttributes": {},
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
}
},
"receipts": [
{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN"
}
],
"scannableCodes": [
"text"
],
"tenantInboundProcessId": "MY_INBOUNDPROCESS_ID"
}{
"anonymized": true,
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"facilityRef": "text",
"id": "text",
"inboundDate": "2026-06-17T12:00:00.000Z",
"lastModified": "2026-01-01T00:00:00.000Z",
"onHold": true,
"origin": [
{
"name": "text"
}
],
"purchaseOrder": {
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"id": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"transfer": {
"id": "text"
}
},
"receipts": [
{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN"
}
],
"scannableCodes": [
"text"
],
"status": "OPEN",
"tenantInboundProcessId": "text",
"version": 1
}Requested Inbound Process entity
InboundProcess
Indicates the inbound process was anonymized acording to configured GDPR retention time.
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
Aggregated dates from sources which advise incoming stock. Currently that is "purchaseOrder"
2026-06-17T12:00:00.000ZIndicates if the inbound process is on hold and will not be processed further
scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
GET /api/inboundprocesses/{inboundProcessId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"anonymized": true,
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"facilityRef": "text",
"id": "text",
"inboundDate": "2026-06-17T12:00:00.000Z",
"lastModified": "2026-01-01T00:00:00.000Z",
"onHold": true,
"origin": [
{
"name": "text"
}
],
"purchaseOrder": {
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"id": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"transfer": {
"id": "text"
}
},
"receipts": [
{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN"
}
],
"scannableCodes": [
"text"
],
"status": "OPEN",
"tenantInboundProcessId": "text",
"version": 1
}Inbound Process successfully deleted
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
DELETE /api/inboundprocesses/{inboundProcessId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
This part of the API is in Beta status. For details, see the API release lifecycle documentation.
InboundProcessForPatch
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
Indicates if the inbound process is on hold and will not be processed further
scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note
Inbound Process successfully patched
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
PATCH /api/inboundprocesses/{inboundProcessId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75
{
"customAttributes": {},
"onHold": true,
"scannableCodes": [
"text"
],
"version": 1
}No content
Creates or updates the specific purchase order of an existing inbound process.
InboundProcessPurchaseOrderForUpsert
This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.
2026-06-17T12:00:00.000ZPurchase order successfully updated on inbound process
InboundProcessPurchaseOrder
This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.
2026-06-17T12:00:00.000ZPurchase order successfully created on inbound process
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
PUT /api/inboundprocesses/{inboundProcessId}/purchaseorder HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 302
{
"customAttributes": {},
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"version": 1
}{
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"id": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"transfer": {
"id": "text"
}
}Adds a receipt to an inbound process.
InboundReceiptForCreation
enables mapping a receipt to one of the ASNs in this inbound process
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fAttributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
date-time of the arrival of the items in the facility
2026-06-17T12:00:00.000Zstatus of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.
Receipt was added to the inbound process
InboundReceipt
enables mapping a receipt to one of the ASNs in this inbound process
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fAttributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
date-time of the arrival of the items in the facility
2026-06-17T12:00:00.000Zstatus of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
POST /api/inboundprocesses/{inboundProcessId}/receipts HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 555
{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN"
}{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN"
}This part of the API is in Alpha status. For details, see the API release lifecycle documentation.
InboundAttachmentForCreation
Base64 encoded attachment file
File name of attachment
Created attachment
InboundAttachment
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
POST /api/inboundprocesses/attachments HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"content": "text",
"fileName": "text"
}{
"created": "2026-01-01T00:00:00.000Z",
"id": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"version": 1
}This part of the API is in Alpha status. For details, see the API release lifecycle documentation.
Signed url
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
GET /api/inboundprocesses/attachments/{attachmentId}/signedurl HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
textSearch for InboundProcess
InboundProcessSearchPayload
The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.
The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).
Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
10The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.
Your search result
InboundProcessPaginatedResult
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
POST /api/inboundprocesses/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 7830
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"inboundDate": "2026-06-17T12:00:00.000Z",
"or": "[Circular Reference]",
"purchaseOrder": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"supplier": {
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"transfer": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
},
"receipts": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": {
"contains": {
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantInboundProcessId": "MY_INBOUNDPROCESS_ID"
}
],
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"inboundDate": "2026-06-17T12:00:00.000Z",
"or": [
{
"and": "[Circular Reference]",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"inboundDate": "2026-06-17T12:00:00.000Z",
"or": "[Circular Reference]",
"purchaseOrder": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"supplier": {
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"transfer": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
},
"receipts": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": {
"contains": {
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantInboundProcessId": "MY_INBOUNDPROCESS_ID"
}
],
"purchaseOrder": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"supplier": {
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"transfer": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
},
"receipts": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": {
"contains": {
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantInboundProcessId": "MY_INBOUNDPROCESS_ID"
}
],
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"inboundDate": "2026-06-17T12:00:00.000Z",
"or": [
{
"and": "[Circular Reference]",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"inboundDate": "2026-06-17T12:00:00.000Z",
"or": "[Circular Reference]",
"purchaseOrder": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"supplier": {
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"transfer": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
},
"receipts": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": {
"contains": {
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantInboundProcessId": "MY_INBOUNDPROCESS_ID"
}
],
"purchaseOrder": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"supplier": {
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"transfer": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
},
"receipts": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": {
"contains": {
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantInboundProcessId": "MY_INBOUNDPROCESS_ID"
},
"size": 10,
"sort": [
{
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lastModified": "ASC",
"po_created": "ASC",
"purchaseOrder": {
"requestedDate": "2026-06-17T12:00:00.000Z",
"supplier": {
"name": "ASC"
}
}
}
]
}{
"inboundProcesses": [
{
"anonymized": true,
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"facilityRef": "text",
"id": "text",
"inboundDate": "2026-06-17T12:00:00.000Z",
"lastModified": "2026-01-01T00:00:00.000Z",
"onHold": true,
"origin": [
{
"name": "text"
}
],
"purchaseOrder": {
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"id": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"transfer": {
"id": "text"
}
},
"receipts": [
{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN"
}
],
"scannableCodes": [
"text"
],
"status": "OPEN",
"tenantInboundProcessId": "text",
"version": 1
}
],
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1
}This part of the API is in Beta status. For details, see the API release lifecycle documentation.
25Example: 252026-06-17T12:00:00.000Z2026-06-17T12:00:00.000ZPaginated Inbound Receipt Jobs
InboundReceiptJobPaginatedResult
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
GET /api/inboundreceiptjobs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"inboundReceiptJobs": [
{
"expectedDate": {
"type": "ASAP",
"value": "2026-01-01T00:00:00.000Z"
},
"facilityRef": "text",
"id": "text",
"inboundProcessRef": "text",
"items": {
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
},
"origin": {
"name": "text"
},
"originReadableId": "text",
"originReadableName": "text",
"status": "OPEN"
}
],
"total": 1
}This part of the API is in Beta status. For details, see the API release lifecycle documentation.
InboundReceiptJob
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
GET /api/inboundreceiptjobs/{inboundEntryId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"expectedDate": {
"type": "ASAP",
"value": "2026-01-01T00:00:00.000Z"
},
"facilityRef": "text",
"id": "text",
"inboundProcessRef": "text",
"items": {
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
},
"origin": {
"name": "text"
},
"originReadableId": "text",
"originReadableName": "text",
"status": "OPEN"
}PurchaseOrderForCreation
This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fTime and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.
2026-06-17T12:00:00.000ZCreated Purchase Order entity
PurchaseOrder
This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.
2026-06-17T12:00:00.000ZYour user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
POST /api/purchaseorders HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 343
{
"customAttributes": {},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
}
}{
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"facilityRef": "text",
"id": "text",
"inboundProcessRef": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"transfer": {
"id": "text"
},
"version": 1
}Purchase Order entity
PurchaseOrder
This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.
2026-06-17T12:00:00.000ZYour user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
GET /api/purchaseorders/{purchaseOrderId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"facilityRef": "text",
"id": "text",
"inboundProcessRef": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"transfer": {
"id": "text"
},
"version": 1
}PurchaseOrderForUpdate
This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.
2026-06-17T12:00:00.000ZUpdated/created Purchase Order entity
PurchaseOrder
This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.
2026-06-17T12:00:00.000ZYour user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
PUT /api/purchaseorders/{purchaseOrderId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 302
{
"customAttributes": {},
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"version": 1
}{
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"facilityRef": "text",
"id": "text",
"inboundProcessRef": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"transfer": {
"id": "text"
},
"version": 1
}Partially updates a Purchase Order using a selection of fields
PurchaseOrderForPartialUpdate
This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
2026-06-17T12:00:00.000ZUpdated Purchase Order entity
PurchaseOrder
This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.
2026-06-17T12:00:00.000ZYour user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
PATCH /api/purchaseorders/{purchaseOrderId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 302
{
"customAttributes": {},
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"version": 1
}{
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"facilityRef": "text",
"id": "text",
"inboundProcessRef": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"transfer": {
"id": "text"
},
"version": 1
}ReceiptForCreation
enables mapping a receipt to one of the ASNs in this inbound process
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fAttributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
date-time of the arrival of the items in the facility
2026-06-17T12:00:00.000Zstatus of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.
Created inbound receipt
Receipt
enables mapping a receipt to one of the ASNs in this inbound process
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fAttributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
date-time of the arrival of the items in the facility
2026-06-17T12:00:00.000Zstatus of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
POST /api/receipts HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 576
{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"facilityRef": "text",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN"
}{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"id": "text",
"inboundProcessRef": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN",
"version": 1
}Receipt
enables mapping a receipt to one of the ASNs in this inbound process
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fAttributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
date-time of the arrival of the items in the facility
2026-06-17T12:00:00.000Zstatus of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
GET /api/receipts/{receiptId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"id": "text",
"inboundProcessRef": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN",
"version": 1
}InboundReceiptForUpdate
enables mapping a receipt to one of the ASNs in this inbound process
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fAttributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
date-time of the arrival of the items in the facility
2026-06-17T12:00:00.000Zstatus of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.
Receipt
enables mapping a receipt to one of the ASNs in this inbound process
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fAttributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
date-time of the arrival of the items in the facility
2026-06-17T12:00:00.000Zstatus of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
PUT /api/receipts/{receiptId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 603
{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN",
"version": 1
}{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"id": "text",
"inboundProcessRef": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN",
"version": 1
}Receipt
enables mapping a receipt to one of the ASNs in this inbound process
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fAttributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
date-time of the arrival of the items in the facility
2026-06-17T12:00:00.000Zstatus of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
DELETE /api/receipts/{receiptId}?version=1 HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"id": "text",
"inboundProcessRef": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN",
"version": 1
}InboundReceiptForPatch
enables mapping a receipt to one of the ASNs in this inbound process
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fAttributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
date-time of the arrival of the items in the facility
2026-06-17T12:00:00.000Zstatus of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.
Receipt
enables mapping a receipt to one of the ASNs in this inbound process
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fAttributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
date-time of the arrival of the items in the facility
2026-06-17T12:00:00.000Zstatus of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
PATCH /api/receipts/{receiptId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 603
{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN",
"version": 1
}{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"id": "text",
"inboundProcessRef": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN",
"version": 1
}Last updated
Was this helpful?