Supplier
Supplier
List all suppliers.
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+External id of a supplier.
Reference to the name of a supplier.
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}/suppliers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"address": "text",
"city": "text",
"contactEmail": "text",
"contactName": "text",
"countryCode": "text",
"createdAt": "2025-11-13T02:36:34.445Z",
"email": "text",
"externalId": "text",
"lastModifiedAt": "2025-11-13T02:36:34.445Z",
"name": "text",
"phone": "text",
"postalCode": "text",
"supplierUid": "text",
"vatNumber": "text",
"active": true,
"bankInfo": {
"accountNumber": "text",
"bankName": "text",
"iban": "text",
"swift": "text"
},
"fixedDiscountRate": 1,
"currency": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new supplier.
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/suppliers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 357
{
"address": "text",
"city": "text",
"contactEmail": "text",
"contactName": "text",
"countryCode": "text",
"email": "text",
"externalId": "text",
"name": "text",
"phone": "text",
"postalCode": "text",
"vatNumber": "text",
"active": true,
"bankInfo": {
"accountNumber": "text",
"bankName": "text",
"iban": "text",
"swift": "text"
},
"fixedDiscountRate": 1,
"currency": "text",
"supplierUid": "text"
}Example response
{
"address": "text",
"city": "text",
"contactEmail": "text",
"contactName": "text",
"countryCode": "text",
"createdAt": "2025-11-13T02:36:34.445Z",
"email": "text",
"externalId": "text",
"lastModifiedAt": "2025-11-13T02:36:34.445Z",
"name": "text",
"phone": "text",
"postalCode": "text",
"supplierUid": "text",
"vatNumber": "text",
"active": true,
"bankInfo": {
"accountNumber": "text",
"bankName": "text",
"iban": "text",
"swift": "text"
},
"fixedDiscountRate": 1,
"currency": "text"
}Get details for a supplier.
Accesstoken recevied after user login with a deviceToken
Reference to a Supplier.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
GET /v2/tenants/{tenantUid}/suppliers/{supplierUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"address": "text",
"city": "text",
"contactEmail": "text",
"contactName": "text",
"countryCode": "text",
"createdAt": "2025-11-13T02:36:34.445Z",
"email": "text",
"externalId": "text",
"lastModifiedAt": "2025-11-13T02:36:34.445Z",
"name": "text",
"phone": "text",
"postalCode": "text",
"supplierUid": "text",
"vatNumber": "text",
"active": true,
"bankInfo": {
"accountNumber": "text",
"bankName": "text",
"iban": "text",
"swift": "text"
},
"fixedDiscountRate": 1,
"currency": "text"
}Update details for a supplier. Partial updates are allowed.
Accesstoken recevied after user login with a deviceToken
Reference to a Supplier.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+VAT identification number for value added tax reporting purposes.
ISO 4217 code
Example response
PUT /v2/tenants/{tenantUid}/suppliers/{supplierUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 336
{
"address": "text",
"city": "text",
"contactEmail": "text",
"contactName": "text",
"countryCode": "text",
"email": "text",
"externalId": "text",
"name": "text",
"phone": "text",
"postalCode": "text",
"vatNumber": "text",
"active": true,
"bankInfo": {
"accountNumber": "text",
"bankName": "text",
"iban": "text",
"swift": "text"
},
"fixedDiscountRate": 1,
"currency": "text"
}Example response
{
"address": "text",
"city": "text",
"contactEmail": "text",
"contactName": "text",
"countryCode": "text",
"createdAt": "2025-11-13T02:36:34.445Z",
"email": "text",
"externalId": "text",
"lastModifiedAt": "2025-11-13T02:36:34.445Z",
"name": "text",
"phone": "text",
"postalCode": "text",
"supplierUid": "text",
"vatNumber": "text",
"active": true,
"bankInfo": {
"accountNumber": "text",
"bankName": "text",
"iban": "text",
"swift": "text"
},
"fixedDiscountRate": 1,
"currency": "text"
}Deletes a supplier.
Accesstoken recevied after user login with a deviceToken
Reference to a Supplier.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+No Content
DELETE /v2/tenants/{tenantUid}/suppliers/{supplierUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Lists all supplier products for a supplier. If the product has been linked to a tenant productUid then additional information will be added.
Accesstoken recevied after user login with a deviceToken
Reference to a Supplier.
^[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 a product from the specific supplier
Example response
GET /v2/tenants/{tenantUid}/suppliers/{supplierUid}/products HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"createdAt": "2025-11-13T02:36:34.445Z",
"lastModifiedAt": "2025-11-13T02:36:34.445Z",
"productUid": "text",
"supplierUid": "text",
"purchasePrice": 1,
"supplierProductUid": "text",
"supplierSku": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new supplier product.
Accesstoken recevied after user login with a deviceToken
Reference to a Supplier.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/suppliers/{supplierUid}/products HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88
{
"supplierProductUid": "text",
"productUid": "text",
"purchasePrice": 1,
"supplierSku": "text"
}Example response
{
"createdAt": "2025-11-13T02:36:34.445Z",
"lastModifiedAt": "2025-11-13T02:36:34.445Z",
"productUid": "text",
"supplierUid": "text",
"purchasePrice": 1,
"supplierProductUid": "text",
"supplierSku": "text"
}Get supplier product details
Get details for a supplier product.
Accesstoken recevied after user login with a deviceToken
Reference to a Supplier.
^[A-Za-z0-9-_]+Reference to the product of a supplier.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
GET /v2/tenants/{tenantUid}/suppliers/{supplierUid}/products/{supplierProductUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"createdAt": "2025-11-13T02:36:34.445Z",
"lastModifiedAt": "2025-11-13T02:36:34.445Z",
"productUid": "text",
"supplierUid": "text",
"purchasePrice": 1,
"supplierProductUid": "text",
"supplierSku": "text"
}Update supplier product
Update details for a supplier product.
Accesstoken recevied after user login with a deviceToken
Reference to a Supplier.
^[A-Za-z0-9-_]+Reference to the product of a supplier.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
PUT /v2/tenants/{tenantUid}/suppliers/{supplierUid}/products/{supplierProductUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"purchasePrice": 1,
"supplierSku": "text"
}Example response
{
"createdAt": "2025-11-13T02:36:34.445Z",
"lastModifiedAt": "2025-11-13T02:36:34.445Z",
"productUid": "text",
"supplierUid": "text",
"purchasePrice": 1,
"supplierProductUid": "text",
"supplierSku": "text"
}Delete supplier product
Delete a supplier product.
Accesstoken recevied after user login with a deviceToken
Reference to a Supplier.
^[A-Za-z0-9-_]+Reference to the product of a supplier.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+No Content
DELETE /v2/tenants/{tenantUid}/suppliers/{supplierUid}/products/{supplierProductUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Set suppliers' payouts for commission sales as paid.
If paid is true and paidAt is not given, today's date is set.
If paid is false paidAt is set to nil.
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+default is now
No Content
PUT /v2/tenants/{tenantUid}/suppliers/payouts HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75
{
"commissionUids": [
"text"
],
"paid": true,
"paidAt": "2025-11-13T02:36:34.445Z"
}No Content
No content
Last updated
Was this helpful?