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

OrderDelivery

OrderDelivery

List delivery Providers

get

List all delivery providers

Authorizations
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:
querystringOptional

Query for the deliveryProvider

Responses
200

Example response

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

Example response

{
  "items": [
    {
      "name": "text",
      "externalId": "text",
      "deliveryProviderUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new delivery provider

post

Create a new delivery provider

Required permission: TENANT.ACCESS

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
namestringRequired
externalIdstringOptional
deliveryProviderUidstringOptionalPattern: ^[A-Za-z0-9-_]+
Responses
201

Example response

application/json
post
POST /v2/tenants/{tenantUid}/delivery-providers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderUid": "text"
}
201

Example response

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderUid": "text"
}

Get delivery provider details

get

Get delivery provider details

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a delivery provider.

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

Example response

application/json
get
GET /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderUid": "text"
}

Update delivery provider details

put

Update delivery provider details

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a delivery provider.

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

Example response

application/json
put
PUT /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "text",
  "externalId": "text"
}
200

Example response

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderUid": "text"
}

Delete an delivery provider

delete

Delete an delivery provider

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a delivery provider.

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

No Content

delete
DELETE /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content

List delivery methods for a delivery Provider

get

List delivery methods for a delivery Provider

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a delivery provider.

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

Query for the deliveryProviderMethod

Responses
200

Example response

application/json
get
GET /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "name": "text",
      "externalId": "text",
      "deliveryProviderMethodUid": "text",
      "freightProductUid": "text",
      "externalSystemMappings": [
        {
          "systemCode": "OMNIUM",
          "externalId": "text",
          "deliveryProviderMethodMappingUid": "text"
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new delivery provider method

post

Create a new delivery provider method

Required permission: TENANT.ACCESS

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a delivery provider.

Pattern: ^[A-Za-z0-9-_]+
Body
namestringRequired
externalIdstringOptional
deliveryProviderMethodUidstringOptionalPattern: ^[A-Za-z0-9-_]+
freightProductUidstringOptionalPattern: ^[A-Za-z0-9-_]*
Responses
201

Example response

application/json
post
POST /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderMethodUid": "text",
  "freightProductUid": "text"
}
201

Example response

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderUid": "text"
}

Get delivery provider method details

get

Get delivery provider method details

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a delivery provider.

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

Reference to a delivery provider method.

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

Example response

application/json
get
GET /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderMethodUid": "text",
  "freightProductUid": "text",
  "externalSystemMappings": [
    {
      "systemCode": "OMNIUM",
      "externalId": "text",
      "deliveryProviderMethodMappingUid": "text"
    }
  ]
}

Update delivery provider method details

put

Update delivery provider details

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a delivery provider.

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

Reference to a delivery provider method.

Pattern: ^[A-Za-z0-9-_]+
Body
namestringOptional
externalIdstringOptional
freightProductUidstringOptionalPattern: ^[A-Za-z0-9-_]*
Responses
200

Example response

application/json
put
PUT /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "name": "text",
  "externalId": "text",
  "freightProductUid": "text"
}
200

Example response

{
  "name": "text",
  "externalId": "text",
  "deliveryProviderMethodUid": "text",
  "freightProductUid": "text",
  "externalSystemMappings": [
    {
      "systemCode": "OMNIUM",
      "externalId": "text",
      "deliveryProviderMethodMappingUid": "text"
    }
  ]
}

Delete a delivery provider method

delete

Delete an delivery provider method

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a delivery provider.

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

Reference to a delivery provider method.

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

No Content

delete
DELETE /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content

List all mappings for a delivery provider method

get

List all mappings for a delivery provider method

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a delivery provider.

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

Reference to a delivery provider method.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
systemCodestring · enumOptional

Reference to a system code

Possible values:
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
GET /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/mappings HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "systemCode": "OMNIUM",
      "externalId": "text",
      "deliveryProviderMethodMappingUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create delivery provider method mapping

post

Create delivery provider method mapping

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a delivery provider.

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

Reference to a delivery provider method.

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

Example response

application/json
Responseall of
and
post
POST /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/mappings HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "deliveryProviderMethodMappingUid": "text",
  "externalId": "text",
  "systemCode": "OMNIUM"
}
200

Example response

{
  "systemCode": "OMNIUM",
  "externalId": "text",
  "deliveryProviderMethodMappingUid": "text"
}

Update a mapping for a delivery provider method

put

Update a mapping for a delivery provider method

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a delivery provider.

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

Reference to a delivery provider method.

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

Reference to a delivery provider method.

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

Example response

application/json
Responseall of
and
put
PUT /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/mappings/{deliveryProviderMethodMappingUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "externalId": "text"
}
200

Example response

{
  "systemCode": "OMNIUM",
  "externalId": "text",
  "deliveryProviderMethodMappingUid": "text"
}

Delete a delivery provider method mapping

delete

Delete a delivery provider method mapping

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a delivery provider.

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

Reference to a delivery provider method.

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

Reference to a delivery provider method.

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

No Content

delete
DELETE /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/mappings/{deliveryProviderMethodMappingUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "deliveryProviderMethodMappingUid": "text",
  "externalId": "text",
  "systemCode": "OMNIUM"
}
204

No Content

No content

List deliveries for an order

get

List all deliveries for a specific order

Authorizations
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
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-08-17T05:51:35.383Z",
      "createdBy": "text",
      "deliveryUid": "text",
      "lastModifiedAt": "2025-08-17T05:51:35.383Z",
      "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-08-17",
      "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"
        }
      ],
      "orderItems": [
        {
          "actions": [
            {
              "comment": "text",
              "createdAt": "2025-08-17T05:51:35.383Z",
              "createdBy": "text",
              "handlingActionUid": "text",
              "handlingActionName": "text",
              "handlingDescription": "text",
              "handlingUid": "text",
              "handlingName": "text",
              "lastModifiedAt": "2025-08-17T05:51:35.383Z",
              "lastModifiedBy": "text",
              "orderHandlingActionUid": "text"
            }
          ],
          "allowedActions": [
            "QUANTITY_SOLD"
          ],
          "createdAt": "2025-08-17T05:51:35.383Z",
          "discountReasonCode": "text",
          "externalId": "text",
          "itemCost": 1,
          "itemDiscountAmount": 1,
          "itemDiscountPercentage": 1,
          "itemGrossProfitAmount": 1,
          "itemGrossProfitPercentage": 1,
          "itemPrice": 1,
          "itemVatAmount": 1,
          "lastModifiedAt": "2025-08-17T05:51:35.383Z",
          "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",
          "allowDeliveryFromDate": "2025-08-17T05:51:35.383Z",
          "reservationType": "NONE",
          "reservationDetails": {
            "warehouse": {
              "warehouseName": "text"
            },
            "purchaseOrder": {
              "purchaseOrderUid": "text",
              "purchaseOrderItemUid": "text",
              "expectedDeliveryDate": "2025-08-17T05:51:35.383Z",
              "purchaseOrderNumber": "text",
              "quantityOrdered": 1
            }
          }
        }
      ],
      "freightOrderItemUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new delivery for an order

post

Create a new delivery for an order

Authorizations
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
deliveryCustomerAddressUidstringOptionalPattern: ^[A-Za-z0-9-_]+
deliveryAddressall ofOptional
deliveryStatestring · enumOptional

Remark! The NOT_DELIVERED state is deprecated.

Possible values:
deliveryDatestring · date | nullableOptional
externalDeliveryReferencestringOptional
notestringOptional
trackingNumberstringOptional
deliveryProviderUidstringOptionalPattern: ^[A-Za-z0-9-_]+
deliveryProviderMethodUidstringOptionalPattern: ^[A-Za-z0-9-_]+
warehouseUidstringOptionalPattern: ^[A-Za-z0-9-_]+
deliveryUidstringOptionalPattern: ^[A-Za-z0-9-_]+
Responses
201

Example response

application/json
post
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: 458

{
  "deliveryCustomerAddressUid": "text",
  "deliveryAddress": {
    "address": "text",
    "city": "text",
    "companyName": "text",
    "countryCode": "text",
    "email": "text",
    "mobile": "text",
    "firstname": "text",
    "lastname": "text",
    "postalCode": "text"
  },
  "deliveryState": "NOT_DELIVERED",
  "deliveryDate": "2025-08-17",
  "externalDeliveryReference": "text",
  "note": "text",
  "trackingNumber": "text",
  "deliveryProviderUid": "text",
  "deliveryProviderMethodUid": "text",
  "warehouseUid": "text",
  "deliveryUid": "text"
}
201

Example response

{
  "createdAt": "2025-08-17T05:51:35.383Z",
  "createdBy": "text",
  "deliveryUid": "text",
  "lastModifiedAt": "2025-08-17T05:51:35.383Z",
  "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-08-17",
  "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"
    }
  ],
  "orderItems": [
    {
      "actions": [
        {
          "comment": "text",
          "createdAt": "2025-08-17T05:51:35.383Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2025-08-17T05:51:35.383Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2025-08-17T05:51:35.383Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2025-08-17T05:51:35.383Z",
      "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",
      "allowDeliveryFromDate": "2025-08-17T05:51:35.383Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2025-08-17T05:51:35.383Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1
        }
      }
    }
  ],
  "freightOrderItemUid": "text"
}

Fetch delivery sources for an order

post

Fetch delivery sources for an order

Authorizations
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
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

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
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
Responses
200

Example response

application/json
post
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-08-17T05:51:35.383Z",
  "toDateTime": "2025-08-17T05:51:35.383Z",
  "deliveryStates": [
    "NOT_DELIVERED"
  ],
  "storeUids": [
    "text"
  ],
  "query": "text",
  "deliveryProviders": [
    {
      "uid": "text",
      "deliveryProviderMethodUids": [
        "text"
      ]
    }
  ],
  "orderSettleStates": [
    "NOT_STARTED"
  ],
  "orderOrderStates": [
    "OPEN"
  ]
}
200

Example response

{
  "items": [
    {
      "createdAt": "2025-08-17T05:51:35.383Z",
      "createdBy": "text",
      "deliveryUid": "text",
      "lastModifiedAt": "2025-08-17T05:51:35.383Z",
      "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-08-17",
      "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-08-17T05:51:35.383Z",
                "createdBy": "text",
                "handlingActionUid": "text",
                "handlingActionName": "text",
                "handlingDescription": "text",
                "handlingUid": "text",
                "handlingName": "text",
                "lastModifiedAt": "2025-08-17T05:51:35.383Z",
                "lastModifiedBy": "text",
                "orderHandlingActionUid": "text"
              }
            ],
            "allowedActions": [
              "QUANTITY_SOLD"
            ],
            "createdAt": "2025-08-17T05:51:35.383Z",
            "discountReasonCode": "text",
            "externalId": "text",
            "itemCost": 1,
            "itemDiscountAmount": 1,
            "itemDiscountPercentage": 1,
            "itemGrossProfitAmount": 1,
            "itemGrossProfitPercentage": 1,
            "itemPrice": 1,
            "itemVatAmount": 1,
            "lastModifiedAt": "2025-08-17T05:51:35.383Z",
            "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",
            "allowDeliveryFromDate": "2025-08-17T05:51:35.383Z",
            "reservationType": "NONE",
            "reservationDetails": {
              "warehouse": {
                "warehouseName": "text"
              },
              "purchaseOrder": {
                "purchaseOrderUid": "text",
                "purchaseOrderItemUid": "text",
                "expectedDeliveryDate": "2025-08-17T05:51:35.383Z",
                "purchaseOrderNumber": "text",
                "quantityOrdered": 1
              }
            }
          }
        ]
      }
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get order delivery information

get

Get information, like signature, about a specific delivery

Authorizations
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
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-08-17T05:51:35.383Z",
  "createdBy": "text",
  "deliveryUid": "text",
  "lastModifiedAt": "2025-08-17T05:51:35.383Z",
  "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-08-17",
  "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"
    }
  ],
  "orderItems": [
    {
      "actions": [
        {
          "comment": "text",
          "createdAt": "2025-08-17T05:51:35.383Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2025-08-17T05:51:35.383Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2025-08-17T05:51:35.383Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2025-08-17T05:51:35.383Z",
      "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",
      "allowDeliveryFromDate": "2025-08-17T05:51:35.383Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2025-08-17T05:51:35.383Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1
        }
      }
    }
  ],
  "freightOrderItemUid": "text"
}

Update delivery

put

Update a delivery with signature

Authorizations
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

deliveryCustomerAddressUidstringOptionalPattern: ^[A-Za-z0-9-_]+
deliveryAddressall ofOptional
deliveryStatestring · enumOptional

Remark! The NOT_DELIVERED state is deprecated.

Possible values:
deliveryDatestring · date | nullableOptional
externalDeliveryReferencestringOptional
notestringOptional
trackingNumberstringOptional
deliveryProviderUidstringOptionalPattern: ^[A-Za-z0-9-_]*
deliveryProviderMethodUidstringOptionalPattern: ^[A-Za-z0-9-_]*
warehouseUidstringOptionalPattern: ^[A-Za-z0-9-_]*
Responses
200

Example response

application/json
put
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: 456

{
  "signature": "text",
  "deliveryCustomerAddressUid": "text",
  "deliveryAddress": {
    "address": "text",
    "city": "text",
    "companyName": "text",
    "countryCode": "text",
    "email": "text",
    "mobile": "text",
    "firstname": "text",
    "lastname": "text",
    "postalCode": "text"
  },
  "deliveryState": "NOT_DELIVERED",
  "deliveryDate": "2025-08-17",
  "externalDeliveryReference": "text",
  "note": "text",
  "trackingNumber": "text",
  "deliveryProviderUid": "text",
  "deliveryProviderMethodUid": "text",
  "warehouseUid": "text"
}
200

Example response

{
  "createdAt": "2025-08-17T05:51:35.383Z",
  "createdBy": "text",
  "deliveryUid": "text",
  "lastModifiedAt": "2025-08-17T05:51:35.383Z",
  "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-08-17",
  "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"
    }
  ],
  "orderItems": [
    {
      "actions": [
        {
          "comment": "text",
          "createdAt": "2025-08-17T05:51:35.383Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2025-08-17T05:51:35.383Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2025-08-17T05:51:35.383Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2025-08-17T05:51:35.383Z",
      "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",
      "allowDeliveryFromDate": "2025-08-17T05:51:35.383Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2025-08-17T05:51:35.383Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1
        }
      }
    }
  ],
  "freightOrderItemUid": "text"
}

Delete order delivery

delete

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

Authorizations
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
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

Deliver on an orderitem.

Authorizations
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
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-08-17T05:51:35.383Z",
  "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-08-17T05:51:35.383Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2025-08-17T05:51:35.383Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2025-08-17T05:51:35.383Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2025-08-17T05:51:35.383Z",
      "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",
      "allowDeliveryFromDate": "2025-08-17T05:51:35.383Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2025-08-17T05:51:35.383Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1
        }
      }
    }
  ],
  "lastModifiedAt": "2025-08-17T05:51:35.383Z",
  "note": "text",
  "orderUid": "text",
  "orderNumber": "text",
  "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-08-17T05:51:35.383Z",
      "createdBy": "text",
      "description": "text",
      "handlingUid": "text",
      "lastModifiedAt": "2025-08-17T05:51:35.383Z",
      "lastModifiedBy": "text",
      "name": "text",
      "orderHandlingUid": "text",
      "state": "NOT_STARTED"
    }
  ],
  "settleState": "NOT_STARTED",
  "settledAt": "2025-08-17T05:51:35.383Z",
  "settlementTotals": {
    "change": 1,
    "remaining": 1,
    "remainingRounded": 1,
    "totals": 1,
    "remainingPrePayment": 1
  },
  "settlements": [
    {
      "amount": 1,
      "createdAt": "2025-08-17T05:51:35.383Z",
      "displayMessages": [
        {
          "key": "text",
          "message": "text",
          "timestamp": "2025-08-17T05:51:35.383Z"
        }
      ],
      "externalId": "text",
      "externalPaymentReference": "text",
      "idMethod": "NO_CVM_RULE_PERFORMED",
      "lastModifiedAt": "2025-08-17T05:51:35.383Z",
      "ledgerNumber": "text",
      "ledgerType": "LEDGER",
      "parameters": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "settledAt": "2025-08-17T05:51:35.383Z",
      "settlementCode": "text",
      "settlementUid": "text",
      "settlementName": "text",
      "state": "NOT_STARTED",
      "status": "NEW",
      "storeSettlementIssuerUid": "text",
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "storePaymentMethodUid": "text",
      "currency": {
        "amount": 1,
        "code": "text",
        "exchangeRate": 1
      },
      "additionalDetails": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "paymentCount": 1,
      "paymentAmount": 1,
      "orderReceiptUid": "text"
    }
  ],
  "storeUid": "text",
  "storeName": "text",
  "systemOrigin": "text",
  "tenantUserDisplayName": "text",
  "tenantUserUid": "text",
  "tillUid": "text",
  "type": "OFFER",
  "validUntil": "2025-08-17T05:51:35.383Z",
  "vatFree": true,
  "vatPrint": "SUM",
  "voucherNumber": "text",
  "deliveryDate": "2025-08-17",
  "discounts": [
    {
      "orderDiscountUid": "text",
      "discountCode": "text",
      "type": "PERCENTAGE",
      "amount": 1,
      "name": "text",
      "origin": "LOYALTY",
      "validTo": "2025-08-17T05:51:35.383Z",
      "maxUsage": 1,
      "productSkus": [
        "text"
      ],
      "orderItemUids": [
        "text"
      ],
      "externalTransactionId": "text",
      "scope": "WHOLE_ORDER",
      "discountReasonCode": "text",
      "createdAt": "2025-08-17T05:51:35.383Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-08-17T05:51:35.383Z",
      "lastModifiedBy": "text",
      "campaignUid": "text"
    }
  ],
  "compensationReasonUid": "text",
  "lastModifiedBy": "text"
}

Download packing list for a delivery

get

Print packing list for an order delivery.

Authorizations
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
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

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.

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

Download picking list for several deliveries

post

Download picking list for several deliveries

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

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

post
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

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.

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

Fetch options for a delivery site

post

Fetch options for a delivery site

Authorizations
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
deliveringSitestringRequired
startDatestring · dateRequired
endDatestring · dateRequired
deliveryProductUidstringOptionalPattern: ^[A-Za-z0-9-_]+
Responses
200

Example response

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

{
  "deliveringSite": "text",
  "startDate": "2025-08-17",
  "endDate": "2025-08-17",
  "deliveryProductUid": "text"
}
200

Example response

{
  "deliveryOptions": {
    "deliveryOption": [
      {
        "deliveryProductId": "text",
        "specialProcInd": "text",
        "pickup": {
          "pickupPlace": [
            {
              "pickupPointType": "text",
              "pickupPointId": "text",
              "displayName": "text",
              "latitude": "text",
              "longitude": "text",
              "visitingAddress": {
                "streetName": "text",
                "houseId": "text",
                "postalCode": "text",
                "city": "text",
                "countryCode": "text",
                "descriptipon": "text"
              }
            }
          ]
        },
        "homeDelivery": {
          "arrivalDateTime": [
            {
              "date": "2025-08-17",
              "startTime": "05:51:35",
              "endTime": "05:51:35",
              "currencyCode": "text",
              "price": 1
            }
          ]
        },
        "parcelDelivery": [
          {
            "shippingDate": "2025-08-17",
            "currencyCode": "text",
            "price": 1
          }
        ]
      }
    ]
  }
}

Was this helpful?