docs
  1. Developer-guide
  2. Multiple Legal Entities
  3. Manage Legal Entities

Manage Legal Entities

General

A company in SCAYLE represents a legal entity within your business system. Each shop you create is linked to a company.

By default, your SCAYLE account starts with just one company. But, if needed, you can add more.

Admin API

Create a Company

It is only required to provide a name to create a new company.

Update a Company

SCAYLE allows you to change the company name.

ParameterDetails
id

Integer READ-ONLY

The ID of the company created by SCAYLE.

name

String

Name of the company.

Get a Company

This method can be used to get an existing company by its ID.

ParameterDetails
id

Integer READ-ONLY

The ID of the company created by SCAYLE.

name

String

Name of the company.

Get a Collection of Companies

You can configure number of companies returned by SCAYLE.

Options

ParameterDetails
limit

Integer

Maximum number of items in the result. (default: 100, maximum: 1000)

filters[id]

String

Comma-separated list of company IDs that should be used for filtering.

filters[minId]

Integer

Minimum ID of companies that should be returned.

filters[maxId]

Integer

Maximum ID of companies that should be returned.

ParameterDetails
entities

Company

A collection of companies.

cursor

Cursor

An object containing information for use in pagination.

Examples