All pages
Powered by GitBook
1 of 1

Supplier

Supplier

List suppliers

get

List all suppliers.

Authorizations
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
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-07-11T22:29:19.135Z",
      "email": "text",
      "externalId": "text",
      "lastModifiedAt": "2025-07-11T22:29:19.135Z",
      "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

post

Create a new supplier.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
all ofOptional
and
Responses
200
Example response
application/json
post
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"
}
200

Example response

{
  "address": "text",
  "city": "text",
  "contactEmail": "text",
  "contactName": "text",
  "countryCode": "text",
  "createdAt": "2025-07-11T22:29:19.135Z",
  "email": "text",
  "externalId": "text",
  "lastModifiedAt": "2025-07-11T22:29:19.135Z",
  "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 supplier details

get

Get details for a supplier.

Authorizations
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
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-07-11T22:29:19.135Z",
  "email": "text",
  "externalId": "text",
  "lastModifiedAt": "2025-07-11T22:29:19.135Z",
  "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 supplier details

put

Update details for a supplier. Partial updates are allowed.

Authorizations
Path parameters
supplierUidstringRequired

Reference to a Supplier.

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

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
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

Responses
200
Example response
application/json
put
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"
}
200

Example response

{
  "address": "text",
  "city": "text",
  "contactEmail": "text",
  "contactName": "text",
  "countryCode": "text",
  "createdAt": "2025-07-11T22:29:19.135Z",
  "email": "text",
  "externalId": "text",
  "lastModifiedAt": "2025-07-11T22:29:19.135Z",
  "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"
}

Delete a supplier

delete

Deletes a supplier.

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

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

Authorizations
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
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-07-11T22:29:19.135Z",
      "lastModifiedAt": "2025-07-11T22:29:19.135Z",
      "productUid": "text",
      "supplierUid": "text",
      "purchasePrice": 1,
      "supplierProductUid": "text",
      "supplierSku": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new supplier product

post

Create a new supplier product.

Authorizations
Path parameters
supplierUidstringRequired

Reference to a Supplier.

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

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
supplierProductUidstringOptionalPattern: ^[A-Za-z0-9-_]+
productUidstringRequiredPattern: ^[A-Za-z0-9-_]+
purchasePriceintegerRequired
supplierSkustringOptional
Responses
200
Example response
application/json
post
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-07-11T22:29:19.135Z",
  "lastModifiedAt": "2025-07-11T22:29:19.135Z",
  "productUid": "text",
  "supplierUid": "text",
  "purchasePrice": 1,
  "supplierProductUid": "text",
  "supplierSku": "text"
}

Get supplier product details

get

Get details for a supplier product.

Authorizations
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
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-07-11T22:29:19.135Z",
  "lastModifiedAt": "2025-07-11T22:29:19.135Z",
  "productUid": "text",
  "supplierUid": "text",
  "purchasePrice": 1,
  "supplierProductUid": "text",
  "supplierSku": "text"
}

Update supplier product

put

Update details for a supplier product.

Authorizations
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
purchasePriceintegerOptional
supplierSkustringOptional
Responses
200
Example response
application/json
put
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-07-11T22:29:19.135Z",
  "lastModifiedAt": "2025-07-11T22:29:19.135Z",
  "productUid": "text",
  "supplierUid": "text",
  "purchasePrice": 1,
  "supplierProductUid": "text",
  "supplierSku": "text"
}

Delete supplier product

delete

Delete a supplier product.

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

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
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
commissionUidsstring[]Required
paidbooleanRequired
paidAtstring · date-timeOptional

default is now

Responses
204
No Content
put
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-07-11T22:29:19.135Z"
}
204

No Content

No content