Retrieve a Company

curl --request GET \
  --url https://commerce.driv.ly/api/companies/{id}

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "addresses": [
      "<string>"
    ],
    "phoneNumbers": [
      "<string>"
    ],
    "contacts": [
      "<string>"
    ]
  },
  "success": true
}

GET

companies

{id}

Retrieve a Company

curl --request GET \
  --url https://commerce.driv.ly/api/companies/{id}

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "addresses": [
      "<string>"
    ],
    "phoneNumbers": [
      "<string>"
    ],
    "contacts": [
      "<string>"
    ]
  },
  "success": true
}

Path Parameters

string

required

Customer is uniquely identified by id

Query Parameters

depth

integer

The number of levels of related objects to include in the response

Response

Company Found

data

Company · object

Show child attributes

data.id

string

required

Customer is uniquely identified by id

data.name

string

required

Company has Name

data.addresses

(string | Address · object)[]

Customer is located at Addresses

data.phoneNumbers

string[]

Customer has Phone Number

data.contacts

(string | Contact · object)[]

Company has Contact

success

boolean

Create a new Company Update an existing Company

⌘I

Services

Guides

API Reference

Retrieve a Company

Path Parameters

Query Parameters

Response