Receivement

PreviousReceipt NextReports

Was this helpful?

Download PDF of receivement receipt

get

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

objectoptional

get

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

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

Available options:

Responses

application/json

objectoptional

get

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-04-18T01:45:26.391Z",
      "createdBy": "text",
      "externalId": "text",
      "items": [
        {
          "createdAt": "2025-04-18T01:45:26.391Z",
          "createdBy": "text",
          "externalId": "text",
          "lastModifiedAt": "2025-04-18T01:45:26.391Z",
          "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-04-18T01:45:26.391Z",
      "lastModifiedBy": "text",
      "packingList": "text",
      "purchaseOrderUid": "text",
      "receivementUid": "text",
      "status": "RECEIVED",
      "warehouseUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get receivement details

get

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

application/json

objectoptional

get

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-04-18T01:45:26.391Z",
  "createdBy": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2025-04-18T01:45:26.391Z",
      "createdBy": "text",
      "externalId": "text",
      "lastModifiedAt": "2025-04-18T01:45:26.391Z",
      "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-04-18T01:45:26.391Z",
  "lastModifiedBy": "text",
  "packingList": "text",
  "purchaseOrderUid": "text",
  "receivementUid": "text",
  "status": "RECEIVED",
  "warehouseUid": "text"
}

Delete a receivement

delete

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

delete

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

204

No Content

List receivement items

get

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

Available options:

Responses

application/json

objectoptional

get

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-04-18T01:45:26.391Z",
      "createdBy": "text",
      "externalId": "text",
      "lastModifiedAt": "2025-04-18T01:45:26.391Z",
      "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
  }
}

Get receivement item details

get

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

application/json

objectoptional

get

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-04-18T01:45:26.391Z",
  "createdBy": "text",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:45:26.391Z",
  "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

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

delete

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

Deprecated

Print or send receivement receipt

post

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

attachmentsobject[]optional

Responses

objectoptional

post

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

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

attachmentsobject[]optional

Responses

objectoptional

post

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"
}

Create a new receivement

post

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

packingListstringoptional

purchaseOrderUidstringrequiredPattern: ^[A-Za-z0-9-_]+

statusstring · enumrequired

ENUM	Description
RECEIVED	Received
PENDING	Put aside, not finished
UPDATING	Updating in progress

Available options:

warehouseUidstringrequiredPattern: ^[A-Za-z0-9-_]+

Responses

application/json

objectoptional

post

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-04-18T01:45:26.391Z",
  "createdBy": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2025-04-18T01:45:26.391Z",
      "createdBy": "text",
      "externalId": "text",
      "lastModifiedAt": "2025-04-18T01:45:26.391Z",
      "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-04-18T01:45:26.391Z",
  "lastModifiedBy": "text",
  "packingList": "text",
  "purchaseOrderUid": "text",
  "receivementUid": "text",
  "status": "RECEIVED",
  "warehouseUid": "text"
}

Update receivement details

put

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

Available options:

Responses

application/json

objectoptional

put

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-04-18T01:45:26.391Z",
  "createdBy": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2025-04-18T01:45:26.391Z",
      "createdBy": "text",
      "externalId": "text",
      "lastModifiedAt": "2025-04-18T01:45:26.391Z",
      "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-04-18T01:45:26.391Z",
  "lastModifiedBy": "text",
  "packingList": "text",
  "purchaseOrderUid": "text",
  "receivementUid": "text",
  "status": "RECEIVED",
  "warehouseUid": "text"
}

Add an item to a receivement

post

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

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.

Responses

application/json

objectoptional

post

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-04-18T01:45:26.391Z",
  "createdBy": "text",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:45:26.391Z",
  "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

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

application/json

objectoptional

put

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-04-18T01:45:26.391Z",
  "createdBy": "text",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:45:26.391Z",
  "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"
}