Supplier

Supplier

List suppliers

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/suppliers

List all suppliers.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

supplierExternalIdstringOptional

External id of a supplier.

supplierNamestringOptional

Reference to the name of a supplier.

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/suppliers

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/suppliers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "address": "text",
      "city": "text",
      "contactEmail": "text",
      "contactName": "text",
      "countryCode": "text",
      "createdAt": "2025-12-15T23:57:50.464Z",
      "email": "text",
      "externalId": "text",
      "lastModifiedAt": "2025-12-15T23:57:50.464Z",
      "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",
      "freightPercentage": 1
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new supplier

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/suppliers

Create a new supplier.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

application/json

and

Responses

200

Example response

application/json

post

/tenants/{tenantUid}/suppliers

HTTPcURLJavaScriptPython

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

{
  "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",
  "freightPercentage": 1,
  "supplierUid": "text"
}

200

Example response

{
  "address": "text",
  "city": "text",
  "contactEmail": "text",
  "contactName": "text",
  "countryCode": "text",
  "createdAt": "2025-12-15T23:57:50.464Z",
  "email": "text",
  "externalId": "text",
  "lastModifiedAt": "2025-12-15T23:57:50.464Z",
  "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",
  "freightPercentage": 1
}

Get supplier details

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/suppliers/{supplierUid}

Get details for a supplier.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

supplierUidstringRequired

Reference to a Supplier.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/suppliers/{supplierUid}

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/suppliers/{supplierUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "address": "text",
  "city": "text",
  "contactEmail": "text",
  "contactName": "text",
  "countryCode": "text",
  "createdAt": "2025-12-15T23:57:50.464Z",
  "email": "text",
  "externalId": "text",
  "lastModifiedAt": "2025-12-15T23:57:50.464Z",
  "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",
  "freightPercentage": 1
}

Update supplier details

put

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/suppliers/{supplierUid}

Update details for a supplier. Partial updates are allowed.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

supplierUidstringRequired

Reference to a Supplier.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

application/json

addressstringOptional

citystringOptional

contactEmailstringOptional

contactNamestringOptional

countryCodestringOptional

emailstringOptional

externalIdstringOptional

namestringOptional

phonestringOptional

postalCodestringOptional

vatNumberstringOptional

VAT identification number for value added tax reporting purposes.

activebooleanOptional

fixedDiscountRateintegerOptional

currencystringOptional

ISO 4217 code

freightPercentageintegerOptional

Responses

200

Example response

application/json

put

/tenants/{tenantUid}/suppliers/{supplierUid}

HTTPcURLJavaScriptPython

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

{
  "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",
  "freightPercentage": 1
}

200

Example response

{
  "address": "text",
  "city": "text",
  "contactEmail": "text",
  "contactName": "text",
  "countryCode": "text",
  "createdAt": "2025-12-15T23:57:50.464Z",
  "email": "text",
  "externalId": "text",
  "lastModifiedAt": "2025-12-15T23:57:50.464Z",
  "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",
  "freightPercentage": 1
}

Delete a supplier

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/suppliers/{supplierUid}

Deletes a supplier.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

supplierUidstringRequired

Reference to a Supplier.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

204

No Content

delete

/tenants/{tenantUid}/suppliers/{supplierUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/suppliers/{supplierUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

List supplier products for supplier

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/suppliers/{supplierUid}/products

Lists all supplier products for a supplier. If the product has been linked to a tenant productUid then additional information will be added.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

supplierUidstringRequired

Reference to a Supplier.

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

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

supplierSkustringOptional

Search for a product from the specific supplier

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/suppliers/{supplierUid}/products

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/suppliers/{supplierUid}/products HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "createdAt": "2025-12-15T23:57:50.464Z",
      "lastModifiedAt": "2025-12-15T23:57:50.464Z",
      "productUid": "text",
      "supplierUid": "text",
      "purchasePrice": 1,
      "supplierProductUid": "text",
      "supplierSku": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new supplier product

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/suppliers/{supplierUid}/products

Create a new supplier product.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

supplierUidstringRequired

Reference to a Supplier.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

application/json

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

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

purchasePriceintegerRequired

supplierSkustringOptional

Responses

200

Example response

application/json

post

/tenants/{tenantUid}/suppliers/{supplierUid}/products

HTTPcURLJavaScriptPython

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"
}

200

Example response

{
  "createdAt": "2025-12-15T23:57:50.464Z",
  "lastModifiedAt": "2025-12-15T23:57:50.464Z",
  "productUid": "text",
  "supplierUid": "text",
  "purchasePrice": 1,
  "supplierProductUid": "text",
  "supplierSku": "text"
}

Get supplier product details

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/suppliers/{supplierUid}/products/{supplierProductUid}

Get details for a supplier product.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

supplierUidstringRequired

Reference to a Supplier.

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

supplierProductUidstringRequired

Reference to the product of a supplier.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/suppliers/{supplierUid}/products/{supplierProductUid}

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/suppliers/{supplierUid}/products/{supplierProductUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "createdAt": "2025-12-15T23:57:50.464Z",
  "lastModifiedAt": "2025-12-15T23:57:50.464Z",
  "productUid": "text",
  "supplierUid": "text",
  "purchasePrice": 1,
  "supplierProductUid": "text",
  "supplierSku": "text"
}

Update supplier product

put

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/suppliers/{supplierUid}/products/{supplierProductUid}

Update details for a supplier product.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

supplierUidstringRequired

Reference to a Supplier.

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

supplierProductUidstringRequired

Reference to the product of a supplier.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

application/json

purchasePriceintegerOptional

supplierSkustringOptional

Responses

200

Example response

application/json

put

/tenants/{tenantUid}/suppliers/{supplierUid}/products/{supplierProductUid}

HTTPcURLJavaScriptPython

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"
}

200

Example response

{
  "createdAt": "2025-12-15T23:57:50.464Z",
  "lastModifiedAt": "2025-12-15T23:57:50.464Z",
  "productUid": "text",
  "supplierUid": "text",
  "purchasePrice": 1,
  "supplierProductUid": "text",
  "supplierSku": "text"
}

Delete supplier product

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/suppliers/{supplierUid}/products/{supplierProductUid}

Delete a supplier product.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

supplierUidstringRequired

Reference to a Supplier.

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

supplierProductUidstringRequired

Reference to the product of a supplier.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

204

No Content

delete

/tenants/{tenantUid}/suppliers/{supplierUid}/products/{supplierProductUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/suppliers/{supplierUid}/products/{supplierProductUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Update suppliers' commission sales payouts paid date

put

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/suppliers/payouts

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.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

application/json

commissionUidsstring[]Required

paidbooleanRequired

paidAtstring · date-timeOptional

default is now

Responses

204

No Content

put

/tenants/{tenantUid}/suppliers/payouts

HTTPcURLJavaScriptPython

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-12-15T23:57:50.464Z"
}

204

No Content

No content