AlphaAlpha Docs
API Reference

Incoming Stock Transfers

Incoming Stock Transfer API

Delete by list of ids in current tenant

DELETE
/incoming-stock-transfers

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

curl -X DELETE "http://localhost:18080/api/v1/incoming-stock-transfers" \  -H "Content-Type: application/json" \  -d '[    "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"
}

Find by list of ids in current tenant

GET
/incoming-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/incoming-stock-transfers/find?ids=string"
[
  {
    "acceptedProducts": [
      {
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "destinationSiteId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "rejectedProducts": [
      {
        "batches": [
          {
            "quantity": 0.1,
            "reason": "string"
          }
        ],
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "sourceSiteId": "string",
    "sourceSubsidiaryId": "string",
    "status": "EXPECTED",
    "stockTransferId": "string",
    "tenantId": "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
/incoming-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/incoming-stock-transfers/find-all"
[
  {
    "acceptedProducts": [
      {
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "destinationSiteId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "rejectedProducts": [
      {
        "batches": [
          {
            "quantity": 0.1,
            "reason": "string"
          }
        ],
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "sourceSiteId": "string",
    "sourceSubsidiaryId": "string",
    "status": "EXPECTED",
    "stockTransferId": "string",
    "tenantId": "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
/incoming-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/incoming-stock-transfers/find/string"
{
  "acceptedProducts": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "rejectedProducts": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "sourceSiteId": "string",
  "sourceSubsidiaryId": "string",
  "status": "EXPECTED",
  "stockTransferId": "string",
  "tenantId": "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
/incoming-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/incoming-stock-transfers/page"
{
  "content": [
    {
      "acceptedProducts": [
        {
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "destinationSiteId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "rejectedProducts": [
        {
          "batches": [
            {
              "quantity": 0.1,
              "reason": "string"
            }
          ],
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "sourceSiteId": "string",
      "sourceSubsidiaryId": "string",
      "status": "EXPECTED",
      "stockTransferId": "string",
      "tenantId": "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
/incoming-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
statuses?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/incoming-stock-transfers/page-enriched?pageNumber=0"
{
  "content": [
    {
      "acceptedProducts": [
        {
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "destinationSiteId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "products": [
        {
          "accepted": 0.1,
          "canReceive": true,
          "currency": "string",
          "imageAssets": [
            {
              "blobId": "string",
              "created": "2019-08-24T14:15:22Z",
              "extension": "string",
              "fileSize": 0,
              "name": "string",
              "type": "IMAGE"
            }
          ],
          "pending": 0.1,
          "percentageAccepted": 0.1,
          "percentagePending": 0.1,
          "percentageRejected": 0.1,
          "price": 0.1,
          "productId": "string",
          "productName": "string",
          "quantity": 0.1,
          "rejected": 0.1,
          "sourceLocationId": "string",
          "totalPrice": 0.1,
          "unitsOfMeasurement": [
            {
              "baseUnit": true,
              "cost": 0.1,
              "decimal": true,
              "isBaseUnit": true,
              "isDecimal": true,
              "name": "string",
              "quantity": 0.1,
              "salesPrice": 0.1,
              "unit": "string"
            }
          ]
        }
      ],
      "rejectedProducts": [
        {
          "batches": [
            {
              "quantity": 0.1,
              "reason": "string"
            }
          ],
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "sourceSiteId": "string",
      "sourceSubsidiaryId": "string",
      "status": "EXPECTED",
      "stockTransferId": "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 for incoming stock transfers

GET
/incoming-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/incoming-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 Incoming Transfer

GET
/incoming-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/incoming-stock-transfers/string"
{
  "acceptedProducts": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "products": [
    {
      "accepted": 0.1,
      "canReceive": true,
      "currency": "string",
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "percentageAccepted": 0.1,
      "percentagePending": 0.1,
      "percentageRejected": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "rejected": 0.1,
      "sourceLocationId": "string",
      "totalPrice": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedProducts": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "sourceSiteId": "string",
  "sourceSubsidiaryId": "string",
  "status": "EXPECTED",
  "stockTransferId": "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
/incoming-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/incoming-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"
}

Close an incoming stock transfer

PATCH
/incoming-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/incoming-stock-transfers/string/close"
{
  "acceptedProducts": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "products": [
    {
      "accepted": 0.1,
      "canReceive": true,
      "currency": "string",
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "percentageAccepted": 0.1,
      "percentagePending": 0.1,
      "percentageRejected": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "rejected": 0.1,
      "sourceLocationId": "string",
      "totalPrice": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedProducts": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "sourceSiteId": "string",
  "sourceSubsidiaryId": "string",
  "status": "EXPECTED",
  "stockTransferId": "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"
}

Comment on an incoming stock transfer

POST
/incoming-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/incoming-stock-transfers/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{
  "acceptedProducts": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "products": [
    {
      "accepted": 0.1,
      "canReceive": true,
      "currency": "string",
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "percentageAccepted": 0.1,
      "percentagePending": 0.1,
      "percentageRejected": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "rejected": 0.1,
      "sourceLocationId": "string",
      "totalPrice": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedProducts": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "sourceSiteId": "string",
  "sourceSubsidiaryId": "string",
  "status": "EXPECTED",
  "stockTransferId": "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"
}

Receive stock in destination site

PATCH
/incoming-stock-transfers/{id}/receive

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/incoming-stock-transfers/string/receive" \  -H "Content-Type: application/json" \  -d '{    "acceptedGoods": [      {        "batchNumber": "string",        "locationId": "string",        "productId": "string",        "uomSplit": [          {            "productId": "string",            "quantity": 0.1,            "unit": "string"          }        ]      }    ],    "rejectedGoods": [      {        "productId": "string",        "unit": "string",        "uomSplit": [          {            "productId": "string",            "quantity": 0.1,            "unit": "string"          }        ]      }    ],    "shortageGoods": [      {        "productId": "string",        "unit": "string",        "uomSplit": [          {            "productId": "string",            "quantity": 0.1,            "unit": "string"          }        ]      }    ]  }'
{
  "acceptedProducts": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "destinationSiteId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "products": [
    {
      "accepted": 0.1,
      "canReceive": true,
      "currency": "string",
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "pending": 0.1,
      "percentageAccepted": 0.1,
      "percentagePending": 0.1,
      "percentageRejected": 0.1,
      "price": 0.1,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "rejected": 0.1,
      "sourceLocationId": "string",
      "totalPrice": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedProducts": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "sourceSiteId": "string",
  "sourceSubsidiaryId": "string",
  "status": "EXPECTED",
  "stockTransferId": "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"
}

Inbound Emails

Previous Page

Invoice

Next Page