Create Company

Create Company

curl --request POST \
  --url https://api-staging.luladelivery.store/stores/company

const options = {method: 'POST'};

fetch('https://api-staging.luladelivery.store/stores/company', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.luladelivery.store/stores/company",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.luladelivery.store/stores/company"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-staging.luladelivery.store/stores/company")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "address_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "logo": "<string>",
  "banner": "<string>",
  "profile_image": "<string>",
  "receipt_header": "<string>",
  "ein": "<string>",
  "status": "<string>",
  "company_type": "<string>",
  "active": 123,
  "hubspot_id": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>",
  "website": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>",
  "deleted_at": "<string>"
}

POST

stores

company

Create Company

curl --request POST \
  --url https://api-staging.luladelivery.store/stores/company

const options = {method: 'POST'};

fetch('https://api-staging.luladelivery.store/stores/company', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.luladelivery.store/stores/company",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.luladelivery.store/stores/company"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-staging.luladelivery.store/stores/company")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "address_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "logo": "<string>",
  "banner": "<string>",
  "profile_image": "<string>",
  "receipt_header": "<string>",
  "ein": "<string>",
  "status": "<string>",
  "company_type": "<string>",
  "active": 123,
  "hubspot_id": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>",
  "website": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>",
  "deleted_at": "<string>"
}

This endpoint allows you to create a new company with all necessary business information. The company will be assigned a unique ID and can then be used to create and manage stores under its umbrella.

Request Body Fields

string

required

Company name. Example: “Salman’s Company”

string

required

Company contact email address. Example: “[email protected]”

object

required

Company address information

Show address

string

required

Primary address line. Example: “123 Main Street”

string

required

City name. Example: “Philadelphia”

string

required

State or province. Example: “PA”

string

required

ZIP or postal code. Example: “19104”

string

required

Company contact phone number. Example: “090078601”

string

Company website URL. Example: “https://www.lulaconvenience.com/“

Note the correct spelling is “website” not “webiste”

string

Company logo URL or base64 encoded image

string

Company banner image URL or base64 encoded image

string

Company profile image URL or base64 encoded image

string

Custom header text for receipts

string

required

Employer Identification Number. Example: “0000”

string

required

Company operational status. Example: “On Boarding”

Valid Status Values

On Boarding
Live
Off Boarding
Churned
Suspended

string

required

Type of company classification. Example: “Mid-Market”

Valid Company Types

Enterprise
Mid-Market
Small Business
Startup

number

required

Company active status. Use 1 for active, 0 for inactive

Setting to 0 will deactivate the company and all associated stores

number

Associated HubSpot contact ID for CRM integration. Example: 12121212121212

Request Example

{
    "name": "Salman's Company",
    "email": "[email protected]",
    "address": {
        "line_1": "123 Main Street",
        "city": "Philadelphia",
        "state": "PA",
        "zip": "19104"
    },
    "phone_number": "090078601",
    "website": "https://www.lulaconvenience.com/",
    "logo": "",
    "banner": "",
    "profile_image": "",
    "receipt_header": "",
    "ein": "0000",
    "status": "On Boarding",
    "company_type": "Mid-Market",
    "active": 1,
    "hubspot_id": 12121212121212
}

Response

string

Unique company identifier generated by the system

string

Unique identifier for the company’s address record

string

Company name as provided in the request

string

Company contact email address

string

Company contact phone number

string

Company logo URL or encoded image

string

Company banner image URL or encoded image

string

Company profile image URL or encoded image

string

Custom receipt header text

string

Employer Identification Number

string

Current company operational status

string

Company classification type

number

Company active status (1 = active, 0 = inactive)

string

Associated HubSpot contact ID

string

Timestamp of last update (ISO 8601 format)

string

Timestamp of creation (ISO 8601 format)

string

Company website URL

string

ID of user who created the company record

string

ID of user who last updated the company record

string

Timestamp of deletion (null if not deleted)

Response Example

{
    "id": "1000003",
    "address_id": "480c9c0c-50b8-4911-89db-e63d68c6f58a",
    "name": "Salman's Company",
    "email": "[email protected]",
    "phone_number": "090078601",
    "logo": "",
    "banner": "",
    "profile_image": "",
    "receipt_header": "",
    "ein": "0000",
    "status": "On Boarding",
    "company_type": "Mid-Market",
    "active": 1,
    "hubspot_id": "12121212121212",
    "updated_at": "2023-06-19T15:22:31.591Z",
    "created_at": "2023-06-19T15:22:31.591Z",
    "website": null,
    "created_by": null,
    "updated_by": null,
    "deleted_at": null
}

API Documentation - Legacy

API Documentation - Latest

Request Example

Response

Response Example

​Request Example

​Response

​Response Example

Request Example

Response

Response Example