# Inbound (Inventory)
Endpoints to create, update and read inbound processes and receipts.
## GET /api/inboundprocesses
> List inbound processes
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundProcessPaginatedResult":{"properties":{"inboundProcesses":{"items":{"$ref":"#/components/schemas/InboundProcess"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","inboundProcesses"],"title":"InboundProcessPaginatedResult","type":"object","description":"InboundProcessPaginatedResult"},"InboundProcess":{"properties":{"anonymized":{"description":"Indicates the inbound process was anonymized acording to configured GDPR retention time.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundDate":{"description":"Aggregated dates from sources which advise incoming stock. Currently that is \"purchaseOrder\"","items":{"format":"date-time","type":"string"},"type":"array"},"lastModified":{"format":"date-time","type":"string"},"onHold":{"description":"Indicates if the inbound process is on hold and will not be processed further","type":"boolean"},"origin":{"description":"Aggregated origin data from sources which advise incoming stock. Currently that is just \"purchaseOrder\"","items":{"$ref":"#/components/schemas/InboundProcessOrigin"},"type":"array"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipts":{"items":{"$ref":"#/components/schemas/InboundReceipt"},"type":"array"},"scannableCodes":{"description":"scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note","items":{"type":"string"},"type":"array"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessId":{"type":"string"},"version":{"type":"number"}},"required":["facilityRef","id","version","created","lastModified","inboundDate","origin","anonymized","status","onHold","scannableCodes","receipts"],"title":"InboundProcess","type":"object","description":"InboundProcess"},"InboundProcessOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundProcessOrigin","type":"object","description":"InboundProcessOrigin"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundprocesses":{"get":{"deprecated":false,"description":"","operationId":"getInboundProcesses","parameters":[{"in":"query","name":"size","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"number"}},{"in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"in":"query","name":"sort","required":false,"schema":{"enum":["ORIGIN_NAME_ASC","REQUESTED_DATE_ASC","LAST_MODIFIED_ASC","ORIGIN_NAME_DESC","REQUESTED_DATE_DESC","LAST_MODIFIED_DESC"],"type":"string"}},{"in":"query","name":"facilityRef","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"scannableCode","required":false,"schema":{"type":"string"}},{"explode":false,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"type":"array"}},{"description":"Matches partial values; The queries terms and therefore the result set of the query can change in the future:\n- tenantInboundProcessId\n- scannableCodes\n- receipts.receivedItems.tenantArticleId\n- purchaseOrder.requestedItems.tenantArticleId\n- purchaseOrder.supplier.name\n- values of related listings\n - listing.title\n - listing.scannableCodes\n","in":"query","name":"searchTerm","required":false,"schema":{"type":"string"}},{"description":"Only matches complete values; The queries terms and therefore the result set of the query can change in the future:\n- tenantInboundProcessId\n- scannableCodes\n- receipts.receivedItems.tenantArticleId\n- purchaseOrder.requestedItems.tenantArticleId\n- purchaseOrder.supplier.name\n- values of related listings\n - listing.title\n - listing.scannableCodes\n","in":"query","name":"searchTermExact","required":false,"schema":{"type":"string"}},{"in":"query","name":"purchaseOrder_cancelled","required":false,"schema":{"type":"boolean"}},{"explode":false,"in":"query","name":"receipt_status","required":false,"schema":{"items":{"enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundProcessPaginatedResult"}}},"description":"Paginated result containing the matching Inbound Process entities"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"List inbound processes","tags":["Inbound (Inventory)"]}}}}
```
## POST /api/inboundprocesses
> Create inbound process
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundProcessForCreation":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"Facility in which the inbound process takes place","type":"string"},"onHold":{"description":"Indicates if the inbound process is on hold and will not be processed further","type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderForCreation"},"receipts":{"items":{"$ref":"#/components/schemas/InboundReceiptForCreation"},"maxItems":200,"type":"array"},"scannableCodes":{"description":"scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note","items":{"type":"string"},"type":"array"},"tenantInboundProcessId":{"description":"Identifier of the process provided by the tenant system. It is recommended to be unique","type":"string"}},"required":["facilityRef"],"title":"InboundProcessForCreation","type":"object","description":"InboundProcessForCreation"},"InboundProcessPurchaseOrderForCreation":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"}},"required":["orderDate","requestedDate","requestedItems"],"title":"InboundProcessPurchaseOrderForCreation","type":"object","description":"InboundProcessPurchaseOrderForCreation"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundReceiptForCreation":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForCreation"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments"],"title":"InboundReceiptForCreation","type":"object","description":"InboundReceiptForCreation"},"InboundReceiptCommentForCreation":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForCreation","type":"object","description":"InboundReceiptCommentForCreation"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForCreation":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForCreation","type":"object","description":"InboundReceiptLineItemForCreation"},"InboundProcess":{"properties":{"anonymized":{"description":"Indicates the inbound process was anonymized acording to configured GDPR retention time.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundDate":{"description":"Aggregated dates from sources which advise incoming stock. Currently that is \"purchaseOrder\"","items":{"format":"date-time","type":"string"},"type":"array"},"lastModified":{"format":"date-time","type":"string"},"onHold":{"description":"Indicates if the inbound process is on hold and will not be processed further","type":"boolean"},"origin":{"description":"Aggregated origin data from sources which advise incoming stock. Currently that is just \"purchaseOrder\"","items":{"$ref":"#/components/schemas/InboundProcessOrigin"},"type":"array"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipts":{"items":{"$ref":"#/components/schemas/InboundReceipt"},"type":"array"},"scannableCodes":{"description":"scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note","items":{"type":"string"},"type":"array"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessId":{"type":"string"},"version":{"type":"number"}},"required":["facilityRef","id","version","created","lastModified","inboundDate","origin","anonymized","status","onHold","scannableCodes","receipts"],"title":"InboundProcess","type":"object","description":"InboundProcess"},"InboundProcessOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundProcessOrigin","type":"object","description":"InboundProcessOrigin"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundprocesses":{"post":{"deprecated":false,"description":"","operationId":"createInboundProcess","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundProcessForCreation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundProcess"}}},"description":"Created Inbound Process entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Create inbound process","tags":["Inbound (Inventory)"]}}}}
```
## GET /api/inboundprocesses/{inboundProcessId}
> Get inbound process
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundProcess":{"properties":{"anonymized":{"description":"Indicates the inbound process was anonymized acording to configured GDPR retention time.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundDate":{"description":"Aggregated dates from sources which advise incoming stock. Currently that is \"purchaseOrder\"","items":{"format":"date-time","type":"string"},"type":"array"},"lastModified":{"format":"date-time","type":"string"},"onHold":{"description":"Indicates if the inbound process is on hold and will not be processed further","type":"boolean"},"origin":{"description":"Aggregated origin data from sources which advise incoming stock. Currently that is just \"purchaseOrder\"","items":{"$ref":"#/components/schemas/InboundProcessOrigin"},"type":"array"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipts":{"items":{"$ref":"#/components/schemas/InboundReceipt"},"type":"array"},"scannableCodes":{"description":"scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note","items":{"type":"string"},"type":"array"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessId":{"type":"string"},"version":{"type":"number"}},"required":["facilityRef","id","version","created","lastModified","inboundDate","origin","anonymized","status","onHold","scannableCodes","receipts"],"title":"InboundProcess","type":"object","description":"InboundProcess"},"InboundProcessOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundProcessOrigin","type":"object","description":"InboundProcessOrigin"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundprocesses/{inboundProcessId}":{"get":{"deprecated":false,"description":"","operationId":"getInboundProcess","parameters":[{"in":"path","name":"inboundProcessId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundProcess"}}},"description":"Requested Inbound Process entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Get inbound process","tags":["Inbound (Inventory)"]}}}}
```
## DELETE /api/inboundprocesses/{inboundProcessId}
> Delete inbound process
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundprocesses/{inboundProcessId}":{"delete":{"deprecated":false,"description":"","operationId":"deleteInboundProcess","parameters":[{"in":"path","name":"inboundProcessId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Inbound Process successfully deleted"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Delete inbound process","tags":["Inbound (Inventory)"]}}}}
```
## Update inbound process
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundProcessForPatch":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"onHold":{"description":"Indicates if the inbound process is on hold and will not be processed further","type":"boolean"},"scannableCodes":{"description":"scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note","items":{"type":"string"},"type":"array"},"version":{"type":"number"}},"required":["version"],"title":"InboundProcessForPatch","type":"object","description":"InboundProcessForPatch"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundprocesses/{inboundProcessId}":{"patch":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
","operationId":"Patch InboundProcess","parameters":[{"in":"path","name":"inboundProcessId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundProcessForPatch"}}},"required":true},"responses":{"200":{"description":"Inbound Process successfully patched"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Update inbound process","tags":["Inbound (Inventory)"]}}}}
```
## Update purchase order
> Creates or updates the specific purchase order of an existing inbound process.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundProcessPurchaseOrderForUpsert":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","version"],"title":"InboundProcessPurchaseOrderForUpsert","type":"object","description":"InboundProcessPurchaseOrderForUpsert"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundprocesses/{inboundProcessId}/purchaseorder":{"put":{"deprecated":false,"description":"Creates or updates the specific purchase order of an existing inbound process.","operationId":"upsertInboundProcessPurchaseOrder","parameters":[{"in":"path","name":"inboundProcessId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderForUpsert"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"}}},"description":"Purchase order successfully updated on inbound process"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"}}},"description":"Purchase order successfully created on inbound process"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Update purchase order","tags":["Inbound (Inventory)"]}}}}
```
## Create inbound process receipt
> Adds a receipt to an inbound process.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundReceiptForCreation":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForCreation"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments"],"title":"InboundReceiptForCreation","type":"object","description":"InboundReceiptForCreation"},"InboundReceiptCommentForCreation":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForCreation","type":"object","description":"InboundReceiptCommentForCreation"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForCreation":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForCreation","type":"object","description":"InboundReceiptLineItemForCreation"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundprocesses/{inboundProcessId}/receipts":{"post":{"deprecated":false,"description":"Adds a receipt to an inbound process.","operationId":"addReceiptToInboundProcess","parameters":[{"in":"path","name":"inboundProcessId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundReceiptForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundReceipt"}}},"description":"Receipt was added to the inbound process"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Create inbound process receipt","tags":["Inbound (Inventory)"]}}}}
```
## Create attachment
> This part of the API is in Alpha status. For details please check the \api-release-life-cycle documentation\.\
\
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundAttachmentForCreation":{"properties":{"content":{"description":"Base64 encoded attachment file","type":"string"},"fileName":{"description":"File name of attachment","type":"string"}},"required":["fileName","content"],"title":"InboundAttachmentForCreation","type":"object","description":"InboundAttachmentForCreation"},"InboundAttachment":{"properties":{"created":{"format":"date-time","type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"version":{"type":"number"}},"required":["id","version"],"title":"InboundAttachment","type":"object","description":"InboundAttachment"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundprocesses/attachments":{"post":{"deprecated":false,"description":"This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
","operationId":"createAttachment","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundAttachmentForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundAttachment"}}},"description":"Created attachment"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Create attachment","tags":["Inbound (Inventory)"]}}}}
```
## Get signed attachment url
> This part of the API is in Alpha status. For details please check the \api-release-life-cycle documentation\.\
\
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundprocesses/attachments/{attachmentId}/signedurl":{"get":{"deprecated":false,"description":"This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
","operationId":"getSignedAttachmentUrl","parameters":[{"in":"path","name":"attachmentId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Signed url"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Get signed attachment url","tags":["Inbound (Inventory)"]}}}}
```
## List inbound processes (search)
> Search for InboundProcess
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundProcessSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"$ref":"#/components/schemas/SearchOptions"},"query":{"$ref":"#/components/schemas/InboundProcessSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/InboundProcessSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"InboundProcessSearchPayload","type":"object","description":"InboundProcessSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"InboundProcessSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/InboundProcessSearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"inboundDate":{"allOf":[{"$ref":"#/components/schemas/DateListFilter"}],"description":"Search by inboundDate"},"or":{"items":{"$ref":"#/components/schemas/InboundProcessSearchQuery"},"maxItems":500,"type":"array"},"purchaseOrder":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderFilter"}],"description":"Nested search by purchaseOrder"},"receipts":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsListFilter"}],"description":"Nested list search by receipts"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessStatusTypeEnumFilter"}],"description":"Search by status"},"tenantInboundProcessId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantInboundProcessId"}},"title":"InboundProcessSearchQuery","type":"object","description":"InboundProcessSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"maxLength":256,"type":"string"},"notIn":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"DateListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/DateEqFilter"}},"title":"DateListFilter","type":"object","description":"DateListFilter"},"DateEqFilter":{"properties":{"eq":{"format":"date-time","type":"string"},"notEq":{"format":"date-time","type":"string"}},"title":"DateEqFilter","type":"object","description":"DateEqFilter"},"InboundProcessPurchaseOrderFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedDateFilter"}],"description":"Nested search by requestedDate"},"requestedItems":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedItemsListFilter"}],"description":"Nested list search by requestedItems"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter"}],"description":"Search by status"},"supplier":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplierFilter"}],"description":"Nested search by supplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransferFilter"}],"description":"Nested search by transfer"}},"title":"InboundProcessPurchaseOrderFilter","type":"object","description":"InboundProcessPurchaseOrderFilter"},"InboundProcessPurchaseOrderRequestedDateFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"}],"description":"Search by type"},"value":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by value"}},"title":"InboundProcessPurchaseOrderRequestedDateFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateFilter"},"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["ASAP","TIME_POINT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"}},"title":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"},"InboundProcessPurchaseOrderRequestedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedItemsFilter"}],"description":"Contains returns if at least one entry matches"}},"title":"InboundProcessPurchaseOrderRequestedItemsListFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsListFilter"},"InboundProcessPurchaseOrderRequestedItemsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessPurchaseOrderRequestedItemsFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsFilter"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELED"],"type":"string"}},"title":"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter","type":"object","description":"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter"},"InboundProcessPurchaseOrderSupplierFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"}},"title":"InboundProcessPurchaseOrderSupplierFilter","type":"object","description":"InboundProcessPurchaseOrderSupplierFilter"},"InboundProcessPurchaseOrderTransferFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"}},"title":"InboundProcessPurchaseOrderTransferFilter","type":"object","description":"InboundProcessPurchaseOrderTransferFilter"},"InboundProcessReceiptsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsFilter"}],"description":"Contains returns if at least one entry matches"}},"title":"InboundProcessReceiptsListFilter","type":"object","description":"InboundProcessReceiptsListFilter"},"InboundProcessReceiptsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"receivedDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by receivedDate"},"receivedItems":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsListFilter"}],"description":"Nested list search by receivedItems"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"}],"description":"Search by status"}},"title":"InboundProcessReceiptsFilter","type":"object","description":"InboundProcessReceiptsFilter"},"InboundProcessReceiptsReceivedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsFilter"}],"description":"Contains returns if at least one entry matches"}},"title":"InboundProcessReceiptsReceivedItemsListFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsListFilter"},"InboundProcessReceiptsReceivedItemsFilter":{"properties":{"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessReceiptsReceivedItemsFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsFilter"},"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"title":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter","type":"object","description":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"InboundProcessStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"}},"title":"InboundProcessStatusTypeEnumFilter","type":"object","description":"InboundProcessStatusTypeEnumFilter"},"InboundProcessSort":{"properties":{"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"po_created":{"enum":["ASC","DESC"],"type":"string"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSort"}},"title":"InboundProcessSort","type":"object","description":"InboundProcessSort"},"InboundProcessPurchaseOrderSort":{"properties":{"requestedDate":{"$ref":"#/components/schemas/InboundProcessRequestedDateSort"},"supplier":{"$ref":"#/components/schemas/InboundProcessSupplierSort"}},"title":"InboundProcessPurchaseOrderSort","type":"object","description":"InboundProcessPurchaseOrderSort"},"InboundProcessRequestedDateSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"},"value":{"enum":["ASC","DESC"],"type":"string"}},"title":"InboundProcessRequestedDateSort","type":"object","description":"InboundProcessRequestedDateSort"},"InboundProcessSupplierSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"InboundProcessSupplierSort","type":"object","description":"InboundProcessSupplierSort"},"InboundProcessPaginatedResult":{"properties":{"inboundProcesses":{"items":{"$ref":"#/components/schemas/InboundProcess"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","inboundProcesses"],"title":"InboundProcessPaginatedResult","type":"object","description":"InboundProcessPaginatedResult"},"InboundProcess":{"properties":{"anonymized":{"description":"Indicates the inbound process was anonymized acording to configured GDPR retention time.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundDate":{"description":"Aggregated dates from sources which advise incoming stock. Currently that is \"purchaseOrder\"","items":{"format":"date-time","type":"string"},"type":"array"},"lastModified":{"format":"date-time","type":"string"},"onHold":{"description":"Indicates if the inbound process is on hold and will not be processed further","type":"boolean"},"origin":{"description":"Aggregated origin data from sources which advise incoming stock. Currently that is just \"purchaseOrder\"","items":{"$ref":"#/components/schemas/InboundProcessOrigin"},"type":"array"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipts":{"items":{"$ref":"#/components/schemas/InboundReceipt"},"type":"array"},"scannableCodes":{"description":"scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note","items":{"type":"string"},"type":"array"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessId":{"type":"string"},"version":{"type":"number"}},"required":["facilityRef","id","version","created","lastModified","inboundDate","origin","anonymized","status","onHold","scannableCodes","receipts"],"title":"InboundProcess","type":"object","description":"InboundProcess"},"InboundProcessOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundProcessOrigin","type":"object","description":"InboundProcessOrigin"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundprocesses/search":{"post":{"deprecated":false,"description":"Search for InboundProcess","operationId":"searchInboundProcess","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundProcessSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundProcessPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"List inbound processes (search)","tags":["Inbound (Inventory)"]}}}}
```
## List inbound receipt jobs
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundReceiptJobPaginatedResult":{"properties":{"inboundReceiptJobs":{"items":{"$ref":"#/components/schemas/InboundReceiptJob"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","inboundReceiptJobs"],"title":"InboundReceiptJobPaginatedResult","type":"object","description":"InboundReceiptJobPaginatedResult"},"InboundReceiptJob":{"properties":{"expectedDate":{"$ref":"#/components/schemas/RequestedDate"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"items":{"$ref":"#/components/schemas/InboundLineItem"},"origin":{"$ref":"#/components/schemas/InboundReceiptJobOrigin"},"originReadableId":{"type":"string"},"originReadableName":{"type":"string"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"}},"required":["id","facilityRef","inboundProcessRef","status","expectedDate","items","origin"],"title":"InboundReceiptJob","type":"object","description":"InboundReceiptJob"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundReceiptJobOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundReceiptJobOrigin","type":"object","description":"InboundReceiptJobOrigin"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundreceiptjobs":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
","operationId":"getInboundReceiptJobs","parameters":[{"in":"query","name":"size","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"number"}},{"in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"in":"query","name":"facilityRef","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"explode":false,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"type":"array"}},{"in":"query","name":"searchTerm","required":false,"schema":{"minLength":1,"type":"string"}},{"in":"query","name":"searchTermExact","required":false,"schema":{"minLength":1,"type":"string"}},{"in":"query","name":"fromDate","required":false,"schema":{"format":"date-time","type":"string"}},{"in":"query","name":"toDate","required":false,"schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundReceiptJobPaginatedResult"}}},"description":"Paginated Inbound Receipt Jobs"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"List inbound receipt jobs","tags":["Inbound (Inventory)"]}}}}
```
## Get inbound receipt job
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundReceiptJob":{"properties":{"expectedDate":{"$ref":"#/components/schemas/RequestedDate"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"items":{"$ref":"#/components/schemas/InboundLineItem"},"origin":{"$ref":"#/components/schemas/InboundReceiptJobOrigin"},"originReadableId":{"type":"string"},"originReadableName":{"type":"string"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"}},"required":["id","facilityRef","inboundProcessRef","status","expectedDate","items","origin"],"title":"InboundReceiptJob","type":"object","description":"InboundReceiptJob"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundReceiptJobOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundReceiptJobOrigin","type":"object","description":"InboundReceiptJobOrigin"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundreceiptjobs/{inboundEntryId}":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
","operationId":"getInboundReceiptJob","parameters":[{"in":"path","name":"inboundEntryId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundReceiptJob"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Get inbound receipt job","tags":["Inbound (Inventory)"]}}}}
```
## POST /api/purchaseorders
> Create purchase order
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PurchaseOrderForCreation":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"minLength":1,"type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"}},"required":["orderDate","requestedDate","requestedItems","facilityRef"],"title":"PurchaseOrderForCreation","type":"object","description":"PurchaseOrderForCreation"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"PurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified","version","facilityRef","inboundProcessRef"],"title":"PurchaseOrder","type":"object","description":"PurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/purchaseorders":{"post":{"deprecated":false,"description":"","operationId":"createPurchaseOrder","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"description":"Created Purchase Order entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Create purchase order","tags":["Inbound (Inventory)"]}}}}
```
## GET /api/purchaseorders/{purchaseOrderId}
> Get purchase order
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified","version","facilityRef","inboundProcessRef"],"title":"PurchaseOrder","type":"object","description":"PurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/purchaseorders/{purchaseOrderId}":{"get":{"deprecated":false,"description":"","operationId":"getPurchaseOrder","parameters":[{"in":"path","name":"purchaseOrderId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"description":"Purchase Order entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Get purchase order","tags":["Inbound (Inventory)"]}}}}
```
## PUT /api/purchaseorders/{purchaseOrderId}
> Update purchase order
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PurchaseOrderForUpdate":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","version"],"title":"PurchaseOrderForUpdate","type":"object","description":"PurchaseOrderForUpdate"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"PurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified","version","facilityRef","inboundProcessRef"],"title":"PurchaseOrder","type":"object","description":"PurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/purchaseorders/{purchaseOrderId}":{"put":{"deprecated":false,"description":"","operationId":"upsertPurchaseOrder","parameters":[{"in":"path","name":"purchaseOrderId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderForUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"description":"Updated/created Purchase Order entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Update purchase order","tags":["Inbound (Inventory)"]}}}}
```
## Updates purchase order
> Partially updates a Purchase Order using a selection of fields
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PurchaseOrderForPartialUpdate":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"orderDate":{"format":"date-time","type":"string"},"requestedDate":{"$ref":"#/components/schemas/InputRequestedDate"},"requestedItems":{"items":{"$ref":"#/components/schemas/InboundLineItem"},"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"version":{"type":"number"}},"required":["version"],"title":"PurchaseOrderForPartialUpdate","type":"object","description":"PurchaseOrderForPartialUpdate"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"PurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified","version","facilityRef","inboundProcessRef"],"title":"PurchaseOrder","type":"object","description":"PurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/purchaseorders/{purchaseOrderId}":{"patch":{"deprecated":false,"description":"Partially updates a Purchase Order using a selection of fields","operationId":"patchPurchaseOrder","parameters":[{"in":"path","name":"purchaseOrderId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderForPartialUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"description":"Updated Purchase Order entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Updates purchase order","tags":["Inbound (Inventory)"]}}}}
```
## POST /api/receipts
> Create receipt
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReceiptForCreation":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForCreation"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","facilityRef"],"title":"ReceiptForCreation","type":"object","description":"ReceiptForCreation"},"InboundReceiptCommentForCreation":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForCreation","type":"object","description":"InboundReceiptCommentForCreation"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForCreation":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForCreation","type":"object","description":"InboundReceiptLineItemForCreation"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Receipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","id","inboundProcessRef","version","created","lastModified"],"title":"Receipt","type":"object","description":"Receipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/receipts":{"post":{"deprecated":false,"description":"","operationId":"createReceipt","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt"}}},"description":"Created inbound receipt"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Create receipt","tags":["Inbound (Inventory)"]}}}}
```
## GET /api/receipts/{receiptId}
> Get receipt
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Receipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","id","inboundProcessRef","version","created","lastModified"],"title":"Receipt","type":"object","description":"Receipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/receipts/{receiptId}":{"get":{"deprecated":false,"description":"","operationId":"getReceipt","parameters":[{"in":"path","name":"receiptId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get receipt","tags":["Inbound (Inventory)"]}}}}
```
## PUT /api/receipts/{receiptId}
> Update receipt
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundReceiptForUpdate":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForUpdate"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","version"],"title":"InboundReceiptForUpdate","type":"object","description":"InboundReceiptForUpdate"},"InboundReceiptCommentForUpdate":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForUpdate","type":"object","description":"InboundReceiptCommentForUpdate"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForUpdate":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receival of this item","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForUpdate","type":"object","description":"InboundReceiptLineItemForUpdate"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Receipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","id","inboundProcessRef","version","created","lastModified"],"title":"Receipt","type":"object","description":"Receipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/receipts/{receiptId}":{"put":{"deprecated":false,"description":"","operationId":"putReceipt","parameters":[{"in":"path","name":"receiptId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundReceiptForUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Update receipt","tags":["Inbound (Inventory)"]}}}}
```
## DELETE /api/receipts/{receiptId}
> Delete receipt
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Receipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","id","inboundProcessRef","version","created","lastModified"],"title":"Receipt","type":"object","description":"Receipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/receipts/{receiptId}":{"delete":{"deprecated":false,"description":"","operationId":"deleteReceipt","parameters":[{"in":"path","name":"receiptId","required":true,"schema":{"type":"string"}},{"in":"query","name":"version","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Delete receipt","tags":["Inbound (Inventory)"]}}}}
```
## PATCH /api/receipts/{receiptId}
> Update receipt
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound (Inventory)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundReceiptForPatch":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForUpdate"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["version"],"title":"InboundReceiptForPatch","type":"object","description":"InboundReceiptForPatch"},"InboundReceiptCommentForUpdate":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForUpdate","type":"object","description":"InboundReceiptCommentForUpdate"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForUpdate":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receival of this item","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForUpdate","type":"object","description":"InboundReceiptLineItemForUpdate"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Receipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","id","inboundProcessRef","version","created","lastModified"],"title":"Receipt","type":"object","description":"Receipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/receipts/{receiptId}":{"patch":{"deprecated":false,"description":"","operationId":"patchReceipt","parameters":[{"in":"path","name":"receiptId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundReceiptForPatch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Update receipt","tags":["Inbound (Inventory)"]}}}}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.fulfillmenttools.com/documentation/apis/api-reference/inbound-inventory.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.