AlphaAlpha Docs
API Reference

Stock Transfers

Stock Transfer API

Download Csv_ Stock Transfer

GET
/stock-transfers/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/stock-transfers/csv-export"
"string"
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete a list of entities by their IDs

DELETE
/stock-transfers/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/stock-transfers/delete-list?ids=string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search_ Stock Transfer

GET
/stock-transfers/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/stock-transfers/dynamic-search"
{
  "content": [
    {
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "cancelledProducts": {
        "isNotEmpty": true,
        "products": [
          {
            "productId": "string",
            "quantity": 0.1,
            "unit": "string"
          }
        ]
      },
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "deliveryDate": "2019-08-24T14:15:22Z",
      "deliveryMethod": "REGULAR",
      "destinationStockSiteId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "incomingStockTransferId": "string",
      "isFullyCancelled": true,
      "note": "string",
      "picklistIds": [
        "string"
      ],
      "priority": "LOW",
      "products": [
        {
          "baseUnitConversion": 0.1,
          "baseUnitQuantity": 0.1,
          "pricePerBaseUnit": 0.1,
          "pricePerUnit": 0.1,
          "productId": "string",
          "quantity": 0.1,
          "totalPrice": 0.1,
          "unit": "string"
        }
      ],
      "reservedProducts": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string"
        }
      ],
      "status": "DRAFT",
      "stockSiteId": "string",
      "subsidiaryId": "string",
      "tenantId": "string",
      "transferNumber": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search Post_ Stock Transfer

POST
/stock-transfers/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/stock-transfers/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "cancelledProducts": {
        "isNotEmpty": true,
        "products": [
          {
            "productId": "string",
            "quantity": 0.1,
            "unit": "string"
          }
        ]
      },
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "deliveryDate": "2019-08-24T14:15:22Z",
      "deliveryMethod": "REGULAR",
      "destinationStockSiteId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "incomingStockTransferId": "string",
      "isFullyCancelled": true,
      "note": "string",
      "picklistIds": [
        "string"
      ],
      "priority": "LOW",
      "products": [
        {
          "baseUnitConversion": 0.1,
          "baseUnitQuantity": 0.1,
          "pricePerBaseUnit": 0.1,
          "pricePerUnit": 0.1,
          "productId": "string",
          "quantity": 0.1,
          "totalPrice": 0.1,
          "unit": "string"
        }
      ],
      "reservedProducts": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string"
        }
      ],
      "status": "DRAFT",
      "stockSiteId": "string",
      "subsidiaryId": "string",
      "tenantId": "string",
      "transferNumber": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic search with enriched results

POST
/stock-transfers/dynamic-search-enriched

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/stock-transfers/dynamic-search-enriched" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "cancelledProducts": [
        {
          "productId": "string",
          "quantity": 0.1,
          "unit": "string"
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "deliveryDate": "2019-08-24T14:15:22Z",
      "deliveryMethod": "REGULAR",
      "destinationSiteId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "incomingStockTransferId": "string",
      "incomingStockTransferStatus": "EXPECTED",
      "note": "string",
      "picklistIds": [
        "string"
      ],
      "priority": "LOW",
      "productStatus": [
        {
          "finishedQuantity": 0.1,
          "productId": "string",
          "quantityCanBeCancelled": 0.1,
          "quantityCancelled": 0.1,
          "quantityDelivered": 0.1,
          "quantityOrdered": 0.1,
          "quantityPending": 0.1,
          "quantityPicked": 0.1,
          "quantityReservedPicklist": 0.1,
          "quantityReservedUnassigned": 0.1,
          "quantityReturned": 0.1,
          "quantityShipped": 0.1,
          "returnStarted": true,
          "unitPrice": 0.1
        }
      ],
      "products": [
        {
          "availableStock": 0.1,
          "baseUnitConversion": 0.1,
          "baseUnitQuantity": 0.1,
          "batchAllocations": [
            {
              "batchNumber": "string",
              "expirationDate": "2019-08-24T14:15:22Z",
              "locationId": "string",
              "productId": "string",
              "quantity": 0.1
            }
          ],
          "imageAssets": [
            {
              "blobId": "string",
              "created": "2019-08-24T14:15:22Z",
              "extension": "string",
              "fileSize": 0,
              "name": "string",
              "type": "IMAGE"
            }
          ],
          "pending": 0.1,
          "price": 0.1,
          "productId": "string",
          "productName": "string",
          "quantity": 0.1,
          "quantityCancelled": 0.1,
          "quantityDelivered": 0.1,
          "quantityPicked": 0.1,
          "quantityReturned": 0.1,
          "quantityShipped": 0.1,
          "reservations": [
            {
              "productId": "string",
              "quantity": 0.1,
              "siteId": "string",
              "siteName": "string"
            }
          ],
          "returnStarted": true,
          "totalReserved": 0.1,
          "unit": "string",
          "unitsOfMeasurement": [
            {
              "baseUnit": true,
              "cost": 0.1,
              "decimal": true,
              "isBaseUnit": true,
              "isDecimal": true,
              "name": "string",
              "quantity": 0.1,
              "salesPrice": 0.1,
              "unit": "string"
            }
          ]
        }
      ],
      "reservationsGroupedBySite": {
        "property1": [
          {
            "productId": "string",
            "quantity": 0.1,
            "siteId": "string",
            "siteName": "string"
          }
        ],
        "property2": [
          {
            "productId": "string",
            "quantity": 0.1,
            "siteId": "string",
            "siteName": "string"
          }
        ]
      },
      "reservedProducts": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "status": "DRAFT",
      "stockSiteId": "string",
      "subsidiaryId": "string",
      "tenantId": "string",
      "transferNumber": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Create a draft stock transfer request

POST
/stock-transfers/empty

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/stock-transfers/empty"
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by list of ids in current tenant

GET
/stock-transfers/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/stock-transfers/find?ids=string"
[
  {
    "batchAllocations": [
      {
        "batchNumber": "string",
        "expirationDate": "2019-08-24T14:15:22Z",
        "locationId": "string",
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "cancelledProducts": {
      "isNotEmpty": true,
      "products": [
        {
          "productId": "string",
          "quantity": 0.1,
          "unit": "string"
        }
      ]
    },
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "deliveryMethod": "REGULAR",
    "destinationStockSiteId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "incomingStockTransferId": "string",
    "isFullyCancelled": true,
    "note": "string",
    "picklistIds": [
      "string"
    ],
    "priority": "LOW",
    "products": [
      {
        "baseUnitConversion": 0.1,
        "baseUnitQuantity": 0.1,
        "pricePerBaseUnit": 0.1,
        "pricePerUnit": 0.1,
        "productId": "string",
        "quantity": 0.1,
        "totalPrice": 0.1,
        "unit": "string"
      }
    ],
    "reservedProducts": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string"
      }
    ],
    "status": "DRAFT",
    "stockSiteId": "string",
    "subsidiaryId": "string",
    "tenantId": "string",
    "transferNumber": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find all for current tenant

GET
/stock-transfers/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/stock-transfers/find-all"
[
  {
    "batchAllocations": [
      {
        "batchNumber": "string",
        "expirationDate": "2019-08-24T14:15:22Z",
        "locationId": "string",
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "cancelledProducts": {
      "isNotEmpty": true,
      "products": [
        {
          "productId": "string",
          "quantity": 0.1,
          "unit": "string"
        }
      ]
    },
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "deliveryMethod": "REGULAR",
    "destinationStockSiteId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "incomingStockTransferId": "string",
    "isFullyCancelled": true,
    "note": "string",
    "picklistIds": [
      "string"
    ],
    "priority": "LOW",
    "products": [
      {
        "baseUnitConversion": 0.1,
        "baseUnitQuantity": 0.1,
        "pricePerBaseUnit": 0.1,
        "pricePerUnit": 0.1,
        "productId": "string",
        "quantity": 0.1,
        "totalPrice": 0.1,
        "unit": "string"
      }
    ],
    "reservedProducts": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string"
      }
    ],
    "status": "DRAFT",
    "stockSiteId": "string",
    "subsidiaryId": "string",
    "tenantId": "string",
    "transferNumber": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find a list of entities by their IDs

GET
/stock-transfers/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/stock-transfers/find-list"
[
  {
    "batchAllocations": [
      {
        "batchNumber": "string",
        "expirationDate": "2019-08-24T14:15:22Z",
        "locationId": "string",
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "cancelledProducts": {
      "isNotEmpty": true,
      "products": [
        {
          "productId": "string",
          "quantity": 0.1,
          "unit": "string"
        }
      ]
    },
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "deliveryMethod": "REGULAR",
    "destinationStockSiteId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "incomingStockTransferId": "string",
    "isFullyCancelled": true,
    "note": "string",
    "picklistIds": [
      "string"
    ],
    "priority": "LOW",
    "products": [
      {
        "baseUnitConversion": 0.1,
        "baseUnitQuantity": 0.1,
        "pricePerBaseUnit": 0.1,
        "pricePerUnit": 0.1,
        "productId": "string",
        "quantity": 0.1,
        "totalPrice": 0.1,
        "unit": "string"
      }
    ],
    "reservedProducts": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string"
      }
    ],
    "status": "DRAFT",
    "stockSiteId": "string",
    "subsidiaryId": "string",
    "tenantId": "string",
    "transferNumber": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by id in current tenant

GET
/stock-transfers/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/stock-transfers/find/string"
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": {
    "isNotEmpty": true,
    "products": [
      {
        "productId": "string",
        "quantity": 0.1,
        "unit": "string"
      }
    ]
  },
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationStockSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "isFullyCancelled": true,
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "products": [
    {
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "pricePerBaseUnit": 0.1,
      "pricePerUnit": 0.1,
      "productId": "string",
      "quantity": 0.1,
      "totalPrice": 0.1,
      "unit": "string"
    }
  ],
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/stock-transfers/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/stock-transfers/page"
{
  "content": [
    {
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "cancelledProducts": {
        "isNotEmpty": true,
        "products": [
          {
            "productId": "string",
            "quantity": 0.1,
            "unit": "string"
          }
        ]
      },
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "deliveryDate": "2019-08-24T14:15:22Z",
      "deliveryMethod": "REGULAR",
      "destinationStockSiteId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "incomingStockTransferId": "string",
      "isFullyCancelled": true,
      "note": "string",
      "picklistIds": [
        "string"
      ],
      "priority": "LOW",
      "products": [
        {
          "baseUnitConversion": 0.1,
          "baseUnitQuantity": 0.1,
          "pricePerBaseUnit": 0.1,
          "pricePerUnit": 0.1,
          "productId": "string",
          "quantity": 0.1,
          "totalPrice": 0.1,
          "unit": "string"
        }
      ],
      "reservedProducts": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string"
        }
      ],
      "status": "DRAFT",
      "stockSiteId": "string",
      "subsidiaryId": "string",
      "tenantId": "string",
      "transferNumber": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/stock-transfers/page-enriched

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber*integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string
stockSiteId?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/stock-transfers/page-enriched?pageNumber=0"
{
  "content": [
    {
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "cancelledProducts": [
        {
          "productId": "string",
          "quantity": 0.1,
          "unit": "string"
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "deliveryDate": "2019-08-24T14:15:22Z",
      "deliveryMethod": "REGULAR",
      "destinationSiteId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "incomingStockTransferId": "string",
      "incomingStockTransferStatus": "EXPECTED",
      "note": "string",
      "picklistIds": [
        "string"
      ],
      "priority": "LOW",
      "productStatus": [
        {
          "finishedQuantity": 0.1,
          "productId": "string",
          "quantityCanBeCancelled": 0.1,
          "quantityCancelled": 0.1,
          "quantityDelivered": 0.1,
          "quantityOrdered": 0.1,
          "quantityPending": 0.1,
          "quantityPicked": 0.1,
          "quantityReservedPicklist": 0.1,
          "quantityReservedUnassigned": 0.1,
          "quantityReturned": 0.1,
          "quantityShipped": 0.1,
          "returnStarted": true,
          "unitPrice": 0.1
        }
      ],
      "products": [
        {
          "availableStock": 0.1,
          "baseUnitConversion": 0.1,
          "baseUnitQuantity": 0.1,
          "batchAllocations": [
            {
              "batchNumber": "string",
              "expirationDate": "2019-08-24T14:15:22Z",
              "locationId": "string",
              "productId": "string",
              "quantity": 0.1
            }
          ],
          "imageAssets": [
            {
              "blobId": "string",
              "created": "2019-08-24T14:15:22Z",
              "extension": "string",
              "fileSize": 0,
              "name": "string",
              "type": "IMAGE"
            }
          ],
          "pending": 0.1,
          "price": 0.1,
          "productId": "string",
          "productName": "string",
          "quantity": 0.1,
          "quantityCancelled": 0.1,
          "quantityDelivered": 0.1,
          "quantityPicked": 0.1,
          "quantityReturned": 0.1,
          "quantityShipped": 0.1,
          "reservations": [
            {
              "productId": "string",
              "quantity": 0.1,
              "siteId": "string",
              "siteName": "string"
            }
          ],
          "returnStarted": true,
          "totalReserved": 0.1,
          "unit": "string",
          "unitsOfMeasurement": [
            {
              "baseUnit": true,
              "cost": 0.1,
              "decimal": true,
              "isBaseUnit": true,
              "isDecimal": true,
              "name": "string",
              "quantity": 0.1,
              "salesPrice": 0.1,
              "unit": "string"
            }
          ]
        }
      ],
      "reservationsGroupedBySite": {
        "property1": [
          {
            "productId": "string",
            "quantity": 0.1,
            "siteId": "string",
            "siteName": "string"
          }
        ],
        "property2": [
          {
            "productId": "string",
            "quantity": 0.1,
            "siteId": "string",
            "siteName": "string"
          }
        ]
      },
      "reservedProducts": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "status": "DRAFT",
      "stockSiteId": "string",
      "subsidiaryId": "string",
      "tenantId": "string",
      "transferNumber": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get Stats_ Stock Transfer

GET
/stock-transfers/stats

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

stockSiteId?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/stock-transfers/stats"
{
  "groupedStatuses": {
    "property1": 0,
    "property2": 0
  },
  "topTransferedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ]
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get Enriched Transfer

GET
/stock-transfers/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/stock-transfers/string"
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by id in current tenant

DELETE
/stock-transfers/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/stock-transfers/string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Update a stock transfer request

PUT
/stock-transfers/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:18080/api/v1/stock-transfers/string" \  -H "Content-Type: application/json" \  -d '{    "batchAllocations": [      {        "batchNumber": "string",        "locationId": "string",        "productId": "string",        "quantity": 0.1      }    ],    "deliveryMethod": "REGULAR",    "priority": "LOW",    "products": [      {        "price": 0.1,        "productId": "string",        "quantity": 0.1,        "unit": "string"      }    ],    "subsidiaryId": "string"  }'
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Approve a stock transfer request

PATCH
/stock-transfers/{id}/approve

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/stock-transfers/string/approve"
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Cancel a draft or rejected stock transfer request

PATCH
/stock-transfers/{id}/cancel-draft

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/stock-transfers/string/cancel-draft"
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Close a stock transfer

PATCH
/stock-transfers/{id}/close

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/stock-transfers/string/close"
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add a comment to an entity

POST
/stock-transfers/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/stock-transfers/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Create a picklist for a stock transfer

POST
/stock-transfers/{id}/picklists

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/stock-transfers/string/picklists" \  -H "Content-Type: application/json" \  -d '{    "priority": "LOW_PRIORITY",    "products": [      {        "productId": "string",        "quantity": 0.1      }    ],    "stockSiteId": "string"  }'
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Cancel a picklist of a stock transfer

PATCH
/stock-transfers/{id}/picklists/{picklistId}/cancel

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
picklistId*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/stock-transfers/string/picklists/string/cancel"
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Reinstate a stock transfer request

PATCH
/stock-transfers/{id}/reinstate

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/stock-transfers/string/reinstate"
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Reject a stock transfer request

PATCH
/stock-transfers/{id}/reject

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/stock-transfers/string/reject"
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Request approval for transfer

PATCH
/stock-transfers/{id}/request-approval

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/stock-transfers/string/request-approval"
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

(partially) Reserve products for a stock transfer

POST
/stock-transfers/{id}/reservations

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/stock-transfers/string/reservations" \  -H "Content-Type: application/json" \  -d '{    "reservations": [      {        "products": [          {            "productId": "string",            "quantity": 0.1          }        ],        "stockSiteId": "string"      }    ]  }'
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Cancel (partial) reservations of a stock transfer

PATCH
/stock-transfers/{id}/reservations/cancel

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/stock-transfers/string/reservations/cancel" \  -H "Content-Type: application/json" \  -d '[    {      "productId": "string",      "quantity": 0.1,      "stockSiteId": "string"    }  ]'
{
  "batchAllocations": [
    {
      "batchNumber": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "cancelledProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "unit": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deliveryDate": "2019-08-24T14:15:22Z",
  "deliveryMethod": "REGULAR",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "incomingStockTransferId": "string",
  "incomingStockTransferStatus": "EXPECTED",
  "note": "string",
  "picklistIds": [
    "string"
  ],
  "priority": "LOW",
  "productStatus": [
    {
      "finishedQuantity": 0.1,
      "productId": "string",
      "quantityCanBeCancelled": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityOrdered": 0.1,
      "quantityPending": 0.1,
      "quantityPicked": 0.1,
      "quantityReservedPicklist": 0.1,
      "quantityReservedUnassigned": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "returnStarted": true,
      "unitPrice": 0.1
    }
  ],
  "products": [
    {
      "availableStock": 0.1,
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "batchAllocations": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "locationId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityCancelled": 0.1,
      "quantityDelivered": 0.1,
      "quantityPicked": 0.1,
      "quantityReturned": 0.1,
      "quantityShipped": 0.1,
      "reservations": [
        {
          "productId": "string",
          "quantity": 0.1,
          "siteId": "string",
          "siteName": "string"
        }
      ],
      "returnStarted": true,
      "totalReserved": 0.1,
      "unit": "string",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "reservationsGroupedBySite": {
    "property1": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ],
    "property2": [
      {
        "productId": "string",
        "quantity": 0.1,
        "siteId": "string",
        "siteName": "string"
      }
    ]
  },
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string",
      "siteName": "string"
    }
  ],
  "status": "DRAFT",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transferNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Validate a stock transfer request

GET
/stock-transfers/{id}/validate

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/stock-transfers/string/validate"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Stock Transactions

Previous Page

Subsidiaries

Next Page