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

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Stockobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "Stock": {
      "id": "text",
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "facilityId": "FacilityA",
      "productVariantId": "text",
      "quantity": 1,
      "wayBillNumber": "text",
      "referenceId": "C-1",
      "referenceIdType": "PROJECT",
      "transactionType": "RECEIVED",
      "transactionReason": "RECEIVED",
      "transactingPartyId": "text",
      "transactingPartyType": "WAREHOUSE",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Stock": {
    "id": "text",
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "facilityId": "FacilityA",
    "productVariantId": "text",
    "quantity": 1,
    "wayBillNumber": "text",
    "referenceId": "C-1",
    "referenceIdType": "PROJECT",
    "transactionType": "RECEIVED",
    "transactionReason": "RECEIVED",
    "transactingPartyId": "text",
    "transactingPartyType": "WAREHOUSE",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Stock Transaction request has been accepted.

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

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Stockobject[]required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/v1/bulk/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "Stock": [
      {
        "id": "text",
        "clientReferenceId": "text",
        "tenantId": "tenantA",
        "facilityId": "FacilityA",
        "productVariantId": "text",
        "quantity": 1,
        "wayBillNumber": "text",
        "referenceId": "C-1",
        "referenceIdType": "PROJECT",
        "transactionType": "RECEIVED",
        "transactionReason": "RECEIVED",
        "transactingPartyId": "text",
        "transactingPartyType": "WAREHOUSE",
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "isDeleted": true,
        "rowVersion": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ]
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Stock Transaction request has been accepted.

Update record for transfer of a stock transaction

Update record for transfer of a stock transaction

post

/stock/v1/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Stockobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "Stock": {
      "id": "text",
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "facilityId": "FacilityA",
      "productVariantId": "text",
      "quantity": 1,
      "wayBillNumber": "text",
      "referenceId": "C-1",
      "referenceIdType": "PROJECT",
      "transactionType": "RECEIVED",
      "transactionReason": "RECEIVED",
      "transactingPartyId": "text",
      "transactingPartyType": "WAREHOUSE",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Stock": {
    "id": "text",
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "facilityId": "FacilityA",
    "productVariantId": "text",
    "quantity": 1,
    "wayBillNumber": "text",
    "referenceId": "C-1",
    "referenceIdType": "PROJECT",
    "transactionType": "RECEIVED",
    "transactionReason": "RECEIVED",
    "transactingPartyId": "text",
    "transactingPartyType": "WAREHOUSE",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Stock Transaction request has been accepted.

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

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Stockobject[]required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/v1/bulk/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "Stock": [
      {
        "id": "text",
        "clientReferenceId": "text",
        "tenantId": "tenantA",
        "facilityId": "FacilityA",
        "productVariantId": "text",
        "quantity": 1,
        "wayBillNumber": "text",
        "referenceId": "C-1",
        "referenceIdType": "PROJECT",
        "transactionType": "RECEIVED",
        "transactionReason": "RECEIVED",
        "transactingPartyId": "text",
        "transactingPartyType": "WAREHOUSE",
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "isDeleted": true,
        "rowVersion": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ]
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Stock Transaction request has been accepted.

Soft delete record for transfer of a stock transaction

Soft delete record for transfer of a stock transaction

post

/stock/v1/_delete

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Stockobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/v1/_delete' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "Stock": {
      "id": "text",
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "facilityId": "FacilityA",
      "productVariantId": "text",
      "quantity": 1,
      "wayBillNumber": "text",
      "referenceId": "C-1",
      "referenceIdType": "PROJECT",
      "transactionType": "RECEIVED",
      "transactionReason": "RECEIVED",
      "transactingPartyId": "text",
      "transactingPartyType": "WAREHOUSE",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Stock": {
    "id": "text",
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "facilityId": "FacilityA",
    "productVariantId": "text",
    "quantity": 1,
    "wayBillNumber": "text",
    "referenceId": "C-1",
    "referenceIdType": "PROJECT",
    "transactionType": "RECEIVED",
    "transactionReason": "RECEIVED",
    "transactingPartyId": "text",
    "transactingPartyType": "WAREHOUSE",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Stock Transaction delete request has been accepted.

Soft delete records for transfer of a stock transaction

Soft delete records for transfer of a stock transaction

post

/stock/v1/bulk/_delete

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Stockobject[]required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/v1/bulk/_delete' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "Stock": [
      {
        "id": "text",
        "clientReferenceId": "text",
        "tenantId": "tenantA",
        "facilityId": "FacilityA",
        "productVariantId": "text",
        "quantity": 1,
        "wayBillNumber": "text",
        "referenceId": "C-1",
        "referenceIdType": "PROJECT",
        "transactionType": "RECEIVED",
        "transactionReason": "RECEIVED",
        "transactingPartyId": "text",
        "transactingPartyType": "WAREHOUSE",
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "isDeleted": true,
        "rowVersion": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ]
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Stock Transaction delete request has been accepted.

Search for stock transaction

Search for stock transaction

post

/stock/v1/_search

Query parameters

limitanyrequired

Pagination - limit records in response

offsetanyrequired

Pagination - offset from which records should be returned in response

tenantIdanyrequired

Unique id for a tenant.

lastChangedSinceany

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedany

Used in search APIs to specify if (soft) deleted records should be included in search results.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Stockobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "Stock": {
      "id": [
        "text"
      ],
      "clientReferenceId": [
        "text"
      ],
      "facilityId": "FacilityA",
      "productVariantId": "text",
      "referenceId": "C-1",
      "referenceIdType": "PROJECT",
      "transactionType": "RECEIVED",
      "transactionReason": "RECEIVED",
      "transactingPartyId": "text",
      "transactingPartyType": "WAREHOUSE",
      "wayBillNumber": "text"
    }
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Stock": [
    {
      "id": "text",
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "facilityId": "FacilityA",
      "productVariantId": "text",
      "quantity": 1,
      "wayBillNumber": "text",
      "referenceId": "C-1",
      "referenceIdType": "PROJECT",
      "transactionType": "RECEIVED",
      "transactionReason": "RECEIVED",
      "transactingPartyId": "text",
      "transactingPartyType": "WAREHOUSE",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Stock transfer.

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

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

StockReconciliationobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/reconciliation/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "StockReconciliation": {
      "id": "text",
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "facilityId": "FacilityA",
      "productVariantId": "text",
      "referenceId": "C-1",
      "referenceIdType": "PROJECT",
      "physicalCount": 1,
      "calculatedCount": 1,
      "commentsOnReconciliation": "text",
      "dateOfReconciliation": 1663218161,
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "StockReconciliation": {
    "id": "text",
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "facilityId": "FacilityA",
    "productVariantId": "text",
    "referenceId": "C-1",
    "referenceIdType": "PROJECT",
    "physicalCount": 1,
    "calculatedCount": 1,
    "commentsOnReconciliation": "text",
    "dateOfReconciliation": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Accepted.

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

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

StockReconciliationobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/reconciliation/v1/bulk/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "StockReconciliation": [
      {
        "id": "text",
        "clientReferenceId": "text",
        "tenantId": "tenantA",
        "facilityId": "FacilityA",
        "productVariantId": "text",
        "referenceId": "C-1",
        "referenceIdType": "PROJECT",
        "physicalCount": 1,
        "calculatedCount": 1,
        "commentsOnReconciliation": "text",
        "dateOfReconciliation": 1663218161,
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "isDeleted": true,
        "rowVersion": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ]
  }'

202

400

202

No body

Accepted.

Update stock reconciliation record

Update stock reconciliation record

post

/stock/reconciliation/v1/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

StockReconciliationobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/reconciliation/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "StockReconciliation": {
      "id": "text",
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "facilityId": "FacilityA",
      "productVariantId": "text",
      "referenceId": "C-1",
      "referenceIdType": "PROJECT",
      "physicalCount": 1,
      "calculatedCount": 1,
      "commentsOnReconciliation": "text",
      "dateOfReconciliation": 1663218161,
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "StockReconciliation": {
    "id": "text",
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "facilityId": "FacilityA",
    "productVariantId": "text",
    "referenceId": "C-1",
    "referenceIdType": "PROJECT",
    "physicalCount": 1,
    "calculatedCount": 1,
    "commentsOnReconciliation": "text",
    "dateOfReconciliation": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Stock Reconciliation request has been accepted.

Update stock reconciliation records

Update stock reconciliation records

post

/stock/reconciliation/v1/bulk/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

StockReconciliationobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/reconciliation/v1/bulk/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "StockReconciliation": [
      {
        "id": "text",
        "clientReferenceId": "text",
        "tenantId": "tenantA",
        "facilityId": "FacilityA",
        "productVariantId": "text",
        "referenceId": "C-1",
        "referenceIdType": "PROJECT",
        "physicalCount": 1,
        "calculatedCount": 1,
        "commentsOnReconciliation": "text",
        "dateOfReconciliation": 1663218161,
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "isDeleted": true,
        "rowVersion": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ]
  }'

202

400

202

No body

Stock Reconciliation request has been accepted.

Soft delete stock reconciliation record

Soft delete stock reconciliation record

post

/stock/reconciliation/v1/_delete

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

StockReconciliationobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/reconciliation/v1/_delete' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "StockReconciliation": {
      "id": "text",
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "facilityId": "FacilityA",
      "productVariantId": "text",
      "referenceId": "C-1",
      "referenceIdType": "PROJECT",
      "physicalCount": 1,
      "calculatedCount": 1,
      "commentsOnReconciliation": "text",
      "dateOfReconciliation": 1663218161,
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "StockReconciliation": {
    "id": "text",
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "facilityId": "FacilityA",
    "productVariantId": "text",
    "referenceId": "C-1",
    "referenceIdType": "PROJECT",
    "physicalCount": 1,
    "calculatedCount": 1,
    "commentsOnReconciliation": "text",
    "dateOfReconciliation": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Stock Reconciliation delete request has been accepted.

Soft delete stock reconciliation records

Soft delete stock reconciliation records

post

/stock/reconciliation/v1/bulk/_delete

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

StockReconciliationobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/reconciliation/v1/bulk/_delete' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "StockReconciliation": [
      {
        "id": "text",
        "clientReferenceId": "text",
        "tenantId": "tenantA",
        "facilityId": "FacilityA",
        "productVariantId": "text",
        "referenceId": "C-1",
        "referenceIdType": "PROJECT",
        "physicalCount": 1,
        "calculatedCount": 1,
        "commentsOnReconciliation": "text",
        "dateOfReconciliation": 1663218161,
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "isDeleted": true,
        "rowVersion": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ]
  }'

202

400

202

No body

Stock Reconciliation delete request has been accepted.

Search for stock reconciliation record

Search for stock reconciliation record

post

/stock/reconciliation/v1/_search

Query parameters

limitanyrequired

Pagination - limit records in response

offsetanyrequired

Pagination - offset from which records should be returned in response

tenantIdanyrequired

Unique id for a tenant.

lastChangedSinceany

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedany

Used in search APIs to specify if (soft) deleted records should be included in search results.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

StockReconciliationobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/stock/reconciliation/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "correlationId": "text"
    },
    "StockReconciliation": {
      "id": [
        "text"
      ],
      "clientReferenceId": [
        "text"
      ],
      "facilityId": "FacilityA",
      "productVariantId": "text"
    }
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "StockReconciliation": [
    {
      "id": "text",
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "facilityId": "FacilityA",
      "productVariantId": "text",
      "referenceId": "C-1",
      "referenceIdType": "PROJECT",
      "physicalCount": 1,
      "calculatedCount": 1,
      "commentsOnReconciliation": "text",
      "dateOfReconciliation": 1663218161,
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Stock reconciliations.