Create a new receivement

Create a new receivement.

Required permissions: RECEIVEMENT

post

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

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

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

packingListstringOptional

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

statusstring · enumRequired

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

Possible values:

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

expectedArrivalstring · date-timeOptional

expectedDispatchstring · date-timeOptional

supplierOrderReferencestringOptional

Responses

200

Example response

application/json

createdAtstring · date-timeRequired

createdBystringRequired

externalIdstringRequired

External reference to receivment

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

packingListstringRequired

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

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

statusstring · enumRequired

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

Possible values:

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

expectedArrivalstring · date-timeRequired

ETA

expectedDispatchstring · date-timeRequired

ETD

supplierOrderReferencestringRequired

receivedAtstring · date-time · nullableRequired

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: 468

{
  "receivementUid": "text",
  "externalId": "text",
  "items": [
    {
      "externalId": "text",
      "purchaseOrderItemUid": "text",
      "quantity": 1,
      "serialnumber": "text",
      "unitCost": 1,
      "note": "text",
      "reservations": [
        {
          "orderUid": "text",
          "orderItemUid": "text"
        }
      ],
      "receivementItemUid": "text"
    }
  ],
  "packingList": "text",
  "purchaseOrderUid": "text",
  "status": "RECEIVED",
  "warehouseUid": "text",
  "expectedArrival": "2026-01-01T00:00:00.000Z",
  "expectedDispatch": "2026-01-01T00:00:00.000Z",
  "supplierOrderReference": "text"
}

200

Example response

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "externalId": "text",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "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",
      "reservations": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "quantity": 1,
          "reservationType": "NONE"
        }
      ]
    }
  ],
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text",
  "packingList": "text",
  "receivementUid": "text",
  "status": "RECEIVED",
  "expectedArrival": "2026-01-01T00:00:00.000Z",
  "expectedDispatch": "2026-01-01T00:00:00.000Z",
  "supplierOrderReference": "text",
  "receivedAt": "2026-01-01T00:00:00.000Z",
  "receivedBy": {
    "tenantUserUid": "text",
    "tenantUserDisplayName": "text"
  },
  "purchaseOrder": {
    "purchaseOrderUid": "text",
    "purchaseNumber": "text",
    "externalId": "text"
  },
  "supplier": {
    "supplierUid": "text",
    "name": "text"
  },
  "store": {
    "storeUid": "text",
    "name": "text"
  },
  "organization": {
    "organizationUid": "text",
    "name": "text"
  },
  "warehouse": {
    "warehouseUid": "text",
    "name": "text"
  },
  "invoiceApproval": {
    "approvedAt": "2026-01-01T00:00:00.000Z",
    "tenantUserUid": "text",
    "tenantUserDisplayName": "text"
  }
}