OrderDelivery

List deliveries for an order

get

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries

List all deliveries for a specific order

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-_]+

orderUidstringRequired

Reference to an 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}/orders/{orderUid}/deliveries

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

200

Example response

{
  "items": [
    {
      "createdAt": "2025-12-16T00:15:18.516Z",
      "createdBy": "text",
      "deliveryUid": "text",
      "lastModifiedAt": "2025-12-16T00:15:18.516Z",
      "lastModifiedBy": "text",
      "signature": "text",
      "note": "text",
      "deliveryState": "NOT_DELIVERED",
      "deliveryDate": "2025-12-16",
      "externalDeliveryReference": "text",
      "items": [
        {
          "deliveryItemUid": "text",
          "quantityDelivered": 1,
          "serialnumber": "text",
          "sku": "text",
          "warehouseUid": "text",
          "warehouseName": "text",
          "tenantUserUid": "text",
          "tenantUserDisplayName": "text"
        }
      ],
      "orderItems": [
        {
          "actions": [
            {
              "comment": "text",
              "createdAt": "2025-12-16T00:15:18.516Z",
              "createdBy": "text",
              "handlingActionUid": "text",
              "handlingActionName": "text",
              "handlingDescription": "text",
              "handlingUid": "text",
              "handlingName": "text",
              "lastModifiedAt": "2025-12-16T00:15:18.516Z",
              "lastModifiedBy": "text",
              "orderHandlingActionUid": "text"
            }
          ],
          "allowedActions": [
            "QUANTITY_SOLD"
          ],
          "createdAt": "2025-12-16T00:15:18.516Z",
          "discountReasonCode": "text",
          "externalId": "text",
          "itemCost": 1,
          "itemDiscountAmount": 1,
          "itemDiscountPercentage": 1,
          "itemGrossProfitAmount": 1,
          "itemGrossProfitPercentage": 1,
          "itemPrice": 1,
          "itemVatAmount": 1,
          "lastModifiedAt": "2025-12-16T00:15:18.516Z",
          "ledgerNumber": "text",
          "name": "text",
          "note": "text",
          "orderItemUid": "text",
          "orderLinks": [
            {
              "orderUid": "text",
              "orderItemUid": "text",
              "orderNumber": "text",
              "storeUid": "text",
              "type": "CREDIT"
            }
          ],
          "originalItemPrice": 1,
          "productUid": "text",
          "productType": "STOCK",
          "properties": [
            {
              "uid": "text",
              "key": "text",
              "value": "text"
            }
          ],
          "quantityCredited": 1,
          "quantityDelivered": 1,
          "quantityOrdered": 1,
          "quantityReserved": 1,
          "returnReasonCode": "text",
          "serialnumber": "text",
          "sku": "text",
          "sortOrder": 1,
          "tenantUserDisplayName": "text",
          "tenantUserUid": "text",
          "totalCost": 1,
          "totalDiscountAmount": 1,
          "totalGrossProfitAmount": 1,
          "totalPrice": 1,
          "totalVatAmount": 1,
          "vatCodeUid": "text",
          "warehouseUid": "text",
          "warehouseName": "text",
          "internalInfo": "text",
          "productProperties": [
            {
              "productPropertyUid": "text",
              "propertyName": "text",
              "propertyOptionName": "text",
              "propertyType": "TEXT",
              "propertyText": "text",
              "propertyUid": "text",
              "propertyOptionUid": "text",
              "required": true
            }
          ],
          "coverImage": {
            "productMediaUid": "text",
            "mainUrl": "text",
            "thumbnailUrl": "text"
          },
          "deliveryUid": "text",
          "compensationReasonCode": "text",
          "orderReceiptUid": "text",
          "allowDelivery": "YES",
          "allowDeliveryFromDate": "2025-12-16T00:15:18.516Z",
          "reservationType": "NONE",
          "reservationDetails": {
            "warehouse": {
              "warehouseName": "text"
            },
            "purchaseOrder": {
              "purchaseOrderUid": "text",
              "purchaseOrderItemUid": "text",
              "expectedDeliveryDate": "2025-12-16T00:15:18.516Z",
              "purchaseOrderNumber": "text",
              "quantityOrdered": 1,
              "externalId": "text"
            },
            "receivement": {
              "receivementUid": "text",
              "receivementItemUid": "text",
              "expectedArrival": "2025-12-16T00:15:18.516Z",
              "expectedDispatch": "2025-12-16T00:15:18.516Z",
              "quantity": 1,
              "supplierOrderReference": "text",
              "receivedAt": "2025-12-16T00:15:18.516Z"
            }
          },
          "gtins": [
            {
              "gtin": "text",
              "primary": true,
              "type": "text"
            }
          ]
        }
      ],
      "shipping": {
        "deliveryCustomerAddressUid": "text",
        "deliveryAddress": {
          "address": "text",
          "city": "text",
          "companyName": "text",
          "countryCode": "text",
          "email": "text",
          "mobile": "text",
          "firstname": "text",
          "lastname": "text",
          "postalCode": "text",
          "displayName": "text",
          "customerAddressUid": "text"
        },
        "pickupPoint": {
          "pickupPointId": "text",
          "pickupPointType": "text",
          "name": "text",
          "address": "text",
          "postalCode": "text",
          "city": "text",
          "countryCode": "text"
        },
        "trackingNumber": "text",
        "deliveryProviderUid": "text",
        "deliveryProviderMethodUid": "text",
        "deliveryProviderMethodTimeslotUid": "text",
        "timeslot": {
          "name": "text",
          "fromTime": "00:15:18",
          "toTime": "00:15:18"
        },
        "deliveryProviderProcessIndicator": "text",
        "freightOrderItemUid": "text"
      }
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new delivery for an order

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries

Create a new delivery for an order

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-_]+

orderUidstringRequired

Reference to an Order.

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

Body

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

deliveryStatestring · enumOptional

Remark! The NOT_DELIVERED state is deprecated.

Possible values:

deliveryDatestring · date | nullableOptional

externalDeliveryReferencestringOptional

notestringOptional

trackingNumberstringOptionalDeprecated

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

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

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

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

deliveryProviderMethodTimeslotUidstringOptionalDeprecatedPattern: ^[A-Za-z0-9-_]*

autoPrintbooleanOptional

Used for Profrakt consignment auto print

Responses

201

Example response

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries

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

{
  "deliveryState": "NOT_DELIVERED",
  "deliveryDate": "2025-12-16",
  "externalDeliveryReference": "text",
  "note": "text",
  "deliveryUid": "text",
  "autoPrint": true,
  "shipping": {
    "deliveryCustomerAddressUid": "text",
    "deliveryAddress": {
      "address": "text",
      "city": "text",
      "companyName": "text",
      "countryCode": "text",
      "email": "text",
      "mobile": "text",
      "firstname": "text",
      "lastname": "text",
      "postalCode": "text"
    },
    "pickupPoint": {
      "pickupPointId": "text",
      "pickupPointType": "text",
      "name": "text",
      "address": "text",
      "postalCode": "text",
      "city": "text",
      "countryCode": "text"
    },
    "trackingNumber": "text",
    "deliveryProviderUid": "text",
    "deliveryProviderMethodUid": "text",
    "deliveryProviderMethodTimeslotUid": "text",
    "timeslot": {
      "fromTime": "00:15:18",
      "toTime": "00:15:18"
    },
    "deliveryProviderProcessIndicator": "text",
    "freightProductUid": "text",
    "freightPrice": 1
  }
}

201

Example response

{
  "createdAt": "2025-12-16T00:15:18.516Z",
  "createdBy": "text",
  "deliveryUid": "text",
  "lastModifiedAt": "2025-12-16T00:15:18.516Z",
  "lastModifiedBy": "text",
  "signature": "text",
  "note": "text",
  "deliveryState": "NOT_DELIVERED",
  "deliveryDate": "2025-12-16",
  "externalDeliveryReference": "text",
  "items": [
    {
      "deliveryItemUid": "text",
      "quantityDelivered": 1,
      "serialnumber": "text",
      "sku": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "tenantUserUid": "text",
      "tenantUserDisplayName": "text"
    }
  ],
  "orderItems": [
    {
      "actions": [
        {
          "comment": "text",
          "createdAt": "2025-12-16T00:15:18.516Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2025-12-16T00:15:18.516Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2025-12-16T00:15:18.516Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2025-12-16T00:15:18.516Z",
      "ledgerNumber": "text",
      "name": "text",
      "note": "text",
      "orderItemUid": "text",
      "orderLinks": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "storeUid": "text",
          "type": "CREDIT"
        }
      ],
      "originalItemPrice": 1,
      "productUid": "text",
      "productType": "STOCK",
      "properties": [
        {
          "uid": "text",
          "key": "text",
          "value": "text"
        }
      ],
      "quantityCredited": 1,
      "quantityDelivered": 1,
      "quantityOrdered": 1,
      "quantityReserved": 1,
      "returnReasonCode": "text",
      "serialnumber": "text",
      "sku": "text",
      "sortOrder": 1,
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "totalCost": 1,
      "totalDiscountAmount": 1,
      "totalGrossProfitAmount": 1,
      "totalPrice": 1,
      "totalVatAmount": 1,
      "vatCodeUid": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "internalInfo": "text",
      "productProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "deliveryUid": "text",
      "compensationReasonCode": "text",
      "orderReceiptUid": "text",
      "allowDelivery": "YES",
      "allowDeliveryFromDate": "2025-12-16T00:15:18.516Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2025-12-16T00:15:18.516Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1,
          "externalId": "text"
        },
        "receivement": {
          "receivementUid": "text",
          "receivementItemUid": "text",
          "expectedArrival": "2025-12-16T00:15:18.516Z",
          "expectedDispatch": "2025-12-16T00:15:18.516Z",
          "quantity": 1,
          "supplierOrderReference": "text",
          "receivedAt": "2025-12-16T00:15:18.516Z"
        }
      },
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ]
    }
  ],
  "shipping": {
    "deliveryCustomerAddressUid": "text",
    "deliveryAddress": {
      "address": "text",
      "city": "text",
      "companyName": "text",
      "countryCode": "text",
      "email": "text",
      "mobile": "text",
      "firstname": "text",
      "lastname": "text",
      "postalCode": "text",
      "displayName": "text",
      "customerAddressUid": "text"
    },
    "pickupPoint": {
      "pickupPointId": "text",
      "pickupPointType": "text",
      "name": "text",
      "address": "text",
      "postalCode": "text",
      "city": "text",
      "countryCode": "text"
    },
    "trackingNumber": "text",
    "deliveryProviderUid": "text",
    "deliveryProviderMethodUid": "text",
    "deliveryProviderMethodTimeslotUid": "text",
    "timeslot": {
      "name": "text",
      "fromTime": "00:15:18",
      "toTime": "00:15:18"
    },
    "deliveryProviderProcessIndicator": "text",
    "freightOrderItemUid": "text"
  }
}

Fetch delivery sources for an order

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/delivery-sources

Fetch delivery sources for an order

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-_]+

orderUidstringRequired

Reference to an Order.

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

Body

productUidsstring[]Required

Responses

200

Example response

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/delivery-sources

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

{
  "productUids": [
    "text"
  ]
}

200

Example response

{
  "items": [
    {
      "productUid": "text",
      "sourceId": "text"
    }
  ]
}

Search for deliveries

post

/tenants/{tenantUid}/deliveries/search

Search for order deliveries. fromDateTime and toDateTime can be set to null. If both fields have value null, only order deliveries with no deliveryDate is fetched.

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

fromDateTimestring · date-time | nullableOptional

toDateTimestring · date-time | nullableOptional

storeUidsstring[]Required

querystringOptional

ENUM	Description
NOT_STARTED	Settlement not started
IN_PROGRESS	Settlement is in progress and the order cannot be changed
COMPLETE	Settlement is complete

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}/deliveries/search

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

{
  "fromDateTime": "2025-12-16T00:15:18.516Z",
  "toDateTime": "2025-12-16T00:15:18.516Z",
  "deliveryStates": [
    "NOT_DELIVERED"
  ],
  "storeUids": [
    "text"
  ],
  "query": "text",
  "deliveryProviders": [
    {
      "uid": "text",
      "deliveryProviderMethodUids": [
        "text"
      ]
    }
  ],
  "orderSettleStates": [
    "NOT_STARTED"
  ],
  "orderOrderStates": [
    "OPEN"
  ]
}

200

Example response

{
  "items": [
    {
      "createdAt": "2025-12-16T00:15:18.516Z",
      "createdBy": "text",
      "deliveryUid": "text",
      "lastModifiedAt": "2025-12-16T00:15:18.516Z",
      "lastModifiedBy": "text",
      "signature": "text",
      "note": "text",
      "deliveryAddress": {
        "address": "text",
        "city": "text",
        "companyName": "text",
        "countryCode": "text",
        "email": "text",
        "mobile": "text",
        "firstname": "text",
        "lastname": "text",
        "postalCode": "text",
        "displayName": "text",
        "customerAddressUid": "text"
      },
      "deliveryState": "NOT_DELIVERED",
      "deliveryDate": "2025-12-16",
      "externalDeliveryReference": "text",
      "trackingNumber": "text",
      "deliveryProviderUid": "text",
      "deliveryProviderMethodUid": "text",
      "items": [
        {
          "deliveryItemUid": "text",
          "quantityDelivered": 1,
          "serialnumber": "text",
          "sku": "text",
          "warehouseUid": "text",
          "warehouseName": "text",
          "tenantUserUid": "text",
          "tenantUserDisplayName": "text"
        }
      ],
      "order": {
        "orderUid": "text",
        "orderNumber": "text",
        "settleState": "NOT_STARTED",
        "voucherNumber": "text",
        "storeUid": "text",
        "storeName": "text",
        "orderItems": [
          {
            "actions": [
              {
                "comment": "text",
                "createdAt": "2025-12-16T00:15:18.516Z",
                "createdBy": "text",
                "handlingActionUid": "text",
                "handlingActionName": "text",
                "handlingDescription": "text",
                "handlingUid": "text",
                "handlingName": "text",
                "lastModifiedAt": "2025-12-16T00:15:18.516Z",
                "lastModifiedBy": "text",
                "orderHandlingActionUid": "text"
              }
            ],
            "allowedActions": [
              "QUANTITY_SOLD"
            ],
            "createdAt": "2025-12-16T00:15:18.516Z",
            "discountReasonCode": "text",
            "externalId": "text",
            "itemCost": 1,
            "itemDiscountAmount": 1,
            "itemDiscountPercentage": 1,
            "itemGrossProfitAmount": 1,
            "itemGrossProfitPercentage": 1,
            "itemPrice": 1,
            "itemVatAmount": 1,
            "lastModifiedAt": "2025-12-16T00:15:18.516Z",
            "ledgerNumber": "text",
            "name": "text",
            "note": "text",
            "orderItemUid": "text",
            "orderLinks": [
              {
                "orderUid": "text",
                "orderItemUid": "text",
                "orderNumber": "text",
                "storeUid": "text",
                "type": "CREDIT"
              }
            ],
            "originalItemPrice": 1,
            "productUid": "text",
            "productType": "STOCK",
            "properties": [
              {
                "uid": "text",
                "key": "text",
                "value": "text"
              }
            ],
            "quantityCredited": 1,
            "quantityDelivered": 1,
            "quantityOrdered": 1,
            "quantityReserved": 1,
            "returnReasonCode": "text",
            "serialnumber": "text",
            "sku": "text",
            "sortOrder": 1,
            "tenantUserDisplayName": "text",
            "tenantUserUid": "text",
            "totalCost": 1,
            "totalDiscountAmount": 1,
            "totalGrossProfitAmount": 1,
            "totalPrice": 1,
            "totalVatAmount": 1,
            "vatCodeUid": "text",
            "warehouseUid": "text",
            "warehouseName": "text",
            "internalInfo": "text",
            "productProperties": [
              {
                "productPropertyUid": "text",
                "propertyName": "text",
                "propertyOptionName": "text",
                "propertyType": "TEXT",
                "propertyText": "text",
                "propertyUid": "text",
                "propertyOptionUid": "text",
                "required": true
              }
            ],
            "coverImage": {
              "productMediaUid": "text",
              "mainUrl": "text",
              "thumbnailUrl": "text"
            },
            "deliveryUid": "text",
            "compensationReasonCode": "text",
            "orderReceiptUid": "text",
            "allowDelivery": "YES",
            "allowDeliveryFromDate": "2025-12-16T00:15:18.516Z",
            "reservationType": "NONE",
            "reservationDetails": {
              "warehouse": {
                "warehouseName": "text"
              },
              "purchaseOrder": {
                "purchaseOrderUid": "text",
                "purchaseOrderItemUid": "text",
                "expectedDeliveryDate": "2025-12-16T00:15:18.516Z",
                "purchaseOrderNumber": "text",
                "quantityOrdered": 1,
                "externalId": "text"
              },
              "receivement": {
                "receivementUid": "text",
                "receivementItemUid": "text",
                "expectedArrival": "2025-12-16T00:15:18.516Z",
                "expectedDispatch": "2025-12-16T00:15:18.516Z",
                "quantity": 1,
                "supplierOrderReference": "text",
                "receivedAt": "2025-12-16T00:15:18.516Z"
              }
            },
            "gtins": [
              {
                "gtin": "text",
                "primary": true,
                "type": "text"
              }
            ]
          }
        ]
      },
      "timeslot": {
        "deliveryProviderMethodTimeslotUid": "text",
        "name": "text"
      }
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create Profrakt delivery for an order

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}/profrakt

Create Profrakt delivery for an order

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-_]+

orderUidstringRequired

Reference to an Order.

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

deliveryUidstringRequired

Reference to a delivery

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

Body

autoPrintbooleanOptional

Responses

201

Profrakt delivery created for order

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}/profrakt

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

{
  "autoPrint": true
}

201

Profrakt delivery created for order

{
  "createdAt": "2025-12-16T00:15:18.516Z",
  "createdBy": "text",
  "deliveryUid": "text",
  "lastModifiedAt": "2025-12-16T00:15:18.516Z",
  "lastModifiedBy": "text",
  "signature": "text",
  "note": "text",
  "deliveryState": "NOT_DELIVERED",
  "deliveryDate": "2025-12-16",
  "externalDeliveryReference": "text",
  "items": [
    {
      "deliveryItemUid": "text",
      "quantityDelivered": 1,
      "serialnumber": "text",
      "sku": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "tenantUserUid": "text",
      "tenantUserDisplayName": "text"
    }
  ],
  "orderItems": [
    {
      "actions": [
        {
          "comment": "text",
          "createdAt": "2025-12-16T00:15:18.516Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2025-12-16T00:15:18.516Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2025-12-16T00:15:18.516Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2025-12-16T00:15:18.516Z",
      "ledgerNumber": "text",
      "name": "text",
      "note": "text",
      "orderItemUid": "text",
      "orderLinks": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "storeUid": "text",
          "type": "CREDIT"
        }
      ],
      "originalItemPrice": 1,
      "productUid": "text",
      "productType": "STOCK",
      "properties": [
        {
          "uid": "text",
          "key": "text",
          "value": "text"
        }
      ],
      "quantityCredited": 1,
      "quantityDelivered": 1,
      "quantityOrdered": 1,
      "quantityReserved": 1,
      "returnReasonCode": "text",
      "serialnumber": "text",
      "sku": "text",
      "sortOrder": 1,
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "totalCost": 1,
      "totalDiscountAmount": 1,
      "totalGrossProfitAmount": 1,
      "totalPrice": 1,
      "totalVatAmount": 1,
      "vatCodeUid": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "internalInfo": "text",
      "productProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "deliveryUid": "text",
      "compensationReasonCode": "text",
      "orderReceiptUid": "text",
      "allowDelivery": "YES",
      "allowDeliveryFromDate": "2025-12-16T00:15:18.516Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2025-12-16T00:15:18.516Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1,
          "externalId": "text"
        },
        "receivement": {
          "receivementUid": "text",
          "receivementItemUid": "text",
          "expectedArrival": "2025-12-16T00:15:18.516Z",
          "expectedDispatch": "2025-12-16T00:15:18.516Z",
          "quantity": 1,
          "supplierOrderReference": "text",
          "receivedAt": "2025-12-16T00:15:18.516Z"
        }
      },
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ]
    }
  ],
  "shipping": {
    "deliveryCustomerAddressUid": "text",
    "deliveryAddress": {
      "address": "text",
      "city": "text",
      "companyName": "text",
      "countryCode": "text",
      "email": "text",
      "mobile": "text",
      "firstname": "text",
      "lastname": "text",
      "postalCode": "text",
      "displayName": "text",
      "customerAddressUid": "text"
    },
    "pickupPoint": {
      "pickupPointId": "text",
      "pickupPointType": "text",
      "name": "text",
      "address": "text",
      "postalCode": "text",
      "city": "text",
      "countryCode": "text"
    },
    "trackingNumber": "text",
    "deliveryProviderUid": "text",
    "deliveryProviderMethodUid": "text",
    "deliveryProviderMethodTimeslotUid": "text",
    "timeslot": {
      "name": "text",
      "fromTime": "00:15:18",
      "toTime": "00:15:18"
    },
    "deliveryProviderProcessIndicator": "text",
    "freightOrderItemUid": "text"
  }
}

Print shipping label for Profrakt order delivery

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}/profrakt/print-label

Print shipping label for Profrakt order delivery

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-_]+

orderUidstringRequired

Reference to an Order.

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

deliveryUidstringRequired

Reference to a delivery

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

Responses

202

Accepted

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}/profrakt/print-label

POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}/profrakt/print-label HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

202

Accepted

No content

Get order delivery information

get

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}

Get information, like signature, about a specific delivery

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-_]+

orderUidstringRequired

Reference to an Order.

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

deliveryUidstringRequired

Reference to a delivery

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}

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

200

Example response

{
  "createdAt": "2025-12-16T00:15:18.516Z",
  "createdBy": "text",
  "deliveryUid": "text",
  "lastModifiedAt": "2025-12-16T00:15:18.516Z",
  "lastModifiedBy": "text",
  "signature": "text",
  "note": "text",
  "deliveryState": "NOT_DELIVERED",
  "deliveryDate": "2025-12-16",
  "externalDeliveryReference": "text",
  "items": [
    {
      "deliveryItemUid": "text",
      "quantityDelivered": 1,
      "serialnumber": "text",
      "sku": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "tenantUserUid": "text",
      "tenantUserDisplayName": "text"
    }
  ],
  "orderItems": [
    {
      "actions": [
        {
          "comment": "text",
          "createdAt": "2025-12-16T00:15:18.516Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2025-12-16T00:15:18.516Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2025-12-16T00:15:18.516Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2025-12-16T00:15:18.516Z",
      "ledgerNumber": "text",
      "name": "text",
      "note": "text",
      "orderItemUid": "text",
      "orderLinks": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "storeUid": "text",
          "type": "CREDIT"
        }
      ],
      "originalItemPrice": 1,
      "productUid": "text",
      "productType": "STOCK",
      "properties": [
        {
          "uid": "text",
          "key": "text",
          "value": "text"
        }
      ],
      "quantityCredited": 1,
      "quantityDelivered": 1,
      "quantityOrdered": 1,
      "quantityReserved": 1,
      "returnReasonCode": "text",
      "serialnumber": "text",
      "sku": "text",
      "sortOrder": 1,
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "totalCost": 1,
      "totalDiscountAmount": 1,
      "totalGrossProfitAmount": 1,
      "totalPrice": 1,
      "totalVatAmount": 1,
      "vatCodeUid": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "internalInfo": "text",
      "productProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "deliveryUid": "text",
      "compensationReasonCode": "text",
      "orderReceiptUid": "text",
      "allowDelivery": "YES",
      "allowDeliveryFromDate": "2025-12-16T00:15:18.516Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2025-12-16T00:15:18.516Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1,
          "externalId": "text"
        },
        "receivement": {
          "receivementUid": "text",
          "receivementItemUid": "text",
          "expectedArrival": "2025-12-16T00:15:18.516Z",
          "expectedDispatch": "2025-12-16T00:15:18.516Z",
          "quantity": 1,
          "supplierOrderReference": "text",
          "receivedAt": "2025-12-16T00:15:18.516Z"
        }
      },
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ]
    }
  ],
  "shipping": {
    "deliveryCustomerAddressUid": "text",
    "deliveryAddress": {
      "address": "text",
      "city": "text",
      "companyName": "text",
      "countryCode": "text",
      "email": "text",
      "mobile": "text",
      "firstname": "text",
      "lastname": "text",
      "postalCode": "text",
      "displayName": "text",
      "customerAddressUid": "text"
    },
    "pickupPoint": {
      "pickupPointId": "text",
      "pickupPointType": "text",
      "name": "text",
      "address": "text",
      "postalCode": "text",
      "city": "text",
      "countryCode": "text"
    },
    "trackingNumber": "text",
    "deliveryProviderUid": "text",
    "deliveryProviderMethodUid": "text",
    "deliveryProviderMethodTimeslotUid": "text",
    "timeslot": {
      "name": "text",
      "fromTime": "00:15:18",
      "toTime": "00:15:18"
    },
    "deliveryProviderProcessIndicator": "text",
    "freightOrderItemUid": "text"
  }
}

Update delivery

put

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}

Update a delivery with signature

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-_]+

orderUidstringRequired

Reference to an Order.

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

deliveryUidstringRequired

Reference to a delivery

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

Body

signaturestringOptional

base64 encoded png formatted binary data

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

deliveryStatestring · enumOptional

Remark! The NOT_DELIVERED state is deprecated.

Possible values:

deliveryDatestring · date | nullableOptional

externalDeliveryReferencestringOptional

notestringOptional

trackingNumberstringOptionalDeprecated

deliveryProviderUidstringOptionalDeprecated

Deprecated: Use deliveryProvider -> deliveryProviderUid instead

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

deliveryProviderMethodUidstringOptionalDeprecated

Deprecated: Use deliveryProvider -> deliveryProviderMethodUid instead

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

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

deliveryProviderMethodTimeslotUidstringOptionalDeprecated

Deprecated: Use deliveryProvider -> deliveryProviderMethodTimeslotUid instead

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

Responses

200

Example response

application/json

put

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}

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

{
  "signature": "text",
  "deliveryState": "NOT_DELIVERED",
  "deliveryDate": "2025-12-16",
  "externalDeliveryReference": "text",
  "note": "text",
  "shipping": {
    "deliveryCustomerAddressUid": "text",
    "deliveryAddress": {
      "address": "text",
      "city": "text",
      "companyName": "text",
      "countryCode": "text",
      "email": "text",
      "mobile": "text",
      "firstname": "text",
      "lastname": "text",
      "postalCode": "text"
    },
    "pickupPoint": {
      "pickupPointId": "text",
      "pickupPointType": "text",
      "name": "text",
      "address": "text",
      "postalCode": "text",
      "city": "text",
      "countryCode": "text"
    },
    "trackingNumber": "text",
    "deliveryProviderUid": "text",
    "deliveryProviderMethodUid": "text",
    "deliveryProviderMethodTimeslotUid": "text",
    "timeslot": {
      "fromTime": "00:15:18",
      "toTime": "00:15:18"
    },
    "deliveryProviderProcessIndicator": "text",
    "freightProductUid": "text",
    "freightPrice": 1
  }
}

200

Example response

{
  "createdAt": "2025-12-16T00:15:18.516Z",
  "createdBy": "text",
  "deliveryUid": "text",
  "lastModifiedAt": "2025-12-16T00:15:18.516Z",
  "lastModifiedBy": "text",
  "signature": "text",
  "note": "text",
  "deliveryState": "NOT_DELIVERED",
  "deliveryDate": "2025-12-16",
  "externalDeliveryReference": "text",
  "items": [
    {
      "deliveryItemUid": "text",
      "quantityDelivered": 1,
      "serialnumber": "text",
      "sku": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "tenantUserUid": "text",
      "tenantUserDisplayName": "text"
    }
  ],
  "orderItems": [
    {
      "actions": [
        {
          "comment": "text",
          "createdAt": "2025-12-16T00:15:18.516Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2025-12-16T00:15:18.516Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2025-12-16T00:15:18.516Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2025-12-16T00:15:18.516Z",
      "ledgerNumber": "text",
      "name": "text",
      "note": "text",
      "orderItemUid": "text",
      "orderLinks": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "storeUid": "text",
          "type": "CREDIT"
        }
      ],
      "originalItemPrice": 1,
      "productUid": "text",
      "productType": "STOCK",
      "properties": [
        {
          "uid": "text",
          "key": "text",
          "value": "text"
        }
      ],
      "quantityCredited": 1,
      "quantityDelivered": 1,
      "quantityOrdered": 1,
      "quantityReserved": 1,
      "returnReasonCode": "text",
      "serialnumber": "text",
      "sku": "text",
      "sortOrder": 1,
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "totalCost": 1,
      "totalDiscountAmount": 1,
      "totalGrossProfitAmount": 1,
      "totalPrice": 1,
      "totalVatAmount": 1,
      "vatCodeUid": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "internalInfo": "text",
      "productProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "deliveryUid": "text",
      "compensationReasonCode": "text",
      "orderReceiptUid": "text",
      "allowDelivery": "YES",
      "allowDeliveryFromDate": "2025-12-16T00:15:18.516Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2025-12-16T00:15:18.516Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1,
          "externalId": "text"
        },
        "receivement": {
          "receivementUid": "text",
          "receivementItemUid": "text",
          "expectedArrival": "2025-12-16T00:15:18.516Z",
          "expectedDispatch": "2025-12-16T00:15:18.516Z",
          "quantity": 1,
          "supplierOrderReference": "text",
          "receivedAt": "2025-12-16T00:15:18.516Z"
        }
      },
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ]
    }
  ],
  "shipping": {
    "deliveryCustomerAddressUid": "text",
    "deliveryAddress": {
      "address": "text",
      "city": "text",
      "companyName": "text",
      "countryCode": "text",
      "email": "text",
      "mobile": "text",
      "firstname": "text",
      "lastname": "text",
      "postalCode": "text",
      "displayName": "text",
      "customerAddressUid": "text"
    },
    "pickupPoint": {
      "pickupPointId": "text",
      "pickupPointType": "text",
      "name": "text",
      "address": "text",
      "postalCode": "text",
      "city": "text",
      "countryCode": "text"
    },
    "trackingNumber": "text",
    "deliveryProviderUid": "text",
    "deliveryProviderMethodUid": "text",
    "deliveryProviderMethodTimeslotUid": "text",
    "timeslot": {
      "name": "text",
      "fromTime": "00:15:18",
      "toTime": "00:15:18"
    },
    "deliveryProviderProcessIndicator": "text",
    "freightOrderItemUid": "text"
  }
}

Delete order delivery

delete

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}

Delete an order delivery. Note that this can only be done while the delivery state is "not delivered".

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-_]+

orderUidstringRequired

Reference to an Order.

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

deliveryUidstringRequired

Reference to a delivery

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

Responses

204

No Content

delete

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Deliver on an order item

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}/deliveries

Deliver on an orderitem.

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-_]+

orderUidstringRequired

Reference to an Order.

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

orderItemUidstringRequired

Reference to an order item on an order.

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

Body

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

quantityDeliveredintegerRequired

serialnumberstringOptional

skustringOptional

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

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

Responses

200

Example response

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}/deliveries

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

{
  "deliveryUid": "text",
  "quantityDelivered": 1,
  "serialnumber": "text",
  "sku": "text",
  "warehouseUid": "text",
  "deliveryItemUid": "text"
}

200

Example response

{
  "shippingAddress": {
    "address": "text",
    "city": "text",
    "companyName": "text",
    "countryCode": "text",
    "email": "text",
    "firstname": "text",
    "lastname": "text",
    "mobile": "text",
    "postalCode": "text",
    "vatNumber": "text",
    "displayName": "text"
  },
  "createdAt": "2025-12-16T00:15:18.516Z",
  "customerAddress": {
    "address": "text",
    "city": "text",
    "companyName": "text",
    "countryCode": "text",
    "email": "text",
    "firstname": "text",
    "lastname": "text",
    "mobile": "text",
    "postalCode": "text",
    "vatNumber": "text",
    "displayName": "text"
  },
  "customerUid": "text",
  "customerContact": {
    "customerContactUid": "text",
    "firstname": "text",
    "lastname": "text",
    "email": "text",
    "mobile": "text",
    "displayName": "text"
  },
  "deliveryState": "NOT_STARTED",
  "externalOrderNumber": "text",
  "externalVoucherNumber": "text",
  "invoiceAddress": {
    "address": "text",
    "city": "text",
    "companyName": "text",
    "countryCode": "text",
    "email": "text",
    "mobile": "text",
    "firstname": "text",
    "lastname": "text",
    "postalCode": "text",
    "displayName": "text",
    "customerAddressUid": "text"
  },
  "items": [
    {
      "actions": [
        {
          "comment": "text",
          "createdAt": "2025-12-16T00:15:18.516Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2025-12-16T00:15:18.516Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2025-12-16T00:15:18.516Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2025-12-16T00:15:18.516Z",
      "ledgerNumber": "text",
      "name": "text",
      "note": "text",
      "orderItemUid": "text",
      "orderLinks": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "storeUid": "text",
          "type": "CREDIT"
        }
      ],
      "originalItemPrice": 1,
      "productUid": "text",
      "productType": "STOCK",
      "properties": [
        {
          "uid": "text",
          "key": "text",
          "value": "text"
        }
      ],
      "quantityCredited": 1,
      "quantityDelivered": 1,
      "quantityOrdered": 1,
      "quantityReserved": 1,
      "returnReasonCode": "text",
      "serialnumber": "text",
      "sku": "text",
      "sortOrder": 1,
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "totalCost": 1,
      "totalDiscountAmount": 1,
      "totalGrossProfitAmount": 1,
      "totalPrice": 1,
      "totalVatAmount": 1,
      "vatCodeUid": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "internalInfo": "text",
      "productProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "deliveryUid": "text",
      "compensationReasonCode": "text",
      "orderReceiptUid": "text",
      "allowDelivery": "YES",
      "allowDeliveryFromDate": "2025-12-16T00:15:18.516Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2025-12-16T00:15:18.516Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1,
          "externalId": "text"
        },
        "receivement": {
          "receivementUid": "text",
          "receivementItemUid": "text",
          "expectedArrival": "2025-12-16T00:15:18.516Z",
          "expectedDispatch": "2025-12-16T00:15:18.516Z",
          "quantity": 1,
          "supplierOrderReference": "text",
          "receivedAt": "2025-12-16T00:15:18.516Z"
        }
      },
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ]
    }
  ],
  "lastModifiedAt": "2025-12-16T00:15:18.516Z",
  "note": "text",
  "internalNote": "text",
  "orderUid": "text",
  "orderNumber": "text",
  "orderDate": "2025-12-16T00:15:18.516Z",
  "orderState": "OPEN",
  "orderTotals": {
    "costTotal": 1,
    "grandTotal": 1,
    "grossProfitAmount": 1,
    "grossProfitPercentage": 1,
    "specifiedVat": [
      {
        "vatAmount": 1,
        "vatDescription": "text",
        "vatRate": 1
      }
    ],
    "subtotal": 1,
    "totalDiscount": 1,
    "totalVat": 1
  },
  "orderhandlingState": "NOT_STARTED",
  "orderhandlings": [
    {
      "active": true,
      "createdAt": "2025-12-16T00:15:18.516Z",
      "createdBy": "text",
      "description": "text",
      "handlingUid": "text",
      "lastModifiedAt": "2025-12-16T00:15:18.516Z",
      "lastModifiedBy": "text",
      "name": "text",
      "orderHandlingUid": "text",
      "state": "NOT_STARTED"
    }
  ],
  "settleState": "NOT_STARTED",
  "settledAt": "2025-12-16T00:15:18.516Z",
  "settlementTotals": {
    "change": 1,
    "remaining": 1,
    "remainingRounded": 1,
    "totals": 1,
    "remainingPrePayment": 1
  },
  "settlements": [
    {
      "amount": 1,
      "createdAt": "2025-12-16T00:15:18.516Z",
      "displayMessages": [
        {
          "key": "text",
          "message": "text",
          "timestamp": "2025-12-16T00:15:18.516Z"
        }
      ],
      "externalId": "text",
      "externalPaymentReference": "text",
      "idMethod": "NO_CVM_RULE_PERFORMED",
      "lastModifiedAt": "2025-12-16T00:15:18.516Z",
      "ledgerNumber": "text",
      "ledgerType": "LEDGER",
      "parameters": [
        {
          "key": "text",
          "value": "text",
          "name": "text",
          "type": "TEXT"
        }
      ],
      "settledAt": "2025-12-16T00:15:18.516Z",
      "settlementCode": "text",
      "settlementUid": "text",
      "settlementName": "text",
      "state": "NOT_STARTED",
      "status": "NEW",
      "storeSettlementIssuer": {
        "storeSettlementIssuerUid": "text",
        "name": "text",
        "code": "text"
      },
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "storePaymentMethodUid": "text",
      "currency": {
        "amount": 1,
        "code": "text",
        "exchangeRate": 1
      },
      "additionalDetails": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "creditCount": 1,
      "creditAmount": 1,
      "paymentCount": 1,
      "paymentAmount": 1,
      "orderReceiptUid": "text"
    }
  ],
  "storeUid": "text",
  "storeName": "text",
  "systemOrigin": "text",
  "tenantUserDisplayName": "text",
  "tenantUserUid": "text",
  "tillUid": "text",
  "type": "OFFER",
  "validUntil": "2025-12-16T00:15:18.516Z",
  "vatFree": true,
  "vatPrint": "SUM",
  "voucherNumber": "text",
  "deliveryDate": "2025-12-16",
  "discounts": [
    {
      "orderDiscountUid": "text",
      "discountCode": "text",
      "type": "PERCENTAGE",
      "amount": 1,
      "name": "text",
      "origin": "LOYALTY",
      "validTo": "2025-12-16T00:15:18.516Z",
      "maxUsage": 1,
      "productSkus": [
        "text"
      ],
      "orderItemUids": [
        "text"
      ],
      "externalTransactionId": "text",
      "scope": "WHOLE_ORDER",
      "discountReasonCode": "text",
      "discountReference": "text",
      "createdAt": "2025-12-16T00:15:18.516Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-12-16T00:15:18.516Z",
      "lastModifiedBy": "text",
      "campaignUid": "text"
    }
  ],
  "compensationReasonUid": "text",
  "lastModifiedBy": "text",
  "allowedActions": []
}

Download packing list for a delivery

get

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}/download

Print packing list for an order delivery.

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-_]+

orderUidstringRequired

Reference to an Order.

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

deliveryUidstringRequired

Reference to a delivery

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}/orders/{orderUid}/deliveries/{deliveryUid}/download

GET /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}/download HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

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

Download picking list for several deliveries

post

/tenants/{tenantUid}/deliveries/download

Download picking list for several deliveries

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

deliveryUidsstring[]Required

Responses

200

post

/tenants/{tenantUid}/deliveries/download

POST /v2/tenants/{tenantUid}/deliveries/download HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "deliveryUids": [
    "text"
  ]
}

200

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

List all available shipping options for an order

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/delivery-options

List all available shipping options for an order

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-_]+

orderUidstringRequired

Reference to an Order.

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

Body

startDatestring · dateRequired

endDatestring · dateRequired

postalCodestringRequired

Responses

200

Example response

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/delivery-options

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

{
  "startDate": "2025-12-16",
  "endDate": "2025-12-16",
  "postalCode": "text",
  "products": [
    {
      "productUid": "text",
      "quantity": 1,
      "freightServiceProductUids": [
        "text"
      ],
      "serviceProductUids": [
        "text"
      ]
    }
  ]
}

200

Example response

{
  "deliveryOptions": [
    {
      "freightProductUid": "text",
      "freightProductName": "text",
      "deliveryProviderProcessIndicator": "text",
      "pickupDelivery": {
        "pickupPoints": [
          {
            "pickupPointType": "text",
            "pickupPointId": "text",
            "name": "text",
            "latitude": "text",
            "longitude": "text",
            "address": "text",
            "postalCode": "text",
            "city": "text",
            "countryCode": "text",
            "description": "text",
            "price": 1
          }
        ]
      },
      "addressDelivery": {
        "arrivalOptions": [
          {
            "date": "2025-12-16",
            "startTime": "00:15:18",
            "endTime": "00:15:18",
            "price": 1
          }
        ],
        "shippingOptions": [
          {
            "date": "2025-12-16",
            "price": 1
          }
        ]
      },
      "parcelDelivery": [
        {
          "shippingDate": "2025-12-16",
          "price": 1
        }
      ]
    }
  ],
  "information": [
    "text"
  ]
}

List all available service products for an order

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/delivery-services

List all available service products for an order

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-_]+

orderUidstringRequired

Reference to an Order.

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

Body

postalCodestringRequired

productUidsstring[]Required

Responses

200

Example response

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/delivery-services

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

{
  "postalCode": "text",
  "productUids": [
    "text"
  ]
}

200

Example response

{
  "items": [
    {
      "productUid": "text",
      "serviceProducts": [
        {
          "storeProductDetails": {
            "grossProfitAmount": 1,
            "grossProfitPercentage": 1,
            "costPrice": 1,
            "price": 1,
            "campaignPrice": 1,
            "campaignName": "text",
            "quantityReserved": 1,
            "quantityStock": 1,
            "quantityOrdered": 1,
            "warehouseStockDetails": [
              {
                "grossProfitAmount": 1,
                "grossProfitPercentage": 1,
                "costPrice": 1,
                "quantityReserved": 1,
                "quantityStock": 1,
                "locationLabel": "text",
                "storeUid": "text",
                "storeName": "text",
                "warehouseUid": "text",
                "warehouseName": "text"
              }
            ],
            "soaAmounts": [
              {
                "soaUid": "text",
                "soaName": "text",
                "amount": 1,
                "fromDateTime": "2025-12-16T00:15:18.516Z",
                "toDateTime": "2025-12-16T00:15:18.516Z",
                "soaAmountUid": "text"
              }
            ]
          },
          "allowAddon": true,
          "allowCredit": true,
          "allowNegativePrice": true,
          "allowPurchase": true,
          "allowQuantity": true,
          "allowSale": "YES",
          "allowSaleDate": "2025-12-16T00:15:18.516Z",
          "allowDelivery": "YES",
          "allowDeliveryDate": "2025-12-16T00:15:18.516Z",
          "allowOrderSpecificCost": true,
          "allowOrderSpecificName": true,
          "allowDiscount": true,
          "availableForWeb": true,
          "brandUid": "text",
          "brandName": "text",
          "calculationFactor": 1,
          "categoryUids": [
            "text"
          ],
          "createdAt": "2025-12-16T00:15:18.516Z",
          "customerAgeRestriction": 1,
          "description": "text",
          "discontinuedFrom": "2025-12-16T00:15:18.516Z",
          "externalId": "text",
          "externalInfo": "text",
          "externalUrl": "text",
          "gtins": [
            {
              "gtin": "text",
              "primary": true,
              "type": "text"
            }
          ],
          "height": 1,
          "internalInfo": "text",
          "lastModifiedAt": "2025-12-16T00:15:18.516Z",
          "ledgerNumber": "text",
          "length": 1,
          "name": "text",
          "optionProperties": [
            {
              "productPropertyUid": "text",
              "propertyName": "text",
              "propertyOptionName": "text",
              "propertyType": "TEXT",
              "propertyText": "text",
              "propertyUid": "text",
              "propertyOptionUid": "text",
              "required": true
            }
          ],
          "priceOverride": true,
          "productGroupUid": "text",
          "productGroupPath": [
            {
              "name": "text",
              "parentUid": "text",
              "productGroupUid": "text"
            }
          ],
          "productUid": "text",
          "productType": "STOCK",
          "recommendedRetailPrice": 1,
          "requiredVariantPropertyUids": [
            "text"
          ],
          "serialNoRequired": "NO",
          "shortDescription": "text",
          "sku": "text",
          "manufacturerSku": "text",
          "suppliers": [
            {
              "name": "text",
              "supplierUid": "text"
            }
          ],
          "textProperties": [
            {
              "productPropertyUid": "text",
              "propertyName": "text",
              "propertyOptionName": "text",
              "propertyType": "TEXT",
              "propertyText": "text",
              "propertyUid": "text",
              "propertyOptionUid": "text",
              "required": true
            }
          ],
          "unitLabel": "text",
          "variantProductUids": [
            "text"
          ],
          "variantParentProductUid": "text",
          "vatCodeUid": "text",
          "weight": 1,
          "width": 1,
          "links": [
            {
              "productLinkUid": "text",
              "linkType": "INSURANCE",
              "productUid": "text"
            }
          ],
          "parents": [
            {
              "productLinkUid": "text",
              "linkType": "INSURANCE",
              "productUid": "text"
            }
          ],
          "requirements": {
            "requireCustomer": true,
            "requireCustomerMobile": true,
            "requireCustomerEmail": true,
            "requireCustomerDeliveryAddress": true,
            "orderItemReference": "text"
          },
          "coverImage": {
            "productMediaUid": "text",
            "mainUrl": "text",
            "thumbnailUrl": "text"
          },
          "imageCount": 1,
          "relevance": 1,
          "visibility": "ALWAYS_VISIBLE",
          "commission": 1,
          "productWarrantyUid": "text",
          "excludeFromStatistics": true,
          "purchasePrice": 1,
          "numberOfPieces": 1,
          "limitToStoreUids": [
            "text"
          ],
          "tradeUnit": 1
        }
      ],
      "freightServiceProducts": [
        {
          "storeProductDetails": {
            "grossProfitAmount": 1,
            "grossProfitPercentage": 1,
            "costPrice": 1,
            "price": 1,
            "campaignPrice": 1,
            "campaignName": "text",
            "quantityReserved": 1,
            "quantityStock": 1,
            "quantityOrdered": 1,
            "warehouseStockDetails": [
              {
                "grossProfitAmount": 1,
                "grossProfitPercentage": 1,
                "costPrice": 1,
                "quantityReserved": 1,
                "quantityStock": 1,
                "locationLabel": "text",
                "storeUid": "text",
                "storeName": "text",
                "warehouseUid": "text",
                "warehouseName": "text"
              }
            ],
            "soaAmounts": [
              {
                "soaUid": "text",
                "soaName": "text",
                "amount": 1,
                "fromDateTime": "2025-12-16T00:15:18.516Z",
                "toDateTime": "2025-12-16T00:15:18.516Z",
                "soaAmountUid": "text"
              }
            ]
          },
          "allowAddon": true,
          "allowCredit": true,
          "allowNegativePrice": true,
          "allowPurchase": true,
          "allowQuantity": true,
          "allowSale": "YES",
          "allowSaleDate": "2025-12-16T00:15:18.516Z",
          "allowDelivery": "YES",
          "allowDeliveryDate": "2025-12-16T00:15:18.516Z",
          "allowOrderSpecificCost": true,
          "allowOrderSpecificName": true,
          "allowDiscount": true,
          "availableForWeb": true,
          "brandUid": "text",
          "brandName": "text",
          "calculationFactor": 1,
          "categoryUids": [
            "text"
          ],
          "createdAt": "2025-12-16T00:15:18.516Z",
          "customerAgeRestriction": 1,
          "description": "text",
          "discontinuedFrom": "2025-12-16T00:15:18.516Z",
          "externalId": "text",
          "externalInfo": "text",
          "externalUrl": "text",
          "gtins": [
            {
              "gtin": "text",
              "primary": true,
              "type": "text"
            }
          ],
          "height": 1,
          "internalInfo": "text",
          "lastModifiedAt": "2025-12-16T00:15:18.516Z",
          "ledgerNumber": "text",
          "length": 1,
          "name": "text",
          "optionProperties": [
            {
              "productPropertyUid": "text",
              "propertyName": "text",
              "propertyOptionName": "text",
              "propertyType": "TEXT",
              "propertyText": "text",
              "propertyUid": "text",
              "propertyOptionUid": "text",
              "required": true
            }
          ],
          "priceOverride": true,
          "productGroupUid": "text",
          "productGroupPath": [
            {
              "name": "text",
              "parentUid": "text",
              "productGroupUid": "text"
            }
          ],
          "productUid": "text",
          "productType": "STOCK",
          "recommendedRetailPrice": 1,
          "requiredVariantPropertyUids": [
            "text"
          ],
          "serialNoRequired": "NO",
          "shortDescription": "text",
          "sku": "text",
          "manufacturerSku": "text",
          "suppliers": [
            {
              "name": "text",
              "supplierUid": "text"
            }
          ],
          "textProperties": [
            {
              "productPropertyUid": "text",
              "propertyName": "text",
              "propertyOptionName": "text",
              "propertyType": "TEXT",
              "propertyText": "text",
              "propertyUid": "text",
              "propertyOptionUid": "text",
              "required": true
            }
          ],
          "unitLabel": "text",
          "variantProductUids": [
            "text"
          ],
          "variantParentProductUid": "text",
          "vatCodeUid": "text",
          "weight": 1,
          "width": 1,
          "links": [
            {
              "productLinkUid": "text",
              "linkType": "INSURANCE",
              "productUid": "text"
            }
          ],
          "parents": [
            {
              "productLinkUid": "text",
              "linkType": "INSURANCE",
              "productUid": "text"
            }
          ],
          "requirements": {
            "requireCustomer": true,
            "requireCustomerMobile": true,
            "requireCustomerEmail": true,
            "requireCustomerDeliveryAddress": true,
            "orderItemReference": "text"
          },
          "coverImage": {
            "productMediaUid": "text",
            "mainUrl": "text",
            "thumbnailUrl": "text"
          },
          "imageCount": 1,
          "relevance": 1,
          "visibility": "ALWAYS_VISIBLE",
          "commission": 1,
          "productWarrantyUid": "text",
          "excludeFromStatistics": true,
          "purchasePrice": 1,
          "numberOfPieces": 1,
          "limitToStoreUids": [
            "text"
          ],
          "tradeUnit": 1
        }
      ]
    }
  ]
}

PreviousOrder NextDeliveryProvider

Last updated 5 hours ago