Heads up, our devs are blazing ahead—docs are catching up, so some features might not be fully documented yet.
Visit our websiteAPI Documentation

Receivement

Receivement

Deprecated

Print or send receivement receipt

post
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/receipt

Send receivement receipt as PDF, print on printer or get as PDF

Authorizations
Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
receivementUidstringRequired

Reference to a receivement of a purchase order.

Pattern: ^[A-Za-z0-9-_]+
Body
recepientsstring[]Required
subjectstringOptional
bodystringOptional
includePDFbooleanOptionalDefault: true
Responses
200

Based on the Accept header the response will be base64 json encoded or a raw file. application/octet-stream will return a binary file application/json will return a json with the file content base64 encoded.

post
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/receipt
POST /v2/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/receipt HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "recepients": [
    "text"
  ],
  "subject": "text",
  "body": "text",
  "includePDF": true,
  "attachments": [
    {
      "content": "text",
      "contentType": "text",
      "filename": "text"
    }
  ]
}
{
  "content": "text",
  "contentType": "text",
  "filename": "text"
}

Email PDF of receivement receipt

post
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/email

Email PDF of receivement receipt

Authorizations
Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
receivementUidstringRequired

Reference to a receivement of a purchase order.

Pattern: ^[A-Za-z0-9-_]+
Body
recepientsstring[]Required
subjectstringOptional
bodystringOptional
includePDFbooleanOptionalDefault: true
Responses
200

Based on the Accept header the response will be base64 json encoded or a raw file. application/octet-stream will return a binary file application/json will return a json with the file content base64 encoded.

post
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/email
POST /v2/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/email HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "recepients": [
    "text"
  ],
  "subject": "text",
  "body": "text",
  "includePDF": true,
  "attachments": [
    {
      "content": "text",
      "contentType": "text",
      "filename": "text"
    }
  ]
}
{
  "content": "text",
  "contentType": "text",
  "filename": "text"
}

Download PDF of receivement receipt

get
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/download

Download PDF of receivement receipt

Authorizations
Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
receivementUidstringRequired

Reference to a receivement of a purchase order.

Pattern: ^[A-Za-z0-9-_]+
Responses
200

Based on the Accept header the response will be base64 json encoded or a raw file. application/octet-stream will return a binary file application/json will return a json with the file content base64 encoded.

get
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/download
GET /v2/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/download HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "content": "text",
  "contentType": "text",
  "filename": "text"
}

List receivements

get
/tenants/{tenantUid}/stores/{storeUid}/receivements

List all receivements.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
receivementProductUidstringOptional

Reference to a product uid.

Pattern: ^[A-Za-z0-9-_]+
receivementPurchaseOrderUidstringOptional

Reference to a purchaseOrder uid.

Pattern: ^[A-Za-z0-9-_]+
receivementExternalIdstringOptional

External reference to a receivement.

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Responses
200

Example response

application/json
get
/tenants/{tenantUid}/stores/{storeUid}/receivements
GET /v2/tenants/{tenantUid}/stores/{storeUid}/receivements HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "createdAt": "2025-10-29T06:58:12.910Z",
      "createdBy": "text",
      "externalId": "text",
      "items": [
        {
          "createdAt": "2025-10-29T06:58:12.910Z",
          "createdBy": "text",
          "externalId": "text",
          "lastModifiedAt": "2025-10-29T06:58:12.910Z",
          "lastModifiedBy": "text",
          "product": {
            "productUid": "text",
            "name": "text",
            "sku": "text"
          },
          "purchaseOrderItemUid": "text",
          "quantity": 1,
          "unitCost": 1,
          "receivementItemUid": "text",
          "serialnumber": "text",
          "status": "text",
          "note": "text",
          "tenantUserUid": "text",
          "tenantUserDisplayName": "text"
        }
      ],
      "lastModifiedAt": "2025-10-29T06:58:12.910Z",
      "lastModifiedBy": "text",
      "packingList": "text",
      "purchaseOrderUid": "text",
      "receivementUid": "text",
      "status": "RECEIVED",
      "warehouseUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new receivement

post
/tenants/{tenantUid}/stores/{storeUid}/receivements

Create a new receivement.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
Body
receivementUidstringOptionalPattern: ^[A-Za-z0-9-_]+
externalIdstringOptional

External reference to receivement

itemsall of[]Optional
and
packingListstringOptional
purchaseOrderUidstringRequiredPattern: ^[A-Za-z0-9-_]+
statusstring · enumRequired
ENUM Description
RECEIVED Received
PENDING Put aside, not finished
UPDATING Updating in progress
Possible values:
warehouseUidstringRequiredPattern: ^[A-Za-z0-9-_]+
Responses
200

Example response

application/json
post
/tenants/{tenantUid}/stores/{storeUid}/receivements
POST /v2/tenants/{tenantUid}/stores/{storeUid}/receivements HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "receivementUid": "text",
  "externalId": "text",
  "items": [
    {
      "externalId": "text",
      "purchaseOrderItemUid": "text",
      "quantity": 1,
      "serialnumber": "text",
      "unitCost": 1,
      "note": "text",
      "receivementItemUid": "text"
    }
  ],
  "packingList": "text",
  "purchaseOrderUid": "text",
  "status": "RECEIVED",
  "warehouseUid": "text"
}
200

Example response

{
  "createdAt": "2025-10-29T06:58:12.910Z",
  "createdBy": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2025-10-29T06:58:12.910Z",
      "createdBy": "text",
      "externalId": "text",
      "lastModifiedAt": "2025-10-29T06:58:12.910Z",
      "lastModifiedBy": "text",
      "product": {
        "productUid": "text",
        "name": "text",
        "sku": "text"
      },
      "purchaseOrderItemUid": "text",
      "quantity": 1,
      "unitCost": 1,
      "receivementItemUid": "text",
      "serialnumber": "text",
      "status": "text",
      "note": "text",
      "tenantUserUid": "text",
      "tenantUserDisplayName": "text"
    }
  ],
  "lastModifiedAt": "2025-10-29T06:58:12.910Z",
  "lastModifiedBy": "text",
  "packingList": "text",
  "purchaseOrderUid": "text",
  "receivementUid": "text",
  "status": "RECEIVED",
  "warehouseUid": "text"
}

Get receivement details

get
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}

Get details for a receivement.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
receivementUidstringRequired

Reference to a receivement of a purchase order.

Pattern: ^[A-Za-z0-9-_]+
Responses
200

Example response

application/json
get
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}
GET /v2/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "createdAt": "2025-10-29T06:58:12.910Z",
  "createdBy": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2025-10-29T06:58:12.910Z",
      "createdBy": "text",
      "externalId": "text",
      "lastModifiedAt": "2025-10-29T06:58:12.910Z",
      "lastModifiedBy": "text",
      "product": {
        "productUid": "text",
        "name": "text",
        "sku": "text"
      },
      "purchaseOrderItemUid": "text",
      "quantity": 1,
      "unitCost": 1,
      "receivementItemUid": "text",
      "serialnumber": "text",
      "status": "text",
      "note": "text",
      "tenantUserUid": "text",
      "tenantUserDisplayName": "text"
    }
  ],
  "lastModifiedAt": "2025-10-29T06:58:12.910Z",
  "lastModifiedBy": "text",
  "packingList": "text",
  "purchaseOrderUid": "text",
  "receivementUid": "text",
  "status": "RECEIVED",
  "warehouseUid": "text"
}

Update receivement details

put
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}

Update the details of a receivement.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
receivementUidstringRequired

Reference to a receivement of a purchase order.

Pattern: ^[A-Za-z0-9-_]+
Body
externalIdstringOptional

External reference to receivement

packingListstringOptional
statusstring · enumOptional
ENUM Description
RECEIVED Received
PENDING Put aside, not finished
UPDATING Updating in progress
Possible values:
Responses
200

Example response

application/json
put
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "externalId": "text",
  "packingList": "text",
  "status": "RECEIVED"
}
200

Example response

{
  "createdAt": "2025-10-29T06:58:12.910Z",
  "createdBy": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2025-10-29T06:58:12.910Z",
      "createdBy": "text",
      "externalId": "text",
      "lastModifiedAt": "2025-10-29T06:58:12.910Z",
      "lastModifiedBy": "text",
      "product": {
        "productUid": "text",
        "name": "text",
        "sku": "text"
      },
      "purchaseOrderItemUid": "text",
      "quantity": 1,
      "unitCost": 1,
      "receivementItemUid": "text",
      "serialnumber": "text",
      "status": "text",
      "note": "text",
      "tenantUserUid": "text",
      "tenantUserDisplayName": "text"
    }
  ],
  "lastModifiedAt": "2025-10-29T06:58:12.910Z",
  "lastModifiedBy": "text",
  "packingList": "text",
  "purchaseOrderUid": "text",
  "receivementUid": "text",
  "status": "RECEIVED",
  "warehouseUid": "text"
}

Delete a receivement

delete
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}

Delete a receivement. Only allowed if ReceivementStatus is not UPDATING or COMPLETED.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
receivementUidstringRequired

Reference to a receivement of a purchase order.

Pattern: ^[A-Za-z0-9-_]+
Responses
204

No Content

No content
delete
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content

List receivement items

get
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items

List all items belonging to a specific receivement.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
receivementUidstringRequired

Reference to a receivement of a purchase order.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Responses
200

Example response

application/json
get
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items
GET /v2/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "createdAt": "2025-10-29T06:58:12.910Z",
      "createdBy": "text",
      "externalId": "text",
      "lastModifiedAt": "2025-10-29T06:58:12.910Z",
      "lastModifiedBy": "text",
      "product": {
        "productUid": "text",
        "name": "text",
        "sku": "text"
      },
      "purchaseOrderItemUid": "text",
      "quantity": 1,
      "unitCost": 1,
      "receivementItemUid": "text",
      "serialnumber": "text",
      "status": "text",
      "note": "text",
      "tenantUserUid": "text",
      "tenantUserDisplayName": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add an item to a receivement

post
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items

Add an item to a receivement.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
receivementUidstringRequired

Reference to a receivement of a purchase order.

Pattern: ^[A-Za-z0-9-_]+
Body
all ofOptional
and
Responses
200

Example response

application/json
post
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items
POST /v2/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "externalId": "text",
  "purchaseOrderItemUid": "text",
  "quantity": 1,
  "serialnumber": "text",
  "unitCost": 1,
  "note": "text",
  "receivementItemUid": "text"
}
200

Example response

{
  "createdAt": "2025-10-29T06:58:12.910Z",
  "createdBy": "text",
  "externalId": "text",
  "lastModifiedAt": "2025-10-29T06:58:12.910Z",
  "lastModifiedBy": "text",
  "product": {
    "productUid": "text",
    "name": "text",
    "sku": "text"
  },
  "purchaseOrderItemUid": "text",
  "quantity": 1,
  "unitCost": 1,
  "receivementItemUid": "text",
  "serialnumber": "text",
  "status": "text",
  "note": "text",
  "tenantUserUid": "text",
  "tenantUserDisplayName": "text"
}

Get receivement item details

get
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items/{receivementItemUid}

Get details on an item on a receivement.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
receivementUidstringRequired

Reference to a receivement of a purchase order.

Pattern: ^[A-Za-z0-9-_]+
receivementItemUidstringRequired

Reference to an item on a specific receivement.

Pattern: ^[A-Za-z0-9-_]+
Responses
200

Example response

application/json
get
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items/{receivementItemUid}
GET /v2/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items/{receivementItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "createdAt": "2025-10-29T06:58:12.910Z",
  "createdBy": "text",
  "externalId": "text",
  "lastModifiedAt": "2025-10-29T06:58:12.910Z",
  "lastModifiedBy": "text",
  "product": {
    "productUid": "text",
    "name": "text",
    "sku": "text"
  },
  "purchaseOrderItemUid": "text",
  "quantity": 1,
  "unitCost": 1,
  "receivementItemUid": "text",
  "serialnumber": "text",
  "status": "text",
  "note": "text",
  "tenantUserUid": "text",
  "tenantUserDisplayName": "text"
}

Update receivement item details

put
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items/{receivementItemUid}

Update details of an item on a receivement.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
receivementUidstringRequired

Reference to a receivement of a purchase order.

Pattern: ^[A-Za-z0-9-_]+
receivementItemUidstringRequired

Reference to an item on a specific receivement.

Pattern: ^[A-Za-z0-9-_]+
Body

If you need to receive more than one quantity for items that required serialnumber you need to add one line for each serialnumber.

Example: You are going to receive 3 stk of purchaseorderItemUid 33, then you need to add 3 ReceivementItemCreate lines with quantity 1 and the serialnumber for each item.

externalIdstringOptional

External reference to receivement line

purchaseOrderItemUidstringRequiredPattern: ^[A-Za-z0-9-_]+
quantityintegerRequired
serialnumberstringOptional
unitPriceintegerOptionalDeprecated

Deprecated: Use unitcost instead

unitCostintegerOptional

The unit cost price in local currency

notestringOptional
Responses
200

Example response

application/json
put
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items/{receivementItemUid}
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items/{receivementItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "externalId": "text",
  "purchaseOrderItemUid": "text",
  "quantity": 1,
  "serialnumber": "text",
  "unitCost": 1,
  "note": "text"
}
200

Example response

{
  "createdAt": "2025-10-29T06:58:12.910Z",
  "createdBy": "text",
  "externalId": "text",
  "lastModifiedAt": "2025-10-29T06:58:12.910Z",
  "lastModifiedBy": "text",
  "product": {
    "productUid": "text",
    "name": "text",
    "sku": "text"
  },
  "purchaseOrderItemUid": "text",
  "quantity": 1,
  "unitCost": 1,
  "receivementItemUid": "text",
  "serialnumber": "text",
  "status": "text",
  "note": "text",
  "tenantUserUid": "text",
  "tenantUserDisplayName": "text"
}
delete
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items/{receivementItemUid}

Remove an item from a receivement. Only possible if the item does not have UPDATING or RECEIVED status.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
receivementUidstringRequired

Reference to a receivement of a purchase order.

Pattern: ^[A-Za-z0-9-_]+
receivementItemUidstringRequired

Reference to an item on a specific receivement.

Pattern: ^[A-Za-z0-9-_]+
Responses
204

No Content

No content
delete
/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items/{receivementItemUid}
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/receivements/{receivementUid}/items/{receivementItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content
PreviousReceiptNextReports

Was this helpful?