Heads up, our devs are blazing ahead—docs are catching up, so some features might not be fully documented yet.
Visit our websiteAPI Documentation

ServiceShipment

ServiceShipment

List external workshops

get

Get a list of external workshops for a tenant.

Authorizations
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
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": "2025-07-30T18:10:28.378Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-07-30T18:10:28.378Z",
      "lastModifiedBy": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new external workshop

post

Create a new external workshop for a tenant.

Authorizations
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
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": "2025-07-30T18:10:28.378Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-07-30T18:10:28.378Z",
  "lastModifiedBy": "text"
}

Get external workshop

get

Get a given external workshop.

Authorizations
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
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": "2025-07-30T18:10:28.378Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-07-30T18:10:28.378Z",
  "lastModifiedBy": "text"
}

Update external workshop

put

Update an external workshop.

Authorizations
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
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": "2025-07-30T18:10:28.378Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-07-30T18:10:28.378Z",
  "lastModifiedBy": "text"
}

Delete external workshop

delete

Delete an external workshop.

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

List service shipments.

Authorizations
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
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": "2025-07-30T18:10:28.378Z",
          "createdAt": "2025-07-30T18:10:28.378Z",
          "createdBy": "text",
          "lastModifiedAt": "2025-07-30T18:10:28.378Z",
          "lastModifiedBy": "text"
        }
      ],
      "createdBy": "text",
      "createdAt": "2025-07-30T18:10:28.378Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-07-30T18:10:28.378Z",
      "shipmentDate": "2025-07-30T18:10:28.378Z",
      "allReceived": true
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new service shipment

post

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

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
all ofOptional
and
Responses
201
Example response
application/json
post
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": "2025-07-30T18:10:28.378Z",
  "items": [
    {
      "serviceOrderUid": "text",
      "receivedDate": "2025-07-30T18:10:28.378Z"
    }
  ],
  "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": "2025-07-30T18:10:28.378Z",
      "createdAt": "2025-07-30T18:10:28.378Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-07-30T18:10:28.378Z",
      "lastModifiedBy": "text"
    }
  ],
  "createdBy": "text",
  "createdAt": "2025-07-30T18:10:28.378Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T18:10:28.378Z",
  "shipmentDate": "2025-07-30T18:10:28.378Z",
  "allReceived": true
}

Get service shipment

get

Get service shipment.

Authorizations
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
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": "2025-07-30T18:10:28.378Z",
      "createdAt": "2025-07-30T18:10:28.378Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-07-30T18:10:28.378Z",
      "lastModifiedBy": "text"
    }
  ],
  "createdBy": "text",
  "createdAt": "2025-07-30T18:10:28.378Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T18:10:28.378Z",
  "shipmentDate": "2025-07-30T18:10:28.378Z",
  "allReceived": true
}

Update service shipment

put

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

Authorizations
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
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": "2025-07-30T18:10:28.378Z",
  "items": [
    {
      "serviceOrderUid": "text",
      "receivedDate": "2025-07-30T18:10:28.378Z"
    }
  ]
}
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": "2025-07-30T18:10:28.378Z",
      "createdAt": "2025-07-30T18:10:28.378Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-07-30T18:10:28.378Z",
      "lastModifiedBy": "text"
    }
  ],
  "createdBy": "text",
  "createdAt": "2025-07-30T18:10:28.378Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T18:10:28.378Z",
  "shipmentDate": "2025-07-30T18:10:28.378Z",
  "allReceived": true
}

Delete service shipment

delete

Delete service shipment

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

Get service shipment for a service order

Authorizations
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
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": "2025-07-30T18:10:28.378Z",
          "createdAt": "2025-07-30T18:10:28.378Z",
          "createdBy": "text",
          "lastModifiedAt": "2025-07-30T18:10:28.378Z",
          "lastModifiedBy": "text"
        }
      ],
      "createdBy": "text",
      "createdAt": "2025-07-30T18:10:28.378Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-07-30T18:10:28.378Z",
      "shipmentDate": "2025-07-30T18:10:28.378Z",
      "allReceived": true
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}
PreviousServiceNextStockInfo

Was this helpful?