Create a new Company - Drivly Docs

curl --request POST \ --url https://commerce.driv.ly/api/companies \ --header 'Content-Type: application/json' \ --data ' { "name": "<string>", "id": "<string>", "addresses": [ "<string>" ], "phoneNumbers": [ "<string>" ], "contacts": [ "<string>" ] } '

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

Query Parameters

depth

integer

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

Body

application/json

name

string

required

Company has Name

string

Customer is uniquely identified by id

addresses

(string | Address · object)[]

Customer is located at Addresses

phoneNumbers

string[]

Customer has Phone Number

Pattern: ^\+?1?[- ]?$?([0-9]{3})$?[- ]?([0-9]{3})-?([0-9]{4})$

contacts

(string | Contact · object)[]

Company has Contact

Response

Company Created

data

Company · object

Show child attributes

Example:

{
  "id": "com_9j3k2dls0j29",
  "name": "Auto Sales Co.",
  "address": "123 Main St, Anytown, USA",
  "locations": [
    {
      "id": "loc_k2j3l9s9d4j0",
      "companyId": "com_9j3k2dls0j29",
      "address": "123 Main St, Anytown, USA",
      "phone": "+1234567890"
    }
  ]
}

success

boolean