ServiceShipment

PreviousService NextStockInfo

Was this helpful?

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

application/json

objectoptional

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-04-18T01:44:26.405Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T01:44:26.405Z",
  "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

delete

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

204

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

Available options:

Responses

application/json

objectoptional

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-04-18T01:44:26.405Z",
          "createdAt": "2025-04-18T01:44:26.405Z",
          "createdBy": "text",
          "lastModifiedAt": "2025-04-18T01:44:26.405Z",
          "lastModifiedBy": "text"
        }
      ],
      "createdBy": "text",
      "createdAt": "2025-04-18T01:44:26.405Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T01:44:26.405Z",
      "shipmentDate": "2025-04-18T01:44:26.405Z",
      "allReceived": true
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

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

application/json

objectoptional

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-04-18T01:44:26.405Z",
      "createdAt": "2025-04-18T01:44:26.405Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-04-18T01:44:26.405Z",
      "lastModifiedBy": "text"
    }
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T01:44:26.405Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:44:26.405Z",
  "shipmentDate": "2025-04-18T01:44:26.405Z",
  "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

delete

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

204

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

Available options:

Body

Responses

application/json

objectoptional

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-04-18T01:44:26.405Z",
          "createdAt": "2025-04-18T01:44:26.405Z",
          "createdBy": "text",
          "lastModifiedAt": "2025-04-18T01:44:26.405Z",
          "lastModifiedBy": "text"
        }
      ],
      "createdBy": "text",
      "createdAt": "2025-04-18T01:44:26.405Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T01:44:26.405Z",
      "shipmentDate": "2025-04-18T01:44:26.405Z",
      "allReceived": true
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

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

Available options:

Responses

application/json

objectoptional

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-04-18T01:44:26.405Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-04-18T01:44:26.405Z",
      "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

application/json

objectoptional

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-04-18T01:44:26.405Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T01:44:26.405Z",
  "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

application/json

objectoptional

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-04-18T01:44:26.405Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T01:44:26.405Z",
  "lastModifiedBy": "text"
}

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

Responses

application/json

objectoptional

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-04-18T01:44:26.405Z",
  "items": [
    {
      "serviceOrderUid": "text",
      "receivedDate": "2025-04-18T01:44:26.405Z"
    }
  ],
  "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-04-18T01:44:26.405Z",
      "createdAt": "2025-04-18T01:44:26.405Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-04-18T01:44:26.405Z",
      "lastModifiedBy": "text"
    }
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T01:44:26.405Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:44:26.405Z",
  "shipmentDate": "2025-04-18T01:44:26.405Z",
  "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

senderobjectrequired

receiverobjectrequired

notestringoptional

statusstring · enumoptionalAvailable options:

trackingNumberstringoptional

shipmentNumberstringoptional

shipmentDatestring · date-timeoptional

itemsobject[]optional

Responses

application/json

objectoptional

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-04-18T01:44:26.405Z",
  "items": [
    {
      "serviceOrderUid": "text",
      "receivedDate": "2025-04-18T01:44:26.405Z"
    }
  ]
}

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-04-18T01:44:26.405Z",
      "createdAt": "2025-04-18T01:44:26.405Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-04-18T01:44:26.405Z",
      "lastModifiedBy": "text"
    }
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T01:44:26.405Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:44:26.405Z",
  "shipmentDate": "2025-04-18T01:44:26.405Z",
  "allReceived": true
}