Product
Last updated
Was this helpful?
Last updated
Was this helpful?
Create a new product
/product/v1/_create
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.
Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE
CREATE
CREATE
, UPDATE
, DELETE
Update product
/product/v1/_update
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.
Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE
CREATE
CREATE
, UPDATE
, DELETE
Search product
/product/v1/_search
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.
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.
Create/Add a new variant for a product
/product/variant/v1/_create
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.
Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE
CREATE
CREATE
, UPDATE
, DELETE
Update product variant
/product/variant/v1/_update
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.
Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE
CREATE
CREATE
, UPDATE
, DELETE
Search product variant
/product/variant/v1/_search
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.
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.