Stock
Last updated
Was this helpful?
Last updated
Was this helpful?
Create/Add a new record for transfer of product variant stock
POST /stock/v1/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 574
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Stock": {
"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
}
]
},
"rowVersion": 1
}
}
{
"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
}
}
}
Create/Add a new record for transfer of product variant stock in bulk
POST /stock/v1/bulk/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 576
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Stock": [
{
"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
}
]
},
"rowVersion": 1
}
]
}
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
}
Update record for transfer of a stock transaction
POST /stock/v1/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 574
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Stock": {
"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
}
]
},
"rowVersion": 1
}
}
{
"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
}
}
}
Update records for transfer of a stock transaction in bulk
POST /stock/v1/bulk/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 576
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Stock": [
{
"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
}
]
},
"rowVersion": 1
}
]
}
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
}
Soft delete record for transfer of a stock transaction
POST /stock/v1/_delete HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 574
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Stock": {
"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
}
]
},
"rowVersion": 1
}
}
{
"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
}
}
}
Soft delete records for transfer of a stock transaction
POST /stock/v1/bulk/_delete HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 576
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Stock": [
{
"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
}
]
},
"rowVersion": 1
}
]
}
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
}
Search for stock transaction
Pagination - limit records in response
Pagination - offset from which records should be returned in response
Unique id for a tenant.
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.
Used in search APIs to specify if (soft) deleted records should be included in search results.
POST /stock/v1/_search?limit=null&offset=null&tenantId=null HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 447
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "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"
}
}
{
"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
}
}
]
}
Create/Add a new stock reconciliation record for a product variant
POST /stock/reconciliation/v1/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 535
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"StockReconciliation": {
"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
}
]
},
"rowVersion": 1
}
}
{
"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
}
}
}
Create/Add a new stock reconciliation record for a product variant in bulk
POST /stock/reconciliation/v1/bulk/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 537
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"StockReconciliation": [
{
"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
}
]
},
"rowVersion": 1
}
]
}
No content
Update stock reconciliation record
POST /stock/reconciliation/v1/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 535
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"StockReconciliation": {
"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
}
]
},
"rowVersion": 1
}
}
{
"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
}
}
}
Update stock reconciliation records
POST /stock/reconciliation/v1/bulk/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 537
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"StockReconciliation": [
{
"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
}
]
},
"rowVersion": 1
}
]
}
No content
Soft delete stock reconciliation record
POST /stock/reconciliation/v1/_delete HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 535
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"StockReconciliation": {
"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
}
]
},
"rowVersion": 1
}
}
{
"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
}
}
}
Soft delete stock reconciliation records
POST /stock/reconciliation/v1/bulk/_delete HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 537
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"StockReconciliation": [
{
"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
}
]
},
"rowVersion": 1
}
]
}
No content
Search for stock reconciliation record
Pagination - limit records in response
Pagination - offset from which records should be returned in response
Unique id for a tenant.
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.
Used in search APIs to specify if (soft) deleted records should be included in search results.
POST /stock/reconciliation/v1/_search?limit=null&offset=null&tenantId=null HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 267
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"StockReconciliation": {
"id": [
"text"
],
"clientReferenceId": [
"text"
],
"facilityId": "FacilityA",
"productVariantId": "text"
}
}
{
"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
}
}
]
}