Receipt endpoints

Get receipt

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

receiptIdstringRequired

Responses

200Success

application/json

Receipt

asnRefstringOptional

enables mapping a receipt to one of the ASNs in this inbound process

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

createdstring · date-timeRequired

customAttributesobject · nullableOptional

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.

idstringRequired

inboundProcessRefstringRequired

lastModifiedstring · date-timeRequired

receivedDatestring · date-timeRequired

date-time of the arrival of the items in the facility

Example: 2026-06-17T12:00:00.000Z

statusstring · enumOptional

status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.

Possible values:

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

The requested entity was not found

application/json

get/api/receipts/{receiptId}

HTTPcURLJavaScriptPython

GET /api/receipts/{receiptId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "comments": [
    {
      "content": "text",
      "documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "id": "text",
      "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
    }
  ],
  "created": "2026-08-07T19:11:13.150Z",
  "customAttributes": {},
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2026-08-07T19:11:13.150Z",
  "receivedDate": "2026-06-17T12:00:00.000Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 42
      },
      "comments": [
        {
          "content": "text",
          "documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
          "id": "text",
          "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
        }
      ],
      "customAttributes": {},
      "id": "text",
      "rejectedQuantity": {
        "unit": "text",
        "value": 42
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "tenantArticleId": "MY_ARTICLE_ID"
    }
  ],
  "status": "OPEN",
  "version": 1
}

Update receipt

put

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

receiptIdstringRequired

Body

application/json

InboundReceiptForUpdate

asnRefstringOptional

enables mapping a receipt to one of the ASNs in this inbound process

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

customAttributesobject · nullableOptional

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.

receivedDatestring · date-timeRequired

date-time of the arrival of the items in the facility

Example: 2026-06-17T12:00:00.000Z

statusstring · enumOptional

status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.

Possible values:

versionnumberRequired

Responses

200Success

application/json

Receipt

asnRefstringOptional

enables mapping a receipt to one of the ASNs in this inbound process

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

createdstring · date-timeRequired

customAttributesobject · nullableOptional

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.

idstringRequired

inboundProcessRefstringRequired

lastModifiedstring · date-timeRequired

receivedDatestring · date-timeRequired

date-time of the arrival of the items in the facility

Example: 2026-06-17T12:00:00.000Z

statusstring · enumOptional

status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.

Possible values:

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

The requested entity was not found

application/json

put/api/receipts/{receiptId}

HTTPcURLJavaScriptPython

PUT /api/receipts/{receiptId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 603

{
  "asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "comments": [
    {
      "content": "text",
      "id": "text",
      "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
    }
  ],
  "customAttributes": {},
  "receivedDate": "2026-06-17T12:00:00.000Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 42
      },
      "comments": [
        {
          "content": "text",
          "id": "text",
          "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
        }
      ],
      "customAttributes": {},
      "id": "text",
      "rejectedQuantity": {
        "unit": "text",
        "value": 42
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "tenantArticleId": "MY_ARTICLE_ID"
    }
  ],
  "status": "OPEN",
  "version": 1
}

{
  "asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "comments": [
    {
      "content": "text",
      "documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "id": "text",
      "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
    }
  ],
  "created": "2026-08-07T19:11:13.150Z",
  "customAttributes": {},
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2026-08-07T19:11:13.150Z",
  "receivedDate": "2026-06-17T12:00:00.000Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 42
      },
      "comments": [
        {
          "content": "text",
          "documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
          "id": "text",
          "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
        }
      ],
      "customAttributes": {},
      "id": "text",
      "rejectedQuantity": {
        "unit": "text",
        "value": 42
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "tenantArticleId": "MY_ARTICLE_ID"
    }
  ],
  "status": "OPEN",
  "version": 1
}

Update receipt

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

receiptIdstringRequired

Body

application/json

InboundReceiptForPatch

asnRefstringOptional

enables mapping a receipt to one of the ASNs in this inbound process

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

customAttributesobject · nullableOptional

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.

receivedDatestring · date-timeOptional

date-time of the arrival of the items in the facility

Example: 2026-06-17T12:00:00.000Z

statusstring · enumOptional

status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.

Possible values:

versionnumberRequired

Responses

200Success

application/json

Receipt

asnRefstringOptional

enables mapping a receipt to one of the ASNs in this inbound process

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

createdstring · date-timeRequired

customAttributesobject · nullableOptional

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.

idstringRequired

inboundProcessRefstringRequired

lastModifiedstring · date-timeRequired

receivedDatestring · date-timeRequired

date-time of the arrival of the items in the facility

Example: 2026-06-17T12:00:00.000Z

statusstring · enumOptional

status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.

Possible values:

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

The requested entity was not found

application/json

patch/api/receipts/{receiptId}

HTTPcURLJavaScriptPython

PATCH /api/receipts/{receiptId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 603

{
  "asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "comments": [
    {
      "content": "text",
      "id": "text",
      "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
    }
  ],
  "customAttributes": {},
  "receivedDate": "2026-06-17T12:00:00.000Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 42
      },
      "comments": [
        {
          "content": "text",
          "id": "text",
          "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
        }
      ],
      "customAttributes": {},
      "id": "text",
      "rejectedQuantity": {
        "unit": "text",
        "value": 42
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "tenantArticleId": "MY_ARTICLE_ID"
    }
  ],
  "status": "OPEN",
  "version": 1
}

{
  "asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "comments": [
    {
      "content": "text",
      "documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "id": "text",
      "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
    }
  ],
  "created": "2026-08-07T19:11:13.150Z",
  "customAttributes": {},
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2026-08-07T19:11:13.150Z",
  "receivedDate": "2026-06-17T12:00:00.000Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 42
      },
      "comments": [
        {
          "content": "text",
          "documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
          "id": "text",
          "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
        }
      ],
      "customAttributes": {},
      "id": "text",
      "rejectedQuantity": {
        "unit": "text",
        "value": 42
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "tenantArticleId": "MY_ARTICLE_ID"
    }
  ],
  "status": "OPEN",
  "version": 1
}

Create receipt

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ReceiptForCreation

asnRefstringOptional

enables mapping a receipt to one of the ASNs in this inbound process

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

customAttributesobject · nullableOptional

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.

facilityRefstringRequired

receivedDatestring · date-timeRequired

date-time of the arrival of the items in the facility

Example: 2026-06-17T12:00:00.000Z

statusstring · enumOptional

status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.

Possible values:

Responses

201

Created inbound receipt

application/json

Receipt

asnRefstringOptional

enables mapping a receipt to one of the ASNs in this inbound process

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

createdstring · date-timeRequired

customAttributesobject · nullableOptional

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.

idstringRequired

inboundProcessRefstringRequired

lastModifiedstring · date-timeRequired

receivedDatestring · date-timeRequired

date-time of the arrival of the items in the facility

Example: 2026-06-17T12:00:00.000Z

statusstring · enumOptional

status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.

Possible values:

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post/api/receipts

HTTPcURLJavaScriptPython

POST /api/receipts HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 576

{
  "asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "comments": [
    {
      "content": "text",
      "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
    }
  ],
  "customAttributes": {},
  "facilityRef": "text",
  "receivedDate": "2026-06-17T12:00:00.000Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 42
      },
      "comments": [
        {
          "content": "text",
          "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
        }
      ],
      "customAttributes": {},
      "rejectedQuantity": {
        "unit": "text",
        "value": 42
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "tenantArticleId": "MY_ARTICLE_ID"
    }
  ],
  "status": "OPEN"
}

{
  "asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "comments": [
    {
      "content": "text",
      "documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "id": "text",
      "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
    }
  ],
  "created": "2026-08-07T19:11:13.150Z",
  "customAttributes": {},
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2026-08-07T19:11:13.150Z",
  "receivedDate": "2026-06-17T12:00:00.000Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 42
      },
      "comments": [
        {
          "content": "text",
          "documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
          "id": "text",
          "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
        }
      ],
      "customAttributes": {},
      "id": "text",
      "rejectedQuantity": {
        "unit": "text",
        "value": 42
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "tenantArticleId": "MY_ARTICLE_ID"
    }
  ],
  "status": "OPEN",
  "version": 1
}

Delete receipt

delete

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

receiptIdstringRequired

Query parameters

versionnumberRequired

Responses

200Success

application/json

Receipt

asnRefstringOptional

enables mapping a receipt to one of the ASNs in this inbound process

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

createdstring · date-timeRequired

customAttributesobject · nullableOptional

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.

idstringRequired

inboundProcessRefstringRequired

lastModifiedstring · date-timeRequired

receivedDatestring · date-timeRequired

date-time of the arrival of the items in the facility

Example: 2026-06-17T12:00:00.000Z

statusstring · enumOptional

status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.

Possible values:

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

The requested entity was not found

application/json

delete/api/receipts/{receiptId}

HTTPcURLJavaScriptPython

DELETE /api/receipts/{receiptId}?version=1 HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "comments": [
    {
      "content": "text",
      "documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "id": "text",
      "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
    }
  ],
  "created": "2026-08-07T19:11:13.150Z",
  "customAttributes": {},
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2026-08-07T19:11:13.150Z",
  "receivedDate": "2026-06-17T12:00:00.000Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 42
      },
      "comments": [
        {
          "content": "text",
          "documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
          "id": "text",
          "userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
        }
      ],
      "customAttributes": {},
      "id": "text",
      "rejectedQuantity": {
        "unit": "text",
        "value": 42
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "tenantArticleId": "MY_ARTICLE_ID"
    }
  ],
  "status": "OPEN",
  "version": 1
}