Create new service shipment

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

Required permissions: SERVICE_ORDER

post

/tenants/{tenantUid}/serviceorders/shipments

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

notestringOptional

statusstring · enumOptionalPossible values:

trackingNumberstringOptional

shipmentNumberstringOptional

shipmentDatestring · date-timeOptional

serviceShipmentUidstringOptionalPattern: ^[A-Za-z0-9-_]*

Responses

201

Example response

application/json

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

statusstring · enumRequiredPossible values:

notestringRequired

trackingNumberstringRequired

shipmentNumberstringRequired

createdBystringRequired

createdAtstring · date-timeRequired

lastModifiedBystringRequired

lastModifiedAtstring · date-timeRequired

shipmentDatestring · date-timeRequired

allReceivedbooleanRequired

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-01T00:00:00.000Z",
  "items": [
    {
      "serviceOrderUid": "text",
      "receivedDate": "2026-01-01T00:00:00.000Z"
    }
  ],
  "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-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text"
    }
  ],
  "createdBy": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "shipmentDate": "2026-01-01T00:00:00.000Z",
  "allReceived": true
}