Purchase

List purchase orders

get

/tenants/{tenantUid}/stores/{storeUid}/purchase-orders

Lists all purchase orders.

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

purchaseOrderExternalIdstringOptional

External reference to a purchaseOrderUid.

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

get/tenants/{tenantUid}/stores/{storeUid}/purchase-orders

GET /v2/tenants/{tenantUid}/stores/{storeUid}/purchase-orders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "deliveryAddress": "text",
      "deliveryCity": "text",
      "deliveryCountryCode": "text",
      "deliveryName": "text",
      "deliveryPostalCode": "text",
      "externalId": "text",
      "items": [
        {
          "createdAt": "2026-01-01T00:00:00.000Z",
          "createdBy": "text",
          "expectedDeliveryDate": "2026-01-01",
          "externalId": "text",
          "lastModifiedAt": "2026-01-01T00:00:00.000Z",
          "lastModifiedBy": "text",
          "productUid": "text",
          "productName": "text",
          "productSerialNoRequired": "NO",
          "productSku": "text",
          "purchaseOrderItemUid": "text",
          "quantityOrdered": 1,
          "quantityReceived": 1,
          "quantityReserved": 1,
          "supplierSku": "text",
          "unitPrice": 1,
          "receivementItems": [
            {
              "receivementUid": "text",
              "receivementStatus": "RECEIVED",
              "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"
                }
              ]
            }
          ],
          "discountAmount": 1,
          "freightAmount": 1,
          "unitCost": 1,
          "totalLinePrice": 1,
          "localCurrency": {
            "unitPrice": 1,
            "discountAmount": 1,
            "freightAmount": 1,
            "unitCost": 1,
            "totalLinePrice": 1
          },
          "reservations": [
            {
              "orderUid": "text",
              "orderItemUid": "text",
              "orderNumber": "text",
              "quantity": 1,
              "reservationType": "NONE"
            }
          ],
          "note": "text",
          "sortOrder": 1,
          "purchaseOrderItemLinks": [
            {
              "purchaseOrderItemUid": "text",
              "type": "PACKAGE"
            }
          ]
        }
      ],
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text",
      "note": "text",
      "purchaseNumber": "text",
      "purchaseOrderUid": "text",
      "status": "NEW",
      "storeUid": "text",
      "storeName": "text",
      "supplierUid": "text",
      "supplierName": "text",
      "discountRate": 1,
      "freight": 1,
      "currency": {
        "code": "text",
        "exchangeRate": 1
      },
      "supplierReferenceNumber": "text",
      "invoiceAddress": {
        "companyName": "text",
        "address": "text",
        "postalCode": "text",
        "city": "text",
        "countryCode": "text",
        "vatNumber": "text",
        "email": "text"
      },
      "reserveAfter": "2026-01-01T00:00:00.000Z",
      "hasConfirmedReceivements": true
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new purchase order

post

/tenants/{tenantUid}/stores/{storeUid}/purchase-orders

Specify a currency when the order is not in local currency. The currency must exist in your foreign currencies. If you leave exchangeRate empty, the exchange rate that is on the foreign currency will be used.

Required permissions: PURCHASE_ORDER

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

deliveryAddressstringOptional

deliveryCitystringOptional

deliveryCountryCodestringOptional

deliveryNamestringOptional

deliveryPostalCodestringOptional

externalIdstringOptional

notestringOptional

statusstring · enumOptional

ENUM	Description
NEW	Created, but not sent to supplier yet.
SENT_TO_SUPPLIER	Sent to supplier.
CANCELLED_BY_SUPPLIER	The purchase order have been cancelled by the supplier. This status is only applicable for suppliers who are integrated with FlowRetail.
IN_TRANSIT	The goods are in transit. This status is only applicable for suppliers who are integrated with FlowRetail.
PARTIALLY_RECEIVED	Not all goods have been received yet.
RECEIVED	All goods have been received.
CLOSED	No longer able to process purchase order.
CANCELLED_BY_SUPPLIER	Purchase was cancelled by supplier

Possible values:

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

discountRateintegerOptional

freightintegerOptional

currencystringOptional

ISO 4217 code

exchangeRateintegerOptional

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

supplierReferenceNumberstringOptional

reserveAfterstring · date-timeOptional

If set, items in this purchase order cannot be reserved before this date.

Responses

200

Example response

application/json

createdAtstring · date-timeRequired

createdBystringRequired

deliveryAddressstringRequired

deliveryCitystringRequired

deliveryCountryCodestringRequired

deliveryNamestringRequired

deliveryPostalCodestringRequired

externalIdstringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

notestringRequired

purchaseNumberstringRequired

Reference to a customer order

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

statusstring · enumRequired

ENUM	Description
NEW	Created, but not sent to supplier yet.
SENT_TO_SUPPLIER	Sent to supplier.
CANCELLED_BY_SUPPLIER	The purchase order have been cancelled by the supplier. This status is only applicable for suppliers who are integrated with FlowRetail.
IN_TRANSIT	The goods are in transit. This status is only applicable for suppliers who are integrated with FlowRetail.
PARTIALLY_RECEIVED	Not all goods have been received yet.
RECEIVED	All goods have been received.
CLOSED	No longer able to process purchase order.
CANCELLED_BY_SUPPLIER	Purchase was cancelled by supplier

Possible values:

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

storeNamestringRequired

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

supplierNamestringRequired

discountRateintegerRequired

freightintegerRequired

supplierReferenceNumberstringRequired

Supplier reference number

reserveAfterstring · date-time · nullableRequired

If set, items in this purchase order cannot be reserved before this date.

hasConfirmedReceivementsbooleanRequired

post/tenants/{tenantUid}/stores/{storeUid}/purchase-orders

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

{
  "deliveryAddress": "text",
  "deliveryCity": "text",
  "deliveryCountryCode": "text",
  "deliveryName": "text",
  "deliveryPostalCode": "text",
  "externalId": "text",
  "note": "text",
  "status": "NEW",
  "supplierUid": "text",
  "discountRate": 1,
  "freight": 1,
  "currency": "text",
  "exchangeRate": 1,
  "purchaseOrderUid": "text",
  "items": [
    {
      "expectedDeliveryDate": "2026-01-01",
      "externalId": "text",
      "productUid": "text",
      "quantityOrdered": 1,
      "supplierSku": "text",
      "unitPrice": 1,
      "note": "text",
      "sortOrder": 1,
      "purchaseOrderItemUid": "text"
    }
  ],
  "autoOrderProposal": {
    "warehouseUid": "text",
    "countReservedItems": true,
    "honorTradeUnits": true
  },
  "supplierReferenceNumber": "text",
  "invoiceAddress": {
    "companyName": "text",
    "address": "text",
    "postalCode": "text",
    "city": "text",
    "countryCode": "text",
    "vatNumber": "text",
    "email": "text"
  },
  "reserveAfter": "2026-01-01T00:00:00.000Z"
}

200

Example response

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "deliveryAddress": "text",
  "deliveryCity": "text",
  "deliveryCountryCode": "text",
  "deliveryName": "text",
  "deliveryPostalCode": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "expectedDeliveryDate": "2026-01-01",
      "externalId": "text",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text",
      "productUid": "text",
      "productName": "text",
      "productSerialNoRequired": "NO",
      "productSku": "text",
      "purchaseOrderItemUid": "text",
      "quantityOrdered": 1,
      "quantityReceived": 1,
      "quantityReserved": 1,
      "supplierSku": "text",
      "unitPrice": 1,
      "receivementItems": [
        {
          "receivementUid": "text",
          "receivementStatus": "RECEIVED",
          "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"
            }
          ]
        }
      ],
      "discountAmount": 1,
      "freightAmount": 1,
      "unitCost": 1,
      "totalLinePrice": 1,
      "localCurrency": {
        "unitPrice": 1,
        "discountAmount": 1,
        "freightAmount": 1,
        "unitCost": 1,
        "totalLinePrice": 1
      },
      "reservations": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "quantity": 1,
          "reservationType": "NONE"
        }
      ],
      "note": "text",
      "sortOrder": 1,
      "purchaseOrderItemLinks": [
        {
          "purchaseOrderItemUid": "text",
          "type": "PACKAGE"
        }
      ]
    }
  ],
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text",
  "note": "text",
  "purchaseNumber": "text",
  "purchaseOrderUid": "text",
  "status": "NEW",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "discountRate": 1,
  "freight": 1,
  "currency": {
    "code": "text",
    "exchangeRate": 1
  },
  "supplierReferenceNumber": "text",
  "invoiceAddress": {
    "companyName": "text",
    "address": "text",
    "postalCode": "text",
    "city": "text",
    "countryCode": "text",
    "vatNumber": "text",
    "email": "text"
  },
  "reserveAfter": "2026-01-01T00:00:00.000Z",
  "hasConfirmedReceivements": true
}

Get purchase order details

get

/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}

Get details for a purchase order.

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

purchaseOrderUidstringRequired

Reference to a PurchaseOrder.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

200

Example response

application/json

createdAtstring · date-timeRequired

createdBystringRequired

deliveryAddressstringRequired

deliveryCitystringRequired

deliveryCountryCodestringRequired

deliveryNamestringRequired

deliveryPostalCodestringRequired

externalIdstringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

notestringRequired

purchaseNumberstringRequired

Reference to a customer order

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

statusstring · enumRequired

ENUM	Description
NEW	Created, but not sent to supplier yet.
SENT_TO_SUPPLIER	Sent to supplier.
CANCELLED_BY_SUPPLIER	The purchase order have been cancelled by the supplier. This status is only applicable for suppliers who are integrated with FlowRetail.
IN_TRANSIT	The goods are in transit. This status is only applicable for suppliers who are integrated with FlowRetail.
PARTIALLY_RECEIVED	Not all goods have been received yet.
RECEIVED	All goods have been received.
CLOSED	No longer able to process purchase order.
CANCELLED_BY_SUPPLIER	Purchase was cancelled by supplier

Possible values:

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

storeNamestringRequired

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

supplierNamestringRequired

discountRateintegerRequired

freightintegerRequired

supplierReferenceNumberstringRequired

Supplier reference number

reserveAfterstring · date-time · nullableRequired

If set, items in this purchase order cannot be reserved before this date.

hasConfirmedReceivementsbooleanRequired

get/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}

GET /v2/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "deliveryAddress": "text",
  "deliveryCity": "text",
  "deliveryCountryCode": "text",
  "deliveryName": "text",
  "deliveryPostalCode": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "expectedDeliveryDate": "2026-01-01",
      "externalId": "text",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text",
      "productUid": "text",
      "productName": "text",
      "productSerialNoRequired": "NO",
      "productSku": "text",
      "purchaseOrderItemUid": "text",
      "quantityOrdered": 1,
      "quantityReceived": 1,
      "quantityReserved": 1,
      "supplierSku": "text",
      "unitPrice": 1,
      "receivementItems": [
        {
          "receivementUid": "text",
          "receivementStatus": "RECEIVED",
          "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"
            }
          ]
        }
      ],
      "discountAmount": 1,
      "freightAmount": 1,
      "unitCost": 1,
      "totalLinePrice": 1,
      "localCurrency": {
        "unitPrice": 1,
        "discountAmount": 1,
        "freightAmount": 1,
        "unitCost": 1,
        "totalLinePrice": 1
      },
      "reservations": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "quantity": 1,
          "reservationType": "NONE"
        }
      ],
      "note": "text",
      "sortOrder": 1,
      "purchaseOrderItemLinks": [
        {
          "purchaseOrderItemUid": "text",
          "type": "PACKAGE"
        }
      ]
    }
  ],
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text",
  "note": "text",
  "purchaseNumber": "text",
  "purchaseOrderUid": "text",
  "status": "NEW",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "discountRate": 1,
  "freight": 1,
  "currency": {
    "code": "text",
    "exchangeRate": 1
  },
  "supplierReferenceNumber": "text",
  "invoiceAddress": {
    "companyName": "text",
    "address": "text",
    "postalCode": "text",
    "city": "text",
    "countryCode": "text",
    "vatNumber": "text",
    "email": "text"
  },
  "reserveAfter": "2026-01-01T00:00:00.000Z",
  "hasConfirmedReceivements": true
}

Update purchase order details

put

/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}

Required permissions: PURCHASE_ORDER

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

purchaseOrderUidstringRequired

Reference to a PurchaseOrder.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

deliveryAddressstringOptional

deliveryCitystringOptional

deliveryCountryCodestringOptional

deliveryNamestringOptional

deliveryPostalCodestringOptional

externalIdstringOptional

notestringOptional

statusstring · enumOptional

ENUM	Description
NEW	Created, but not sent to supplier yet.
SENT_TO_SUPPLIER	Sent to supplier.
CANCELLED_BY_SUPPLIER	The purchase order have been cancelled by the supplier. This status is only applicable for suppliers who are integrated with FlowRetail.
IN_TRANSIT	The goods are in transit. This status is only applicable for suppliers who are integrated with FlowRetail.
PARTIALLY_RECEIVED	Not all goods have been received yet.
RECEIVED	All goods have been received.
CLOSED	No longer able to process purchase order.
CANCELLED_BY_SUPPLIER	Purchase was cancelled by supplier

Possible values:

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

discountRateintegerOptional

freightintegerOptional

currencystringOptional

ISO 4217 code

exchangeRateintegerOptional

supplierReferenceNumberstringOptional

Supplier reference number

reserveAfterstring · date-time · nullableOptional

If set, items in this purchase order cannot be reserved before this date.

Responses

200

Example response

application/json

createdAtstring · date-timeRequired

createdBystringRequired

deliveryAddressstringRequired

deliveryCitystringRequired

deliveryCountryCodestringRequired

deliveryNamestringRequired

deliveryPostalCodestringRequired

externalIdstringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

notestringRequired

purchaseNumberstringRequired

Reference to a customer order

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

statusstring · enumRequired

ENUM	Description
NEW	Created, but not sent to supplier yet.
SENT_TO_SUPPLIER	Sent to supplier.
CANCELLED_BY_SUPPLIER	The purchase order have been cancelled by the supplier. This status is only applicable for suppliers who are integrated with FlowRetail.
IN_TRANSIT	The goods are in transit. This status is only applicable for suppliers who are integrated with FlowRetail.
PARTIALLY_RECEIVED	Not all goods have been received yet.
RECEIVED	All goods have been received.
CLOSED	No longer able to process purchase order.
CANCELLED_BY_SUPPLIER	Purchase was cancelled by supplier

Possible values:

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

storeNamestringRequired

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

supplierNamestringRequired

discountRateintegerRequired

freightintegerRequired

supplierReferenceNumberstringRequired

Supplier reference number

reserveAfterstring · date-time · nullableRequired

If set, items in this purchase order cannot be reserved before this date.

hasConfirmedReceivementsbooleanRequired

put/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 595

{
  "deliveryAddress": "text",
  "deliveryCity": "text",
  "deliveryCountryCode": "text",
  "deliveryName": "text",
  "deliveryPostalCode": "text",
  "externalId": "text",
  "note": "text",
  "status": "NEW",
  "supplierUid": "text",
  "discountRate": 1,
  "freight": 1,
  "currency": "text",
  "exchangeRate": 1,
  "items": [
    {
      "purchaseOrderItemUid": "text",
      "quantityReceived": 1,
      "expectedDeliveryDate": "2026-01-01",
      "unitPrice": 1
    }
  ],
  "supplierReferenceNumber": "text",
  "invoiceAddress": {
    "companyName": "text",
    "address": "text",
    "postalCode": "text",
    "city": "text",
    "countryCode": "text",
    "vatNumber": "text",
    "email": "text"
  },
  "reserveAfter": "2026-01-01T00:00:00.000Z"
}

200

Example response

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "deliveryAddress": "text",
  "deliveryCity": "text",
  "deliveryCountryCode": "text",
  "deliveryName": "text",
  "deliveryPostalCode": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "expectedDeliveryDate": "2026-01-01",
      "externalId": "text",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text",
      "productUid": "text",
      "productName": "text",
      "productSerialNoRequired": "NO",
      "productSku": "text",
      "purchaseOrderItemUid": "text",
      "quantityOrdered": 1,
      "quantityReceived": 1,
      "quantityReserved": 1,
      "supplierSku": "text",
      "unitPrice": 1,
      "receivementItems": [
        {
          "receivementUid": "text",
          "receivementStatus": "RECEIVED",
          "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"
            }
          ]
        }
      ],
      "discountAmount": 1,
      "freightAmount": 1,
      "unitCost": 1,
      "totalLinePrice": 1,
      "localCurrency": {
        "unitPrice": 1,
        "discountAmount": 1,
        "freightAmount": 1,
        "unitCost": 1,
        "totalLinePrice": 1
      },
      "reservations": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "quantity": 1,
          "reservationType": "NONE"
        }
      ],
      "note": "text",
      "sortOrder": 1,
      "purchaseOrderItemLinks": [
        {
          "purchaseOrderItemUid": "text",
          "type": "PACKAGE"
        }
      ]
    }
  ],
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text",
  "note": "text",
  "purchaseNumber": "text",
  "purchaseOrderUid": "text",
  "status": "NEW",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "discountRate": 1,
  "freight": 1,
  "currency": {
    "code": "text",
    "exchangeRate": 1
  },
  "supplierReferenceNumber": "text",
  "invoiceAddress": {
    "companyName": "text",
    "address": "text",
    "postalCode": "text",
    "city": "text",
    "countryCode": "text",
    "vatNumber": "text",
    "email": "text"
  },
  "reserveAfter": "2026-01-01T00:00:00.000Z",
  "hasConfirmedReceivements": true
}

Delete a purchase order

delete

/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}

Deletes a purchase order.

Required permissions: PURCHASE_ORDER

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

purchaseOrderUidstringRequired

Reference to a PurchaseOrder.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

204

No Content

No content

delete/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

List purchase order items

get

/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items

Lists all items on a purchase order.

Required permissions: PURCHASE_ORDER

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

purchaseOrderUidstringRequired

Reference to a PurchaseOrder.

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

tenantUidstringRequired

Reference to a tenant.

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}/purchase-orders/{purchaseOrderUid}/purchase-order-items

GET /v2/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "expectedDeliveryDate": "2026-01-01",
      "externalId": "text",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text",
      "productUid": "text",
      "productName": "text",
      "productSerialNoRequired": "NO",
      "productSku": "text",
      "purchaseOrderItemUid": "text",
      "quantityOrdered": 1,
      "quantityReceived": 1,
      "quantityReserved": 1,
      "supplierSku": "text",
      "unitPrice": 1,
      "receivementItems": [
        {
          "receivementUid": "text",
          "receivementStatus": "RECEIVED",
          "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"
            }
          ]
        }
      ],
      "discountAmount": 1,
      "freightAmount": 1,
      "unitCost": 1,
      "totalLinePrice": 1,
      "localCurrency": {
        "unitPrice": 1,
        "discountAmount": 1,
        "freightAmount": 1,
        "unitCost": 1,
        "totalLinePrice": 1
      },
      "reservations": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "quantity": 1,
          "reservationType": "NONE"
        }
      ],
      "note": "text",
      "sortOrder": 1,
      "purchaseOrderItemLinks": [
        {
          "purchaseOrderItemUid": "text",
          "type": "PACKAGE"
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add a purchase order item

post

/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items

Adds an item to a purchase order.

Required permissions: PURCHASE_ORDER

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

purchaseOrderUidstringRequired

Reference to a PurchaseOrder.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

expectedDeliveryDatestring · dateOptional

externalIdstringOptional

External reference to purchase order line

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

quantityOrderedintegerRequired

supplierSkustringOptional

unitPriceintegerOptional

unitPrice is in purchase order currency

notestringOptional

sortOrderintegerOptional

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

Responses

200

Example response

application/json

createdAtstring · date-timeRequired

createdBystringRequired

deliveryAddressstringRequired

deliveryCitystringRequired

deliveryCountryCodestringRequired

deliveryNamestringRequired

deliveryPostalCodestringRequired

externalIdstringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

notestringRequired

purchaseNumberstringRequired

Reference to a customer order

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

statusstring · enumRequired

ENUM	Description
NEW	Created, but not sent to supplier yet.
SENT_TO_SUPPLIER	Sent to supplier.
CANCELLED_BY_SUPPLIER	The purchase order have been cancelled by the supplier. This status is only applicable for suppliers who are integrated with FlowRetail.
IN_TRANSIT	The goods are in transit. This status is only applicable for suppliers who are integrated with FlowRetail.
PARTIALLY_RECEIVED	Not all goods have been received yet.
RECEIVED	All goods have been received.
CLOSED	No longer able to process purchase order.
CANCELLED_BY_SUPPLIER	Purchase was cancelled by supplier

Possible values:

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

storeNamestringRequired

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

supplierNamestringRequired

discountRateintegerRequired

freightintegerRequired

supplierReferenceNumberstringRequired

Supplier reference number

reserveAfterstring · date-time · nullableRequired

If set, items in this purchase order cannot be reserved before this date.

hasConfirmedReceivementsbooleanRequired

post/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items

POST /v2/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "expectedDeliveryDate": "2026-01-01",
  "externalId": "text",
  "productUid": "text",
  "quantityOrdered": 1,
  "supplierSku": "text",
  "unitPrice": 1,
  "note": "text",
  "sortOrder": 1,
  "purchaseOrderItemUid": "text"
}

200

Example response

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "deliveryAddress": "text",
  "deliveryCity": "text",
  "deliveryCountryCode": "text",
  "deliveryName": "text",
  "deliveryPostalCode": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "expectedDeliveryDate": "2026-01-01",
      "externalId": "text",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text",
      "productUid": "text",
      "productName": "text",
      "productSerialNoRequired": "NO",
      "productSku": "text",
      "purchaseOrderItemUid": "text",
      "quantityOrdered": 1,
      "quantityReceived": 1,
      "quantityReserved": 1,
      "supplierSku": "text",
      "unitPrice": 1,
      "receivementItems": [
        {
          "receivementUid": "text",
          "receivementStatus": "RECEIVED",
          "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"
            }
          ]
        }
      ],
      "discountAmount": 1,
      "freightAmount": 1,
      "unitCost": 1,
      "totalLinePrice": 1,
      "localCurrency": {
        "unitPrice": 1,
        "discountAmount": 1,
        "freightAmount": 1,
        "unitCost": 1,
        "totalLinePrice": 1
      },
      "reservations": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "quantity": 1,
          "reservationType": "NONE"
        }
      ],
      "note": "text",
      "sortOrder": 1,
      "purchaseOrderItemLinks": [
        {
          "purchaseOrderItemUid": "text",
          "type": "PACKAGE"
        }
      ]
    }
  ],
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text",
  "note": "text",
  "purchaseNumber": "text",
  "purchaseOrderUid": "text",
  "status": "NEW",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "discountRate": 1,
  "freight": 1,
  "currency": {
    "code": "text",
    "exchangeRate": 1
  },
  "supplierReferenceNumber": "text",
  "invoiceAddress": {
    "companyName": "text",
    "address": "text",
    "postalCode": "text",
    "city": "text",
    "countryCode": "text",
    "vatNumber": "text",
    "email": "text"
  },
  "reserveAfter": "2026-01-01T00:00:00.000Z",
  "hasConfirmedReceivements": true
}

Get purchase order item details

get

/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items/{purchaseOrderItemUid}

Get details for an item on a purchase order.

Required permissions: PURCHASE_ORDER

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

purchaseOrderUidstringRequired

Reference to a PurchaseOrder.

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

purchaseOrderItemUidstringRequired

Reference to an item on a purchase order

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

200

Example response

application/json

createdAtstring · date-timeRequired

createdBystringRequired

expectedDeliveryDatestring · dateRequired

externalIdstringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

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

productNamestringRequired

productSerialNoRequiredstring · enumRequired

ENUM	Description
NO	No Serial number required
ON_SALE	Can register serial number when selling a product (Serial number is optional)
ON_RECEIVE	Must register serial number when receiving and selling product (Serial number is required)

Possible values:

productSkustringRequired

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

quantityOrderedintegerRequired

quantityReceivedintegerRequired

quantityReservedintegerRequired

supplierSkustringRequired

unitPriceintegerRequired

unitPrice is in purchase price in order currency before discounts

discountAmountintegerRequired

The discount amount pr unit

freightAmountintegerRequired

The portion of the shipping cost pr unit.

unitCostintegerRequired

The price pr unit including discount and freight. This is what will be used as cost price during receivement.

totalLinePriceintegerRequired

Total price for all the items including discounts and freight amount.

notestringRequired

sortOrderintegerRequired

get/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items/{purchaseOrderItemUid}

GET /v2/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items/{purchaseOrderItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "expectedDeliveryDate": "2026-01-01",
  "externalId": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text",
  "productUid": "text",
  "productName": "text",
  "productSerialNoRequired": "NO",
  "productSku": "text",
  "purchaseOrderItemUid": "text",
  "quantityOrdered": 1,
  "quantityReceived": 1,
  "quantityReserved": 1,
  "supplierSku": "text",
  "unitPrice": 1,
  "receivementItems": [
    {
      "receivementUid": "text",
      "receivementStatus": "RECEIVED",
      "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"
        }
      ]
    }
  ],
  "discountAmount": 1,
  "freightAmount": 1,
  "unitCost": 1,
  "totalLinePrice": 1,
  "localCurrency": {
    "unitPrice": 1,
    "discountAmount": 1,
    "freightAmount": 1,
    "unitCost": 1,
    "totalLinePrice": 1
  },
  "reservations": [
    {
      "orderUid": "text",
      "orderItemUid": "text",
      "orderNumber": "text",
      "quantity": 1,
      "reservationType": "NONE"
    }
  ],
  "note": "text",
  "sortOrder": 1,
  "purchaseOrderItemLinks": [
    {
      "purchaseOrderItemUid": "text",
      "type": "PACKAGE"
    }
  ]
}

Update purchase order item details

put

/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items/{purchaseOrderItemUid}

Update details for an item on a purchase order.

Required permissions: PURCHASE_ORDER

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

purchaseOrderUidstringRequired

Reference to a PurchaseOrder.

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

purchaseOrderItemUidstringRequired

Reference to an item on a purchase order

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

tenantUidstringRequired

Reference to a tenant.

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

Body

expectedDeliveryDatestring · dateOptional

externalIdstringOptional

External reference to purchase order line

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

quantityOrderedintegerOptional

supplierSkustringOptional

unitPriceintegerOptional

unitPrice is in purchase order currency

notestringOptional

sortOrderintegerOptional

Responses

200

Example response

application/json

createdAtstring · date-timeRequired

createdBystringRequired

deliveryAddressstringRequired

deliveryCitystringRequired

deliveryCountryCodestringRequired

deliveryNamestringRequired

deliveryPostalCodestringRequired

externalIdstringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

notestringRequired

purchaseNumberstringRequired

Reference to a customer order

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

statusstring · enumRequired

ENUM	Description
NEW	Created, but not sent to supplier yet.
SENT_TO_SUPPLIER	Sent to supplier.
CANCELLED_BY_SUPPLIER	The purchase order have been cancelled by the supplier. This status is only applicable for suppliers who are integrated with FlowRetail.
IN_TRANSIT	The goods are in transit. This status is only applicable for suppliers who are integrated with FlowRetail.
PARTIALLY_RECEIVED	Not all goods have been received yet.
RECEIVED	All goods have been received.
CLOSED	No longer able to process purchase order.
CANCELLED_BY_SUPPLIER	Purchase was cancelled by supplier

Possible values:

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

storeNamestringRequired

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

supplierNamestringRequired

discountRateintegerRequired

freightintegerRequired

supplierReferenceNumberstringRequired

Supplier reference number

reserveAfterstring · date-time · nullableRequired

If set, items in this purchase order cannot be reserved before this date.

hasConfirmedReceivementsbooleanRequired

put/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items/{purchaseOrderItemUid}

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items/{purchaseOrderItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "expectedDeliveryDate": "2026-01-01",
  "externalId": "text",
  "productUid": "text",
  "quantityOrdered": 1,
  "supplierSku": "text",
  "unitPrice": 1,
  "note": "text",
  "sortOrder": 1
}

200

Example response

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "deliveryAddress": "text",
  "deliveryCity": "text",
  "deliveryCountryCode": "text",
  "deliveryName": "text",
  "deliveryPostalCode": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "expectedDeliveryDate": "2026-01-01",
      "externalId": "text",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text",
      "productUid": "text",
      "productName": "text",
      "productSerialNoRequired": "NO",
      "productSku": "text",
      "purchaseOrderItemUid": "text",
      "quantityOrdered": 1,
      "quantityReceived": 1,
      "quantityReserved": 1,
      "supplierSku": "text",
      "unitPrice": 1,
      "receivementItems": [
        {
          "receivementUid": "text",
          "receivementStatus": "RECEIVED",
          "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"
            }
          ]
        }
      ],
      "discountAmount": 1,
      "freightAmount": 1,
      "unitCost": 1,
      "totalLinePrice": 1,
      "localCurrency": {
        "unitPrice": 1,
        "discountAmount": 1,
        "freightAmount": 1,
        "unitCost": 1,
        "totalLinePrice": 1
      },
      "reservations": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "quantity": 1,
          "reservationType": "NONE"
        }
      ],
      "note": "text",
      "sortOrder": 1,
      "purchaseOrderItemLinks": [
        {
          "purchaseOrderItemUid": "text",
          "type": "PACKAGE"
        }
      ]
    }
  ],
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text",
  "note": "text",
  "purchaseNumber": "text",
  "purchaseOrderUid": "text",
  "status": "NEW",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "discountRate": 1,
  "freight": 1,
  "currency": {
    "code": "text",
    "exchangeRate": 1
  },
  "supplierReferenceNumber": "text",
  "invoiceAddress": {
    "companyName": "text",
    "address": "text",
    "postalCode": "text",
    "city": "text",
    "countryCode": "text",
    "vatNumber": "text",
    "email": "text"
  },
  "reserveAfter": "2026-01-01T00:00:00.000Z",
  "hasConfirmedReceivements": true
}

Remove a purchase order item

delete

/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items/{purchaseOrderItemUid}

Removes an item from a purchase order.

Required permissions: PURCHASE_ORDER

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

purchaseOrderUidstringRequired

Reference to a PurchaseOrder.

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

purchaseOrderItemUidstringRequired

Reference to an item on a purchase order

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

200

Example response

application/json

createdAtstring · date-timeRequired

createdBystringRequired

deliveryAddressstringRequired

deliveryCitystringRequired

deliveryCountryCodestringRequired

deliveryNamestringRequired

deliveryPostalCodestringRequired

externalIdstringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

notestringRequired

purchaseNumberstringRequired

Reference to a customer order

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

statusstring · enumRequired

ENUM	Description
NEW	Created, but not sent to supplier yet.
SENT_TO_SUPPLIER	Sent to supplier.
CANCELLED_BY_SUPPLIER	The purchase order have been cancelled by the supplier. This status is only applicable for suppliers who are integrated with FlowRetail.
IN_TRANSIT	The goods are in transit. This status is only applicable for suppliers who are integrated with FlowRetail.
PARTIALLY_RECEIVED	Not all goods have been received yet.
RECEIVED	All goods have been received.
CLOSED	No longer able to process purchase order.
CANCELLED_BY_SUPPLIER	Purchase was cancelled by supplier

Possible values:

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

storeNamestringRequired

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

supplierNamestringRequired

discountRateintegerRequired

freightintegerRequired

supplierReferenceNumberstringRequired

Supplier reference number

reserveAfterstring · date-time · nullableRequired

If set, items in this purchase order cannot be reserved before this date.

hasConfirmedReceivementsbooleanRequired

delete/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items/{purchaseOrderItemUid}

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/purchase-order-items/{purchaseOrderItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "deliveryAddress": "text",
  "deliveryCity": "text",
  "deliveryCountryCode": "text",
  "deliveryName": "text",
  "deliveryPostalCode": "text",
  "externalId": "text",
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "expectedDeliveryDate": "2026-01-01",
      "externalId": "text",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text",
      "productUid": "text",
      "productName": "text",
      "productSerialNoRequired": "NO",
      "productSku": "text",
      "purchaseOrderItemUid": "text",
      "quantityOrdered": 1,
      "quantityReceived": 1,
      "quantityReserved": 1,
      "supplierSku": "text",
      "unitPrice": 1,
      "receivementItems": [
        {
          "receivementUid": "text",
          "receivementStatus": "RECEIVED",
          "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"
            }
          ]
        }
      ],
      "discountAmount": 1,
      "freightAmount": 1,
      "unitCost": 1,
      "totalLinePrice": 1,
      "localCurrency": {
        "unitPrice": 1,
        "discountAmount": 1,
        "freightAmount": 1,
        "unitCost": 1,
        "totalLinePrice": 1
      },
      "reservations": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "quantity": 1,
          "reservationType": "NONE"
        }
      ],
      "note": "text",
      "sortOrder": 1,
      "purchaseOrderItemLinks": [
        {
          "purchaseOrderItemUid": "text",
          "type": "PACKAGE"
        }
      ]
    }
  ],
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text",
  "note": "text",
  "purchaseNumber": "text",
  "purchaseOrderUid": "text",
  "status": "NEW",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "discountRate": 1,
  "freight": 1,
  "currency": {
    "code": "text",
    "exchangeRate": 1
  },
  "supplierReferenceNumber": "text",
  "invoiceAddress": {
    "companyName": "text",
    "address": "text",
    "postalCode": "text",
    "city": "text",
    "countryCode": "text",
    "vatNumber": "text",
    "email": "text"
  },
  "reserveAfter": "2026-01-01T00:00:00.000Z",
  "hasConfirmedReceivements": true
}

Print or send receipt

post

/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/receipt

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

Required permissions: PURCHASE_ORDER

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

purchaseOrderUidstringRequired

Reference to a PurchaseOrder.

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

Body

emailstringRequired

recepientsstring[]Optional

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.

contentstringRequired

base64 encoded

contentTypestringRequired

mime type

filenamestringRequired

201

Created

400

Bad Request

post/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/receipt

POST /v2/tenants/{tenantUid}/stores/{storeUid}/purchase-orders/{purchaseOrderUid}/receipt HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 161

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

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

List supplier products for product

get

/tenants/{tenantUid}/products/{productUid}/suppliers

Lists all supplier products for a productUid. If the product has been linked to a tenant productUid then additional information will be added.

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

productUidstringRequired

Reference to a Product.

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}/products/{productUid}/suppliers

GET /v2/tenants/{tenantUid}/products/{productUid}/suppliers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "productUid": "text",
      "supplierUid": "text",
      "purchasePrice": 1,
      "supplierProductUid": "text",
      "supplierSku": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Search for purchase orders

post

/tenants/{tenantUid}/purchase-orders/search

Search for purchase orders

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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:

Body

Search for purchase orders in all stores on tenant.

An empty string will be ignored, and handeled as if the key did not exist in the payload.

Fuzzy search means that it will try to find words that contains the query string that is supplied. The search is case-insensitive. Example: If you search for "Ol" you will get "Olsen", "Olstad", "Bolset", "Ormebol", kolstad@example.com, etc ..

fromDateTimestring · date-timeOptional

toDateTimestring · date-timeOptional

storeUidsstring[]Optional

Reference to a list of storeUids

organizationUidsstring[]Optional

Reference to a list of organizationUids

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

querystringOptional

productUidsstring[]Optional

hasConfirmedReceivementsbooleanOptional

Responses

200

Example response

post/tenants/{tenantUid}/purchase-orders/search

POST /v2/tenants/{tenantUid}/purchase-orders/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "fromDateTime": "2026-01-01T00:00:00.000Z",
  "toDateTime": "2026-01-01T00:00:00.000Z",
  "orderStatuses": [
    "NEW"
  ],
  "storeUids": [
    "text"
  ],
  "organizationUids": [
    "text"
  ],
  "supplierUid": "text",
  "query": "text",
  "productUids": [
    "text"
  ],
  "hasConfirmedReceivements": true
}

200

Example response

{
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "deliveryAddress": "text",
      "deliveryCity": "text",
      "deliveryCountryCode": "text",
      "deliveryName": "text",
      "deliveryPostalCode": "text",
      "externalId": "text",
      "items": [
        {
          "createdAt": "2026-01-01T00:00:00.000Z",
          "createdBy": "text",
          "expectedDeliveryDate": "2026-01-01",
          "externalId": "text",
          "lastModifiedAt": "2026-01-01T00:00:00.000Z",
          "lastModifiedBy": "text",
          "productUid": "text",
          "productName": "text",
          "productSerialNoRequired": "NO",
          "productSku": "text",
          "purchaseOrderItemUid": "text",
          "quantityOrdered": 1,
          "quantityReceived": 1,
          "quantityReserved": 1,
          "supplierSku": "text",
          "unitPrice": 1,
          "receivementItems": [
            {
              "receivementUid": "text",
              "receivementStatus": "RECEIVED",
              "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"
                }
              ]
            }
          ],
          "discountAmount": 1,
          "freightAmount": 1,
          "unitCost": 1,
          "totalLinePrice": 1,
          "localCurrency": {
            "unitPrice": 1,
            "discountAmount": 1,
            "freightAmount": 1,
            "unitCost": 1,
            "totalLinePrice": 1
          },
          "reservations": [
            {
              "orderUid": "text",
              "orderItemUid": "text",
              "orderNumber": "text",
              "quantity": 1,
              "reservationType": "NONE"
            }
          ],
          "note": "text",
          "sortOrder": 1,
          "purchaseOrderItemLinks": [
            {
              "purchaseOrderItemUid": "text",
              "type": "PACKAGE"
            }
          ]
        }
      ],
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text",
      "note": "text",
      "purchaseNumber": "text",
      "purchaseOrderUid": "text",
      "status": "NEW",
      "storeUid": "text",
      "storeName": "text",
      "supplierUid": "text",
      "supplierName": "text",
      "discountRate": 1,
      "freight": 1,
      "currency": {
        "code": "text",
        "exchangeRate": 1
      },
      "supplierReferenceNumber": "text",
      "invoiceAddress": {
        "companyName": "text",
        "address": "text",
        "postalCode": "text",
        "city": "text",
        "countryCode": "text",
        "vatNumber": "text",
        "email": "text"
      },
      "reserveAfter": "2026-01-01T00:00:00.000Z",
      "hasConfirmedReceivements": true
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Search purchase requests

post

/tenants/{tenantUid}/purchase-orders/requests

List of products from orders where order item reservation type is REQUEST_PURCHASE_ORDERORDER. Optionally filter on organisation, store, supplier, and order state.

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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.

Body

organizationUidsstring[]Optional

storeUidsstring[]Optional

supplierUidsstring[]Optional

ENUM	Description
OPEN	Order is open and beeing edited by someone
PARKED	Order is parked
CANCELED	Order is canceled/deleted
COMPLETE	Order is complete
CONFIRMED	Order is confirmed

Responses

200

Example response

application/json

post/tenants/{tenantUid}/purchase-orders/requests

POST /v2/tenants/{tenantUid}/purchase-orders/requests HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "organizationUids": [
    "text"
  ],
  "storeUids": [
    "text"
  ],
  "supplierUids": [
    "text"
  ],
  "orderStates": [
    "OPEN"
  ]
}

200

Example response

{
  "items": [
    {
      "productUid": "text",
      "sku": "text",
      "productName": "text",
      "totalQuantityOrdered": 1,
      "oldestOrderCreatedAt": "2026-01-01T00:00:00.000Z",
      "suppliers": [
        {
          "supplierUid": "text",
          "name": "text"
        }
      ],
      "orders": [
        {
          "orderUid": "text",
          "orderNumber": "text",
          "orderState": "OPEN",
          "settleState": "NOT_STARTED",
          "customerDisplayName": "text",
          "storeUid": "text",
          "storeName": "text",
          "items": [
            {
              "orderItemUid": "text",
              "sortOrder": 1,
              "quantityOrdered": 1,
              "note": "text"
            }
          ],
          "createdAt": "2026-01-01T00:00:00.000Z"
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Search purchase requests

post

/tenants/{tenantUid}/purchase-orders/requests-by-orders

List of products from orders where order item reservation type is REQUEST_PURCHASE_ORDERORDER. Optionally filter on organisation, store, supplier, and order state.

The output is group by orders

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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.

Body

organizationUidsstring[]Optional

storeUidsstring[]Optional

supplierUidsstring[]Optional

ENUM	Description
OPEN	Order is open and beeing edited by someone
PARKED	Order is parked
CANCELED	Order is canceled/deleted
COMPLETE	Order is complete
CONFIRMED	Order is confirmed

Responses

200

Example response

application/json

post/tenants/{tenantUid}/purchase-orders/requests-by-orders

POST /v2/tenants/{tenantUid}/purchase-orders/requests-by-orders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "organizationUids": [
    "text"
  ],
  "storeUids": [
    "text"
  ],
  "supplierUids": [
    "text"
  ],
  "orderStates": [
    "OPEN"
  ]
}

200

Example response

{
  "items": [
    {
      "orderUid": "text",
      "orderNumber": "text",
      "orderState": "OPEN",
      "settleState": "NOT_STARTED",
      "customerDisplayName": "text",
      "storeUid": "text",
      "storeName": "text",
      "items": [
        {
          "orderItemUid": "text",
          "sortOrder": 1,
          "quantityOrdered": 1,
          "note": "text",
          "sku": "text",
          "productName": "text",
          "productUid": "text",
          "suppliers": [
            {
              "supplierUid": "text",
              "name": "text"
            }
          ]
        }
      ],
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

PreviousProperties

NextReasons

Last updated 4 months ago