LOU REST API (V1)

Updated on August 1, 2023

The LOU REST API offers access to key LOU data.

All resources that you will most likely use are prefixed with a star symbol (⭐).

While integrating the REST API, you may be interested in the following guides:

Productin Product Management

⭐ Product Details

GET
/api/v1/product/{sku_identifier}{?sku_id_type}

Get Product Details.

Match on sku_id_type: sku | primary_key.

URI Parameters
sku_identifier
stringRequired

SKU identifier

sku_id_type
stringRequired

SKU ID type sku | primary_key

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
object

Product SKU

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

skuType
string

Product SKU type

category1
string

Product category 1

category2
string

Product category 2

category3
string

Product category 3

category4
string

Product category 4

onHand
number

Product quantity on hand

reserved
number

Product quantity reserved

available
number

Product quantity available

onOrder
number

Product quantity on order

onEstimate
number

Product quantity on estimate

sellPrice
number

Product sell price

sellUnitMeasure
string

Product sell unit of measure

sellUnitMeasureFactor
string

Product sell unit of measure factor

priceBy
string

Product price by method

priceByValue
number

Product price by value

defaultVendor
string

Product default vendor

defaultVendorSKU
string

Product default vendor SKU

defaultVendorDescription
string

Product vendor description

defaultVendorAlternateUPC
string

Product vendor alternative UPC

purchaseCost
number

Product purchase cost

purchaseUnitMeasure
string

Product purchase unit of measure

purchaseUnitMeasureFactor
string

Product purchase unit of measure factor

weight
number

Product weight

weightUnitMeasure
string

Product weight unit of measure

cubicVolume
number

Product cubic volume

cubicVolumeUnitMeasure
string

Product cubic volume unit of measure

taxable
boolean

Product taxable true | false

trackAsEquipment
boolean

Product track as equipment true | false

discontinued
boolean

Product discontinued true | false

clearance
boolean

Product on clearance true | false

manufacturer
string

Product manufacturer

manufacturerSKU
string

Product manufacturer SKU

manufacturerDescription
string

Product manufacturer description

extendedDescriptionOrder
string

Extended description text for the order

extendedDescriptionInvoice
string

Extended description text for the invoice

extendedDescriptionPackingSlip
string

Extended description text for the packing slip

  • GEThttps://louapi.evosus.com/api/v1/product/sku_identifier
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

⭐ Product Details by UPC

GET
/api/v1/product/by-upc/{upc}

Get Product Details by UPC.

Match on upc.

URI Parameters
upc
stringRequired

UPC identifier

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Product SKUs

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

skuType
string

Product SKU type

category1
string

Product category 1

category2
string

Product category 2

category3
string

Product category 3

category4
string

Product category 4

onHand
number

Product quantity on hand

reserved
number

Product quantity reserved

available
number

Product quantity available

onOrder
number

Product quantity on order

onEstimate
number

Product quantity on estimate

sellPrice
number

Product sell price

sellUnitMeasure
string

Product sell unit of measure

sellUnitMeasureFactor
string

Product sell unit of measure factor

priceBy
string

Product price by method

priceByValue
number

Product price by value

defaultVendor
string

Product default vendor

defaultVendorSKU
string

Product default vendor SKU

defaultVendorDescription
string

Product default vendor description

defaultVendorAlternateUPC
string

Product default vendor alternative UPC

purchaseCost
number

Product purchase cost

purchaseUnitMeasure
string

Product purchase unit of measure

purchaseUnitMeasureFactor
string

Product purchase unit of measure factor

weight
number

Product weight

weightUnitMeasure
string

Product weight unit of measure

cubicVolume
number

Product cubic volume

cubicVolumeUnitMeasure
string

Product cubic volume unit of measure

taxable
boolean

Product taxable true | false

trackAsEquipment
boolean

Product track as equipment true | false

discontinued
boolean

Product discontinued true | false

clearance
boolean

Product on clearance true | false

manufacturer
string

Product manufacturer

manufacturerSKU
string

Product manufacturer SKU

manufacturerDescription
string

Product manufactuer SKU description

extendedDescriptionOrder
string

Extended description text for the order

extendedDescriptionInvoice
string

Extended description text for the invoice

extendedDescriptionPackingSlip
string

Extended description text for the packing slip

vendors
array[object]

Alternate Product Vendors

name
string

Vendor name

vendorSKU
string

Product SKU from Vendor

description
string

Product description from Vendor

alternateUPC
string

Alternate vendor UPC

cost
number

Alternate vendor cost

costUnitMeasure
string

Alternate vendor unit measure for cost

minimumQuantityOrder
number

Minimum quantity for vendor order

isDefaultPurchaseVendor
boolean

Vendor is default true | false

  • GEThttps://louapi.evosus.com/api/v1/product/by-upc/upc
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product All

GET
/api/v1/product/all

Get All Products.

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Product SKUs

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

skuType
string

Product SKU type

  • GEThttps://louapi.evosus.com/api/v1/product/all
  • Tiersbetadeveloper
HTTP
Request
(loading)
Response
(loading)

Product Stocksites

GET
/api/v1/product/{sku_identifier}/stock-sites{?sku_id_type}

Get Product Stocksite Details.

Match on sku_id_type: sku | primary_key.

URI Parameters
sku_identifier
stringRequired

SKU identifier

sku_id_type
stringRequired

SKU ID type sku | primary_key

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
object

Product SKU

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

stocksites
array[object]

Product Stocksites

stocksiteName
string

Stocksite name

onHand
number

Product quantity on hand

reserved
number

Product quantity reserved

available
number

Product quantity available

onOrder
number

Product quantity on order

onEstimate
number

Product quantity on estimate

address1
string

Stocksite address line 1

address2
string

Stocksite address line 1

city
string

Stocksite city

state
string

Stocksite state

country
string

Stocksite country

postalCode
string

Stocksite postal code

latitude
number

Stocksite latitude

longitude
number

Stocksite longitude

phone
string

Stocksite phone

email
string

Stocksite email

  • GEThttps://louapi.evosus.com/api/v1/product/sku_identifier/stock-sites
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Stocksites by UPC

GET
/api/v1/product/by-upc/{upc}/stock-sites

Get Product Stocksite Details by UPC.

Match on upc.

URI Parameters
upc
stringRequired

UPC identifier

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Product SKUs

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

vendors
array[object]

Alternate Product Vendors

name
string

Vendor name

vendorSKU
string

Product SKU from Vendor

description
string

Product description from Vendor

alternateUPC
string

Alternate vendor UPC

cost
number

Alternate vendor cost

costUnitMeasure
string

Alternate vendor unit measure for cost

minimumQuantityOrder
number

Minimum quantity for vendor order

isDefaultPurchaseVendor
boolean

Vendor is default true | false

stocksites
array[object]

Product Stocksites by UPC

stocksiteName
string

Stocksite name

onHand
number

Product quantity on hand

reserved
number

Product quantity reserved

available
number

Product quantity available

onOrder
number

Product quantity on order

onEstimate
number

Product quantity on estimate

address1
string

Stocksite address line 1

address2
string

Stocksite address line 1

city
string

Stocksite city

state
string

Stocksite state

country
string

Stocksite country

postalCode
string

Stocksite postal code

latitude
number

Stocksite latitude

longitude
number

Stocksite longitude

phone
string

Stocksite phone

email
string

Stocksite email

  • GEThttps://louapi.evosus.com/api/v1/product/by-upc/upc/stock-sites
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Stocksites/Bin

GET
/api/v1/product/{sku_identifier}/stock-sites/bins{?sku_id_type}

Get Product Stocksite/Bin Details.

Match on sku_id_type: sku | primary_key.

URI Parameters
sku_identifier
stringRequired

SKU identifier

sku_id_type
stringRequired

SKU ID type sku | primary_key

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
object

Product SKU

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

stocksites
array[object]

Product Stocksites

stocksiteName
string

Stocksite name

address1
string

Stocksite address line 1

address2
string

Stocksite address line 1

city
string

Stocksite city

state
string

Stocksite state

country
string

Stocksite country

postalCode
string

Stocksite postal code

latitude
number

Stocksite latitude

longitude
number

Stocksite longitude

phone
string

Stocksite phone

email
string

Stocksite email

bins
array[object]

Product Bins

bin
string

Bin name

onHand
number

Bin quantity on hand

reserved
number

Bin quantity reserved

available
number

Bin quantity available

onOrder
number

Bin quantity on order

onEstimate
number

Bin quantity on an estimate

isDefault
boolean

Bin is default true | false

  • GEThttps://louapi.evosus.com/api/v1/product/sku_identifier/stock-sites/bins
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Stocksites/Bin by UPC

GET
/api/v1/product/by-upc/{upc}/stock-sites/bins

Get Product Stocksite/Bin Details by UPC.

Match on upc.

URI Parameters
upc
stringRequired

UPC identifier

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Product SKUs

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

vendors
array[object]

Alternate Product Vendors

name
string

Vendor name

vendorSKU
string

Product SKU from Vendor

description
string

Product description from Vendor

alternateUPC
string

Alternate vendor UPC

cost
number

Alternate vendor cost

costUnitMeasure
string

Alternate vendor unit measure for cost

minimumQuantityOrder
number

Minimum quantity for vendor order

isDefaultPurchaseVendor
boolean

Vendor is default true | false

stocksites
array[object]

Product Stocksites by UPC

stocksiteName
string

Stocksite name

address1
string

Stocksite address line 1

address2
string

Stocksite address line 1

city
string

Stocksite city

state
string

Stocksite state

postalCode
string

Stocksite postal code

latitude
number

Stocksite latitude

longitude
number

Stocksite longitude

phone
string

Stocksite phone

email
string

Stocksite email

bins
array[object]

Bins

bin
string
onHand
number

Bin quantity on hand

reserved
number

Bin quantity reserved

available
number

Bin quantity available

onOrder
number

Bin quantity on order

onEstimate
number

Bin quantity on an estimate

isDefault
boolean

Bin is default true | false

  • GEThttps://louapi.evosus.com/api/v1/product/by-upc/upc/stock-sites/bins
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Attributes

GET
/api/v1/product/{sku_identifier}/attributes{?sku_id_type}

Get Product Attribute Details.

Match on sku_id_type: sku | primary_key.

URI Parameters
sku_identifier
stringRequired

SKU identifier

sku_id_type
stringRequired

SKU ID type sku | primary_key

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
object

Product SKU

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

attributes
array[object]

Product Attributes

attributeID
string

Attribute identifier

sortOrder
number

Attribute sort order

name
string

Attribute name

helpText
string

Attribute help text

  • GEThttps://louapi.evosus.com/api/v1/product/sku_identifier/attributes
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Attributes by UPC

GET
/api/v1/product/by-upc/{upc}/attributes

Get Product Attribute Details by UPC.

Match on upc.

URI Parameters
upc
stringRequired

UPC identifier

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Product SKUs

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

vendors
array[object]

Alternate Product Vendors

name
string

Vendor name

vendorSKU
string

Product SKU from Vendor

description
string

Product description from Vendor

alternateUPC
string

Alternate vendor UPC

cost
number

Alternate vendor cost

costUnitMeasure
string

Alternate vendor unit measure for cost

minimumQuantityOrder
number

Minimum quantity for vendor order

isDefaultPurchaseVendor
boolean

Vendor is default true | false

attributes
array[object]

Attributes

attributeID
string

Attribute identifier

sortOrder
number

Attribute sort order

name
string

Attribute name

helpText
string

Attribute help text

  • GEThttps://louapi.evosus.com/api/v1/product/by-upc/upc/attributes
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Attribute Answers

GET
/api/v1/product/attributes/{id}/answers

Get Product Attribute Answers.

Match on id.

URI Parameters
id
stringRequired

Attribute Answer identifier

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
object

Attribute

attributeID
string

Attribute identifier

sortOrder
number

Attribute sort order

name
string

Attribute name

helpText
string

Attribute help text

answers
array[object]

Attribute Answers

answerID
string

Attribute answer identifier

sortOrder
number

Attribute answer sort order

name
string

Attribute answer name

priceAdjustment
number

Attribute answer price adjustment

costAdjustment
number

Attribute answer cost adjustment

appendToSKUCode
string

Attribute answer SKU code to append

  • GEThttps://louapi.evosus.com/api/v1/product/attributes/id/answers
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Kits

GET
/api/v1/product/{sku_identifier}/kits{?sku_id_type}

Get Product Kits.

Match on sku_id_type: sku | primary_key.

URI Parameters
sku_identifier
stringRequired

SKU identifier

sku_id_type
stringRequired

SKU ID type sku | primary_key

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
object

Product SKU

skuId
string

Product identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

kitPrice
number

Kit price

skuKits
array[object]

Product Kit Components

skuId
string

Product identifier

sku
string

Product SKU code

description
string

Product description

skuType
string

Product SKU type

price
number

Product price

quantity
number

Product quantity

unitMeasureName
string

Unit measure name

conversionFactor
number

Unit measure conversion factor

  • GEThttps://louapi.evosus.com/api/v1/product/sku_identifier/kits
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Kits by UPC

GET
/api/v1/product/by-upc/{upc}/kits

Get Product Kits by UPC.

Match on upc.

URI Parameters
upc
stringRequired

UPC identifier

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Product SKUs

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

kitPrice
number

Kit price

skuKits
array[object]

Kit Components

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

skuType
string

Product SKU type

price
number

Product price

quantity
number

Product quantity

unitMeasureName
string

Unit measure name

conversionFactor
number

Unit measure conversion factor

  • GEThttps://louapi.evosus.com/api/v1/product/by-upc/upc/kits
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Kit Questions

GET
/api/v1/product/{sku_identifier}/kits/questions{?sku_id_type}

Get Product Kit Questions.

Match on sku_id_type: sku | primary_key.

URI Parameters
sku_identifier
stringRequired

SKU identifier

sku_id_type
stringRequired

SKU ID type sku | primary_key

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
object

Product SKU

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

skuKitQuestions
array[object]

Product Kit Questions

questionID
string

Question identifier

sortOrder
string

Question sort order

name
string

Question name

question
string

Question string

requiredAnswer
boolean

Question requires an answer true | false

multipleSelection
boolean

Question allows multiple selection true | false

allowQuantityChange
boolean

Question allows quantity change true | false

  • GEThttps://louapi.evosus.com/api/v1/product/sku_identifier/kits/questions
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Kit Questions by UPC

GET
/api/v1/product/by-upc/{upc}/kits/questions

Get Product Kit Questions by UPC.

Match on upc.

URI Parameters
upc
stringRequired

UPC identifier

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Product SKUs

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

skuKitQuestions
array[object]

Product Kit Questions

questionID
string

Question identifier

sortOrder
string

Question sort order

name
string

Question name

question
string

Question string

requiredAnswer
boolean

Question requires an answer true | false

multipleSelection
boolean

Question allows multiple selection true | false

allowQuantityChange
boolean

Question allows quantity change true | false

  • GEThttps://louapi.evosus.com/api/v1/product/by-upc/upc/kits/questions
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Kit Question Answers

GET
/api/v1/product/kits/questions/{id}/answers

Get Product Kit Question Answers.

Match on kit answer id.

URI Parameters
id
stringRequired

Question identifier

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
object

Kit Question

questionID
string

Question identifier

sortOrder
string

Question sort order

name
string

Question name

question
string

Question string

requiredAnswer
boolean

Question requires an answer true | false

multipleSelection
boolean

Question allows multiple selection true | false

allowQuantityChange
boolean

Question allows quantity change true | false

skuKitAnswers
array[object]

Kit Question Answers

answerID
string

Answer identifier

sortOrder
number

Answer sort order

sku
string

Answer SKU

skuID
string

Answer SKU identifier

upc
string

Answer UPC code

description
string

Answer SKU description

comment
string

Answer comment

quantity
number

Answer SKU quantity

unitMeasure
string

Answer SKU unit measure

conversionFactor
number

Answer SKU unit measure conversion factor

skuPrice
number

Answer SKU price

  • GEThttps://louapi.evosus.com/api/v1/product/kits/questions/id/answers
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Pictures

GET
/api/v1/product/{sku_identifier}/pictures{?sku_id_type}

Get Product Pictures.

Match on sku_id_type: sku | primary_key.

URI Parameters
sku_identifier
stringRequired

SKU identifier

sku_id_type
stringRequired

SKU ID type sku | primary_key

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
object

Product SKU

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

pictures
array[object]

Pictures

pictureID
string

Picture identifier

fileName
string

Picture filename

caption
string

Picture caption

description
string

Picture description

tags
string

Picture tags

url
string

Picture URL

uploadDate
string

Picture upload date/time. Ex: MM/dd/YYYY h:mm:ss AM/PM

  • GEThttps://louapi.evosus.com/api/v1/product/sku_identifier/pictures
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Pictures by UPC

GET
/api/v1/product/by-upc/{upc}/pictures

Get Product Pictures by UPC.

Match on upc.

URI Parameters
upc
stringRequired

UPC identifier

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Product SKUs

skuID
string

Product SKU identifier

sku
string

Product SKU code

description
string

Product description

upc
string

Product UPC code

vendors
array[object]

Alternate Product Vendors

name
string

Vendor name

vendorSKU
string

Product SKU from Vendor

description
string

Product description from Vendor

alternateUPC
string

Alternate vendor UPC

cost
number

Alternate vendor cost

costUnitMeasure
string

Alternate vendor unit measure for cost

minimumQuantityOrder
number

Minimum quantity for vendor order

isDefaultPurchaseVendor
boolean

Vendor is default true | false

pictures
array[object]

Pictures

pictureID
string

Picture identifier

fileName
string

Picture filename

caption
string

Picture caption

description
string

Picture description

tags
string

Picture tags

url
string

Picture URL

uploadDate
string

Picture upload date/time. Ex: MM/dd/YYYY h:mm:ss AM/PM

  • GEThttps://louapi.evosus.com/api/v1/product/by-upc/upc/pictures
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Product Categoriesin Product Management

Product Categories

GET
/api/v1/product/category{?query_string}

Get Product Category List.

Get all or filter by optional query_string value.

URI Parameters
query_string
stringOptional

Filter the Product Categories by this value

Response Data
error
boolean

true if response is an error, false if not.

reason
string

The reason for the error, or success if no error.

data
object
category1
string

Category 1

category2
string

Category 2

category3
string

Category 3

category4
string

Category 4

  • GEThttps://louapi.evosus.com/api/v1/product/category
  • Tiersmock datadeveloper
HTTP
Request
(loading)
Response
(loading)

Unit Measuresin Company

Unit Measures

GET
/api/v1/company/unit-measures
Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Unit Measures

name
string

Unit measure name

conversionFactor
number

Unit measure conversion factor

isDefault
boolean

Unit measure is default true | false

  • GEThttps://louapi.evosus.com/api/v1/company/unit-measures
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Schedule Divisionsin Company

Schedule Divisions

GET
/api/v1/company/schedule-divisions
Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Schedule Divisions

id
string

Schedule Division identifier

name
string

Schedule Division name

routeStart
object

Schedule Division route start

name
string

Route start name

address1
string

Route start address line 1

address2
string

Route start address line 2

city
string

Route start city

state
string

Route start state

postalCode
string

Route start postal code

country
string

Route start country

longitude
number

Route start longitude

latitude
number

Route start latitude

scheduleHours
array[object]

Schedule hours list

day
string

Day of week

available
boolean

Available true | false

startTime
string

Start time (h:mmAM/PM)

endTime
string

End time (h:mmAM/PM)

  • GEThttps://louapi.evosus.com/api/v1/company/schedule-divisions
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Distribution Methodsin Company

Distribution Methods

GET
/api/v1/company/distribution-methods
Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Distribution Methods

ID
string

Distribution Method identifier

description
string

Distribution Method name

isDefault
boolean

Distribution Method is default true | false

  • GEThttps://louapi.evosus.com/api/v1/company/distribution-methods
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Departmentsin Company

Departments

GET
/api/v1/company/departments
Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Departments

ID
string

Department identifier

departmentType
string

Department type

name
string

Department name

address1
string

Department address 1

address2
string

Department address 2

city
string

Department city

state
string

Department state

postalCode
string

Department postal code

country
string

Department country

longitude
number

Department longitude

latitude
number

Department latitude

  • GEThttps://louapi.evosus.com/api/v1/company/departments
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Document Typesin Company

Document Types

GET
/api/v1/company/document-types
Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Document Types

ID
string

Document Type identifier

description
string

Document Type description

isDefault
boolean

Document Type is default true | false

  • GEThttps://louapi.evosus.com/api/v1/company/document-types
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Schedule Task Typesin Company

Schedule Task Types

GET
/api/v1/company/schedule-task-types
Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Schedule Task Types

ID
string

Schedule Task Type identifier

name
string

Schedule Task Type name

defaultScheduleDivision
stringOptional

Schedule Task Type default schedule division

  • GEThttps://louapi.evosus.com/api/v1/company/schedule-task-types
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Payment Methodsin Company

Payment Methods

GET
/api/v1/company/payment-methods
Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
array[object]

Payment Methods

ID
string

Payment Method identifier

name
string

Payment Method name

methodType
string

Payment Method type

  • GEThttps://louapi.evosus.com/api/v1/company/payment-methods
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Customersin Customers

Customer Create

POST
/api/v1/customers

Create new Customer.

Supply customer attributes. Returns customer details with LOUCustomerID, customer balance, and portal URL.

Request Body
companyName
string

Customer company name

firstName
string

Customer first name

lastName
string

Customer last name

billToAddress1
string

Customer bill to address line 1

billToAddress2
string

Customer bill to address line 2

billToCity
string

Customer bill to city

billToState
string

Customer bill to state

billToZip
string

Customer bill to zip code

billToCountry
string

Customer bill to country

shipToAddress1
string

Customer ship to address line 1

shipToAddress2
string

Customer ship to address line 2

shipToCity
string

Customer ship to city

shipToState
string

Customer ship to state

shipToZip
string

Customer ship to zip code

shipToCountry
string

Customer ship to country

phoneNumber
string

Customer phone number

email
string

Customer email address

alias
string

Customer alias

tags
string

Customer tags

  • POSThttps://louapi.evosus.com/api/v1/customers
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Customer Detail

GET
/api/v1/customers/{id}

Get Customer Detail by id.

Match on id.

URI Parameters
id
stringRequired

Customer identifier

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
object

Customer

louCustomerID
string

LOU Customer ID

accountName
string

Display name (lastName, firstName)

firstName
string

Customer first name

lastName
string

Customer last name

billToAddress1
string

Customer bill to address line 1

billToAddress2
string

Customer bill to address line 2

billToCity
string

Customer bill to City

billToState
string

Customer bill to State

billToZip
string

Customer bill to Zip Code

billToCountry
string

Customer bill to Country (3 digit code)

shipToAddress1
string

Customer ship to address line 1

shipToAddress2
string

Customer ship to address line 2

shipToCity
string

Customer ship to City

shipToState
string

Customer ship to State

shipToZip
string

Customer ship to Zip Code

shipToCountry
string

Customer ship to Country (3 digit code)

phoneNumber
string

Customer phone number

email
string

Customer email

alternateID
string

Customer alternate ID

alias
string

Customer alias

billMeLater
boolean

Bill Me Later flag true | false

billMeLaterMessage
string

Bill Me Later message

billMeLaterCreditLimit
string

Bill Me Later credit limit

customerBalanceDue
string

Customer balance due

customerPortalURL
string

Customer portal URL

parentCustomerID
string

Parent Customer ID

parentCustomerAccountName
string

Parent Customer account name

parentCustomerBill
string

Parent Customer to Bill

  • GEThttps://louapi.evosus.com/api/v1/customers/id
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Customer Duplicate Check

POST
/api/v1/customers/duplicate-check

Check for Customer Duplicates.

Supply known customer attributes. Request returns existing matching customer and a match confidence level.

Request Body
companyName
string

Company name

firstName
string

Customer first name

lastName
string

Customer last name

billToAddress1
string

Customer bill to address line 1

shipToAddress1
string

Customer ship to address line 1

emails
array[object]

Customer Emails

email
string

Email address

phones
array[object]

Customer Phones

phoneNumber
string

Phone number

  • POSThttps://louapi.evosus.com/api/v1/customers/duplicate-check
  • Tiersdeveloper
HTTP
Request
(loading)
Response
(loading)

Sales Ordersin Order

Sales Order Create

POST
/api/v1/orders/sales

Create a Sales Order.

Request Body
orderTotal
number

Order total

departmentID
string

Department ID

distributionMethodID
string

Distribution method ID

documentTypeID
string

Document type ID

notesCustomerFacing
string

Customer facing notes

notesInternal
string

Internal notes

tags
string

Order tags

customerInfo
object

Customer Information

customerVanityID
string

LOU customer vanity ID

contactEmail
string

Customer email

contactPhone
string

Customer phone

billToAddress1
string

Customer bill to address line 1

billToAddress2
string

Customer bill to address line 2

billToCity
string

Customer bill to city

billToState
string

Customer bill to state

billToPostCode
string

Customer bill to postal code

billToCountry
string

Customer bill to country

shipToAddress1
string

Customer ship to address line 1

shipToAddress2
string

Customer ship to address line 2

shipToCity
string

Customer ship to city

shipToState
string

Customer ship to state

shipToPostCode
string

Customer ship to postal code

shipToCountry
string

Customer ship to country

orderSKUs
array[object]

Product SKUs for Order

sku
string

Product SKU code

quantity
number

Product quantity

subtotal
number

Product subtotal

payments
object

Payments

paymentCards
array[object]

Card Payments

amount
number

Card charge amount

cardAuthCode
string

Card authorization code

cardBrand
string

Card brand

cardLastFourDigits
string

Card last four digits

cardHolderName
string

Card holder name

expDate
string

Card expiration date (MM/YYYY)

comment
string

Card payment comment

taxCode
object

Tax Code

taxCodeName
string

Tax code name

taxRate
number

Tax code rate

taxAmount
number

Tax code amount

taxAuthority
array[object]

Tax Authorities

taxAuthorityName
string

Tax authority name

taxRate
number

Tax authority rate

taxAmount
number

Tax authority amount

  • POSThttps://louapi.evosus.com/api/v1/orders/sales
  • Tiersmock datadeveloper
HTTP
Request
(loading)
Response
(loading)

Sales Order Detail

GET
/api/v1/orders/sales/{id}

Get Sales Order details by id.

URI Parameters
id
stringRequired

Sales Order identifier

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
object

Order

documentVanityID
string

Document vanity ID

orderType
string

Order type

orderStatus
string

Order status

date
string

Order creation date

assignedTo
string

Personnel name

departmentID
string

Department ID

department
string

Department name

distributionMethodID
string

Distribution method ID

distributionMethod
string

Distribution method name

documentTypeID
string

Document type ID

documentType
string

Document type name

notesInternal
string

Internal note

notesCustomerFacing
string

Customer facing notes

tags
string

Order tags

customerInfo
object

Customer Information

customerVanityID
string

LOU customer vanity ID

contactEmail
string

Customer email

contactPhone
string

Customer phone

billToAddress1
string

Customer bill to address line 1

billToAddress2
string

Customer bill to address line 2

billToCity
string

Customer bill to city

billToState
string

Customer bill to state

billToPostCode
string

Customer bill to postal code

billToCountry
string

Customer bill to country

shipToAddress1
string

Customer ship to address line 1

shipToAddress2
string

Customer ship to address line 2

shipToCity
string

Customer ship to city

shipToState
string

Customer ship to state

shipToPostCode
string

Customer ship to postal code

shipToCountry
string

Customer ship to country

orderSKUs
array[object]

Product SKUs

skuID
string

Product SKU identifier

sku
string

Product SKU code

upc
string

Product UPC code

quantity
number

Product quantity

price
number

Product price

subtotal
number

Product subtotal

discount
number

Product discount

description
string

Product description

skuType
string

Product SKU type

sellUnitMeasure
string

Product sell unit of measure

sellUnitMeasureFactor
string

Product sell unit of measure factor

payments
object

Payments

paymentCards
array[object]

Card Payments

amount
number

Card charge amount

cardAuthCode
string

Card authorization code

cardBrand
string

Card brand

cardLastFourDigits
string

Card last four digits

cardHolderName
string

Card holder name

expDate
string

Card expiration date (MM/YYYY)

comment
string

Card payment comment

taxcode
object

Tax code

taxCodeName
string

Tax code name

taxRate
number

Tax code rate

isAvalara
boolean

Tax code is Avalara true | false

taxAuthority
array[object]

Tax Authorities

taxAuthorityName
string

Tax authority name

taxRate
number

Tax authority rate

  • GEThttps://louapi.evosus.com/api/v1/orders/sales/id
  • Tiersmock datadeveloper
HTTP
Request
(loading)
Response
(loading)

Work Ordersin Order

Work Order Create

POST
/api/v1/orders/work

Create a Work Order.

Request Body
orderTotal
number

Order total

departmentID
string

Department ID

distributionMethodID
string

Distribution method ID

documentTypeID
string

Document type ID

taskTypeID
string

Task type ID

scheduleDivisionID
string

Schedule division ID

workOrderRequest
string

Work order request

notesCustomerFacing
string

Customer facing notes

notesInternal
string

Internal notes

tags
string

Order tags

customerInfo
object

Customer Information

customerVanityID
string

LOU customer vanity ID

contactEmail
string

Customer email

contactPhone
string

Customer phone

billToAddress1
string

Customer bill to address line 1

billToAddress2
string

Customer bill to address line 2

billToCity
string

Customer bill to city

billToState
string

Customer bill to state

billToPostCode
string

Customer bill to postal code

billToCountry
string

Customer bill to country

shipToAddress1
string

Customer ship to address line 1

shipToAddress2
string

Customer ship to address line 2

shipToCity
string

Customer ship to city

shipToState
string

Customer ship to state

shipToPostCode
string

Customer ship to postal code

shipToCountry
string

Customer ship to country

orderSKUs
array[object]

Product SKUs for Order

sku
string

Product SKU code

quantity
number

Product quantity

subtotal
number

Product subtotal

payments
object

Payments

paymentCards
array[object]

Card Payments

amount
number

Card charge amount

cardAuthCode
string

Card authorization code

cardBrand
string

Card brand

cardLastFourDigits
string

Card last four digits

cardHolderName
string

Card holder name

expDate
string

Card expiration date (MM/YYYY)

comment
string

Card payment comment

taxCode
object

Tax Code

taxCodeName
string

Tax code name

taxRate
number

Tax code rate

taxAmount
number

Tax code amount

taxAuthority
array[object]

Tax Authorities

taxAuthorityName
string

Tax authority name

taxRate
number

Tax authority rate

taxAmount
number

Tax authority amount

  • POSThttps://louapi.evosus.com/api/v1/orders/work
  • Tiersmock datadeveloper
HTTP
Request
(loading)
Response
(loading)

Work Order Detail

GET
/api/v1/orders/work/{id}

Get Work Order details by id.

URI Parameters
id
stringRequired

Work Order identifier

Response Data
statusCode
number

Status code as in HTTP status code

status
string

Status description

messageCode
string

Application message code

messageText
string

Application message text

response
object

Order

documentVanityID
string

Document vanity ID

orderType
string

Order type

orderStatus
string

Order status

date
string

Order creation date

assignedTo
string

Personnel name

departmentID
string

Department ID

department
string

Department name

distributionMethodID
string

Distribution method ID

distributionMethod
string

Distribution method name

documentTypeID
string

Document type ID

documentType
string

Document type name

workOrderRequest
string

Work order request

notesInternal
string

Internal note

notesCustomerFacing
string

Customer facing notes

tags
string

Order tags

customerInfo
object

Customer Information

customerVanityID
string

LOU customer vanity ID

contactEmail
string

Customer email

contactPhone
string

Customer phone

billToAddress1
string

Customer bill to address line 1

billToAddress2
string

Customer bill to address line 2

billToCity
string

Customer bill to city

billToState
string

Customer bill to state

billToPostCode
string

Customer bill to postal code

billToCountry
string

Customer bill to country

shipToAddress1
string

Customer ship to address line 1

shipToAddress2
string

Customer ship to address line 2

shipToCity
string

Customer ship to city

shipToState
string

Customer ship to state

shipToPostCode
string

Customer ship to postal code

shipToCountry
string

Customer ship to country

orderSKUs
array[object]

Product SKUs

skuID
string

Product SKU identifier

sku
string

Product SKU code

upc
string

Product UPC code

quantity
number

Product quantity

price
number

Product price

subtotal
number

Product subtotal

discount
number

Product discount

description
string

Product description

skuType
string

Product SKU type

sellUnitMeasure
string

Product sell unit of measure

sellUnitMeasureFactor
string

Product sell unit of measure factor

payments
object

Payments

paymentCards
array[object]

Card Payments

amount
number

Card charge amount

cardAuthCode
string

Card authorization code

cardBrand
string

Card brand

cardLastFourDigits
string

Card last four digits

cardHolderName
string

Card holder name

expDate
string

Card expiration date (MM/YYYY)

comment
string

Card payment comment

taxcode
object

Tax code

taxCodeName
string

Tax code name

taxRate
number

Tax code rate

isAvalara
boolean

Tax code is Avalara true | false

taxAuthority
array[object]

Tax Authorities

taxAuthorityName
string

Tax authority name

taxRate
number

Tax authority rate

  • GEThttps://louapi.evosus.com/api/v1/orders/work/id
  • Tiersmock datadeveloper
HTTP
Request
(loading)
Response
(loading)

Tenantin Admin

GET
/api/v1/tenant/search{?query_string}

Get Tenant List.

Get all or filter by optional query_string value.

URI Parameters
query_string
stringOptional

Filter the Tenant list by this value

Response Data
error
boolean

true if response is an error, false if not.

reason
string

The reason for the error, or success if no error.

data
array[object]

Tenant list

id
number

Tenant primary key (auto-increment)

name
string

Tenant name

tenant_id
string

Tenant identifier

serial_number
string

Tenant serial number

insert_at
string

Tenant insert date

  • GEThttps://louapi.evosus.com/api/v1/tenant/search
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)

Tenant Detail

GET
/api/v1/tenant/{tenant_id}

Get Tenant Detail.

Match on tenant_id.

URI Parameters
tenant_id
stringRequired

Tenant identifier

Response Data
error
boolean

true if response is an error, false if not.

reason
string

The reason for the error, or success if no error.

data
object

Tenant

id
number

Tenant primary key (auto-increment)

name
string

Tenant name

tenant_id
string

Tenant identifier

serial_number
string

Tenant serial number

insert_at
string

Tenant insert date

  • GEThttps://louapi.evosus.com/api/v1/tenant/tenant_id
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)

Tenant by Serial Number

GET
/api/v1/tenant/serialnumber/{serial_number}

Get Tenant by Serial Number.

URI Parameters
serial_number
stringRequired

Serial number

Response Data
error
boolean

true if response is an error, false if not.

reason
string

The reason for the error, or success if no error.

data
object

Tenant

id
number

Tenant primary key (auto-increment)

name
string

Tenant name

tenant_id
string

Tenant identifier

serial_number
string

Tenant serial number

insert_at
string

Tenant insert date

  • GEThttps://louapi.evosus.com/api/v1/tenant/serialnumber/serial_number
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)

Tenant Tokens

GET
/api/v1/tenant/{tenant_id}/tokens

Get Tokens by Tenant ID.

Match Tenant on tenant_id.

URI Parameters
tenant_id
stringRequired

Tenant identifier

Response Data
error
boolean

true if response is an error, false if not.

reason
string

The reason for the error, or success if no error.

data
array[object]

Token list

id
number

Token primary key (auto-increment)

token_id
string

Token identifier

name
string

Token friendly name

developer_id
string

Developer identifier

token
string

Internal token

ext_token
string

External token

insert_at
string

Token insert date

access_scopes
array[enum[string]]

One or more access privileges

Values

  • read_products
  • write_orders
  • read_orders
  • read_tenants
active
boolean

Is Token active 1 | 0

on_hold
boolean

Is Token on hold 1 | 0

  • GEThttps://louapi.evosus.com/api/v1/tenant/tenant_id/tokens
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)

Tenant Developers

GET
/api/v1/tenant/{tenant_id}/developers

Get Tenant Developers.

Match Tenant on tenant_id.

URI Parameters
tenant_id
stringRequired

Tenant identifier

Response Data
error
boolean

true if response is an error, false if not.

reason
string

The reason for the error, or success if no error.

data
array[object]

Developer list

id
number

Developer primary key (auto-increment)

developer_id
string

Developer identifier

name
string

Developer name

insert_at
string

Developer insert date

active
boolean

Is Developer active 1 | 0

on_hold
boolean

Is Developer on hold 1 | 0

approved
boolean

Is Developer approved 1 | 0

  • GEThttps://louapi.evosus.com/api/v1/tenant/tenant_id/developers
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)

Create/Update Tenant

POST
/api/v1/tenant

Create or Update a Tenant.

If the tenant_id matches an existing Tenant, update that entity.

Request Body
tenant_id
string

Tenant identifier

name
string

Tenant friendly name

serial_number
string

Tenant serial number

insert_at
string

Tenant insert date

  • POSThttps://louapi.evosus.com/api/v1/tenant
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)

Developerin Admin

GET
/api/v1/developer/search{?query_string}

Get Developer List.

Get all or filter by optional query_string value.

URI Parameters
query_string
stringOptional

Filter the Developer list by this value

Response Data
error
boolean

true if response is an error, false if not.

reason
string

The reason for the error, or success if no error.

data
array[object]

Developer list

id
number

Developer primary key (auto-increment)

name
string

Developer name

developer_id
string

Developer identifier

insert_at
string

Developer insert date

active
boolean

Is Developer active 1 | 0

on_hold
boolean

Is Developer on hold 1 | 0

approved
boolean

Is Developer approved 1 | 0

  • GEThttps://louapi.evosus.com/api/v1/developer/search
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)

Developer Detail

GET
/api/v1/developer/{developer_id}

Get Developer Details.

Match Developer on developer_id.

URI Parameters
developer_id
stringRequired

Developer identifier

Response Data
error
boolean

true if response is an error, false if not.

reason
string

The reason for the error, or success if no error.

data
object
id
number

Developer primary key (auto-increment)

name
string

Developer name

developer_id
string

Developer identifier

insert_at
string

Developer insert date

active
boolean

Is Developer active 1 | 0

on_hold
boolean

Is Developer on hold 1 | 0

approved
boolean

Is Developer approved 1 | 0

  • GEThttps://louapi.evosus.com/api/v1/developer/developer_id
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)

Create/Update Developer

POST
/api/v1/developer

Create or Update an Developer.

If the developer_id matches an existing Developer, update that entity.

Request Body
developer_id
string

Developer identifier

name
string

Developer name

insert_at
string

Developer insert date

active
boolean

Is Developer active 1 | 0

on_hold
boolean

Is Developer on hold 1 | 0

approved
boolean

Is Developer approved 1 | 0

  • POSThttps://louapi.evosus.com/api/v1/developer
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)

Tokenin Admin

GET
/api/v1/token/search{&query_string}{&tenant_id}{&developer_id}

Get Token List.

Get all or filter by optional query_string, tenant_id, or developer_id value.

URI Parameters
query_string
stringOptional

Filter by name

tenant_id
stringOptional

Filter by Tenant identifier

developer_id
stringOptional

Filter by Developer identifier

Response Data
error
boolean

true if response is an error, false if not.

reason
string

The reason for the error, or success if no error.

data
array[object]

Tokens

id
number

Token primary key (auto-increment)

token_id
string

Token identifier

name
string

Token friendly name

tenant_id
string

Tenant identifier

developer_id
string

Developer identifier

token
string

Internal token

ext_token
string

External token

insert_at
string

Token insert date

access_scopes
array[enum[string]]

One or more access privileges

Values

  • read_products
  • write_orders
  • read_orders
  • read_tenants
active
boolean

Is Token active 1 | 0

on_hold
boolean

Is Token on hold 1 | 0

  • GEThttps://louapi.evosus.com/api/v1/token/search
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)

Token Detail

GET
/api/v1/token/{token_id}

Get Token Details and Access.

URI Parameters
token_id
stringRequired

Token identifier

Response Data
error
boolean

true if response is an error, false if not.

reason
string

The reason for the error, or success if no error.

data
object

Token

id
number

Token primary key (auto-increment)

token_id
string

Token identifier

name
string

Token friendly name

tenant_id
string

Tenant identifier

developer_id
string

Developer identifier

token
string

Internal token

ext_token
string

External token

insert_at
string

Token insert date

access_scopes
array[enum[string]]

One or more access privileges

Values

  • read_products
  • write_orders
  • read_orders
  • read_tenants
active
boolean

Is Token active 1 | 0

on_hold
boolean

Is Token on hold 1 | 0

  • GEThttps://louapi.evosus.com/api/v1/token/token_id
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)

External Token

GET
/api/v1/token/external/{ext_token}

Get Token by External Token.

URI Parameters
ext_token
stringRequired

External Token

Response Data
error
boolean

true if response is an error, false if not.

reason
string

The reason for the error, or success if no error.

data
object

Token

id
number

Token primary key (auto-increment)

token_id
string

Token identifier

name
string

Token friendly name

tenant_id
string

Tenant identifier

developer_id
string

Developer identifier

token
string

Internal token

ext_token
string

External token

insert_at
string

Token insert date

access_scopes
array[enum[string]]

One or more access privileges

Values

  • read_products
  • write_orders
  • read_orders
  • read_tenants
active
boolean

Is Token active 1 | 0

on_hold
boolean

Is Token on hold 1 | 0

  • GEThttps://louapi.evosus.com/api/v1/token/external/ext_token
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)

Create/Update Token

POST
/api/v1/token

Create or Update a Token.

If the token_id matches an existing Token, update that entity.

Request Body
token_id
string

Token identifier

name
string

Token friendly name

tenant_id
string

Tenant identifier

developer_id
string

Developer identifier

token
string

Internal token

ext_token
string

External token

insert_at
string

Token insert date

access_scopes
array[enum[string]]

One or more access privileges

Values

  • read_products
  • write_orders
  • read_orders
  • read_tenants
active
boolean

Is Token active 1 | 0

on_hold
boolean

Is Token on hold 1 | 0

  • POSThttps://louapi.evosus.com/api/v1/token
  • Tiersadmin
HTTP
Request
(loading)
Response
(loading)