Basic APIs
Company Details Endpoint
Trace Connect APIs
- Introduction
- Authentication using JWT
- OAuth 2.0
- Basic APIs
- Advanced APIs
Basic APIs
Company Details Endpoint
Get Company Details endpoint allows you to retrieve detailed information about a specific company within the supply chain by making a GET request. Provide the hash ID of the company in the endpoint URL.
GET
/
supply-chains
/
companies
/
{hashid}
curl --request GET \
--url http://localhost:3000/connect/v1/supply-chains/companies/{hashid}/ \
--header 'Authorization: <api-key>'
{
"id": "<string>",
"currency": {
"id": "<string>",
"name": "<string>",
"code": "<string>"
},
"buyer": {
"id": "<string>",
"name": "<string>",
"entity_card": {
"id": "<string>",
"card": {
"id": "<string>",
"card_id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"display_id": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"is_active": true,
"creator": "<string>",
"updater": "<string>",
"entity": "<string>"
},
"image": "<string>",
"description": "<string>"
},
"entity_card": {
"id": "<string>",
"card": {
"id": "<string>",
"card_id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"display_id": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"is_active": true,
"creator": "<string>",
"updater": "<string>",
"entity": "<string>"
},
"forms": [
{
"id": "<string>",
"products": [
{
"id": "<string>",
"premiums": "<string>",
"is_active": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"image": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"fields": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"field_config": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"key": "<string>",
"visibility": true,
"required": true,
"creator": "<string>",
"updater": "<string>"
}
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"form_type": "TRANSACTION",
"creator": "<string>",
"updater": "<string>",
"owner": "<string>"
}
],
"field_visibilties": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"name": "<string>",
"visibility": true,
"type": "TRANSACTION",
"creator": "<string>",
"updater": "<string>",
"company": "<string>"
}
],
"owned_premiums": [
"<string>"
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"image": "<string>",
"description": "<string>",
"house_name": "<string>",
"street": "<string>",
"city": "<string>",
"sub_province": "<string>",
"province": "<string>",
"latitude": 123,
"longitude": 123,
"zipcode": "<string>",
"country": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"name": "<string>",
"buy_enabled": true,
"sell_enabled": true,
"quality_correction": true,
"allow_multiple_login": true,
"creator": "<string>",
"updater": "<string>",
"members": [
"<string>"
],
"products": [
"<string>"
]
}
Authorizations
Path Parameters
Response
200 - application/json
The response is of type object
.
curl --request GET \
--url http://localhost:3000/connect/v1/supply-chains/companies/{hashid}/ \
--header 'Authorization: <api-key>'
{
"id": "<string>",
"currency": {
"id": "<string>",
"name": "<string>",
"code": "<string>"
},
"buyer": {
"id": "<string>",
"name": "<string>",
"entity_card": {
"id": "<string>",
"card": {
"id": "<string>",
"card_id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"display_id": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"is_active": true,
"creator": "<string>",
"updater": "<string>",
"entity": "<string>"
},
"image": "<string>",
"description": "<string>"
},
"entity_card": {
"id": "<string>",
"card": {
"id": "<string>",
"card_id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"display_id": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"is_active": true,
"creator": "<string>",
"updater": "<string>",
"entity": "<string>"
},
"forms": [
{
"id": "<string>",
"products": [
{
"id": "<string>",
"premiums": "<string>",
"is_active": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"image": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"fields": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"field_config": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"key": "<string>",
"visibility": true,
"required": true,
"creator": "<string>",
"updater": "<string>"
}
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"form_type": "TRANSACTION",
"creator": "<string>",
"updater": "<string>",
"owner": "<string>"
}
],
"field_visibilties": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"name": "<string>",
"visibility": true,
"type": "TRANSACTION",
"creator": "<string>",
"updater": "<string>",
"company": "<string>"
}
],
"owned_premiums": [
"<string>"
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"image": "<string>",
"description": "<string>",
"house_name": "<string>",
"street": "<string>",
"city": "<string>",
"sub_province": "<string>",
"province": "<string>",
"latitude": 123,
"longitude": 123,
"zipcode": "<string>",
"country": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"name": "<string>",
"buy_enabled": true,
"sell_enabled": true,
"quality_correction": true,
"allow_multiple_login": true,
"creator": "<string>",
"updater": "<string>",
"members": [
"<string>"
],
"products": [
"<string>"
]
}