| Endpoint |
Description |
Parameters |
| https://tracapi.com/api.v2/location/ |
Create or update a location. Use this endpoint if you have multiple locations in your organization. |
| auth_key | your authorization key. |
| address | Physical addres of the location. |
| suite | Suite # if multi-tenant location. |
| city | City of the location. |
| state | State abbreviation of location. |
| zip | Zip code of location. |
| gln | GS1-Global Location Number (optional) |
| data | JSON encoded data (JSON Object) |
| documents | JSON encoded list of documents. |
|
| https://tracapi.com/api.v2/put_doc/ |
Store a document on the blockchain. |
| auth_key | your authorization key. |
| path | The URL path of the document host. |
| file | The name of the file. |
| file_hash | Optional sha256 has of the file. |
| data | JSON encoded data (JSON Object) |
|
| https://tracapi.com/api.v2/receive/ |
Receive a product. |
| auth_key | your authorization key. |
| address | Physical addres of the location. |
| suite | Suite # if multi-tenant location. |
| city | City of the location. |
| state | State abbreviation of location. |
| zip | Zip code of location. |
| gln | GS1-Global Location Number (optional) |
| gtin | GS1-Global Trade Identification Number (GTIN) |
| lot | Lot or batch number |
| data | JSON encoded data related to the item (JSON Object) |
| shipment_id | Shipment Id (Optional) |
| shipment_data | JSON encoded data related to the shipment (JSON Object) |
| documents | JSON encoded list of documents related to the item. |
|
| https://tracapi.com/api.v2/process/ |
Create a batch of product with multiple inputs. |
| auth_key | your authorization key. |
| gtin | The URL path of the document host. |
| lot | The name of the file. |
| data | JSON encoded data (JSON Object) |
| inputs | JSON encoded data (JSON Array) |
| documents | JSON encoded data (JSON Array) |
|
| https://tracapi.com/api.v2/package/ |
Package or repackage a product. |
| auth_key | your authorization key. |
| package_gtin | GTIN of the packaged (output) product. |
| package_lot | Lot or batch number of the packaged (output) product. |
| package_data | Data related to the packaged (output) product. |
| product_gtin | GTIN of the input product. |
| product_lot | Lot number of the input product. |
| product_data | Data related to the input product. (JSON Object) |
| documents | JSON encoded list of documents linked to the packaged product. |
|
| https://tracapi.com/api.v2/ship/ |
Ship a product to a location. |
| auth_key | your authorization key. |
| address | Physical address of the location receiving the product. |
| suite | Suite # if multi-tenant location. |
| city | City of the location receiving the product. |
| state | State abbreviation of location receiving the product. |
| zip | Zip code of location. |
| gln | GS1-Global Location Number of the receiving location. (optional) |
| gtin | GS1-Global Trade Identification Number (GTIN) |
| lot | Lot or batch number |
| data | JSON encoded data related to the item (JSON Object) |
| shipment_id | Shipment Id (Optional) |
| shipment_data | JSON encoded data related to the shipment (JSON Object) |
| documents | JSON encoded list of documents related to the item. |
|
| https://tracapi.com/api.v2/class/ |
Create a new asset class (GTIN) or update the metadata attached to an asset class. |
| auth_key | your authorization key. |
| gtin | The GTIN of the item. |
| data | JSON encoded data (JSON Object) |
| documents | JSON encoded data (JSON Array) |
|
| https://tracapi.com/api.v2/batch/ |
Create a new batch (GTIN/LOT) to describe a product. Will be attached to the product regardless of the location. |
| auth_key | your authorization key. |
| gtin | The GTIN of the item. |
| lot | The lot number of the batch. |
| data | JSON encoded data (JSON Object) |
| documents | JSON encoded data (JSON Array) |
|
| https://tracapi.com/api.v2/asset/ |
Update an asset's metadata or documents attached to the asset. |
| auth_key | your authorization key. |
| gtin | The GTIN of the item. |
| lot | The lot number of the batch. |
| batch | 0 if updating information about the batch, 1 if updating the asset at your location. |
| documents | JSON encoded data containing a list of documents. (JSON Array) |
|
| https://tracapi.com/api.v2/get_doc/ |
Get a document from the blockchain. Will be returned as it's file type. |
| auth_key | your authorization key. |
| asset_id | The asset id representing the document. |
|
| https://tracapi.com/api.v2/trace/ |
Trace an asset. |
| auth_key | your authorization key. |
| gtin | The GTIN of the item being traced. |
| lot | The lot or batch number of the item being traced. |
| direction | FORWARD/BACKWARD/BOTH - Default BOTH. |
| levels | The number of levels yo trace. |
|
| https://tracapi.com/api.v2/get/ |
Get an asset. |
| auth_key | your authorization key. |
| asset_id | The asset id of the asset. |
|