Order
Order
Get order by order uid
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Example response
GET /v2/tenants/{tenantUid}/orders/{orderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
List all orders.
The query parameter orderStatus
can not be used in combination with orderOrderState
, orderSettleState
or orderDeliveryState
.
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
External reference to a orderUid.
External reference to a voucher id.
Reference to a Customer uid.
^[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 |
Reference to a handling uid.
Filter by settled at from a specific date
Filter by settled at to a specific date
Filter by created at from a specific date
Filter by created at to a specific date
Reference to a till uid.
^[A-Za-z0-9-_]+
Reference to a tenantUserUid.
Example response
GET /v2/tenants/{tenantUid}/stores/{storeUid}/orders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}
Create a new order.
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 742
{
"customerAddress": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"email": "text",
"mobile": "text",
"firstname": "text",
"lastname": "text",
"postalCode": "text",
"vatNumber": "text"
},
"customerUid": "text",
"customerContactUid": "text",
"deviceIdentifier": "text",
"externalOrderNumber": "text",
"externalVoucherNumber": "text",
"invoiceCustomerAddressUid": "text",
"invoiceAddress": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"email": "text",
"mobile": "text",
"firstname": "text",
"lastname": "text",
"postalCode": "text",
"vatNumber": "text"
},
"note": "text",
"type": "OFFER",
"validUntil": "2025-08-17T05:26:54.591Z",
"vatFree": true,
"vatPrint": "SUM",
"orderUid": "text",
"systemOrigin": "text",
"compensationReasonUid": "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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
Import new order from extern source. Complete order with lines and possibly settlements. sellerDisplayName can be set if an integrationToken is used. If no integrationToken and sellerDisplayName is set, an error is returned.
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
Schema for creating a complete order in one request.
^[A-Za-z0-9-_]*
^[A-Za-z0-9-_]*
ENUM | Description |
---|---|
SUM | Print as a part of orderlines. |
SEPARATE | Print as a separate field. |
^[A-Za-z0-9-_]+
Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/import HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1967
{
"createdAt": "2025-08-17T05:26:54.591Z",
"customerAddress": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"email": "text",
"mobile": "text",
"firstname": "text",
"lastname": "text",
"postalCode": "text",
"vatNumber": "text"
},
"customerUid": "text",
"customerContactUid": "text",
"externalOrderNumber": "text",
"externalVoucherNumber": "text",
"invoiceAddress": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"email": "text",
"mobile": "text",
"firstname": "text",
"lastname": "text",
"postalCode": "text",
"vatNumber": "text"
},
"items": [
{
"discountReasonCode": "text",
"externalId": "text",
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemPrice": 1,
"note": "text",
"orderItemLink": {
"linkType": "CREDIT",
"orderItemUid": "text"
},
"productUid": "text",
"properties": [
{
"key": "text",
"value": "text"
}
],
"quantityOrdered": 1,
"deliveryUid": "text",
"returnReasonCode": "text",
"serialnumber": "text",
"sku": "text",
"warehouseUid": "text",
"purchaseOrderItemUid": "text",
"orderItemUid": "text",
"reservationType": "NONE",
"sortOrder": 1
}
],
"note": "text",
"orderTotals": {
"grandTotal": 1,
"totalDiscount": 1,
"totalVat": 1
},
"settlements": [
{
"amount": 1,
"externalId": "text",
"externalPaymentReference": "text",
"settlementUid": "text",
"settledAt": "2025-08-17T05:26:54.591Z",
"storePaymentMethodUid": "text",
"parameters": [
{
"key": "text",
"value": "text"
}
]
}
],
"type": "OFFER",
"systemOrigin": "text",
"validUntil": "2025-08-17T05:26:54.591Z",
"vatFree": true,
"vatPrint": "SUM",
"orderUid": "text",
"tenantUserDisplayName": "text",
"handlingUids": [
"text"
],
"orderDeliveries": [
{
"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-17T05:26:54.591Z",
"externalDeliveryReference": "text",
"trackingNumber": "text",
"deliveryProviderUid": "text",
"deliveryProviderMethodUid": "text",
"signature": "text",
"warehouseUid": "text",
"deliveryUid": "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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
The field orderStatuses
can not be used in combination with orderStates
, settleStates
or deliveryStates
.
Reference to a Store.
^[A-Za-z0-9-_]+
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 |
Search for orders.
Only one of the keys in the search object will be used in a search.
If more than one key is supplied the keys will be used in the priorty of how they appear in the object. Example: query will be used first if it is supplied, if it is not supplied the customer key will be used, and so on.
An empty string will be ignored, and handeled as if the key did not exist in the payload.
Fuzzy search means that it will try to find words that contains the query string that is supplied. Example: If you search for "Ol" you will get "Olsen", "Olstad", "Bolset", "Ormebol", etc ..
Search for orders containting this customer. The customer can be specific by firstname, lastname, phonenumber or email. This is a fuzzy search.
^[A-Za-z0-9-_]+
Search for an order with a specific ordernumber. This is an exact lookup
Search for orders containing the product. This must be a SKU and is an exact lookup.
General query string. Use to search for orders where the server decided the query conditions. This is a fuzzy search.
Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 724
{
"customerQuery": "text",
"customerUid": "text",
"fromDateTime": "2025-08-17T05:26:54.591Z",
"createdAtFrom": "2025-08-17T05:26:54.591Z",
"settledAtFrom": "2025-08-17T05:26:54.591Z",
"lastModifiedAtFrom": "2025-08-17T05:26:54.591Z",
"orderNumber": "text",
"productSku": "text",
"query": "text",
"toDateTime": "2025-08-17T05:26:54.591Z",
"createdAtTo": "2025-08-17T05:26:54.591Z",
"settledAtTo": "2025-08-17T05:26:54.591Z",
"lastModifiedAtTo": "2025-08-17T05:26:54.591Z",
"tenantUserUids": [
"text"
],
"orderHandlingStates": [
"NOT_STARTED"
],
"orderHandlingUids": [
"text"
],
"orderStates": [
"OPEN"
],
"settleStates": [
"NOT_STARTED"
],
"deliveryStates": [
"NOT_STARTED"
],
"orderStatuses": [
"OPEN"
],
"orderTypes": [
"OFFER"
],
"productUids": [
"text"
],
"reservationTypes": [
"NONE"
]
}
Example response
{
"items": [
{
"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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}
Set reservationType on order items to be reserved on a warehouse or a purchaseorder.
Reference to a tenant.
^[A-Za-z0-9-_]+
The uid must be warehouseUid if the reservationType is WAREHOUSE
and purchaseOrderItemUid if it is PURCHASEORDER
^[A-Za-z0-9-_]+
No Content
POST /v2/tenants/{tenantUid}/orders/reservations HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"uid": "text",
"reservationType": "WAREHOUSE",
"orders": [
{
"orderUid": "text",
"orderItemUid": "text"
}
]
}
No Content
No content
Optionally narrow down the search to order in given stores and organizatons.
The field orderStatuses
can not be used in combination with the fields orderStates
, settleStates
or deliveryStates
.
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 |
Search for orders in all stores on tenant.
An empty string will be ignored, and handled as if the key did not exist in the payload.
Fuzzy search means that it will try to find words that contains the query string that is supplied. The search is case-insensitive. Example: If you search for "Ol" you will get "Olsen", "Olstad", "Bolset", "Ormebol", [email protected], etc ..
Search for orders containting this customer. The customer can be specific by firstname, lastname, phonenumber or email. This is a fuzzy search.
^[A-Za-z0-9-_]+
Search for an order with a specific ordernumber. This is an exact lookup
Search for an order with a specific externalOrderNumber. This is an exact lookup
Search for an order with a specific externalVouchermber. This is an exact lookup
Search for orders containing the product. This must be a SKU and is an exact lookup.
General fuzzy search.
Example response
POST /v2/tenants/{tenantUid}/orders/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 783
{
"storeUids": [
"text"
],
"organizationUids": [
"text"
],
"customerQuery": "text",
"customerUid": "text",
"createdAtFrom": "2025-08-17T05:26:54.591Z",
"settledAtFrom": "2025-08-17T05:26:54.591Z",
"lastModifiedAtFrom": "2025-08-17T05:26:54.591Z",
"orderNumber": "text",
"externalOrderNumber": "text",
"externalVoucherNumber": "text",
"productSku": "text",
"createdAtTo": "2025-08-17T05:26:54.591Z",
"settledAtTo": "2025-08-17T05:26:54.591Z",
"lastModifiedAtTo": "2025-08-17T05:26:54.591Z",
"tenantUserUids": [
"text"
],
"orderStates": [
"OPEN"
],
"settleStates": [
"NOT_STARTED"
],
"deliveryStates": [
"NOT_STARTED"
],
"orderStatuses": [
"OPEN"
],
"orderTypes": [
"OFFER"
],
"orderHandlingStates": [
"NOT_STARTED"
],
"orderHandlingUids": [
"text"
],
"deliverFromStoreUids": [
"text"
],
"query": "text",
"productUids": [
"text"
],
"reservationTypes": [
"NONE"
]
}
Example response
{
"items": [
{
"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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}
Get order details. This will return a complete order object.
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
Example response
GET /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
Order Operations
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
ENUM | Description |
---|---|
RECALCULATE_SETTLEMENTS | Do a sum of settlements on order and calculate the settle_state on order |
RECALCULATE_COSTPRICES | Retreive updated costprices on the order linse of an order. Can only be done when order state = PARKED |
Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"operation": "RECALCULATE_SETTLEMENTS"
}
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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
Update order details.
Order details can only be updated when orderState = OPEN and settleState != COMPLETE
Exception:
externalOrderNumber and externalVoucherNumber can be changed when orderState = COMPLETE
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
^[A-Za-z0-9-_]*
^[A-Za-z0-9-_]*
^[A-Za-z0-9-_]+
Note visible on the receipt.
ENUM | Description |
---|---|
SUM | Print as a part of orderlines. |
SEPARATE | Print as a separate field. |
Example response
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 671
{
"customerAddress": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"email": "text",
"mobile": "text",
"firstname": "text",
"lastname": "text",
"postalCode": "text",
"vatNumber": "text"
},
"customerUid": "text",
"customerContactUid": "text",
"deviceIdentifier": "text",
"externalOrderNumber": "text",
"externalVoucherNumber": "text",
"invoiceCustomerAddressUid": "text",
"invoiceAddress": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"email": "text",
"mobile": "text",
"firstname": "text",
"lastname": "text",
"postalCode": "text",
"vatNumber": "text"
},
"note": "text",
"type": "OFFER",
"validUntil": "2025-08-17T05:26:54.591Z",
"vatFree": true,
"vatPrint": "SUM"
}
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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
Delete an order.
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
No Content
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Creates a new item on 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-_]+
External reference to order line
Used to calculate itemDiscountAmount.
^[A-Za-z0-9-_]+
Set this to true to only resevere the stock from the warehouse when the order is settled.
false
^[A-Za-z0-9-_]+
Product SKU
^[A-Za-z0-9-_]*
^[A-Za-z0-9-_]*
^[A-Za-z0-9-_]*
Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 467
{
"discountReasonCode": "text",
"externalId": "text",
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemPrice": 1,
"note": "text",
"orderItemLink": {
"linkType": "CREDIT",
"orderItemUid": "text"
},
"productUid": "text",
"properties": [
{
"key": "text",
"value": "text"
}
],
"quantityOrdered": 1,
"deliveryUid": "text",
"returnReasonCode": "text",
"serialnumber": "text",
"sku": "text",
"warehouseUid": "text",
"purchaseOrderItemUid": "text",
"orderItemUid": "text",
"reservationType": "NONE",
"sortOrder": 1
}
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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
Get available payment methods 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
GET /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/payment-methods HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"allowCashback": true,
"allowAmount": true,
"name": "text",
"description": "text",
"parameters": [
{
"name": "text",
"description": "text",
"required": true,
"key": "text",
"keyType": "TEXT",
"regex": "text"
}
],
"paymentCode": "CASH",
"storePaymentMethodUid": "text",
"requirements": {
"requireCustomer": true,
"requireCustomerMobile": true,
"requireCustomerEmail": true,
"requireCustomerContact": true,
"requireExclusiveUse": true
},
"settlementCode": "text",
"visibility": "FEATURED",
"position": 1
}
]
}
Update details for an item on an order. Partial updates are allowed. Order item details can only be updated when order.orderState = OPEN and order.settleState != COMPLETE
Exception:
externalId can be changed when orderState = COMPLETE
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-_]+
External reference to order line
Used to calculate itemDiscountAmount.
Set this to true to only resevere the stock from the warehouse when the order is settled.
^[A-Za-z0-9-_]*
^[A-Za-z0-9-_]*
^[A-Za-z0-9-_]*
Example response
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 352
{
"discountReasonCode": "text",
"externalId": "text",
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemPrice": 1,
"note": "text",
"properties": [
{
"key": "text",
"value": "text"
}
],
"quantityOrdered": 1,
"deliveryUid": "text",
"returnReasonCode": "text",
"serialnumber": "text",
"warehouseUid": "text",
"reservationType": "NONE",
"purchaseOrderItemUid": "text",
"sortOrder": 1
}
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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
Delete an item on 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-_]+
Reference to an order item on an order.
^[A-Za-z0-9-_]+
Example response
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
List addons for order item
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-_]+
Reference to a productLinkType.
Example response
GET /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}/addons HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"productUid": "text",
"productLinkType": "INSURANCE",
"sku": "text",
"name": "text",
"price": 1,
"productType": "STOCK",
"serialNoRequired": "NO",
"allowSale": "YES",
"allowSaleDate": "2025-08-17T05:26:54.591Z"
}
]
}
Print order Content and form is decided by type. orderItemUids is omitted when type is RECEIPT
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
ENUM | Description |
---|---|
RECEIPT | Print sales receipt |
EXCHANGENOTE | Print exchange note |
GIFTCARD | Print giftcard barcode |
PICKUP | Print a pickup label/note |
The printer to send the print to
^[A-Za-z0-9-_]+
Only valid for type EXCHANGENOTE. Sets a date that the exchange note is valid until. If not set, exchangeNoteValidUntil is calculated from the store's exchangeNoteValidDays setting. Stored on all orderItemUids in request, usually only one item.
Created
Bad Request
POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/print HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101
{
"type": "RECEIPT",
"printerUid": "text",
"orderItemUids": [
"text"
],
"exchangenoteValidUntil": "2025-08-17"
}
No content
Create an order pdf. Content and form is decided by type.
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
ENUM | Description |
---|---|
RECEIPT | Make pdf file from sales receipt |
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.
Bad Request
POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/pdf HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"type": "RECEIPT"
}
{
"content": "text",
"contentType": "text",
"filename": "text"
}
Send order content by email.
Content and form is decided by type. orderItemUids is omitted when type is RECEIPT
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
Reference to a tenant.
^[A-Za-z0-9-_]+
ENUM | Description |
---|---|
RECEIPT | Send sales receipt as email |
GIFTCARD | Send giftcard as email |
Created
Bad Request
POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/email HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"type": "RECEIPT",
"email": "text",
"orderItemUids": [
"text"
]
}
No content
Set status on an order. Limited to Open and Parked.
Reference to a tenant.
^[A-Za-z0-9-_]+
Reference to a Store.
^[A-Za-z0-9-_]+
Reference to an Order.
^[A-Za-z0-9-_]+
ENUM | Description |
---|---|
OPEN | Set order in state open, to be able to edit it. |
PARKED | Set order in state parked. |
Example response
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/status HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"status": "PARKED"
}
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:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"handlingActionUid": "text",
"handlingActionName": "text",
"handlingDescription": "text",
"handlingUid": "text",
"handlingName": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"orderHandlingActionUid": "text"
}
],
"allowedActions": [
"QUANTITY_SOLD"
],
"createdAt": "2025-08-17T05:26:54.591Z",
"discountReasonCode": "text",
"externalId": "text",
"itemCost": 1,
"itemDiscountAmount": 1,
"itemDiscountPercentage": 1,
"itemGrossProfitAmount": 1,
"itemGrossProfitPercentage": 1,
"itemPrice": 1,
"itemVatAmount": 1,
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"reservationType": "NONE",
"reservationDetails": {
"warehouse": {
"warehouseName": "text"
},
"purchaseOrder": {
"purchaseOrderUid": "text",
"purchaseOrderItemUid": "text",
"expectedDeliveryDate": "2025-08-17T05:26:54.591Z",
"purchaseOrderNumber": "text",
"quantityOrdered": 1
}
}
}
],
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"createdBy": "text",
"description": "text",
"handlingUid": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"name": "text",
"orderHandlingUid": "text",
"state": "NOT_STARTED"
}
],
"settleState": "NOT_STARTED",
"settledAt": "2025-08-17T05:26:54.591Z",
"settlementTotals": {
"change": 1,
"remaining": 1,
"remainingRounded": 1,
"totals": 1,
"remainingPrePayment": 1
},
"settlements": [
{
"amount": 1,
"createdAt": "2025-08-17T05:26:54.591Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-08-17T05:26:54.591Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-08-17T05:26:54.591Z",
"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:26:54.591Z",
"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:26:54.591Z",
"maxUsage": 1,
"productSkus": [
"text"
],
"orderItemUids": [
"text"
],
"externalTransactionId": "text",
"scope": "WHOLE_ORDER",
"discountReasonCode": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"createdBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"campaignUid": "text"
}
],
"compensationReasonUid": "text",
"lastModifiedBy": "text"
}
List additional notes, or comments, on orders.
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}/additional-notes HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"orderAdditionalNoteUid": "text",
"note": "text",
"tenantUserUid": "text",
"tenantUserDisplayName": "text",
"notifications": [
{
"notificationUid": "text",
"type": "EMAIL",
"state": "NOT_STARTED",
"recipient": "text"
}
]
},
{
"createdBy": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}
Create additional notes, or comments, on orders. Define wether a notification is to be sent to the customer. The notification may be on email or SMS or both.
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-_]*
Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/additional-notes HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101
{
"note": "text",
"notifications": [
{
"recipient": "text",
"type": "EMAIL"
}
],
"orderAdditionalNoteUid": "text"
}
Example response
{
"orderAdditionalNoteUid": "text",
"note": "text",
"tenantUserUid": "text",
"tenantUserDisplayName": "text",
"notifications": [
{
"notificationUid": "text",
"type": "EMAIL",
"state": "NOT_STARTED",
"recipient": "text"
}
],
"createdBy": "text",
"createdAt": "2025-08-17T05:26:54.591Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-08-17T05:26:54.591Z"
}
Delete order additional notes
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 orderAdditionalNote
^[A-Za-z0-9-_]+
No Content
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/additional-notes/{orderAdditionalNoteUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Was this helpful?