OrderDelivery
OrderDelivery
List all delivery providers
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
ENUM | Description |
---|---|
ASC | Sort in ascending order |
DESC | Sort in descending order |
Query for the deliveryProvider
Example response
GET /v2/tenants/{tenantUid}/delivery-providers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"name": "text",
"externalId": "text",
"deliveryProviderUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}
Create a new delivery provider
Required permission: TENANT.ACCESS
Reference to a tenant.
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]+
Example response
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"
}
Example response
{
"name": "text",
"externalId": "text",
"deliveryProviderUid": "text"
}
Get delivery provider details
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a delivery provider.
^[A-Za-z0-9-_]+
Example response
GET /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"name": "text",
"externalId": "text",
"deliveryProviderUid": "text"
}
Update delivery provider details
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a delivery provider.
^[A-Za-z0-9-_]+
Example response
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"
}
Example response
{
"name": "text",
"externalId": "text",
"deliveryProviderUid": "text"
}
Delete an delivery provider
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a delivery provider.
^[A-Za-z0-9-_]+
No Content
DELETE /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
List delivery methods for a delivery Provider
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a delivery provider.
^[A-Za-z0-9-_]+
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
ENUM | Description |
---|---|
ASC | Sort in ascending order |
DESC | Sort in descending order |
Query for the deliveryProviderMethod
Example response
GET /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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
Required permission: TENANT.ACCESS
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a delivery provider.
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]*
Example response
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"
}
Example response
{
"name": "text",
"externalId": "text",
"deliveryProviderUid": "text"
}
Get delivery provider method details
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a delivery provider.
^[A-Za-z0-9-_]+
Reference to a delivery provider method.
^[A-Za-z0-9-_]+
Example response
GET /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"name": "text",
"externalId": "text",
"deliveryProviderMethodUid": "text",
"freightProductUid": "text",
"externalSystemMappings": [
{
"systemCode": "OMNIUM",
"externalId": "text",
"deliveryProviderMethodMappingUid": "text"
}
]
}
Update delivery provider details
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a delivery provider.
^[A-Za-z0-9-_]+
Reference to a delivery provider method.
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]*
Example response
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"
}
Example response
{
"name": "text",
"externalId": "text",
"deliveryProviderMethodUid": "text",
"freightProductUid": "text",
"externalSystemMappings": [
{
"systemCode": "OMNIUM",
"externalId": "text",
"deliveryProviderMethodMappingUid": "text"
}
]
}
Delete an delivery provider method
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a delivery provider.
^[A-Za-z0-9-_]+
Reference to a delivery provider method.
^[A-Za-z0-9-_]+
No Content
DELETE /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
List all mappings for a delivery provider method
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a delivery provider.
^[A-Za-z0-9-_]+
Reference to a delivery provider method.
^[A-Za-z0-9-_]+
Reference to a system code
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
ENUM | Description |
---|---|
ASC | Sort in ascending order |
DESC | Sort in descending order |
Example response
GET /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/mappings HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"systemCode": "OMNIUM",
"externalId": "text",
"deliveryProviderMethodMappingUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}
Create delivery provider method mapping
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a delivery provider.
^[A-Za-z0-9-_]+
Reference to a delivery provider method.
^[A-Za-z0-9-_]+
Example response
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"
}
Example response
{
"systemCode": "OMNIUM",
"externalId": "text",
"deliveryProviderMethodMappingUid": "text"
}
Update a mapping for a delivery provider method
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a delivery provider.
^[A-Za-z0-9-_]+
Reference to a delivery provider method.
^[A-Za-z0-9-_]+
Reference to a delivery provider method.
^[A-Za-z0-9-_]+
Example response
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"
}
Example response
{
"systemCode": "OMNIUM",
"externalId": "text",
"deliveryProviderMethodMappingUid": "text"
}
Delete a delivery provider method mapping
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a delivery provider.
^[A-Za-z0-9-_]+
Reference to a delivery provider method.
^[A-Za-z0-9-_]+
Reference to a delivery provider method.
^[A-Za-z0-9-_]+
No Content
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"
}
No Content
No content
List all deliveries for a specific order
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
ENUM | Description |
---|---|
ASC | Sort in ascending order |
DESC | Sort in descending order |
Example response
GET /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]+
Remark! The NOT_DELIVERED state is deprecated.
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]+
Example response
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"
}
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
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Example response
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"
]
}
Example response
{
"items": [
{
"productUid": "text",
"sourceId": "text"
}
]
}
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.
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
ENUM | Description |
---|---|
ASC | Sort in ascending order |
DESC | Sort in descending order |
Example response
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"
]
}
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 information, like signature, about a specific delivery
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a delivery
^[A-Za-z0-9-_]+
Example response
GET /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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 a delivery with signature
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a delivery
^[A-Za-z0-9-_]+
base64 encoded png formatted binary data
^[A-Za-z0-9-_]+
Remark! The NOT_DELIVERED state is deprecated.
^[A-Za-z0-9-_]*
^[A-Za-z0-9-_]*
^[A-Za-z0-9-_]*
Example response
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"
}
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 an order delivery. Note that this can only be done while the delivery state is "not delivered".
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a delivery
^[A-Za-z0-9-_]+
No Content
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Deliver on an orderitem.
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to an order item on an order.
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]+
Example response
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"
}
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"
}
Print packing list for an order delivery.
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a delivery
^[A-Za-z0-9-_]+
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 /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/deliveries/{deliveryUid}/download HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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
Reference to a tenant.
^[A-Za-z0-9-_]+
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 /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"
]
}
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
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a delivery
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]+
Example response
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"
}
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?