SOA

SOA

List SOAs

get

/tenants/{tenantUid}/soas

List all SOAs.

Required permissions: SOA

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

namestringOptional

Reference to the name of a SOA.

externalIdstringOptional

External reference to a SOA.

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}/soas

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

200

Example response

{
  "items": [
    {
      "name": "text",
      "externalId": "text",
      "soaUid": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new SOA

post

/tenants/{tenantUid}/soas

Create a new SOA.

Required permissions: SOA

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

externalIdstringOptional

namestringRequired

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

Responses

201

Example response

application/json

namestringRequired

externalIdstringRequired

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

createdAtstring · date-timeRequired

createdBystringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

post/tenants/{tenantUid}/soas

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

{
  "externalId": "text",
  "name": "text",
  "soaUid": "text"
}

201

Example response

{
  "name": "text",
  "externalId": "text",
  "soaUid": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text"
}

BATCH Create SOA amounts

post

/tenants/{tenantUid}/soas/batch

Creates amounts on a SOA.

Items in:

• create : will be created.

• update : will be updated.

• delete: will be deleted.

• upsert: will create or update if needed.

The response http status is either:

• 200: all items in request was processed successfully,

• 207: one or more item was processed with an error.

Required permissions: SOA

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

Responses

200

Response for SOAAmountBatchRequest. 200: All items in request was processed with no errors 207: One or more items in request returned an error

application/json

207

Response for SOAAmountBatchRequest. 200: All items in request was processed with no errors 207: One or more items in request returned an error

application/json

post/tenants/{tenantUid}/soas/batch

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

{
  "upsert": [
    {
      "storeUid": "text",
      "productUid": "text",
      "amount": 1,
      "fromDateTime": "2026-01-01T00:00:00.000Z",
      "toDateTime": "2026-01-01T00:00:00.000Z",
      "soaAmountUid": "text",
      "soaUid": "text"
    }
  ]
}

{
  "upsert": {
    "errors": [
      {
        "errorCode": "text",
        "message": "text",
        "productUid": "text",
        "storeUid": "text",
        "soaUid": "text",
        "soaAmountUid": "text"
      }
    ],
    "success": 1
  }
}

Get SOA details

get

/tenants/{tenantUid}/soas/{soaUid}

Get SOA details.

Required permissions: SOA

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

soaUidstringRequired

Reference to a SOA.

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

Responses

200

Example response

application/json

namestringRequired

externalIdstringRequired

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

createdAtstring · date-timeRequired

createdBystringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

get/tenants/{tenantUid}/soas/{soaUid}

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

200

Example response

{
  "name": "text",
  "externalId": "text",
  "soaUid": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text"
}

Update SOA details

put

/tenants/{tenantUid}/soas/{soaUid}

Update SO details.

Required permissions: SOA

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

soaUidstringRequired

Reference to a SOA.

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

Body

externalIdstringOptional

namestringOptional

Responses

200

Example response

application/json

namestringRequired

externalIdstringRequired

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

createdAtstring · date-timeRequired

createdBystringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

put/tenants/{tenantUid}/soas/{soaUid}

PUT /v2/tenants/{tenantUid}/soas/{soaUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "externalId": "text",
  "name": "text"
}

200

Example response

{
  "name": "text",
  "externalId": "text",
  "soaUid": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text"
}

Delete a SOA

delete

/tenants/{tenantUid}/soas/{soaUid}

Deletes a SOA and all associated amounts.

Required permissions: SOA

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

soaUidstringRequired

Reference to a SOA.

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

Responses

204

No Content

No content

delete/tenants/{tenantUid}/soas/{soaUid}

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

204

No Content

No content

List SOA Amounts associated with a SOA

get

/tenants/{tenantUid}/soas/{soaUid}/amounts

List SOA Amounts associated with a SOA

Required permissions: SOA

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

soaUidstringRequired

Reference to a SOA.

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:

Responses

2XX

List of SOA Amounts

application/json

get/tenants/{tenantUid}/soas/{soaUid}/amounts

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

2XX

List of SOA Amounts

{
  "items": [
    {
      "soaUid": "text",
      "storeUid": "text",
      "productUid": "text",
      "soaAmountUid": "text",
      "amount": 1,
      "fromDateTime": "2026-01-01T00:00:00.000Z",
      "toDateTime": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a SOA amount

post

/tenants/{tenantUid}/soas/{soaUid}/amounts

Create a SOA amount.

Required permissions: SOA

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

soaUidstringRequired

Reference to a SOA.

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

Body

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

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

amountintegerRequired

fromDateTimestring · date-timeRequired

toDateTimestring · date-timeRequired

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

Responses

201

Example response

application/json

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

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

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

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

amountintegerRequired

fromDateTimestring · date-timeRequired

toDateTimestring · date-timeRequired

createdAtstring · date-timeRequired

createdBystringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

post/tenants/{tenantUid}/soas/{soaUid}/amounts

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

{
  "storeUid": "text",
  "productUid": "text",
  "amount": 1,
  "fromDateTime": "2026-01-01T00:00:00.000Z",
  "toDateTime": "2026-01-01T00:00:00.000Z",
  "soaAmountUid": "text"
}

201

Example response

{
  "soaUid": "text",
  "storeUid": "text",
  "productUid": "text",
  "soaAmountUid": "text",
  "amount": 1,
  "fromDateTime": "2026-01-01T00:00:00.000Z",
  "toDateTime": "2026-01-01T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text"
}

Get a SOA amount

get

/tenants/{tenantUid}/soas/{soaUid}/amounts/{soaAmountUid}

Get a SOA amount.

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

soaUidstringRequired

Reference to a SOA.

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

soaAmountUidstringRequired

Reference to a SOA amount.

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

Responses

200

Example response

application/json

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

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

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

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

amountintegerRequired

fromDateTimestring · date-timeRequired

toDateTimestring · date-timeRequired

createdAtstring · date-timeRequired

createdBystringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

get/tenants/{tenantUid}/soas/{soaUid}/amounts/{soaAmountUid}

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

200

Example response

{
  "soaUid": "text",
  "storeUid": "text",
  "productUid": "text",
  "soaAmountUid": "text",
  "amount": 1,
  "fromDateTime": "2026-01-01T00:00:00.000Z",
  "toDateTime": "2026-01-01T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text"
}

Update SOA amount details

put

/tenants/{tenantUid}/soas/{soaUid}/amounts/{soaAmountUid}

Update SOA amount details

Required permissions: SOA

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

soaUidstringRequired

Reference to a SOA.

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

soaAmountUidstringRequired

Reference to a SOA amount.

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

Body

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

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

amountintegerOptional

fromDateTimestring · date-timeOptional

toDateTimestring · date-timeOptional

Responses

200

Example response

application/json

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

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

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

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

amountintegerRequired

fromDateTimestring · date-timeRequired

toDateTimestring · date-timeRequired

createdAtstring · date-timeRequired

createdBystringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

put/tenants/{tenantUid}/soas/{soaUid}/amounts/{soaAmountUid}

PUT /v2/tenants/{tenantUid}/soas/{soaUid}/amounts/{soaAmountUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "storeUid": "text",
  "productUid": "text",
  "amount": 1,
  "fromDateTime": "2026-01-01T00:00:00.000Z",
  "toDateTime": "2026-01-01T00:00:00.000Z"
}

200

Example response

{
  "soaUid": "text",
  "storeUid": "text",
  "productUid": "text",
  "soaAmountUid": "text",
  "amount": 1,
  "fromDateTime": "2026-01-01T00:00:00.000Z",
  "toDateTime": "2026-01-01T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text"
}

Delete a SOA amount

delete

/tenants/{tenantUid}/soas/{soaUid}/amounts/{soaAmountUid}

Delete a SOA amount

Required permissions: SOA

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

soaUidstringRequired

Reference to a SOA.

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

soaAmountUidstringRequired

Reference to a SOA amount.

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

Responses

204

No Content

No content

delete/tenants/{tenantUid}/soas/{soaUid}/amounts/{soaAmountUid}

DELETE /v2/tenants/{tenantUid}/soas/{soaUid}/amounts/{soaAmountUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content