ServiceShipment

List external workshops

get

/tenants/{tenantUid}/serviceorders/externalworkshops

Get a list of external workshops for a tenant.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

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:

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/serviceorders/externalworkshops

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

200

Example response

{
  "items": [
    {
      "externalWorkshopUid": "text",
      "companyName": "text",
      "address": "text",
      "postalCode": "text",
      "city": "text",
      "countryCode": "text",
      "email": "text",
      "phone": "text",
      "contactName": "text",
      "note": "text",
      "active": true,
      "createdAt": "2026-01-29T12:38:35.253Z",
      "createdBy": "text",
      "lastModifiedAt": "2026-01-29T12:38:35.253Z",
      "lastModifiedBy": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new external workshop

post

/tenants/{tenantUid}/serviceorders/externalworkshops

Create a new external workshop for a tenant.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

companyNamestringRequired

addressstringOptional

postalCodestringOptional

citystringOptional

countryCodestringOptional

emailstringOptional

phonestringOptional

contactNamestringOptional

notestringOptional

activebooleanOptionalDefault: true

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

Responses

201

Example response

application/json

post

/tenants/{tenantUid}/serviceorders/externalworkshops

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

{
  "companyName": "text",
  "address": "text",
  "postalCode": "text",
  "city": "text",
  "countryCode": "text",
  "email": "text",
  "phone": "text",
  "contactName": "text",
  "note": "text",
  "active": true,
  "externalWorkshopUid": "text"
}

201

Example response

{
  "externalWorkshopUid": "text",
  "companyName": "text",
  "address": "text",
  "postalCode": "text",
  "city": "text",
  "countryCode": "text",
  "email": "text",
  "phone": "text",
  "contactName": "text",
  "note": "text",
  "active": true,
  "createdAt": "2026-01-29T12:38:35.253Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-01-29T12:38:35.253Z",
  "lastModifiedBy": "text"
}

Get external workshop

get

/tenants/{tenantUid}/serviceorders/externalworkshops/{externalWorkshopUid}

Get a given external workshop.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

externalWorkshopUidstringRequired

Reference to an external workshop.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/serviceorders/externalworkshops/{externalWorkshopUid}

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

200

Example response

{
  "externalWorkshopUid": "text",
  "companyName": "text",
  "address": "text",
  "postalCode": "text",
  "city": "text",
  "countryCode": "text",
  "email": "text",
  "phone": "text",
  "contactName": "text",
  "note": "text",
  "active": true,
  "createdAt": "2026-01-29T12:38:35.253Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-01-29T12:38:35.253Z",
  "lastModifiedBy": "text"
}

Update external workshop

put

/tenants/{tenantUid}/serviceorders/externalworkshops/{externalWorkshopUid}

Update an external workshop.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

externalWorkshopUidstringRequired

Reference to an external workshop.

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

Body

companyNamestringOptional

addressstringOptional

postalCodestringOptional

citystringOptional

countryCodestringOptional

emailstringOptional

phonestringOptional

contactNamestringOptional

notestringOptional

activebooleanOptionalDefault: true

Responses

200

Example response

application/json

put

/tenants/{tenantUid}/serviceorders/externalworkshops/{externalWorkshopUid}

PUT /v2/tenants/{tenantUid}/serviceorders/externalworkshops/{externalWorkshopUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "companyName": "text",
  "address": "text",
  "postalCode": "text",
  "city": "text",
  "countryCode": "text",
  "email": "text",
  "phone": "text",
  "contactName": "text",
  "note": "text",
  "active": true
}

200

Example response

{
  "externalWorkshopUid": "text",
  "companyName": "text",
  "address": "text",
  "postalCode": "text",
  "city": "text",
  "countryCode": "text",
  "email": "text",
  "phone": "text",
  "contactName": "text",
  "note": "text",
  "active": true,
  "createdAt": "2026-01-29T12:38:35.253Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-01-29T12:38:35.253Z",
  "lastModifiedBy": "text"
}

Delete external workshop

delete

/tenants/{tenantUid}/serviceorders/externalworkshops/{externalWorkshopUid}

Delete an external workshop.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

externalWorkshopUidstringRequired

Reference to an external workshop.

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

Responses

204

No Content

delete

/tenants/{tenantUid}/serviceorders/externalworkshops/{externalWorkshopUid}

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

204

No Content

No content

List service shipments

get

/tenants/{tenantUid}/serviceorders/shipments

List service shipments.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

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:

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/serviceorders/shipments

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

200

Example response

{
  "items": [
    {
      "serviceShipmentUid": "text",
      "sender": {
        "storeUid": "text"
      },
      "receiver": {
        "storeUid": "text",
        "externalWorkshopUid": "text"
      },
      "status": "NOT_SENT",
      "note": "text",
      "trackingNumber": "text",
      "shipmentNumber": "text",
      "items": [
        {
          "serviceOrderUid": "text",
          "receivedDate": "2026-01-29T12:38:35.253Z",
          "createdAt": "2026-01-29T12:38:35.253Z",
          "createdBy": "text",
          "lastModifiedAt": "2026-01-29T12:38:35.253Z",
          "lastModifiedBy": "text"
        }
      ],
      "createdBy": "text",
      "createdAt": "2026-01-29T12:38:35.253Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2026-01-29T12:38:35.253Z",
      "shipmentDate": "2026-01-29T12:38:35.253Z",
      "allReceived": true
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new service shipment

post

/tenants/{tenantUid}/serviceorders/shipments

Create new service shipment. For receiver, either a store or an external workshop must be set (by its UID).

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

Responses

201

Example response

application/json

post

/tenants/{tenantUid}/serviceorders/shipments

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

{
  "sender": {
    "storeUid": "text"
  },
  "receiver": {
    "storeUid": "text",
    "externalWorkshopUid": "text"
  },
  "note": "text",
  "status": "NOT_SENT",
  "trackingNumber": "text",
  "shipmentNumber": "text",
  "shipmentDate": "2026-01-29T12:38:35.253Z",
  "items": [
    {
      "serviceOrderUid": "text",
      "receivedDate": "2026-01-29T12:38:35.253Z"
    }
  ],
  "serviceShipmentUid": "text"
}

201

Example response

{
  "serviceShipmentUid": "text",
  "sender": {
    "storeUid": "text"
  },
  "receiver": {
    "storeUid": "text",
    "externalWorkshopUid": "text"
  },
  "status": "NOT_SENT",
  "note": "text",
  "trackingNumber": "text",
  "shipmentNumber": "text",
  "items": [
    {
      "serviceOrderUid": "text",
      "receivedDate": "2026-01-29T12:38:35.253Z",
      "createdAt": "2026-01-29T12:38:35.253Z",
      "createdBy": "text",
      "lastModifiedAt": "2026-01-29T12:38:35.253Z",
      "lastModifiedBy": "text"
    }
  ],
  "createdBy": "text",
  "createdAt": "2026-01-29T12:38:35.253Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2026-01-29T12:38:35.253Z",
  "shipmentDate": "2026-01-29T12:38:35.253Z",
  "allReceived": true
}

Get service shipment

get

/tenants/{tenantUid}/serviceorders/shipments/{serviceShipmentUid}

Get service shipment.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

serviceShipmentUidstringRequired

Reference to a service shipment.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/serviceorders/shipments/{serviceShipmentUid}

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

200

Example response

{
  "serviceShipmentUid": "text",
  "sender": {
    "storeUid": "text"
  },
  "receiver": {
    "storeUid": "text",
    "externalWorkshopUid": "text"
  },
  "status": "NOT_SENT",
  "note": "text",
  "trackingNumber": "text",
  "shipmentNumber": "text",
  "items": [
    {
      "serviceOrderUid": "text",
      "receivedDate": "2026-01-29T12:38:35.253Z",
      "createdAt": "2026-01-29T12:38:35.253Z",
      "createdBy": "text",
      "lastModifiedAt": "2026-01-29T12:38:35.253Z",
      "lastModifiedBy": "text"
    }
  ],
  "createdBy": "text",
  "createdAt": "2026-01-29T12:38:35.253Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2026-01-29T12:38:35.253Z",
  "shipmentDate": "2026-01-29T12:38:35.253Z",
  "allReceived": true
}

Update service shipment

put

/tenants/{tenantUid}/serviceorders/shipments/{serviceShipmentUid}

Update service shipment. For receiver, either a store or an external workshop must be set (by its UID).

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

serviceShipmentUidstringRequired

Reference to a service shipment.

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

Body

notestringOptional

statusstring · enumOptionalPossible values:

trackingNumberstringOptional

shipmentNumberstringOptional

shipmentDatestring · date-timeOptional

Responses

200

Example response

application/json

put

/tenants/{tenantUid}/serviceorders/shipments/{serviceShipmentUid}

PUT /v2/tenants/{tenantUid}/serviceorders/shipments/{serviceShipmentUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 293

{
  "sender": {
    "storeUid": "text"
  },
  "receiver": {
    "storeUid": "text",
    "externalWorkshopUid": "text"
  },
  "note": "text",
  "status": "NOT_SENT",
  "trackingNumber": "text",
  "shipmentNumber": "text",
  "shipmentDate": "2026-01-29T12:38:35.253Z",
  "items": [
    {
      "serviceOrderUid": "text",
      "receivedDate": "2026-01-29T12:38:35.253Z"
    }
  ]
}

200

Example response

{
  "serviceShipmentUid": "text",
  "sender": {
    "storeUid": "text"
  },
  "receiver": {
    "storeUid": "text",
    "externalWorkshopUid": "text"
  },
  "status": "NOT_SENT",
  "note": "text",
  "trackingNumber": "text",
  "shipmentNumber": "text",
  "items": [
    {
      "serviceOrderUid": "text",
      "receivedDate": "2026-01-29T12:38:35.253Z",
      "createdAt": "2026-01-29T12:38:35.253Z",
      "createdBy": "text",
      "lastModifiedAt": "2026-01-29T12:38:35.253Z",
      "lastModifiedBy": "text"
    }
  ],
  "createdBy": "text",
  "createdAt": "2026-01-29T12:38:35.253Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2026-01-29T12:38:35.253Z",
  "shipmentDate": "2026-01-29T12:38:35.253Z",
  "allReceived": true
}

Delete service shipment

delete

/tenants/{tenantUid}/serviceorders/shipments/{serviceShipmentUid}

Delete service shipment

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

serviceShipmentUidstringRequired

Reference to a service shipment.

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

Responses

204

No Content

delete

/tenants/{tenantUid}/serviceorders/shipments/{serviceShipmentUid}

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

204

No Content

No content

Get service shipments for a service order

get

/tenants/{tenantUid}/serviceorders/shipments/items/{serviceOrderUid}

Get service shipment for a service order

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

serviceOrderUidstringRequired

Reference to a service order

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:

Body

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/serviceorders/shipments/items/{serviceOrderUid}

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

200

Example response

{
  "items": [
    {
      "serviceShipmentUid": "text",
      "sender": {
        "storeUid": "text"
      },
      "receiver": {
        "storeUid": "text",
        "externalWorkshopUid": "text"
      },
      "status": "NOT_SENT",
      "note": "text",
      "trackingNumber": "text",
      "shipmentNumber": "text",
      "items": [
        {
          "serviceOrderUid": "text",
          "receivedDate": "2026-01-29T12:38:35.253Z",
          "createdAt": "2026-01-29T12:38:35.253Z",
          "createdBy": "text",
          "lastModifiedAt": "2026-01-29T12:38:35.253Z",
          "lastModifiedBy": "text"
        }
      ],
      "createdBy": "text",
      "createdAt": "2026-01-29T12:38:35.253Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2026-01-29T12:38:35.253Z",
      "shipmentDate": "2026-01-29T12:38:35.253Z",
      "allReceived": true
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

PreviousService NextStockInfo

Last updated 9 months ago

Was this helpful?

hashtagList external workshops

hashtagCreate new external workshop

hashtagGet external workshop

hashtagUpdate external workshop

hashtagDelete external workshop

hashtagList service shipments

hashtagCreate new service shipment

hashtagGet service shipment

hashtagUpdate service shipment

hashtagDelete service shipment

hashtagGet service shipments for a service order

List external workshops

Create new external workshop

Get external workshop

Update external workshop

Delete external workshop

List service shipments

Create new service shipment

Get service shipment

Update service shipment

Delete service shipment

Get service shipments for a service order