Stock

Stock Service APIs

Facilitates the management of stocks.

Create/Add a new record for transfer of product variant stock

Create/Add a new record for transfer of product variant stock

POST/stock/v1/_create

Body

application/json

Capture details of stock transaction.

Stock*any

Response

202400

Stock Transaction request has been accepted.

Body

*/*

Stock*any

Request

JavaScriptCurlPython

const response = await fetch('/stock/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Create/Add a new record for transfer of product variant stock in bulk

Create/Add a new record for transfer of product variant stock in bulk

POST/stock/v1/bulk/_create

Body

application/json

Capture details of stock transaction.

Stock*array of any

Response

202400

Stock Transaction request has been accepted.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/stock/v1/bulk/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Stock": []
    }),
});
const data = await response.json();

Response

202

{}

Update record for transfer of a stock transaction

Update record for transfer of a stock transaction

POST/stock/v1/_update

Body

application/json

Capture details of stock transaction

Stock*Stock (object)

Response

202400

Stock Transaction request has been accepted.

Body

*/*

Stock*Stock (object)

Request

JavaScriptCurlPython

const response = await fetch('/stock/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Stock": {
        "facilityId": "FacilityA",
        "productVariantId": "text",
        "quantity": 0,
        "transactionType": "RECEIVED",
        "transactingPartyId": "text",
        "transactingPartyType": "WAREHOUSE"
      }
    }),
});
const data = await response.json();

Response

202

{
  "Stock": {
    "facilityId": "FacilityA",
    "productVariantId": "text",
    "quantity": 0,
    "wayBillNumber": "text",
    "referenceId": "C-1",
    "referenceIdType": "PROJECT",
    "transactionType": "RECEIVED",
    "transactionReason": "RECEIVED",
    "transactingPartyId": "text",
    "transactingPartyType": "WAREHOUSE"
  }
}

Update records for transfer of a stock transaction in bulk

Update records for transfer of a stock transaction in bulk

POST/stock/v1/bulk/_update

Body

application/json

Capture details of stock transaction

Stock*array of Stock (object)

Response

202400

Stock Transaction request has been accepted.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/stock/v1/bulk/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Stock": [
        {
          "facilityId": "FacilityA",
          "productVariantId": "text",
          "quantity": 0,
          "transactionType": "RECEIVED",
          "transactingPartyId": "text",
          "transactingPartyType": "WAREHOUSE"
        }
      ]
    }),
});
const data = await response.json();

Response

202

{}

Soft delete record for transfer of a stock transaction

Soft delete record for transfer of a stock transaction

POST/stock/v1/_delete

Body

application/json

Capture details of stock transaction

Stock*Stock (object)

Response

202400

Stock Transaction delete request has been accepted.

Body

*/*

Stock*Stock (object)

Request

JavaScriptCurlPython

const response = await fetch('/stock/v1/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Stock": {
        "facilityId": "FacilityA",
        "productVariantId": "text",
        "quantity": 0,
        "transactionType": "RECEIVED",
        "transactingPartyId": "text",
        "transactingPartyType": "WAREHOUSE"
      }
    }),
});
const data = await response.json();

Response

202

{
  "Stock": {
    "facilityId": "FacilityA",
    "productVariantId": "text",
    "quantity": 0,
    "wayBillNumber": "text",
    "referenceId": "C-1",
    "referenceIdType": "PROJECT",
    "transactionType": "RECEIVED",
    "transactionReason": "RECEIVED",
    "transactingPartyId": "text",
    "transactingPartyType": "WAREHOUSE"
  }
}

Soft delete records for transfer of a stock transaction

Soft delete records for transfer of a stock transaction

POST/stock/v1/bulk/_delete

Body

application/json

Capture details of stock transaction

any

Response

202400

Stock Transaction delete request has been accepted.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/stock/v1/bulk/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

202

{}

Search for stock transaction

Search for stock transaction

POST/stock/v1/_search

Query parameters

Body

application/json

Capture details of Stock Transfer.

Stock*StockSearch (object)

Response

200400

Stock transfer.

Body

*/*

Stock*array of Stock (object)

Request

JavaScriptCurlPython

const response = await fetch('/stock/v1/_search?limit=0&offset=0&tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Stock": {}
    }),
});
const data = await response.json();

Response

200

{
  "Stock": [
    {
      "facilityId": "FacilityA",
      "productVariantId": "text",
      "quantity": 0,
      "wayBillNumber": "text",
      "referenceId": "C-1",
      "referenceIdType": "PROJECT",
      "transactionType": "RECEIVED",
      "transactionReason": "RECEIVED",
      "transactingPartyId": "text",
      "transactingPartyType": "WAREHOUSE"
    }
  ]
}

Create/Add a new stock reconciliation record for a product variant

Create/Add a new stock reconciliation record for a product variant

POST/stock/reconciliation/v1/_create

Body

application/json

Capture details of stock transaction.

StockReconciliation*any

Response

202400

Accepted.

Body

*/*

StockReconciliation*any

Request

JavaScriptCurlPython

const response = await fetch('/stock/reconciliation/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Create/Add a new stock reconciliation record for a product variant in bulk

Create/Add a new stock reconciliation record for a product variant in bulk

POST/stock/reconciliation/v1/bulk/_create

Body

application/json

Capture details of stock transaction.

StockReconciliation*array of any

Response

202400

Accepted.

Request

JavaScriptCurlPython

const response = await fetch('/stock/reconciliation/v1/bulk/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "StockReconciliation": []
    }),
});
const data = await response.json();

Update stock reconciliation record

Update stock reconciliation record

POST/stock/reconciliation/v1/_update

Body

application/json

Capture details of stock transaction

StockReconciliation*StockReconciliation (object)

Response

202400

Stock Reconciliation request has been accepted.

Body

*/*

StockReconciliation*StockReconciliation (object)

Request

JavaScriptCurlPython

const response = await fetch('/stock/reconciliation/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "StockReconciliation": {
        "facilityId": "FacilityA",
        "productVariantId": "text"
      }
    }),
});
const data = await response.json();

Response

202

{
  "StockReconciliation": {
    "facilityId": "FacilityA",
    "productVariantId": "text",
    "referenceId": "C-1",
    "referenceIdType": "PROJECT",
    "physicalCount": 0,
    "calculatedCount": 0,
    "commentsOnReconciliation": "text"
  }
}

Update stock reconciliation records

Update stock reconciliation records

POST/stock/reconciliation/v1/bulk/_update

Body

application/json

Capture details of stock transaction

StockReconciliation*array of StockReconciliation (object)

Response

202400

Stock Reconciliation request has been accepted.

Request

JavaScriptCurlPython

const response = await fetch('/stock/reconciliation/v1/bulk/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "StockReconciliation": [
        {
          "facilityId": "FacilityA",
          "productVariantId": "text"
        }
      ]
    }),
});
const data = await response.json();

Soft delete stock reconciliation record

Soft delete stock reconciliation record

POST/stock/reconciliation/v1/_delete

Body

application/json

Capture details of stock transaction

StockReconciliation*StockReconciliation (object)

Response

202400

Stock Reconciliation delete request has been accepted.

Body

*/*

StockReconciliation*StockReconciliation (object)

Request

JavaScriptCurlPython

const response = await fetch('/stock/reconciliation/v1/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "StockReconciliation": {
        "facilityId": "FacilityA",
        "productVariantId": "text"
      }
    }),
});
const data = await response.json();

Response

202

{
  "StockReconciliation": {
    "facilityId": "FacilityA",
    "productVariantId": "text",
    "referenceId": "C-1",
    "referenceIdType": "PROJECT",
    "physicalCount": 0,
    "calculatedCount": 0,
    "commentsOnReconciliation": "text"
  }
}

Soft delete stock reconciliation records

Soft delete stock reconciliation records

POST/stock/reconciliation/v1/bulk/_delete

Body

application/json

Capture details of stock transaction

any

Response

202400

Stock Reconciliation delete request has been accepted.

Request

JavaScriptCurlPython

const response = await fetch('/stock/reconciliation/v1/bulk/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Search for stock reconciliation record

Search for stock reconciliation record

POST/stock/reconciliation/v1/_search

Query parameters

Body

application/json

Capture details of Stock Reconciliation.

StockReconciliation*StockReconciliationSearch (object)

Response

200400

Stock reconciliations.

Body

*/*

StockReconciliation*array of StockReconciliation (object)

Request

JavaScriptCurlPython

const response = await fetch('/stock/reconciliation/v1/_search?limit=0&offset=0&tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "StockReconciliation": {}
    }),
});
const data = await response.json();

Response

200

{
  "StockReconciliation": [
    {
      "facilityId": "FacilityA",
      "productVariantId": "text",
      "referenceId": "C-1",
      "referenceIdType": "PROJECT",
      "physicalCount": 0,
      "calculatedCount": 0,
      "commentsOnReconciliation": "text"
    }
  ]
}