API docs by Redocly

Quasydoc API (2.0.0)

Download OpenAPI specification:Download

For any questions related to the API: support@quasydoc.eu

This is the official Quasydoc API documentation.

Our OAuth2 documentation with details on how to authenticate with the API can be found here

customers

Manage customers data

Get a list of customers

Get a list of customers

Authorizations:
OAuth2
query Parameters
filter[reference]
string

Only get the customer that matches given reference

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

include
string
Enum: "customer_type" "language" "currency" "account_manager" "customer_service_mananger"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
Array of objects (Customer)
Array of CustomerType (object) or I18nLanguage (object) or Currency (object) or User (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a customer

Add a customer

Authorizations:
OAuth2
Request Body schema: application/json
required

Customer to add

object (Customer)

Responses

Response Schema: application/json
object (Customer)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a single customer

Get a single customer by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

query Parameters
include
string
Enum: "customer_type" "language" "currency" "account_manager" "customer_service_manager"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Customer)
Array of CustomerType (object) or I18nLanguage (object) or Currency (object) or User (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Update a customer

Update a customer by its id. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

Request Body schema: application/json
required

Customer properties to update

object (Customer)

Responses

Response Schema: application/json
object (Customer)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a customer

Delete a customer by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

customers relationships

Manage customer relations

customer_type

Get the current customer_type relationship of the customer

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

query Parameters
include
string
Value: "customer_type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomerTypeRelation)
Array of objects (CustomerType) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

customer_type

Update a customer_type of a customer. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

Request Body schema: application/json
required

Customer type object identifier. This is a to-one relationship that cannot be removed.

object (CustomerTypeRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

customer_type object

Get the current customer_type of the customer

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

Responses

Response Schema: application/json
object (CustomerType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

language

Get the current language relationship of the customer

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

query Parameters
include
string
Value: "language"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (I18nLanguageRelation)
Array of objects (I18nLanguage) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

language

Update a language of a customer. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

Request Body schema: application/json
required

Language object identifier. This is a to-one relationship that cannot be removed.

object (I18nLanguageRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

language object

Get the current language of the customer

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

Responses

Response Schema: application/json
object (I18nLanguage)

Response samples

Content type
application/json
{
  • "data": {
    }
}

currency

Get the current currency relationship of the customer

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

query Parameters
include
string
Value: "currency"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CurrencyRelation)
Array of objects (Currency) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

currency

Update a currency of a customer. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

Request Body schema: application/json
required

Currency object identifier. This is a to-one relationship that cannot be removed.

object (CurrencyRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

currency object

Get the current currency of the customer

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

Responses

Response Schema: application/json
object (Currency)

Response samples

Content type
application/json
{
  • "data": {
    }
}

account_manager

Get the current account manager relationship of the customer

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

query Parameters
include
string
Value: "account_manager"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

account_manager

Update a account manager of a customer. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

Request Body schema: application/json
required

Account manager object identifier. This is a to-one relationship that cannot be removed.

object (UserRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

account manager object

Get the current account manager of the customer

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

customer_service_manager

Get the current customer service manager relationship of the customer

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

query Parameters
include
string
Value: "customer_service_manager"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

customer_service_manager

Update a customer service manager of a customer. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

Request Body schema: application/json
required

Customer service manager object identifier. This is a to-one relationship that cannot be removed.

object (UserRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

customer service manager object

Get the current customer service manager of the customer

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

customer_products

Manage customer products data

Get a list of customer products

Get a list of customer products

Authorizations:
OAuth2
query Parameters
include
string
Enum: "customer" "product"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (CustomerProduct)
Array of Customer (object) or Product (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a customer product

Add a customer product

Authorizations:
OAuth2
Request Body schema: application/json
required

Customer product to add

object (CustomerProduct)

Responses

Response Schema: application/json
object (CustomerProduct)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a single customer product

Get a single customer product by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer product

query Parameters
include
string
Enum: "customer" "product"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (CustomerProduct)
Array of Customer (object) or Product (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Update a customer product

Update a customer product by its id. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer product

Request Body schema: application/json
required

Customer product properties to update

object (CustomerProduct)

Responses

Response Schema: application/json
object (CustomerProduct)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a customer product

Deleting a customer product relation is not implemented

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer product

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

customer_products relationships

Manage customer products relations

customer

Get the current customer relationship of the customer product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer product

query Parameters
include
string
Value: "customer"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (CustomerRelation)
Array of objects (Customer) unique
object (Links)

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {
    }
}

customer

Updating a customer of a customer product relation is not allowed

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer product

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

customer object

Get the current customer of the customer product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer product

Responses

Response Schema: application/json
object (Customer)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product

Get the current product relationship of the customer product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer product

query Parameters
include
string
Value: "product"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductRelation)
Array of objects (Product) unique
object (Links)

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {
    }
}

product

Updating a product of a customer product relation is not allowed

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer product

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

product object

Get the current product of the customer product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer product

Responses

Response Schema: application/json
object (Links)
object (Product)
Array of objects (Product) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

customer_types

Manage customer type data

Get a list of customer types

Get a list of customer types

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (CustomerType)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a customer type

Add a customer type

Authorizations:
OAuth2
Request Body schema: application/json
required

Customer type to add

object (CustomerType)

Responses

Response Schema: application/json
object (CustomerType)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a single customer type

Get a single customer type by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer type

Responses

Response Schema: application/json
object (CustomerType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a customer type

Update a customer type by its id. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer type

Request Body schema: application/json
required

Customer type properties to update

object (CustomerType)

Responses

Response Schema: application/json
object (CustomerType)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a customer type

Delete a customer type by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer type

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

products

Manage all of your product data

Get a list of products

Get a list of products

Authorizations:
OAuth2
query Parameters
include
string
Enum: "unit" "product_group" "product_structure"

Customise which related resources should be returned. Include one or more from the given options comma separated

sales
integer
Enum: 0 1

Only get the sales products?

active
integer
Enum: 0 1

Only get the active products?

gtin
integer

Only get the product that matches the gtin

product_group_id
integer

Only get the products that match the product group

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (Product)
Array of Unit (object) or ProductGroup (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a product

Add a product

Authorizations:
OAuth2
Request Body schema: application/json
required

Product to add

object (Product)

Responses

Response Schema: application/json
object (Product)
Array of Unit (object) or ProductGroup (object) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Get a single product

Get a single product by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product

query Parameters
include
string
Enum: "unit" "product_group"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Product)
Array of Unit (object) or ProductGroup (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Update a product

Update a product by its id. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product

Request Body schema: application/json
required

Product properties to update

object (Product)

Responses

Response Schema: application/json
object (Product)
Array of Unit (object) or ProductGroup (object) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

products relationships

Manage product relations

unit

Get the current unit relationship of the product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product

query Parameters
include
string
Value: "unit"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UnitRelation)
Array of objects (Unit) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

unit

Updating a product's unit relation is forbidden

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

unit object

Get the current unit of the product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product

Responses

Response Schema: application/json
object (Unit)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product group

Get the current product group relation of the product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product

query Parameters
include
string
Value: "product_group"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object or null (ProductGroupRelation)
Array of objects (ProductGroup) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product group

Update a product's product group relation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product

Request Body schema: application/json
required

Product group object identifier. This is a to-one relationship. To remove the relationship, set the id to null.

object or null (ProductGroupRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

product group object

Get the current product group of the product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product

query Parameters
include
string
Value: "type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductGroup)
Array of objects (ProductGroupType) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

product structure

Get the current product structure relation of the product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product

query Parameters
include
string
Value: "product_structure"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object or null (ProductStructureRelation)
Array of objects (ProductStructure) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product structure

Update a product's product structure relation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product

Request Body schema: application/json
required

Product structure object identifier. This is a to-one relationship.

object or null (ProductStructureRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

product structure object

Get the current product structure of the product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product

query Parameters
include
string
Value: "items"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductStructure)
Array of objects (ProductStructureItem) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

product structure

Add a product's product structure

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product

Request Body schema: application/json
required

Product structure object

object (ProductStructure)

Responses

Response Schema: application/json
object (ProductStructure)
Array of objects (ProductStructureItem) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

product_groups

Manage all of your product group data

Get a list of product groups

Get a list of product groups

Authorizations:
OAuth2
query Parameters
include
string
Value: "type"

Customise which related resources should be returned. Include one or more from the given options comma separated

active
integer
Enum: 0 1

Only get the active product_groups

product_group_type_id
integer

Only get the product groups that are part of the given product group type

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductGroup)
Array of objects (ProductGroupType) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a product group

Add a product group

Authorizations:
OAuth2
Request Body schema: application/json
required

Product group to add

object (ProductGroup)

Responses

Response Schema: application/json
object (ProductGroup)
Array of objects (ProductGroupType) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Get a single product group

Get a single product group by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product group

query Parameters
include
string
Value: "type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductGroup)
Array of objects (ProductGroupType) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Update a product group

Update a product group. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product group

Request Body schema: application/json
required

Product group properties to update

object (ProductGroup)

Responses

Response Schema: application/json
object (ProductGroup)
Array of objects (ProductGroupType) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Delete a product group

Delete a product group by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product group

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

product_groups relationships

Manage product group relations

type

Get the current type relationship of the productgroup

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product group

query Parameters
include
string
Value: "type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductGroupTypeRelation)
Array of objects (ProductGroupType) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

type

Update a product group type of a productgroup. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product group

Request Body schema: application/json
required

Product group type object identifier. This is a to-one relationship that cannot be removed.

object (ProductGroupTypeRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

type object

Get the current type of the productgroup

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product group

Responses

Response Schema: application/json
object (ProductGroupType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_structures

Manage all of your product structure data

Get a list of product structures

Get a list of product structures

Authorizations:
OAuth2
query Parameters
include
string
Value: "items"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
Array of objects (ProductStructure)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a product structure

Adding a product structure is forbidden this way, use products/{product_id}/product_structure endpoint.

Authorizations:
OAuth2
Request Body schema: application/json
required

Product structure object to add

object (ProductStructure)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get a single product structure

Get a single product structure by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure

query Parameters
include
string
Value: "type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductStructure)
Array of objects (ProductStructureItem) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Update a product structure

Update a product structure. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure

Request Body schema: application/json
required

Product structure properties to update

object (ProductStructure)

Responses

Response Schema: application/json
object (ProductStructure)
Array of objects (ProductStructureItem) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Delete a product structure

Delete a product structure by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

product_structures relationships

Manage product structure relations

items

Get the current items relationship of the product structure

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure

query Parameters
include
string
Value: "items"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
Array of objects or null (ProductStructureItemRelation) unique
Array of objects (ProductStructureItem) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

items

Add items relations to the product structure

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure

Request Body schema: application/json
required

Product structure item relation objects.

Array of objects or null (ProductStructureItemRelation) unique

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

items

Update a product structure items relation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure

Request Body schema: application/json
required

Product structure item objects. This is a to-many relationship and given items will be replacing existing ones

Array of objects (ProductStructureItem) unique

Responses

Response Schema: application/json
object (Links)
object or null (ProductStructureItemRelation)
Array of objects (ProductStructureItem) unique

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

items

Delete items from a product structure

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure

Request Body schema: application/json
required

Product structure item object identifiers. This is a to-many relationship and given items will be removed from the product structure

Array of objects or null (ProductStructureItemRelation) unique

Responses

Response Schema: application/json
object (Links)
object or null (ProductStructureItemRelation)
Array of objects (ProductStructureItem) unique

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

items objects

Get the current items of the product structure

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure

Responses

Response Schema: application/json
Array of objects (ProductStructureItem) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

items objects

Add items to the product structure

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure

Request Body schema: application/json
required

Product structure item objects. This is a to-many relationship and given items will be added but not replace existing ones

Array of objects (ProductStructureItem) unique

Responses

Response Schema: application/json
object (Links)
object or null (ProductStructureItemRelation)
Array of objects (ProductStructureItem) unique

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product_structure_items

Manage all of your product structure item data

Get a list of product structure items

Get a list of product structure items

Authorizations:
OAuth2
query Parameters
include
string
Enum: "product" "unit" "type" "calculation_method"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductStructureItem)
Array of Product (object) or Unit (object) or ProductStructureItemType (object) or ProductStructureItemCalculationMethod (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a product structure item

Adding a product structure item is forbidden this way, use product_structures/{product_structure_id}/items endpoint.

Authorizations:
OAuth2
Request Body schema: application/json
required

Product structure item object to add

object (ProductStructureItem)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get a single product structure item

Get a single product structure item by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

query Parameters
include
string
Enum: "product" "unit" "type" "calculation_method"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductStructureItem)
Array of Product (object) or Unit (object) or ProductStructureItemType (object) or ProductStructureItemCalculationMethod (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Update a product structure item

Update a product structure item

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

Request Body schema: application/json
required

Product structure item to update

object (ProductStructureItem)

Responses

Response Schema: application/json
object (ProductStructureItem)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a product structure item

Delete a product structure item

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

product_structure_items relationships

Manage product structure item relations

product

Get the current product relationship of the product structure item

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

query Parameters
include
string
Value: "product"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductRelation)
Array of objects (Product) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product

Updating a product structure item product relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

product object

Get the current product of the product structure item

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

Responses

Response Schema: application/json
object (Product)

Response samples

Content type
application/json
{
  • "data": {
    }
}

unit

Get the current unit relationship of the product structure item

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

query Parameters
include
string
Value: "unit"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UnitRelation)
Array of objects (Unit) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

unit

Update a product structure item unit relation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

Request Body schema: application/json
required

Unit object identifier. This is a to-one relationship.

object (UnitRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

unit object

Get the current unit of the product structure item

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

Responses

Response Schema: application/json
object (Unit)

Response samples

Content type
application/json
{
  • "data": {
    }
}

type

Get the current type relationship of the product structure item

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

query Parameters
include
string
Value: "type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductStructureItemTypeRelation)
Array of objects (ProductStructureItemType) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

type

Update a product structure item type relation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

Request Body schema: application/json
required

Type object identifier. This is a to-one relationship.

object (ProductStructureItemTypeRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

type object

Get the current type of the product structure item

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

Responses

Response Schema: application/json
object (ProductStructureItemType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

calculation method

Get the current calculation method relationship of the product structure item

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

query Parameters
include
string
Value: "calculation_method"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductStructureItemCalculationMethodRelation)
Array of objects (ProductStructureItemCalculationMethod) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

calculation_method

Update a product structure item calculation method relation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

Request Body schema: application/json
required

Calculation method object identifier. This is a to-one relationship.

object (ProductStructureItemCalculationMethodRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

calculation method object

Get the current calculation method of the product structure item

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item

Responses

Response Schema: application/json
object (ProductStructureItemCalculationMethod)

Response samples

Content type
application/json
{
  • "data": {
    }
}

units

Manage all of your unit data

Get a list of units

Get a list of units

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (Unit)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a unit

Add a unit

Authorizations:
OAuth2
Request Body schema: application/json
required

Unit to add

object (Unit)

Responses

Response Schema: application/json
object (Unit)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a single unit

Get a single unit by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the unit

Responses

Response Schema: application/json
object (Unit)

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a unit

Update a unit. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the unit

Request Body schema: application/json
required

Unit properties to update

object (Unit)

Responses

Response Schema: application/json
object (Unit)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a unit

Delete a unit by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the unit

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

suppliers

Manage supplier data

Get a list of suppliers

Get a list of suppliers

Authorizations:
OAuth2
query Parameters
include
string
Enum: "types" "currency" "buyer" "key_user" "address"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (Supplier)
Array of SupplierType (object) or Currency (object) or User (object) or Address (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a supplier

Add a supplier

Authorizations:
OAuth2
Request Body schema: application/json
required

Supplier to add

object (Supplier)

Responses

Response Schema: application/json
object (Supplier)
Array of SupplierType (object) or Currency (object) or User (object) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Get a single supplier

Get a single supplier by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

query Parameters
include
string
Enum: "types" "currency" "buyer" "key_user" "address"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Supplier)
Array of SupplierType (object) or Currency (object) or User (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Update a supplier

Update a supplier by its id. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Request Body schema: application/json
required

Supplier properties to update

object (Supplier)

Responses

Response Schema: application/json
object (Supplier)
Array of SupplierType (object) or Currency (object) or User (object) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

suppliers relationships

Manage supplier relations

types

Get the current types relationship of the supplier

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

query Parameters
include
string
Value: "types"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (SupplierTypeRelation)
Array of objects (SupplierType) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

types

Add types relations to the supplier

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Request Body schema: application/json
required

Supplier type object identifiers. This is a to-many relationship and given types will be added but not replace existing ones

Array of objects (SupplierTypeRelation) unique

Responses

Response Schema: application/json
object (Links)
Array of objects (SupplierTypeRelation) unique

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ]
}

types

Update a suppliers' type relation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Request Body schema: application/json
required

Supplier type object identifiers. This is a to-many relationship and will replace the types by the given types

Array of objects (SupplierTypeRelation) unique

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

types

Delete a type from a supplier

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Request Body schema: application/json
required

Supplier type object identifiers. This is a to-many relationship and given types will be removed from the supplier

Array of objects (SupplierTypeRelation) unique

Responses

Response Schema: application/json
object (Links)
Array of objects (SupplierTypeRelation) unique

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ]
}

types objects

Get the current types of the supplier

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Responses

Response Schema: application/json
Array of objects (SupplierType) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

currency

Get the current currency relationship of the supplier

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

query Parameters
include
string
Value: "currency"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CurrencyRelation)
Array of objects (Currency) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

currency

Update a currency of a supplier. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Request Body schema: application/json
required

Currency object identifier. This is a to-one relationship that cannot be removed.

object (CurrencyRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

currency object

Get the current currency of the supplier

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Responses

Response Schema: application/json
object (Currency)

Response samples

Content type
application/json
{
  • "data": {
    }
}

buyer

Get the current buyer relationship of the supplier

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

query Parameters
include
string
Value: "buyer"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

buyer

Update a buyer of a supplier. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Request Body schema: application/json
required

Buyer object identifier. This is a to-one relationship that cannot be removed.

object (UserRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

buyer object

Get the current buyer of the supplier

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

key_user

Get the current key user relationship of the supplier

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

query Parameters
include
string
Value: "key_user"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

key_user

Update a key user of a supplier. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Request Body schema: application/json
required

Key user object identifier. This is a to-one relationship that cannot be removed.

object (UserRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

key user object

Get the current key_user of the supplier

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

address

Get the current address relationship of the supplier

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

query Parameters
include
string
Value: "address"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (AddressRelation)
Array of objects (Address) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

address

Update a address of a supplier. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Request Body schema: application/json
required

Address object identifier. This is a to-one relationship that cannot be removed.

object (AddressRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

address object

Get the current address of the supplier

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier

Responses

Response Schema: application/json
object (Address)

Response samples

Content type
application/json
{
  • "data": {
    }
}

supplier_types

Manage supplier type data

Get a list of supplier types

Get a list of supplier types

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (SupplierType)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a supplier type

Add a supplier type

Authorizations:
OAuth2
Request Body schema: application/json
required

Supplier type to add

object (SupplierType)

Responses

Response Schema: application/json
object (SupplierType)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a single supplier type

Get a single supplier type by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier type

Responses

Response Schema: application/json
object (SupplierType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a supplier type

Update a supplier type. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier type

Request Body schema: application/json
required

Supplier type properties to update

object (SupplierType)

Responses

Response Schema: application/json
object (SupplierType)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a supplier type

Delete a supplier type by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier type

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

supplier_products

Manage supplier product data

Get a list of supplier products

Get a list of supplier products

Authorizations:
OAuth2
query Parameters
include
string
Enum: "supplier" "product" "order_unit"

Customise which related resources should be returned. Include one or more from the given options comma separated

supplier_id
integer

Only get the supplier products that match the supplier

product_id
integer

Only get the supplier products that match the product

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (SupplierProduct)
Array of Supplier (object) or Product (object) or Unit (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a supplier product

Add a supplier product

Authorizations:
OAuth2
Request Body schema: application/json
required

Supplier product to add

object (SupplierProduct)

Responses

Response Schema: application/json
object (SupplierProduct)
Array of Supplier (object) or Product (object) or Unit (object) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Get a single supplier product

Get a single supplier product by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier product

query Parameters
include
string
Enum: "supplier" "product" "order_unit"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (SupplierProduct)
Array of Supplier (object) or Product (object) or Unit (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Update a supplier product

Update a supplier product by its id. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier product

Request Body schema: application/json
required

Supplier product properties to update

object (SupplierProduct)

Responses

Response Schema: application/json
object (SupplierProduct)
Array of Supplier (object) or Product (object) or Unit (object) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Delete a supplier product

Delete a supplier product by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier product

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

supplier_products relationships

Manage supplier product relations

supplier

Get the current supplier relationship of the supplier product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier product

query Parameters
include
string
Value: "supplier"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (SupplierRelation)
Array of objects (Supplier) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

supplier

Updating a supplier product's supplier relation is forbidden

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier product

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

supplier object

Get the current supplier of the supplier product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier product

Responses

Response Schema: application/json
object (Supplier)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product

Get the current product relationship of the supplier product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier product

query Parameters
include
string
Value: "product"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductRelation)
Array of objects (Product) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product

Updating a supplier product's product relation is forbidden

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier product

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

product object

Get the current product of the supplier product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier product

Responses

Response Schema: application/json
object (Product)

Response samples

Content type
application/json
{
  • "data": {
    }
}

order_unit

Get the current order unit relationship of the supplier product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier product

query Parameters
include
string
Value: "unit"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UnitRelation)
Array of objects (Unit) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

order unit

Update the order unit of a supplier product. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier product

Request Body schema: application/json
required

Order unit object identifier

object (UnitRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

order unit object

Get the current order unit of the supplier product

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the supplier product

Responses

Response Schema: application/json
object (Unit)

Response samples

Content type
application/json
{
  • "data": {
    }
}

stock_locations

Manage stock location data

Get a list of stock locations

Get a list of stock locations

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (StockLocation)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single stock location

Get a single stock location by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the stock location

Responses

Response Schema: application/json
object (StockLocation)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_groups

Manage data groups data

Get a list of data groups

Get a list of data groups

Authorizations:
OAuth2
query Parameters
include
string

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (DataGroup)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single data group

Get a single data group by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group

query Parameters
include
string

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (DataGroup)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_groups relationships

Manage data groups relations

parameter_numerics

Manage numeric parameters data

Get a list of numeric parameters

Get a list of numeric parameters

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ParameterNumeric)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single numeric parameter

Get a single numeric parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the numeric parameter

Responses

Response Schema: application/json
object (ParameterNumeric)

Response samples

Content type
application/json
{
  • "data": {
    }
}

parameter_textuals

Manage textual parameters data

Get a list of textual parameters

Get a list of textual parameters

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ParameterTextual)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single textual parameter

Get a single textual parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the textual parameter

Responses

Response Schema: application/json
object (ParameterTextual)

Response samples

Content type
application/json
{
  • "data": {
    }
}

parameter_nutritionals

Manage nutritional parameters data

Get a list of nutritional parameter

Get a list of nutritional parameter

Authorizations:
OAuth2
query Parameters
include
string
Value: "nutrients"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ParameterNutritional)
Array of Nutrient (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single nutritional parameter

Get a single nutritional parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the nutritional parameters

query Parameters
include
string
Value: "parameter_nutritional"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ParameterNutritional)
Array of Nutrient (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

parameter_nutritionals relationships

Manage nutritional parameters relations

nutrient

Get the current nutrient relationship of the nutritional parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the nutritional parameter

query Parameters
include
string
Value: "parameter_nutritionals"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (NutrientsRelation)
Array of objects (Nutrient) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

nutrient object

Get the current nutrient of the nutritional parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the nutritional parameter

Responses

Response Schema: application/json
object (Nutrient)

Response samples

Content type
application/json
{
  • "data": {
    }
}

parameter_allergens

Manage allergen parameters data

Get a list of allergen parameters

Get a list of allergen parameters

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ParameterAllergen)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single allergen parameter

Get a single allergen parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the allergen parameter

Responses

Response Schema: application/json
object (ParameterAllergen)

Response samples

Content type
application/json
{
  • "data": {
    }
}

parameter_lists

Manage list parameters data

Get a list of list parameters

Get a list of list parameter

Authorizations:
OAuth2
query Parameters
include
string
Value: "options"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ParameterList)
Array of ParameterListOption (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single list parameter

Get a single list parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the list parameters

query Parameters
include
string
Value: "parameter_list"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ParameterList)
Array of ParameterListOption (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

parameter_lists relationships

Manage list parameters relations

list option

Get the current list option relationship of the list parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the list parameter

query Parameters
include
string
Value: "parameter_lists"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterListOptionsRelation)
Array of objects (ParameterListOption) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

list option object

Get the current list option of the list parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the list parameter

Responses

Response Schema: application/json
object (ParameterListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

parameter_list_options

Manage list option parameters data

Get a list of list option parameters

Get a list of list option parameters

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ParameterListOption)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single list option parameter

Get a single list option parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the list option parameter

Responses

Response Schema: application/json
object (ParameterListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_group_parameter_numerics

Manage data group numeric parameters data

Get a list of data group numeric parameters

Get a list of data group numeric parameters

Authorizations:
OAuth2
query Parameters
include
string
Value: "parameter_numerics"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (DataGroupParameterNumeric)
Array of ParameterNumeric (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single data group numeric parameter

Get a single data group numeric parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group numeric parameter

query Parameters
include
string
Value: "parameter_numerics"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (DataGroupParameterNumeric)
Array of ParameterNumeric (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

data_group_parameter_numerics relationships

Manage data group numeric parameters relations

parameter numeric

Get the current numeric parameter relationship of the data group numeric parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group numeric parameter

query Parameters
include
string
Value: "parameter_numerics"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterNumericsRelation)
Array of objects (ParameterNumeric) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

parameter numeric object

Get the current numeric parameter of the data group numeric parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group numeric parameter

Responses

Response Schema: application/json
object (ParameterNumeric)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_group_parameter_textuals

Manage data group textual parameters data

Get a list of data group textual parameters

Get a list of data group textual parameters

Authorizations:
OAuth2
query Parameters
include
string
Value: "parameter_textuals"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (DataGroupParameterTextual)
Array of ParameterTextual (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single data group textual parameter

Get a single data group textual parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group textual parameter

query Parameters
include
string
Value: "parameter_textuals"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (DataGroupParameterTextual)
Array of ParameterTextual (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

data_group_parameter_textuals relationships

Manage data group textual parameters relations

parameter textual

Get the current textual parameter relationship of the data group textual parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group textual parameter

query Parameters
include
string
Value: "parameter_textuals"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterTextualsRelation)
Array of objects (ParameterTextual) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

parameter textual object

Get the current textual parameter of the data group textual parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group textual parameter

Responses

Response Schema: application/json
object (ParameterTextual)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_group_parameter_nutritionals

Manage data group nutritional parameters data

Get a list of data group nutritional parameters

Get a list of data group nutritional parameters

Authorizations:
OAuth2
query Parameters
include
string
Value: "parameter_nutritionals"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (DataGroupParameterNutritional)
Array of ParameterNutritional (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single data group nutritional parameter

Get a single data group nutritional parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group nutritional parameter

query Parameters
include
string
Value: "parameter_nutritionals"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (DataGroupParameterNutritional)
Array of ParameterNutritional (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

data_group_parameter_nutritionals relationships

Manage data group nutritional parameters relations

parameter nutritional

Get the current nutritional parameter relationship of the data group nutritional parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group nutritional parameter

query Parameters
include
string
Value: "parameter_nutritionals"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterNutritionalsRelation)
Array of objects (ParameterNutritional) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

parameter nutritional object

Get the current nutritional parameter of the data group nutritional parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group nutritional parameter

Responses

Response Schema: application/json
object (ParameterNutritional)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_group_parameter_allergens

Manage data group allergen parameters data

Get a list of data group allergen parameters

Get a list of data group allergen parameters

Authorizations:
OAuth2
query Parameters
include
string
Value: "parameter_allergens"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (DataGroupParameterAllergen)
Array of ParameterAllergen (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single data group allergen parameter

Get a single data group allergen parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group allergen parameter

query Parameters
include
string
Value: "parameter_allergens"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (DataGroupParameterAllergen)
Array of ParameterAllergen (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

data_group_parameter_allergens relationships

Manage data group allergen parameters relations

parameter allergen

Get the current allergen parameter relationship of the data group allergen parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group allergen parameter

query Parameters
include
string
Value: "parameter_allergens"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterAllergensRelation)
Array of objects (ParameterAllergen) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

parameter allergen object

Get the current allergen parameter of the data group allergen parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group allergen parameter

Responses

Response Schema: application/json
object (ParameterAllergen)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_group_parameter_list_options

Manage data group list option parameters data

Get a list of data group list option parameters

Get a list of data group list option parameters

Authorizations:
OAuth2
query Parameters
include
string
Enum: "parameter_lists" "parameter_list_options"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (DataGroupParameterListOption)
Array of ParameterListOption (object) or ParameterList (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single data group list option parameter

Get a single data group list option parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group list option parameter

query Parameters
include
string
Enum: "parameter_lists" "parameter_list_options"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (DataGroupParameterListOption)
Array of ParameterList (object) or ParameterListOption (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

data_group_parameter_list_options relationships

Manage data group list option parameters relations

parameter list

Get the current list parameter relationship of the data group list option parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group list option parameter

query Parameters
include
string
Value: "parameter_lists"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterListsRelation)
Array of objects (ParameterList) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

parameter list object

Get the current parameter list of the data group list option parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group list option parameter

Responses

Response Schema: application/json
object (ParameterList)

Response samples

Content type
application/json
{
  • "data": {
    }
}

parameter list option

Get the current list option parameter relationship of the data group list option parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group list option parameter

query Parameters
include
string
Value: "parameter_list_options"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterListOptionsRelation)
Array of objects (ParameterListOption) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

parameter list option object

Get the current parameter list option of the data group list option parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group list option parameter

Responses

Response Schema: application/json
object (ParameterListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_parameter_numerics

Manage product numeric parameters data

Get a list of product numeric parameters

Get a list of product numeric parameters

Authorizations:
OAuth2
query Parameters
include
string
Value: "parameter_numerics"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductParameterNumeric)
Array of ParameterNumeric (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product numeric parameter

Get a single product numeric parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product numeric parameter

query Parameters
include
string
Value: "parameter_numerics"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductParameterNumeric)
Array of ParameterNumeric (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

product_parameter_numerics relationships

Manage product numeric parameters relations

parameter numeric

Get the current numeric parameter relationship of the product numeric parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product numeric parameter

query Parameters
include
string
Value: "parameter_numerics"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterNumericsRelation)
Array of objects (ParameterNumeric) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

parameter numeric object

Get the current numeric parameter of the product numeric parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product numeric parameter

Responses

Response Schema: application/json
object (ParameterNumeric)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_parameter_textuals

Manage product textual parameters data

Get a list of product textual parameters

Get a list of product textual parameters

Authorizations:
OAuth2
query Parameters
include
string
Value: "parameter_textuals"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductParameterTextual)
Array of ParameterTextual (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product textual parameter

Get a single product textual parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product textual parameter

query Parameters
include
string
Value: "parameter_textuals"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductParameterTextual)
Array of ParameterTextual (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

product_parameter_textuals relationships

Manage product textual parameters relations

parameter textual

Get the current textual parameter relationship of the product textual parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product textual parameter

query Parameters
include
string
Value: "parameter_textuals"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterTextualsRelation)
Array of objects (ParameterTextual) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

parameter textual object

Get the current textual parameter of the product textual parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product textual parameter

Responses

Response Schema: application/json
object (ParameterTextual)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_parameter_nutritionals

Manage product nutritional parameters data

Get a list of product nutritional parameters

Get a list of product nutritional parameters

Authorizations:
OAuth2
query Parameters
include
string
Value: "parameter_nutritionals"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductParameterNutritional)
Array of ParameterNutritional (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product nutritional parameter

Get a single product nutritional parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product nutritional parameter

query Parameters
include
string
Value: "parameter_nutritionals"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductParameterNutritional)
Array of ParameterNutritional (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

product_parameter_nutritionals relationships

Manage product nutritional parameters relations

parameter nutritional

Get the current nutritional parameter relationship of the product nutritional parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product nutritional parameter

query Parameters
include
string
Value: "parameter_nutritionals"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterNutritionalsRelation)
Array of objects (ParameterNutritional) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

parameter nutritional object

Get the current nutritional parameter of the product nutritional parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product nutritional parameter

Responses

Response Schema: application/json
object (ParameterNutritional)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_parameter_allergens

Manage product allergen parameters data

Get a list of product allergen parameters

Get a list of product allergen parameters

Authorizations:
OAuth2
query Parameters
include
string
Value: "parameter_allergens"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductParameterAllergen)
Array of ParameterAllergen (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product allergen parameter

Get a single product allergen parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product allergen parameter

query Parameters
include
string
Value: "parameter_allergens"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductParameterAllergen)
Array of ParameterAllergen (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

product_parameter_allergens relationships

Manage product allergen parameters relations

parameter allergen

Get the current allergen parameter relationship of the product allergen parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product allergen parameter

query Parameters
include
string
Value: "parameter_allergens"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterAllergensRelation)
Array of objects (ParameterAllergen) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

parameter allergen object

Get the current allergen parameter of the product allergen parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product allergen parameter

Responses

Response Schema: application/json
object (ParameterAllergen)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_parameter_list_options

Manage product list option parameters data

Get a list of product list option parameters

Get a list of product list option parameters

Authorizations:
OAuth2
query Parameters
include
string
Enum: "parameter_lists" "parameter_list_options"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductParameterListOption)
Array of ParameterListOption (object) or ParameterList (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product list option parameter

Get a single product list option parameter by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product list option parameter

query Parameters
include
string
Enum: "parameter_lists" "parameter_list_options"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductParameterListOption)
Array of ParameterList (object) or ParameterListOption (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

product_parameter_list_options relationships

Manage product list option parameters relations

parameter list

Get the current list parameter relationship of the product list option parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product list option parameter

query Parameters
include
string
Value: "parameter_lists"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterListsRelation)
Array of objects (ParameterList) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

parameter list object

Get the current parameter list of the product list option parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product list option parameter

Responses

Response Schema: application/json
object (ParameterList)

Response samples

Content type
application/json
{
  • "data": {
    }
}

parameter list option

Get the current list option parameter relationship of the product list option parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product list option parameter

query Parameters
include
string
Value: "parameter_list_options"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ParameterListOptionsRelation)
Array of objects (ParameterListOption) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

parameter list option object

Get the current parameter list option of the product list option parameter

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product list option parameter

Responses

Response Schema: application/json
object (ParameterListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

custom_field_values

Manage custom field values data

Get a list of text custom fields

Get a list of text custom fields

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (CustomFieldValue)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single custom field value

Get a single custom field value by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the custom field value

Responses

Response Schema: application/json
object (CustomFieldValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

custom_field_fixed_values

Manage custom field fixed values data

Get a list of fixed value custom fields

Get a list of fixed value custom fields

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (CustomFieldFixedValue)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single custom field fixed value

Get a single custom field fixed value by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the custom field fixed value

Responses

Response Schema: application/json
object (CustomFieldFixedValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

custom_field_lists

Manage list custom fields data

Get a list of list custom fields

Get a list of list custom fields

Authorizations:
OAuth2
query Parameters
include
string
Value: "options"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (CustomFieldList)
Array of CustomFieldListOption (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single list custom field

Get a single list custom field by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the list custom fields

query Parameters
include
string
Value: "custom_field_list"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (CustomFieldList)
Array of CustomFieldListOption (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

custom_field_lists relationships

Manage list custom fields relations

list option

Get the current list option relationship of the list custom field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the list custom_field

query Parameters
include
string
Value: "custom_field_lists"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldListOptionRelation)
Array of objects (CustomFieldListOption) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

list option object

Get the current list option of the list custom field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the list custom field

Responses

Response Schema: application/json
object (CustomFieldListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

custom_field_list_options

Manage list option custom fields data

Get a list of list option custom fields

Get a list of list option custom fields

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (CustomFieldListOption)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single list option custom field

Get a single list option custom field by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the list option custom_field

Responses

Response Schema: application/json
object (CustomFieldListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

custom_field_input_tables

Manage custom field input tables data

Get a list of custom field input tables

Get a list of custom field input tables

Authorizations:
OAuth2
query Parameters
include
string
Value: "headers"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (CustomFieldInputTable)
Array of CustomFieldInputTableHeader (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single custom field input table

Get a single custom field input table by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the custom field input tables

query Parameters
include
string
Value: "custom_field_input_table"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (CustomFieldInputTable)
Array of CustomFieldInputTableHeader (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

custom_field_input_tables relationships

Manage custom fields input tables relations

input table header

Get the current headers relationship of the custom field input table

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the custom_field_input_table

query Parameters
include
string
Value: "custom_field_input_table_headers"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldInputTableHeaderRelation)
Array of objects (CustomFieldInputTableHeader) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field input table header object

Get the current headers of the custom field input table

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the custom field input table header

Responses

Response Schema: application/json
object (CustomFieldInputTableHeader)

Response samples

Content type
application/json
{
  • "data": {
    }
}

custom_field_input_table_headers

Get a list of custom field input table headers

Get a list of custom field input table headers

Authorizations:
OAuth2
query Parameters
include
string
Enum: "custom_field_value" "custom_field_fixed_value" "custom_field_list"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (CustomFieldInputTableHeader)
Array of CustomFieldValue (object) or CustomFieldFixedValue (object) or CustomFieldList (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single custom field input table header

Get a single custom field input table header by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the custom field input table headers

query Parameters
include
string
Enum: "custom_field_value" "custom_field_fixed_value" "custom_field_list"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (CustomFieldInputTableHeader)
Array of CustomFieldValue (object) or CustomFieldFixedValue (object) or CustomFieldList (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

custom_field_input_table_headers relationships

custom field value

Get the current custom_field_value relationship of the custom field input table header

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the custom_field_value

query Parameters
include
string
Value: "custom_field_value"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldValueRelation)
Array of objects (CustomFieldValue) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field value object

Get the current custom_field_value of the custom field input table header

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the custom field value

Responses

Response Schema: application/json
object (CustomFieldValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

custom field fixed value

Get the current custom_field_fixed_value relationship of the custom field input table header

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the custom_field_fixed_value

query Parameters
include
string
Value: "custom_field_fixed_value"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldFixedValueRelation)
Array of objects (CustomFieldFixedValue) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field fixed value object

Get the current custom_field_fixed_value of the custom field input table header

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the custom field fixed value

Responses

Response Schema: application/json
object (CustomFieldFixedValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

custom field list

Get the current custom_field_list relationship of the custom field input table header

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the custom_field_list

query Parameters
include
string
Value: "custom_field_list"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldListRelation)
Array of objects (CustomFieldList) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field list object

Get the current custom_field_list of the custom field input table header

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the custom field list

Responses

Response Schema: application/json
object (CustomFieldList)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_custom_field_values

Manage product custom field values data

Get a list of product custom field values

Get a list of product custom field values

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductCustomFieldValue)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product custom field value

Get a single product custom field value by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field value

Responses

Response Schema: application/json
object (ProductCustomFieldValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_custom_field_values relationships

Manage product custom field values relations

custom field value

Get the current custom_field_value relationship of the product custom field value

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_custom_field_value

query Parameters
include
string
Value: "custom_field_value"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldValueRelation)
Array of objects (CustomFieldValue) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field value object

Get the current custom_field_value of the product custom field value

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field value

Responses

Response Schema: application/json
object (CustomFieldValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

language

Get the current language relationship of the product custom field value

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_custom_field_value

query Parameters
include
string
Value: "language"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (I18nLanguageRelation)
Array of objects (I18nLanguage) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

language object

Get the current language of the product custom field value

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field value

Responses

Response Schema: application/json
object (I18nLanguage)

Response samples

Content type
application/json
{
  • "data": {
    }
}

user

Get the current user relationship of the product custom field value

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_custom_field_value

query Parameters
include
string
Value: "user"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

user object

Get the current user of the product custom field value

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field value

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_custom_field_fixed_values

Manage product custom field fixed values data

Get a list of product custom field fixed values

Get a list of product custom field fixed values

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductCustomFieldFixedValue)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product custom field fixed value

Get a single product custom field fixed value by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field fixed value

Responses

Response Schema: application/json
object (ProductCustomFieldFixedValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_custom_field_list_options

Manage product custom field list options data

Get a list of product custom field list options

Get a list of product custom field list options

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductCustomFieldListOption)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product custom field list option

Get a single product custom field list option by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field list option

Responses

Response Schema: application/json
object (ProductCustomFieldListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_custom_field_list_options relationships

Manage product custom field list options relations

custom field list

Get the current custom_field_list relationship of the product custom field list option

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_custom_field_list_option

query Parameters
include
string
Value: "custom_field_list"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldListRelation)
Array of objects (CustomFieldList) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field list object

Get the current custom_field_list of the product custom field list option

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field list option

Responses

Response Schema: application/json
object (CustomFieldList)

Response samples

Content type
application/json
{
  • "data": {
    }
}

custom field list option

Get the current custom_field_list_option relationship of the product custom field list option

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_custom_field_list_option

query Parameters
include
string
Value: "custom_field_list_option"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldListOptionRelation)
Array of objects (CustomFieldListOption) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field list option object

Get the current custom_field_list_option of the product custom field list option

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field list option

Responses

Response Schema: application/json
object (CustomFieldListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

user

Get the current user relationship of the product custom field list option

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_custom_field_list_option

query Parameters
include
string
Value: "user"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

user object

Get the current user of the product custom field list option

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field list option

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_custom_field_input_table_contents

Manage product custom field input table contents data

Get a list of product custom field input table contents

Get a list of product custom field input table contents

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductCustomFieldInputTableContent)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product custom field input table content

Get a single product custom field input table content by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field input table content

Responses

Response Schema: application/json
object (ProductCustomFieldInputTableContent)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_custom_field_input_table_contents relationships

Manage product custom field input table contents relations

custom field input table

Get the current custom_field_input_table relationship of the product custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_custom_field_input_table_content

query Parameters
include
string
Value: "custom_field_input_table"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldInputTableRelation)
Array of objects (CustomFieldInputTable) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field input table object

Get the current custom_field_input_table of the product custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field input table content

Responses

Response Schema: application/json
object (CustomFieldInputTable)

Response samples

Content type
application/json
{
  • "data": {
    }
}

custom field input table header

Get the current custom_field_input_table_header relationship of the product custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_custom_field_input_table_content

query Parameters
include
string
Value: "custom_field_input_table_header"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldInputTableHeaderRelation)
Array of objects (CustomFieldInputTableHeader) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field input table header object

Get the current custom_field_input_table)_header of the product custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field input table content

Responses

Response Schema: application/json
object (CustomFieldInputTableHeader)

Response samples

Content type
application/json
{
  • "data": {
    }
}

language

Get the current language relationship of the product custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_custom_field_input_table_content

query Parameters
include
string
Value: "language"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (I18nLanguageRelation)
Array of objects (I18nLanguage) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

language object

Get the current language of the product custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field input table content

Responses

Response Schema: application/json
object (I18nLanguage)

Response samples

Content type
application/json
{
  • "data": {
    }
}

user

Get the current user relationship of the product custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_custom_field_input_table_content

query Parameters
include
string
Value: "user"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

user object

Get the current user of the product custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product custom field input table content

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_group_custom_field_values

Manage data group custom field values data

Get a list of data_group custom field values

Get a list of data_group custom field values

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (DataGroupCustomFieldValue)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single data group custom field value

Get a single data group custom field value by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field value

Responses

Response Schema: application/json
object (DataGroupCustomFieldValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_group_custom_field_values relationships

Manage data group custom field values relations

custom field value

Get the current custom_field_value relationship of the data group custom field value

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data_group_custom_field_value

query Parameters
include
string
Value: "custom_field_value"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldValueRelation)
Array of objects (CustomFieldValue) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field value object

Get the current custom_field_value of the data group custom field value

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field value

Responses

Response Schema: application/json
object (CustomFieldValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

language

Get the current language relationship of the data group custom field value

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data_group_custom_field_value

query Parameters
include
string
Value: "language"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (I18nLanguageRelation)
Array of objects (I18nLanguage) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

language object

Get the current language of the data group custom field value

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field value

Responses

Response Schema: application/json
object (I18nLanguage)

Response samples

Content type
application/json
{
  • "data": {
    }
}

user

Get the current user relationship of the data group custom field value

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data_group_custom_field_value

query Parameters
include
string
Value: "user"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

user object

Get the current user of the data group custom field value

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field value

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_group_custom_field_fixed_values

Manage data group custom field fixed values data

Get a list of data group custom field fixed values

Get a list of data group custom field fixed values

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (DataGroupCustomFieldFixedValue)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single data group custom field fixed value

Get a single data group custom field fixed value by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field fixed value

Responses

Response Schema: application/json
object (DataGroupCustomFieldFixedValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_group_custom_field_list_options

Manage data group custom field list options data

Get a list of data group custom field list options

Get a list of data group custom field list options

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (DataGroupCustomFieldListOption)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single data group custom field list option

Get a single data group custom field list option by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field list option

Responses

Response Schema: application/json
object (DataGroupCustomFieldListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_group_custom_field_list_options relationships

Manage data group custom field list options relations

custom field list

Get the current custom_field_list relationship of the data group custom field list option

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data_group_custom_field_list_option

query Parameters
include
string
Value: "custom_field_list"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldListRelation)
Array of objects (CustomFieldList) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field list object

Get the current custom_field_list of the data group custom field list option

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field list option

Responses

Response Schema: application/json
object (CustomFieldList)

Response samples

Content type
application/json
{
  • "data": {
    }
}

custom field list option

Get the current custom_field_list_option relationship of the data group custom field list option

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data_group_custom_field_list_option

query Parameters
include
string
Value: "custom_field_list_option"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldListOptionRelation)
Array of objects (CustomFieldListOption) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field list option object

Get the current custom_field_list_option of the data group custom field list option

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field list option

Responses

Response Schema: application/json
object (CustomFieldListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

user

Get the current user relationship of the data group custom field list option

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data_group_custom_field_list_option

query Parameters
include
string
Value: "user"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

user object

Get the current user of the data group custom field list option

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field list option

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_group_custom_field_input_table_contents

Manage data group custom field input table contents data

Get a list of data group custom field input table contents

Get a list of data group custom field input table contents

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (DataGroupCustomFieldInputTableContent)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single data group custom field input table content

Get a single data group custom field input table content by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field input table content

Responses

Response Schema: application/json
object (DataGroupCustomFieldInputTableContent)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data_group_custom_field_input_table_contents relationships

Manage data group custom field input table contents relations

custom field input table

Get the current custom_field_input_table relationship of the data group custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data_group_custom_field_input_table_content

query Parameters
include
string
Value: "custom_field_input_table"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldInputTableRelation)
Array of objects (CustomFieldInputTable) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field input table object

Get the current custom_field_input_table of the data group custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field input table content

Responses

Response Schema: application/json
object (CustomFieldInputTable)

Response samples

Content type
application/json
{
  • "data": {
    }
}

custom field input table header

Get the current custom_field_input_table_header relationship of the data group custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data_group_custom_field_input_table_content

query Parameters
include
string
Value: "custom_field_input_table_header"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomFieldInputTableHeaderRelation)
Array of objects (CustomFieldInputTableHeader) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

custom field input table header object

Get the current custom_field_input_table)_header of the data group custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field input table content

Responses

Response Schema: application/json
object (CustomFieldInputTableHeader)

Response samples

Content type
application/json
{
  • "data": {
    }
}

language

Get the current language relationship of the data group custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data_group_custom_field_input_table_content

query Parameters
include
string
Value: "language"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (I18nLanguageRelation)
Array of objects (I18nLanguage) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

language object

Get the current language of the data group custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field input table content

Responses

Response Schema: application/json
object (I18nLanguage)

Response samples

Content type
application/json
{
  • "data": {
    }
}

user

Get the current user relationship of the data group custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data_group_custom_field_input_table_content

query Parameters
include
string
Value: "user"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

user object

Get the current user of the data group custom field input table content

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the data group custom field input table content

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_consolidated_fields

Manage product consolidated fields data

Get a list of product consolidated fields

Get a list of product consolidated fields

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductConsolidatedField)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product consolidated field

Get a single product consolidated field by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (ProductConsolidatedField)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_consolidated_fields relationships

Manage product consolidated fields relations

product parameter numeric

Get the current product_parameter_numeric relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "product_parameter_numeric"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductParameterNumericRelation)
Array of objects (ProductParameterNumeric) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product parameter numeric object

Get the current product_parameter_numeric of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (ProductParameterNumeric)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product parameter textual

Get the current product_parameter_textual relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "product_parameter_textual"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductParameterTextualRelation)
Array of objects (ProductParameterTextual) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product parameter textual object

Get the current product_parameter_textual of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (ProductParameterTextual)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product parameter list option

Get the current product_parameter_list_option relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "product_parameter_list_option"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductParameterListOptionRelation)
Array of objects (ProductParameterListOption) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product parameter list option object

Get the current product_parameter_list_option of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (ProductParameterListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product parameter nutritional

Get the current product_parameter_nutritional relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "product_parameter_nutritional"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductParameterNutritionalRelation)
Array of objects (ProductParameterNutritional) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product parameter nutritional object

Get the current product_parameter_nutritional of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (ProductParameterNutritional)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product parameter allergen

Get the current product_parameter_allergen relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "product_parameter_allergen"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductParameterAllergenRelation)
Array of objects (ProductParameterAllergen) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product parameter allergen object

Get the current product_parameter_allergen of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (ProductParameterAllergen)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data group parameter numeric

Get the current data_group_parameter_numeric relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "data_group_parameter_numeric"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (DataGroupParameterNumericRelation)
Array of objects (DataGroupParameterNumeric) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

data group parameter numeric object

Get the current data_group_parameter_numeric of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (DataGroupParameterNumeric)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data group parameter textual

Get the current data_group_parameter_textual relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "data_group_parameter_textual"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (DataGroupParameterTextualRelation)
Array of objects (DataGroupParameterTextual) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

data group parameter textual object

Get the current data_group_parameter_textual of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (DataGroupParameterTextual)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data group parameter list option

Get the current data_group_parameter_list_option relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "data_group_parameter_list_option"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (DataGroupParameterListOptionRelation)
Array of objects (DataGroupParameterListOption) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

data group parameter list option object

Get the current data_group_parameter_list_option of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (DataGroupParameterListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data group parameter nutritional

Get the current data_group_parameter_nutritional relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "data_group_parameter_nutritional"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (DataGroupParameterNutritionalRelation)
Array of objects (DataGroupParameterNutritional) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

data group parameter nutritional object

Get the current data_group_parameter_nutritional of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (DataGroupParameterNutritional)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data group parameter allergen

Get the current data_group_parameter_allergen relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "data_group_parameter_allergen"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (DataGroupParameterAllergenRelation)
Array of objects (DataGroupParameterAllergen) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

data group parameter allergen object

Get the current data_group_parameter_allergen of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (DataGroupParameterAllergen)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product custom field value

Get the current product_custom_field_value relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "product_custom_field_value"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductCustomFieldValueRelation)
Array of objects (ProductCustomFieldValue) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product custom field value object

Get the current product_custom_field_value of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (ProductCustomFieldValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product custom field fixed value

Get the current product_custom_field_fixed_value relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "product_custom_field_fixed_value"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductCustomFieldFixedValueRelation)
Array of objects (ProductCustomFieldFixedValue) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product custom field fixed value object

Get the current product_custom_field_fixed_value of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (ProductCustomFieldFixedValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product custom field list option

Get the current product_custom_field_list_option relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "product_custom_field_list_option"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductCustomFieldListOptionRelation)
Array of objects (ProductCustomFieldListOption) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product custom field list option object

Get the current product_custom_field_list_option of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (ProductCustomFieldListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product custom field input table content

Get the current product_custom_field_input_table_content relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "product_custom_field_input_table_content"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductCustomFieldInputTableContentRelation)
Array of objects (ProductCustomFieldInputTableContent) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product custom field input table content object

Get the current product_custom_field_input_table_content of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (ProductCustomFieldInputTableContent)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data group custom field value

Get the current data_group_custom_field_value relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "data_group_custom_field_value"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (DataGroupCustomFieldValueRelation)
Array of objects (DataGroupCustomFieldValue) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

data group custom field value object

Get the current data_group_custom_field_value of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (DataGroupCustomFieldValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data group custom field fixed value

Get the current data_group_custom_field_fixed_value relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "data_group_custom_field_fixed_value"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (DataGroupCustomFieldFixedValueRelation)
Array of objects (DataGroupCustomFieldFixedValue) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

data group custom field fixed value object

Get the current data_group_custom_field_fixed_value of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (DataGroupCustomFieldFixedValue)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data group custom field list option

Get the current data_group_custom_field_list_option relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "data_group_custom_field_list_option"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (DataGroupCustomFieldListOptionRelation)
Array of objects (DataGroupCustomFieldListOption) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

data group custom field list option object

Get the current data_group_custom_field_list_option of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (DataGroupCustomFieldListOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

data group custom field input table content

Get the current data_group_custom_field_input_table_content relationship of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product_consolidated_field

query Parameters
include
string
Value: "data_group_custom_field_input_table_content"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (DataGroupCustomFieldInputTableContentRelation)
Array of objects (DataGroupCustomFieldInputTableContent) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

data group custom field input table content object

Get the current data_group_custom_field_input_table_content of the product consolidated field

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product consolidated field

Responses

Response Schema: application/json
object (DataGroupCustomFieldInputTableContent)

Response samples

Content type
application/json
{
  • "data": {
    }
}

addresses

Manage address data

Get a list of addresses

Get a list of addresses

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (Address)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a address

Add a address

Authorizations:
OAuth2
Request Body schema: application/json
required

Address to add

object (Address)

Responses

Response Schema: application/json
object (Address)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a single address

Get a single address by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the address

Responses

Response Schema: application/json
object (Address)

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a address

Update a address by its id. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the address

Request Body schema: application/json
required

Address properties to update

object (Address)

Responses

Response Schema: application/json
object (Address)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a address

Delete a address by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the address

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

interventions

Manage interventions data

Get a list of interventions

Get a list of interventions

Authorizations:
OAuth2
query Parameters
include
string
Enum: "machine" "requester" "executer" "type" "category" "priority" "status" "actions"

Customise which related resources should be returned. Include one or more from the given options comma separated

filter[status]
string
Enum: "not_completed" "temporarily_fixed" "completed" "requested"

Only get interventions that match given status. Multiple statusses can be given separated by comma

filter[actions.status]
string
Enum: "not_completed" "in_progress" "completed"

Only get interventions that have actions matching the given status. Multiple statusses can be given separated by comma

filter[actions.action_by]
string

Only get interventions that have actions where this user has to take action. Value has to be a valid username. This filter also implies filtering on actions that are not completed yet. Using this filter will also limit the actions returned for the interventions to the ones that match!

filter[machine.internal_reference]
string

Only get interventions that have a machine linked with this internal reference

filter[actions.time_registrations.from_date_from]
string <DateTime ATOM>

Only get interventions that have time registrations on actions for which the from date comes before or is the same as the given date. Value has to be a valid ATOM string.

filter[actions.time_registrations.from_date_until]
string <DateTime ATOM>

Only get interventions that have time registrations on actions for which the from date comes before or is the same as the given date. Value has to be a valid ATOM string.

filter[actions.time_registrations.to_date_from]
string <DateTime ATOM>

Only get interventions that have time registrations on actions for which the to date comes after or is the same as the given date. Value has to be a valid ATOM string.

filter[actions.time_registrations.to_date_until]
string <DateTime ATOM>

Only get interventions that have time registrations on actions for which the to date comes before or is the same as the given date. Value has to be a valid ATOM string.

filter[actions.time_registrations.user_id]
string

Only get interventions that have time registrations on actions for which the user registered time registrations.

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (Intervention)
Array of Machine (object) or InterventionPriority (object) or InterventionStatus (object) or InterventionAction (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add an intervention

Add an intervention

Authorizations:
OAuth2
Request Body schema: application/json
required

Intervention to add

object (Intervention)

Responses

Response Schema: application/json
object (Intervention)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a single intervention

Get a single intervention by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

query Parameters
include
string
Enum: "machine" "requester" "executer" "type" "category" "priority" "status" "actions"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Intervention)
Array of Machine (object) or InterventionPriority (object) or InterventionStatus (object) or InterventionAction (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

interventions relationships

Manage intervention relations

machine

Get the current machine relationship of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

query Parameters
include
string
Value: "machine"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (MachineRelation)
Array of objects (Machine) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

machine

Updating an intervention's machine relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

machine object

Get the current machine of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response Schema: application/json
object (Machine)

Response samples

Content type
application/json
{
  • "data": {
    }
}

requester

Get the current requester relationship of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

query Parameters
include
string
Value: "requester"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

requester

Updating an intervention's requester relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

requester object

Get the current requester of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

executer

Get the current executer relationship of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

query Parameters
include
string
Value: "executer"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

executer

Updating an intervention's executer relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

executer object

Get the current executer of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

type

Get the current type relationship of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

query Parameters
include
string
Value: "type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (InterventionTypeRelation)
Array of objects (InterventionType) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

type

Updating an intervention's type relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

type object

Get the current type of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response Schema: application/json
object (InterventionType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

category

Get the current category relationship of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

query Parameters
include
string
Value: "category"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (InterventionCategoryRelation)
Array of objects (InterventionCategory) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

category

Updating an intervention's category relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

category object

Get the current category of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response Schema: application/json
object (InterventionCategory)

Response samples

Content type
application/json
{
  • "data": {
    }
}

priority

Get the current priority relationship of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

query Parameters
include
string
Value: "priority"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (InterventionPriorityRelation)
Array of objects (InterventionPriority) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

priority

Updating an intervention's priority relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

priority object

Get the current priority of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response Schema: application/json
object (InterventionPriority)

Response samples

Content type
application/json
{
  • "data": {
    }
}

status

Get the current status relationship of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

query Parameters
include
string
Value: "status"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (InterventionStatusRelation)
Array of objects (InterventionStatus) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

status

Updating an intervention's status relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

status object

Get the current status of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response Schema: application/json
object (InterventionStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

actions

Get the current actions relationship of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

query Parameters
include
string
Value: "actions"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
Array of objects (InterventionActionRelation) unique
Array of objects (InterventionAction) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

actions

Add actions relations to the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Request Body schema: application/json
required

Intervention action object identifiers

Array of objects (InterventionActionRelation) unique

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

actions

Update an intervention's action relation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Request Body schema: application/json
required

Intervention action object identifiers

Array of objects (InterventionActionRelation) unique

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

actions

Delete an action from an intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Request Body schema: application/json
required

Intervention action object identifiers

Array of objects (InterventionActionRelation) unique

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

actions objects

Get the current actions of the intervention

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention

Responses

Response Schema: application/json
Array of objects (InterventionAction) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

intervention_actions

Manage intervention actions data

Get a list of intervention actions

Get a list of intervention actions.

Authorizations:
OAuth2
query Parameters
include
string
Enum: "status" "release_signature" "time_registrations"

Customise which related resources should be returned. Include one or more from the given options comma separated

filter[action_by]
string

Only get intervention actions where this user has to take action. Value has to be a valid username. This filter also implies filtering on actions that are not completed yet.

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (InterventionAction)
Array of InterventionActionStatus (object) or Signature (object) or InterventionActionTimeRegistration (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single intervention action

Get a single intervention action by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

query Parameters
include
string
Enum: "status" "release_signature" "time_registrations"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (InterventionAction)
Array of InterventionActionStatus (object) or Signature (object) or InterventionActionTimeRegistration (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Update an intervention action

Update an intervention action by its id. Only given properties will be updated. TO BE IMPLEMENTED

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

Request Body schema: application/json
required

Intervention action properties to update

object (InterventionAction)

Responses

Response Schema: application/json
object (InterventionAction)
Array of InterventionActionStatus (object) or Signature (object) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

intervention_actions relationships

Manage intervention actions relations

status

Get the current status relationship of the intervention action

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

query Parameters
include
string
Value: "status"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (InterventionActionStatusRelation)
Array of objects (InterventionActionStatus) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

status

Updating an intervention action's status relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

status object

Get the current status of the intervention action

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

Responses

Response Schema: application/json
object (InterventionActionStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

release_signature

Get the current release signature relationship of the intervention action

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

query Parameters
include
string
Value: "release_signature"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (SignatureRelation)
Array of objects (Signature) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

release_signature

Updating an intervention action's release signature relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

release_signature object

Get the current release signature of the intervention action

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

Responses

Response Schema: application/json
object (Signature)

Response samples

Content type
application/json
{
  • "data": {
    }
}

release_signature

Link a new signature to an intervention action. The signature must be a non existing one and its id must be null

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

Request Body schema: application/json
required

Signature object

object (Signature)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

time_registrations

Get the current time_registrations relationship of the intervention action

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

query Parameters
include
string
Value: "time_registrations"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
Array of objects (InterventionActionTimeRegistrationRelation) unique
Array of objects (InterventionActionTimeRegistration) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

time_registrations

Link intervention action time registrations to an intervention action.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

Request Body schema: application/json
required

Intervention Action Time Registration objects

Array of objects (InterventionActionTimeRegistrationRelation) unique

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

time_registrations

Updating an intervention action's time registrations relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

time_registrations

Deleting an intervention action's time registrations relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

time_registrations objects

Get the current time registrations of the intervention action

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

Responses

Response Schema: application/json
Array of objects (InterventionActionTimeRegistration) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

time_registrations objects

Link new intervention action time registrations to an intervention action. The time registrations must be non existing and their id must be null

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action

Request Body schema: application/json
required

Intervention Action Time Registration objects

Array of objects (InterventionActionTimeRegistration) unique

Responses

Response Schema: application/json
Array of objects (InterventionActionTimeRegistration) unique

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

intervention_action_time_registrations

Manage intervention action time registrations data

Get a list of intervention action time registrations

Get a list of intervention action time registrations.

Authorizations:
OAuth2
query Parameters
include
string
Value: "user"

Customise which related resources should be returned. Include one or more from the given options comma separated

filter[intervention_id]
integer

Only get intervention action time registrations for a specific intervention. Value has to be a valid intervention id.

filter[intervention_action_id]
integer

Only get intervention action time registrations for a specific intervention action. Value has to be a valid intervention action id.

filter[user_id]
integer

Only get intervention action time registrations where this user registered the time registration. Value has to be a valid user id.

filter[from_date_from]
string <DateTime ATOM>

Only get intervention action time registrations for which the from date comes after or is the same as the given date. Value has to be a valid ATOM string.

filter[from_date_until]
string <DateTime ATOM>

Only get intervention action time registrations for which the from date comes before or is the same as the given date. Value has to be a valid ATOM string.

filter[to_date_from]
string <DateTime ATOM>

Only get intervention action time registrations for which the to date comes after or is the same as the given date. Value has to be a valid ATOM string.

filter[to_date_until]
string <DateTime ATOM>

Only get intervention action time registrations for which the to date comes before or is the same as the given date. Value has to be a valid ATOM string.

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (InterventionActionTimeRegistration)
Array of User (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single intervention action time registration

Get a single intervention action time registration by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action time registration

query Parameters
include
string
Value: "user"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (InterventionActionTimeRegistration)
Array of User (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Update an intervention action time registration

Update an intervention action time registration by its id. Only given properties will be updated.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action time registration

Request Body schema: application/json
required

Intervention action time registration properties to update

object (InterventionActionTimeRegistration)

Responses

Response Schema: application/json
object (InterventionActionTimeRegistration)
Array of User (object) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Delete an intervention action time registration

Delete an intervention action time registration

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action time registration

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

intervention_action_time_registrations relationships

Manage intervention action time registrations relations

user

Get the current user relationship of the intervention action time registration

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action time registration

query Parameters
include
string
Value: "user"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

user

Replace an intervention action time registration's user relation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action time registration

Request Body schema: application/json
required

User object identifier. This is a to-one relationship and will replace the user by the given user

object (UserRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

user object

Get the current user of the intervention action time registration

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action time registration

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

machines

Manage machines data

Get a list of machines

Get a list of machines.

Authorizations:
OAuth2
query Parameters
include
string
Enum: "status" "department_corporate_group"

Customise which related resources should be returned. Include one or more from the given options comma separated

filter[status]
string
Enum: "active" "not_active" "on_hold"

Only get machines that match given status. Multiple statusses can be given separated by comma

filter[internal_reference]
string

Only get the machine that matches the given internal reference

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (Machine)
Array of MachineStatus (object) or DepartmentCorporateGroup (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single machine

Get a single machine by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the machine

query Parameters
include
string
Enum: "status" "department_corporate_group"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Machine)
Array of MachineStatus (object) or DepartmentCorporateGroup (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

machines relationships

Manage machine relations

status

Get the current status relationship of the machine

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the machine

query Parameters
include
string
Value: "status"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (MachineStatusRelation)
Array of objects (MachineStatus) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

status

Updating a machine's status relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the machine

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

status object

Get the current status of the machine

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the machine

Responses

Response Schema: application/json
object (MachineStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

department_corporate_group

Get the current department corporate group relationship of the machine

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the machine

query Parameters
include
string
Value: "department_corporate_group"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (DepartmentCorporateGroupRelation)
Array of objects (DepartmentCorporateGroup) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

department_corporate_group

Updating a machine's department corporate group relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the machine

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

department_corporate_group object

Get the current department corporate group of the machine

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the machine

Responses

Response Schema: application/json
object (DepartmentCorporateGroup)

Response samples

Content type
application/json
{
  • "data": {
    }
}

non_conformities

Manage non conformities data

Get a list of non conformities

Get a list of non conformities

Authorizations:
OAuth2
query Parameters
include
string
Enum: "complaint_ranking" "block_category" "employee" "reporter" "execution_type" "status" "created_by" "blocked_by" "product" "processing_method_proposals" "processing_method_settlements"

Customise which related resources should be returned. Include one or more from the given options comma separated

filter[complaint_date_from]
string <DateTime ATOM>

An ATOM formatted string describing the start time from when to look for complaints

filter[complaint_date_until]
string <DateTime ATOM>

An ATOM formatted string describing the end time until when to look for complaints

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (NonConformity)
Array of ComplaintRanking (object) or NonConformityBlockCategory (object) or Employee (object) or NonConformityExecutionType (object) or NonConformityStatus (object) or ProblemCode (object) or User (object) or Product (object) or NonConformityProcessingMethodProposal (object) or NonConformityProcessingMethodSettlement (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single non conformity

Get a single non conformity by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Enum: "complaint_ranking" "block_category" "employee" "reporter" "execution_type" "status" "created_by" "blocked_by" "product" "processing_method_proposals" "processing_method_settlements"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (NonConformity)
Array of ComplaintRanking (object) or NonConformityBlockCategory (object) or Employee (object) or NonConformityExecutionType (object) or NonConformityStatus (object) or ProblemCode (object) or User (object) or Product (object) or NonConformityProcessingMethodProposal (object) or NonConformityProcessingMethodSettlement (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

non_conformities relationships

Manage non conformities relations

complaint_ranking

Get the current complaint ranking relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "complaint_ranking"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ComplaintRankingRelation)
Array of objects (ComplaintRanking) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

complaint_ranking

Updating a non conformity complaint ranking relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

complaint_ranking object

Get the current complaint ranking of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
object (ComplaintRanking)

Response samples

Content type
application/json
{
  • "data": {
    }
}

block_category

Get the current block category relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "block_category"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (NonConformityBlockCategoryRelation)
Array of objects (NonConformityBlockCategory) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

block_category

Updating a non conformity block category relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

block_category object

Get the current block category of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
object (NonConformityBlockCategory)

Response samples

Content type
application/json
{
  • "data": {
    }
}

employee

Get the current employee relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "employee"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (EmployeeRelation)
Array of objects (Employee) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

employee

Updating a non conformity employee relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

employee object

Get the current employee of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
object (Employee)

Response samples

Content type
application/json
{
  • "data": {
    }
}

reporter

Get the current reporter relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "reporter"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (EmployeeRelation)
Array of objects (Employee) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

reporter

Updating a non conformity reporter relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

reporter object

Get the current reporter of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
object (Employee)

Response samples

Content type
application/json
{
  • "data": {
    }
}

execution_type

Get the current execution_type relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "execution_type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (NonConformityExecutionTypeRelation)
Array of objects (NonConformityExecutionType) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

execution_type

Updating a non conformity execution_type relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

execution_type object

Get the current execution_type of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
object (NonConformityExecutionType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

status

Get the current status relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "status"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (NonConformityStatusRelation)
Array of objects (NonConformityStatus) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

status

Updating a non conformity status relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

status object

Get the current status of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
object (NonConformityStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

processing method proposal

Get the current processing method proposal relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "processing_method_proposals"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (NonConformityProcessingMethodProposalRelation)
Array of objects (NonConformityProcessingMethodProposal) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

processing_method_proposal

Adding a non conformity processing method proposal relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

processing_method_proposal

Updating a non conformity processing method proposal relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

processing_method_proposal

Deleting a non conformity processing method proposal relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

processing method proposal object

Get the current processing method proposals of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
Array of objects (NonConformityProcessingMethodProposal) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

processing method settlement

Get the current processing method settlement relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "processing_method_settlements"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (NonConformityProcessingMethodSettlementRelation)
Array of objects (NonConformityProcessingMethodSettlement) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

processing_method_settlement

Adding a non conformity processing method settlement relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

processing_method_settlement

Updating a non conformity processing method settlement relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

processing_method_settlement

Deleting a non conformity processing method settlement relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

processing method settlement object

Get the current processing method settlements of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
Array of objects (NonConformityProcessingMethodSettlement) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

problem_code

Get the current problem_code relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "problem_code"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProblemCodeRelation)
Array of objects (ProblemCode) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

problem_code

Updating a non conformity problem_code relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

problem_code object

Get the current problem_code of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
object (ProblemCode)

Response samples

Content type
application/json
{
  • "data": {
    }
}

created_by

Get the current created_by relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "created_by"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

created_by

Updating a non conformity created_by relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

created_by object

Get the current created_by of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

executer

Get the current executer relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "executer"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

executer

Updating a non conformity executer relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

executer object

Get the current executer of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

blocked_by

Get the current blocked_by relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "blocked_by"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

blocked_by

Updating a non conformity blocked_by relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

blocked_by object

Get the current blocked_by of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product

Get the current product relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "product"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductRelation)
Array of objects (Product) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product

Updating a non conformity product relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

product object

Get the current product of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
object (Product)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_line

Get the current production_line relationship of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

query Parameters
include
string
Value: "production_line"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductionLineRelation)
Array of objects (ProductionLine) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

production_line

Updating a non conformity production_line relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

production_line object

Get the current production_line of the non conformity

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity

Responses

Response Schema: application/json
object (ProductionLine)

Response samples

Content type
application/json
{
  • "data": {
    }
}

non_conformity_block_categories

Manage non conformity block category data

Get a list of non conformity block categories

Get a list of non conformity block categories

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (NonConformityBlockCategory)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single non conformity block category

Get a single non conformity block category by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity block category

Responses

Response Schema: application/json
object (NonConformityBlockCategory)

Response samples

Content type
application/json
{
  • "data": {
    }
}

non_conformity_processing_methods

Manage non conformity processing method data

Get a list of non conformity processing methods

Get a list of non conformity processing methods

Authorizations:
OAuth2
query Parameters
include
string
Value: "category"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
Array of objects (NonConformityProcessingMethod)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single non conformity processing method

Get a single non conformity processing method by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method

query Parameters
include
string
Value: "category"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (NonConformityProcessingMethod)

Response samples

Content type
application/json
{
  • "data": {
    }
}

non_conformity_processing_methods relationships

Manage non conformity processing method relations

category

Get the current category relationship of the non conformity processing method

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method

query Parameters
include
string
Value: "category"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (NonConformityProcessingMethodCategoryRelation)
Array of objects (NonConformityProcessingMethodCategory) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

category

Updating a non conformity processing method category relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

category object

Get the current category of the non conformity processing method

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method

Responses

Response Schema: application/json
object (NonConformityProcessingMethodCategory)

Response samples

Content type
application/json
{
  • "data": {
    }
}

non_conformity_processing_method_categories

Manage non conformity processing method category data

Get a list of non conformity processing method categories

Get a list of non conformity processing method categories

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (NonConformityProcessingMethodCategory)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single non conformity processing method category

Get a single non conformity processing method category by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method category

Responses

Response Schema: application/json
object (NonConformityProcessingMethodCategory)

Response samples

Content type
application/json
{
  • "data": {
    }
}

non_conformity_processing_method_proposals

Manage non conformity processing method proposal data

Get a list of non conformity processing method proposals

Get a list of non conformity processing method proposals

Authorizations:
OAuth2
query Parameters
include
string
Value: "processing_method"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
Array of objects (NonConformityProcessingMethodProposal)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single non conformity processing method proposal

Get a single non conformity processing method proposal by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method proposal

query Parameters
include
string
Value: "processing_method"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (NonConformityProcessingMethodProposal)

Response samples

Content type
application/json
{
  • "data": {
    }
}

non_conformity_processing_method_proposals relationships

Manage non conformity processing method proposal relations

processing_method

Get the current processing method relationship of the non conformity processing method proposal

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method proposal

query Parameters
include
string
Value: "processing_method"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (NonConformityProcessingMethodProposalRelation)
Array of objects (NonConformityProcessingMethodProposal) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

processing_method

Updating a non conformity processing method proposal processing method relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method proposal

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

processing_method object

Get the current processing method of the non conformity processing method proposal

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method proposal

Responses

Response Schema: application/json
object (NonConformityProcessingMethod)

Response samples

Content type
application/json
{
  • "data": {
    }
}

non_conformity_processing_method_settlements

Manage non conformity processing method settlement data

Get a list of non conformity processing method settlements

Get a list of non conformity processing method settlements

Authorizations:
OAuth2
query Parameters
include
string
Value: "processing_method"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
Array of objects (NonConformityProcessingMethodSettlement)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single non conformity processing method settlement

Get a single non conformity processing method settlement by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method settlement

query Parameters
include
string
Value: "processing_method"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (NonConformityProcessingMethodSettlement)

Response samples

Content type
application/json
{
  • "data": {
    }
}

non_conformity_processing_method_settlements relationships

Manage non conformity processing method settlement relations

processing_method

Get the current processing method relationship of the non conformity processing method settlement

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method settlement

query Parameters
include
string
Value: "processing_method"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (NonConformityProcessingMethodSettlementRelation)
Array of objects (NonConformityProcessingMethodSettlement) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

processing_method

Updating a non conformity processing method settlement processing method relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method settlement

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

processing_method object

Get the current processing method of the non conformity processing method settlement

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity processing method settlement

Responses

Response Schema: application/json
object (NonConformityProcessingMethod)

Response samples

Content type
application/json
{
  • "data": {
    }
}

problem_codes

Manage problem code data

Get a list of problem codes

Get a list of problem codes

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (ProblemCode)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single problem code

Get a single problem code by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the problem code

Responses

Response Schema: application/json
object (ProblemCode)

Response samples

Content type
application/json
{
  • "data": {
    }
}

complaint_rankings

Manage complaint ranking data

Get a list of complaint rankings

Get a list of complaint rankings

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (ComplaintRanking)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single complaint ranking

Get a single complaint ranking by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the complaint ranking

Responses

Response Schema: application/json
object (ComplaintRanking)

Response samples

Content type
application/json
{
  • "data": {
    }
}

customer_complaints

Manage customer complaints data

Get a list of customer complaints

Get a list of customer complaints

Authorizations:
OAuth2
query Parameters
include
string
Enum: "status" "created_by" "transport_transporter" "customer" "supplier" "executer" "product" "production_line" "problem_code" "complaint_ranking" "execution_type" "transport_type"

Customise which related resources should be returned. Include one or more from the given options comma separated

filter[complaint_date_from]
string <DateTime ATOM>

An ATOM formatted string describing the start time from when to look for complaints

filter[complaint_date_until]
string <DateTime ATOM>

An ATOM formatted string describing the end time until when to look for complaints

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (CustomerComplaint)
Array of CustomerComplaintStatus (object) or User (object) or Supplier (object) or Customer (object) or Product (object) or ProductionLine (object) or CustomerComplaintExecutionType (object) or CustomerComplaintTransportType (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single customer complaint

Get a single customer complaint by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Enum: "status" "created_by" "transport_transporter" "customer" "supplier" "executer" "product" "production_line" "problem_code" "complaint_ranking" "execution_type" "transport_type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (CustomerComplaint)
Array of CustomerComplaintStatus (object) or User (object) or Supplier (object) or Customer (object) or Product (object) or ProductionLine (object) or CustomerComplaintExecutionType (object) or CustomerComplaintTransportType (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

customer_complaints relationships

Manage customer complaints relations

status

Get the current status relationship of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Value: "status"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomerComplaintStatusRelation)
Array of objects (CustomerComplaintStatus) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

status

Updating a customer complaint status relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

status object

Get the current status of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response Schema: application/json
object (CustomerComplaintStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

created_by

Get the current created_by relationship of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Value: "created_by"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

created_by

Updating a customer complaint created_by relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

created_by object

Get the current created_by of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

transport_transporter

Get the current transport_transporter relationship of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Value: "transport_transporter"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (SupplierRelation)
Array of objects (Supplier) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

transport_transporter

Updating a customer complaint transport_transporter relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

transport_transporter object

Get the current transport_transporter of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response Schema: application/json
object (Supplier)

Response samples

Content type
application/json
{
  • "data": {
    }
}

customer

Get the current customer relationship of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Value: "customer"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomerRelation)
Array of objects (Customer) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

customer

Updating a customer complaint customer relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

customer object

Get the current customer of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response Schema: application/json
object (Customer)

Response samples

Content type
application/json
{
  • "data": {
    }
}

supplier

Get the current supplier relationship of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Value: "supplier"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (SupplierRelation)
Array of objects (Supplier) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

supplier

Updating a customer complaint supplier relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

supplier object

Get the current supplier of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response Schema: application/json
object (Supplier)

Response samples

Content type
application/json
{
  • "data": {
    }
}

executer

Get the current executer relationship of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Value: "executer"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

executer

Updating a customer complaint executer relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

executer object

Get the current executer of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product

Get the current product relationship of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Value: "product"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductRelation)
Array of objects (Product) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product

Updating a customer complaint product relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

product object

Get the current product of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response Schema: application/json
object (Product)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_line

Get the current production_line relationship of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Value: "production_line"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductionLineRelation)
Array of objects (ProductionLine) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

production_line

Updating a customer complaint production_line relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

production_line object

Get the current production_line of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response Schema: application/json
object (ProductionLine)

Response samples

Content type
application/json
{
  • "data": {
    }
}

problem_code

Get the current problem_code relationship of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Value: "problem_code"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProblemCodeRelation)
Array of objects (ProblemCode) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

problem_code

Updating a customer complaint problem_code relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

problem_code object

Get the current problem_code of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response Schema: application/json
object (ProblemCode)

Response samples

Content type
application/json
{
  • "data": {
    }
}

complaint_ranking

Get the current complaint_ranking relationship of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Value: "complaint_ranking"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ComplaintRankingRelation)
Array of objects (ComplaintRanking) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

complaint_ranking

Updating a customer complaint complaint_ranking relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

complaint_ranking object

Get the current complaint_ranking of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response Schema: application/json
object (ComplaintRanking)

Response samples

Content type
application/json
{
  • "data": {
    }
}

execution_type

Get the current execution_type relationship of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Value: "execution_type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomerComplaintExecutionTypeRelation)
Array of objects (CustomerComplaintExecutionType) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

execution_type

Updating a customer complaint execution_type relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

execution_type object

Get the current execution_type of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response Schema: application/json
object (CustomerComplaintExecutionType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

transport_type

Get the current transport_type relationship of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

query Parameters
include
string
Value: "transport_type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (CustomerComplaintTransportTypeRelation)
Array of objects (CustomerComplaintTransportType) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

transport_type

Updating a customer complaint transport_type relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

transport_type object

Get the current transport_type of the customer complaint

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint

Responses

Response Schema: application/json
object (CustomerComplaintTransportType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

lots

Manage lot data

Get a list of lots

Get a list of lots

Authorizations:
OAuth2
query Parameters
include
string
Enum: "product" "stock_distributions"

Customise which related resources should be returned. Include one or more from the given options comma separated

filter[has_stock]
integer
Enum: 0 1

A simple flag to limit the returned lots to those that have stock

filter[product_id]
integer

Can be used to show only lots of specific products. Use it as an array to filter on multiple products (filter[product_id][]=123)

filter[base_lot_reference]
string

Can be used to fetch all collis for the given base reference. For example: filter[base_lot_reference]=0000123 will return all lots that start with '0000123'

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (Lot)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single lot

Get a single lot by its id

Authorizations:
OAuth2
path Parameters
id
required
string

Id of the lot

query Parameters
include
string
Enum: "product" "stock_distributions"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Lot)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_orders

Manage production order data

Get a list of production orders

Get a list of production orders

Authorizations:
OAuth2
query Parameters
include
string
Enum: "status" "type" "product" "production_line" "components" "component_reports" "reports"

Customise which related resources should be returned. Include one or more from the given options comma separated

filter[production_date_from]
string <DateTime ATOM>

An ATOM formatted string describing the start time from when to look for production orders

filter[production_date_until]
string <DateTime ATOM>

An ATOM formatted string describing the end time until when to look for production orders

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductionOrder)
Array of ProductionOrderStatus (object) or ProductionOrderType (object) or Product (object) or ProductionLine (object) or ProductionOrderComponent (object) or ProductionOrderComponentReport (object) or ProductionOrderReport (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single production order

Get a single production order by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

query Parameters
include
string
Enum: "status" "type" "product" "production_line" "components" "component_reports" "reports"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductionOrder)
Array of ProductionOrderStatus (object) or ProductionOrderType (object) or Product (object) or ProductionLine (object) or ProductionOrderComponent (object) or ProductionOrderComponentReport (object) or ProductionOrderReport (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

production_orders relationships

Manage production orders relations

status

Get the current production_order_status relationship of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

query Parameters
include
string
Value: "production_order_status"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductionOrderStatusRelation)
Array of objects (ProductionOrderStatus) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

status

Updating a production order production_order_status relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

status object

Get the current production_order_status of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response Schema: application/json
object (ProductionOrderStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

type

Get the current production_order_type relationship of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

query Parameters
include
string
Value: "production_order_type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductionOrderTypeRelation)
Array of objects (ProductionOrderType) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

type

Updating a production order production_order_type relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

type object

Get the current production_order_type of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response Schema: application/json
object (ProductionOrderType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product

Get the current product relationship of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

query Parameters
include
string
Value: "product"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductRelation)
Array of objects (Product) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product

Updating a production order product relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

product object

Get the current product of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response Schema: application/json
object (Product)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_line

Get the current production_line relationship of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

query Parameters
include
string
Value: "production_line"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductionLineRelation)
Array of objects (ProductionLine) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

production_line

Updating a production order production_line relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

production_line object

Get the current production_line of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response Schema: application/json
object (ProductionLine)

Response samples

Content type
application/json
{
  • "data": {
    }
}

components

Get the current components relationship of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

query Parameters
include
string
Value: "components"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
Array of objects (ProductionOrderComponentRelation) unique
Array of objects (ProductionOrderComponent) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

components

Add components relations to the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

components

Update a production order components relation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

components

Delete components from a production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

components objects

Get the current components of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response Schema: application/json
Array of objects (ProductionOrderComponent) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

component_reports

Get the current component_reports relationship of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

query Parameters
include
string
Value: "component_reports"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
Array of objects (ProductionOrderComponentReportRelation) unique
Array of objects (ProductionOrderComponentReport) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

component_reports

Add component_reports relations to the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Request Body schema: application/json
required

This is an array of ProductionOrderComponentReportRelation objects.

Array of objects (ProductionOrderComponentReportRelation) unique

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

component_reports

Update a production order component_reports relation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

component_reports

Delete component_reports from a production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

component_reports objects

Get the current component_reports of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response Schema: application/json
Array of objects (ProductionOrderComponentReport) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

component_reports objects

Add component_reports to the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Request Body schema: application/json
required

This is an array of ProductionOrderComponentReport objects. The reports will be processed in the given order and individually.
This means that if the first report uses the same stock as a following report, the latter reports can fail if the stock is no longer sufficient but the first report went through successfully

Array of objects (ProductionOrderComponentReport) unique

Responses

Response Schema: application/json
Array of objects (ProductionOrderComponentReport) unique

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

reports

Get the current reports relationship of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

query Parameters
include
string
Value: "reports"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
Array of objects (ProductionOrderReportRelation) unique
Array of objects (ProductionOrderReport) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

reports

Add report relations to the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Request Body schema: application/json
required

This is an array of ProductionOrderReportRelation objects.

Array of objects (ProductionOrderReportRelation) unique

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

reports

Update a production order reports relation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

reports

Delete reports from a production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

reports objects

Get the current reports of the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Responses

Response Schema: application/json
Array of objects (ProductionOrderReport) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

reports objects

Add reports to the production order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order

Request Body schema: application/json
required

This is an array of ProductionOrderReport objects. The reports will be processed in the given order and individually.

Array of objects (ProductionOrderReport) unique

Responses

Response Schema: application/json
Array of objects (ProductionOrderReport) unique

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

production_order_components

Manage production order components data

Get a list of production order components

Get a list of production order components

Authorizations:
OAuth2
query Parameters
include
string
Enum: "product" "report_type" "origin_product"

Customise which related resources should be returned. Include one or more from the given options comma separated

filter[production_order_id]
integer

Can be used as a single value filter or as an array

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductionOrderComponent)
Array of Product (object) or ProductionReportType (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single production order component

Get a single production order component by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component

query Parameters
include
string
Enum: "product" "report_type" "origin_product"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductionOrderComponent)
Array of Product (object) or ProductionReportType (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

production_order_components relationships

Manage production order components relations

product

Get the current product relationship of the production order component

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component

query Parameters
include
string
Value: "product"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductRelation)
Array of objects (Product) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product

Updating a production order component product relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

product object

Get the current product of the production order component

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component

Responses

Response Schema: application/json
object (Product)

Response samples

Content type
application/json
{
  • "data": {
    }
}

report_type

Get the current report type relationship of the production order component

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component

query Parameters
include
string
Value: "report_type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductionReportTypeRelation)
Array of objects (ProductionReportType) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

report_type

Updating a production order component report type relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

report_type object

Get the current report type of the production order component

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component

Responses

Response Schema: application/json
object (ProductionReportType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

origin_product

Get the current origin product relationship of the production order component

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component

query Parameters
include
string
Value: "origin_product"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductRelation)
Array of objects (Product) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

origin_product

Updating a production order component origin product relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

origin_product object

Get the current origin product of the production order component

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component

Responses

Response Schema: application/json
object (Product)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_order_component_reports

Manage production order component reports data

Get a list of production order component reports

Get a list of production order component reports

Authorizations:
OAuth2
query Parameters
include
string
Enum: "lot" "report_type" "stock_location"

Customise which related resources should be returned. Include one or more from the given options comma separated

filter[production_order_id]
integer

Can be used as a single value filter or as an array

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductionOrderComponentReport)
Array of Lot (object) or ProductionReportType (object) or StockLocation (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single production order component report

Get a single production order component report by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component report

query Parameters
include
string
Enum: "lot" "report_type" "stock_location"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductionOrderComponentReport)
Array of Lot (object) or ProductionReportType (object) or StockLocation (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

production_order_component_reports relationships

Manage production order component reports relations

lot

Get the current lot relationship of the production order component report

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component report

query Parameters
include
string
Value: "lot"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (LotRelation)
Array of objects (Lot) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

lot

Updating a production order component report lot relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component report

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

lot object

Get the current lot of the production order component report

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component report

Responses

Response Schema: application/json
object (Lot)

Response samples

Content type
application/json
{
  • "data": {
    }
}

report_type

Get the current report type relationship of the production order component report

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component report

query Parameters
include
string
Value: "report_type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductionReportTypeRelation)
Array of objects (ProductionReportType) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

report_type

Updating a production order component report report type relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component report

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

report_type object

Get the current report type of the production order component report

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component report

Responses

Response Schema: application/json
object (ProductionReportType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

stock_location

Get the current stock location relationship of the production order component report

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component report

query Parameters
include
string
Value: "stock_location"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (StockLocationRelation)
Array of objects (StockLocation) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

stock_location

Updating a production order component report stock location relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component report

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

stock_location object

Get the current stock location of the production order component report

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order component report

Responses

Response Schema: application/json
object (StockLocation)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_order_reports

Manage production order reports data

Get a list of production order reports

Get a list of production order reports

Authorizations:
OAuth2
query Parameters
include
string
Enum: "lot_colli" "production_line" "stock_location"

Customise which related resources should be returned. Include one or more from the given options comma separated

filter[production_order_id]
integer

Can be used as a single value filter or as an array

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductionOrderReport)
Array of Lot (object) or ProductionLine (object) or StockLocation (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single production order report

Get a single production order report by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order report

query Parameters
include
string
Enum: "lot_colli" "production_line" "stock_location"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductionOrderReport)
Array of Lot (object) or ProductionLine (object) or StockLocation (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

production_order_reports relationships

Manage production order reports relations

lot_colli

Get the current lot_colli relationship of the production order report

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order report

query Parameters
include
string
Value: "lot_colli"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (LotRelation)
Array of objects (Lot) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

lot

Updating a production order report lot_colli relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order report

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

lot_colli object

Get the current lot_colli of the production order report

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order report

Responses

Response Schema: application/json
object (Lot)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_line

Get the current production line relationship of the production order report

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order report

query Parameters
include
string
Value: "production_line"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductionLineRelation)
Array of objects (ProductionLine) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

production_line

Updating a production order report production line relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order report

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

production_line object

Get the current production line of the production order report

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order report

Responses

Response Schema: application/json
object (ProductionLine)

Response samples

Content type
application/json
{
  • "data": {
    }
}

stock_location

Get the current stock location relationship of the production order report

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order report

query Parameters
include
string
Value: "stock_location"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (StockLocationRelation)
Array of objects (StockLocation) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

stock_location

Updating a production order report stock location relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order report

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

stock_location object

Get the current stock location of the production order report

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order report

Responses

Response Schema: application/json
object (StockLocation)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_lines

Manage production line data

Get a list of production lines

Get a list of production lines

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductionLine)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single production line

Get a single production line by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the stock location

Responses

Response Schema: application/json
object (ProductionLine)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_rush_orders

Manage production rush order data

Get a list of production rush orders

Get a list of production rush orders

Authorizations:
OAuth2
query Parameters
include
string
Enum: "product" "production_line" "production_orders"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductionRushOrder)
Array of Product (object) or ProductionLine (object) or ProductionOrder (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a production rush order

Add a production rush order. Depending on the product production batch size, this will create multiple production orders for the related product.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get a single production rush order

Get a single production rush order by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production rush order

query Parameters
include
string
Enum: "product" "production_line" "production_orders"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ProductionRushOrder)
Array of Product (object) or ProductionLine (object) or ProductionOrder (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

production_rush_orders relationships

Manage production rush orders relations

product

Get the product relationship of the production rush order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production rush order

query Parameters
include
string
Value: "product"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductRelation)
Array of objects (Product) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product

Updating a production rush order product relation is not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production rush order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

product object

Get the product of the production rush order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production rush order

Responses

Response Schema: application/json
object (Product)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_line

Get the production_line relationship of the production rush order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production rush order

query Parameters
include
string
Value: "production_line"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductionLineRelation)
Array of objects (ProductionLine) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

production_line

Updating a production rush order production_line relation is not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production rush order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

production_line object

Get the production_line of the production rush order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production rush order

Responses

Response Schema: application/json
object (ProductionLine)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_orders

Get the production_orders relationship of the production rush order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production rush order

query Parameters
include
string
Value: "production_orders"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
Array of objects (ProductionOrderRelation) unique
Array of objects (ProductionOrder) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

production_orders

Adding production orders to a rush order is not allowed

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production rush order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

production_orders

Updating production orders relations for a rush order is not allowed

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production rush order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

production_orders

Deleting production order relations in a rush order is not allowed

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production rush order

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

production_orders objects

Get the production_orders of the production rush order

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production rush order

Responses

Response Schema: application/json
Array of objects (ProductionOrder) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

employees

Manage employee data

Get a list of employees

Get a list of employees

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (Employee)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single employee

Get a single employee by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the employee

Responses

Response Schema: application/json
object (Employee)

Response samples

Content type
application/json
{
  • "data": {
    }
}

users

Manage user data

Get a list of users

Get a list of users

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (User)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single user

Get a single user by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the user

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

department_corporate_groups

Manage department corporate groups data

Get a list of department corporate groups

Get a list of department corporate groups

Authorizations:
OAuth2
query Parameters
filter[reference]
string

Only get the department corporate group that matches given reference

filter[is_active]
boolean

Only get the department corporate groups that match given filter

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (DepartmentCorporateGroup)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single department corporate group

Get a single department corporate group by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the department corporate group

Responses

Response Schema: application/json
object (DepartmentCorporateGroup)

Response samples

Content type
application/json
{
  • "data": {
    }
}

function_corporate_groups

Manage function corporate groups data

Get a list of function corporate groups

Get a list of function corporate groups

Authorizations:
OAuth2
query Parameters
filter[reference]
string

Only get the function corporate group that matches given reference

filter[active]
integer
Enum: 0 1

Only get the active or inactive functions

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (FunctionCorporateGroup)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single function corporate group

Get a single function corporate group by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the function corporate group

Responses

Response Schema: application/json
object (FunctionCorporateGroup)

Response samples

Content type
application/json
{
  • "data": {
    }
}

function_corporate_groups relationships

Manage function corporate groups relations

members

Get the current members relationship of the function corporate group

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the function corporate group

query Parameters
include
string
Value: "members"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
Array of objects (UserRelation) unique
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

members objects

Get the current members of the function corporate group

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the function corporate group

Responses

Response Schema: application/json
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

checklists

Manage checklists data

Get a list of checklists

Get a list of checklists

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

include
string
Enum: "status" "score_table" "executer" "production_order" "production_line" "department" "product" "elements" "executer_users" "executer_functions" "photo_quality_option"

Customise which related resources should be returned. Include one or more from the given options comma separated

filter[can_execute]
boolean

Only get checklists that the current user can execute. This filter does not need a value

filter[status]
string
Enum: "new" "uploaded" "completed"

Only get checklists that match given status. Multiple statusses can be given separated by comma

Responses

Response Schema: application/json
Array of objects (Checklist)
Array of ChecklistStatus (object) or ScoreTable (object) or User (object) or ProductionOrder (object) or ProductionLine (object) or DepartmentCorporateGroup (object) or Product (object) or ChecklistElement (object) or FunctionCorporateGroup (object) or ChecklistPhotoQualityOption (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single checklist

Get a single checklist by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

query Parameters
include
string
Enum: "status" "score_table" "executer" "production_order" "production_line" "department" "product" "elements" "executer_users" "executer_functions" "photo_quality_option"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Checklist)
Array of ChecklistStatus (object) or ScoreTable (object) or User (object) or ProductionOrder (object) or ProductionLine (object) or DepartmentCorporateGroup (object) or Product (object) or ChecklistElement (object) or FunctionCorporateGroup (object) or ChecklistPhotoQualityOption (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

checklists relationships

Manage checklists relations

status

Get the current status relationship of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

query Parameters
include
string
Value: "status"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ChecklistStatusRelation)
Array of objects (ChecklistStatus) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

status

Update the status of a checklist. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Request Body schema: application/json
required

Checklist status object identifier. This is a to-one relationship that cannot be removed.

object (ChecklistStatusRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

status object

Get the current status of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Responses

Response Schema: application/json
object (ChecklistStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

score table

Get the current score table relationship of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

query Parameters
include
string
Value: "score_table"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ScoreTableRelation)
Array of objects (ScoreTable) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

score table object

Get the current score table of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Responses

Response Schema: application/json
object (ScoreTable)

Response samples

Content type
application/json
{
  • "data": {
    }
}

executer

Get the current executer relationship of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

query Parameters
include
string
Value: "executer"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (UserRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

executer

Update the executer of a checklist. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Request Body schema: application/json
required

User object identifier. This is a to-one relationship that cannot be removed.

object (UserRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

executer object

Get the current executer of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production order

Get the current production order relationship of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

query Parameters
include
string
Value: "production_order"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductionOrderRelation)
Array of objects (ProductionOrder) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

production order object

Get the current production order of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Responses

Response Schema: application/json
object (ProductionOrder)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production line

Get the current production line relationship of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

query Parameters
include
string
Value: "production_line"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductionLineRelation)
Array of objects (ProductionLine) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

production line object

Get the current production line of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Responses

Response Schema: application/json
object (ProductionLine)

Response samples

Content type
application/json
{
  • "data": {
    }
}

department

Get the current department relationship of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

query Parameters
include
string
Value: "department"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (DepartmentCorporateGroupRelation)
Array of objects (DepartmentCorporateGroup) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

department object

Get the current department of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Responses

Response Schema: application/json
object (DepartmentCorporateGroup)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product

Get the current product relationship of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

query Parameters
include
string
Value: "product"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ProductRelation)
Array of objects (Product) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

product object

Get the current product of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Responses

Response Schema: application/json
object (Product)

Response samples

Content type
application/json
{
  • "data": {
    }
}

elements

Get the current elements relationship of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

query Parameters
include
string
Value: "elements"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
Array of objects (ChecklistElementRelation) unique
Array of objects (ChecklistElement) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

elements objects

Get the current elements of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Responses

Response Schema: application/json
Array of objects (ChecklistElement) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

executer_users

Get the current executer users relationship of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

query Parameters
include
string
Value: "executer_users"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
Array of objects (UserRelation) unique
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

executer user objects

Get the current executer users of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Responses

Response Schema: application/json
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

executer functions

Get the current executer functions relationship of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

query Parameters
include
string
Value: "executer_functions"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
Array of objects (FunctionCorporateGroupRelation) unique
Array of objects (FunctionCorporateGroup) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

executer function objects

Get the current executer functions of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Responses

Response Schema: application/json
Array of objects (FunctionCorporateGroup) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

photo quality option

Get the current photo quality option relationship of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

query Parameters
include
string
Value: "photo_quality_option"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ChecklistPhotoQualityOptionRelation)
Array of objects (ChecklistPhotoQualityOption) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

photo quality option

Update the photo quality option of a checklist. This is a to-one relationship that cannot be removed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Request Body schema: application/json
required

Checklist photo quality option object identifier. This is a to-one relationship that cannot be removed.

object (ChecklistPhotoQualityOptionRelation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

photo quality option object

Get the current photo quality option of the checklist

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist

Responses

Response Schema: application/json
object (ChecklistPhotoQualityOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

checklist_elements

Manage checklist elements data

Get a list of checklist elements

Get a list of checklist elements

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

include
string
Enum: "checklist_item" "checklist_element_answer"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
Array of objects (ChecklistElement)
Array of ChecklistItem (object) or ChecklistElementAnswer (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single checklist element

Get a single checklist element by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist element

query Parameters
include
string
Enum: "checklist_item" "checklist_element_answer"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ChecklistElement)
Array of ChecklistItem (object) or ChecklistElementAnswer (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

checklist_elements relationships

Manage checklist elements relations

checklist item

Get the current checklist item relationship of the checklist element

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist element

query Parameters
include
string
Value: "checklist_item"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ChecklistItemRelation)
Array of objects (ChecklistItem) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

checklist item object

Get the current checklist item of the checklist element

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist element

Responses

Response Schema: application/json
object (ChecklistItem)

Response samples

Content type
application/json
{
  • "data": {
    }
}

checklist element answer

Get the current checklist element answer relationship of the checklist element

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist element

query Parameters
include
string
Value: "checklist_element_answer"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ChecklistElementAnswerRelation)
Array of objects (ChecklistElementAnswer) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

checklist element answer object

Get the current checklist element answer of the checklist element

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist element

Responses

Response Schema: application/json
object (ChecklistElementAnswer)

Response samples

Content type
application/json
{
  • "data": {
    }
}

checklist element answer object

Link a new answer to a checklist element. The answer must be a non existing one and its id must be null

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist element

Request Body schema: application/json
required

Checklist element answer

object (ChecklistElementAnswer)

Responses

Response Schema: application/json
object (ChecklistElementAnswer)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

checklist_element_answers

Manage checklist element answers data

Get a list of checklist element answers

Get a list of checklist element answers

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

include
string
Value: "score"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
Array of objects (ChecklistElementAnswer)
Array of Score (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single checklist element answer

Get a single checklist element answer by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist element answer

query Parameters
include
string
Value: "score"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ChecklistElementAnswer)
Array of Score (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

checklist_element_answers relationships

Manage checklist element answers relations

score

Get the current score relationship of the checklist element answer

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist element answer

query Parameters
include
string
Value: "score"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ScoreRelation)
Array of objects (Score) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

score object

Get the current score of the checklist element answer

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist element answer

Responses

Response Schema: application/json
object (Score)

Response samples

Content type
application/json
{
  • "data": {
    }
}

checklist_items

Manage checklist items data

Get a list of checklist_items

Get a list of checklist_items

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

include
string
Value: "checklist_item_type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
Array of objects (ChecklistItem)
Array of ChecklistItemType (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single checklist item

Get a single checklist item by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist_item

query Parameters
include
string
Value: "checklist_item_type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ChecklistItem)
Array of ChecklistItemType (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

checklist_items relationships

Manage checklist items relations

checklist_item_type

Get the current checklist_item_type relationship of the checklist item

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist item

query Parameters
include
string
Value: "checklist_item_type"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ChecklistItemTypeRelation)
Array of objects (ChecklistItemType) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

checklist_item_type object

Get the current checklist_item_type of the checklist item

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist item

Responses

Response Schema: application/json
object (ChecklistItemType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

checklist_item_types

Manage checklist item types data

Get a list of checklist item types

Get a list of checklist item types

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (ChecklistItemType)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single checklist item type

Get a single checklist item type by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist item type

Responses

Response Schema: application/json
object (ChecklistItemType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

score_tables

Manage score tables data

Get a list of score tables

Get a list of score tables

Authorizations:
OAuth2
query Parameters
include
string
Value: "scores"

Customise which related resources should be returned. Include one or more from the given options comma separated

page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ScoreTable)
Array of objects (Score) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a score table

Add a score table

Authorizations:
OAuth2
Request Body schema: application/json
required

Score table to add

object (ScoreTable)

Responses

Response Schema: application/json
object (ScoreTable)
Array of objects (Score) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Get a single score table

Get a single score table by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the score table

query Parameters
include
string
Value: "scores"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (ScoreTable)
Array of objects (Score) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Update a score table

Update a score table. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the score table

Request Body schema: application/json
required

Score table properties to update

object (ScoreTable)

Responses

Response Schema: application/json
object (ScoreTable)
Array of objects (Score) unique

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Delete a score table

Delete a score table by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the score table

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

score_tables relationships

Manage score tables relations

scores

Get the current scores relationship of the score table

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the score table

query Parameters
include
string
Value: "scores"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
Array of objects (ScoreRelation) unique
Array of objects (Score) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

scores

Add a Score to a Score Table.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the score table

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

scores

Updating an score table's score relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the score table

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

scores

Deleting a score table's scores relation is currently not supported

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the score table

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

scores objects

Get the current scores of the score table

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the score table

Responses

Response Schema: application/json
Array of objects (Score) unique

Response samples

Content type
application/json
{
  • "data": [
    ]
}

scores objects

Link new scores to a score table. The scores must be non existing and their id must be null

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the score table

Request Body schema: application/json
required

Score objects

Array of objects (Score) unique

Responses

Response Schema: application/json
Array of objects (Score) unique

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

scores

Manage scores data

Get a list of scores

Get a list of scores

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (Score)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add a score

Add a score

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get a single score

Get a single score by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the score

Responses

Response Schema: application/json
object (Score)

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a score

Update a score. Only given properties will be updated

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the score

Request Body schema: application/json
required

Score properties to update

object (Score)

Responses

Response Schema: application/json
object (Score)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a score

Delete a score by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the score

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

observations

Manage observations data

Get a list of observations

Get a list of observations

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

include
string
Value: "observation_status"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
Array of objects (Observation)
Array of ObservationStatus (object) or User (object) unique
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Add an observation

Add an observation

Authorizations:
OAuth2
Request Body schema: application/json
required

Observation to add

object (Observation)

Responses

Response Schema: application/json
object (Observation)

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a single observation

Get a single observation by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the observation

query Parameters
include
string
Value: "observation_status"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Observation)
Array of ObservationStatus (object) or User (object) unique

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

observations relationships

Manage observations relations

status

Get the current status relationship of the observation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the observation

query Parameters
include
string
Value: "status"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ObservationStatusRelation)
Array of objects (ObservationStatus) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

status object

Get the current status of the observation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the observation

Responses

Response Schema: application/json
object (ObservationStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

created_by

Get the current created_by relationship of the observation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the observation

query Parameters
include
string
Value: "user"

Customise which related resources should be returned. Include one or more from the given options comma separated

Responses

Response Schema: application/json
object (Links)
object (ObservationCreatedByRelation)
Array of objects (User) unique

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": {
    },
  • "included": [
    ]
}

created_by user object

Get the current created_by user of the observation

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the observation

Responses

Response Schema: application/json
object (User)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_group_types

Manage product group type data

Get a list of product group types

Get a list of product group types

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ProductGroupType)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product group type

Get a single product group type by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product group type

Responses

Response Schema: application/json
object (ProductGroupType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

intervention_status

Manage intervention status data

Get a list of intervention status

Get a list of intervention status

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (InterventionStatus)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single intervention status

Get a single intervention status by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention status

Responses

Response Schema: application/json
object (InterventionStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

intervention_priorities

Manage intervention priorities data

Get a list of intervention priorities

Get a list of intervention priorities

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (InterventionPriority)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single intervention priority

Get a single intervention priority by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention priority

Responses

Response Schema: application/json
object (InterventionPriority)

Response samples

Content type
application/json
{
  • "data": {
    }
}

intervention_categories

Manage intervention categories data

Get a list of intervention categories

Get a list of intervention categories

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (InterventionCategory)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single intervention category

Get a single intervention category by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention category

Responses

Response Schema: application/json
object (InterventionCategory)

Response samples

Content type
application/json
{
  • "data": {
    }
}

machine_status

Manage machine status data

Get a list of machine status

Get a list of machine status

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (MachineStatus)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single machine status

Get a single machine status by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the machine status

Responses

Response Schema: application/json
object (MachineStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

intervention_action_status

Manage intervention action status data

Get a list of intervention action status

Get a list of intervention action status

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (InterventionActionStatus)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single intervention action status

Get a single intervention action status by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the intervention action status

Responses

Response Schema: application/json
object (InterventionActionStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

non_conformity_execution_types

Manage non conformity execution types data

Get a list of non conformity execution types

Get a list of non conformity execution types

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (NonConformityExecutionType)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single non conformity execution type

Get a single non conformity execution type by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity execution type

Responses

Response Schema: application/json
object (NonConformityExecutionType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

non_conformity_status

Manage non conformity status data

Get a list of non conformity status

Get a list of non conformity status

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (NonConformityStatus)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single non conformity status

Get a single non conformity status by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the non conformity status

Responses

Response Schema: application/json
object (NonConformityStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

customer_complaint_status

Manage customer complaint status data

Get a list of customer complaint status

Get a list of customer complaint status

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (CustomerComplaintStatus)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single customer complaint status

Get a single customer complaint status by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint status

Responses

Response Schema: application/json
object (CustomerComplaintStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

customer_complaint_execution_type

Manage customer complaint execution type data

Get a list of customer complaint execution type

Get a list of customer complaint execution type

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (CustomerComplaintExecutionType)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single customer complaint execution type

Get a single customer complaint execution type by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint execution type

Responses

Response Schema: application/json
object (CustomerComplaintExecutionType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

customer_complaint_transport_type

Manage customer complaint transport type data

Get a list of customer complaint transport type

Get a list of customer complaint transport type

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (CustomerComplaintTransportType)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single customer complaint transport type

Get a single customer complaint transport type by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the customer complaint transport type

Responses

Response Schema: application/json
object (CustomerComplaintTransportType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_order_status

Manage production order status data

Get a list of production order status

Get a list of production order status

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (ProductionOrderStatus)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single production order status

Get a single production order status by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order status

Responses

Response Schema: application/json
object (ProductionOrderStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_order_types

Manage production order type data

Get a list of production order types

Get a list of production order types

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (ProductionOrderType)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single production order types

Get a single production order types by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production order type

Responses

Response Schema: application/json
object (ProductionOrderType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

production_report_types

Manage production report type data

Get a list of production report types

Get a list of production report types

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (ProductionReportType)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single production report types

Get a single production report types by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the production report type

Responses

Response Schema: application/json
object (ProductionOrderType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

languages

Manage language data

Get a list of languages

Get a list of languages

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (I18nLanguage)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single language

Get a single language by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the language

Responses

Response Schema: application/json
object (I18nLanguage)

Response samples

Content type
application/json
{
  • "data": {
    }
}

currencies

Manage currency data

Get a list of currencies

Get a list of currencies

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (Currency)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single currency

Get a single currency by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the currency

Responses

Response Schema: application/json
object (Currency)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_structure_item_types

Manage all of your product structure item type data

Get a list of product structure item types

Get a list of product structure item types

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (ProductStructureItemType)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product structure item type

Get a single product structure item types by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item type

Responses

Response Schema: application/json
object (ProductStructureItemType)

Response samples

Content type
application/json
{
  • "data": {
    }
}

product_structure_item_calculation_methods

Manage all of your product structure item calculation method data

Get a list of product structure item calculation methods

Get a list of product structure item calculation methods

Authorizations:
OAuth2

Responses

Response Schema: application/json
Array of objects (ProductStructureItemCalculationMethod)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single product structure item calculation methods

Get a single product structure item calculation methods by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the product structure item calculation method

Responses

Response Schema: application/json
object (ProductStructureItemCalculationMethod)

Response samples

Content type
application/json
{
  • "data": {
    }
}

checklist_status

Manage checklist status data

Get a list of checklist status

Get a list of checklist status

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ChecklistStatus)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single checklist status

Get a single checklist status by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist status

Responses

Response Schema: application/json
object (ChecklistStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

observation_status

Get a list of observation status

Get a list of observation status

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ObservationStatus)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single observation status

Get a single observation status by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the observation status

Responses

Response Schema: application/json
object (ObservationStatus)

Response samples

Content type
application/json
{
  • "data": {
    }
}

checklist_photo_quality_option

Manage checklist photo quality option data

Get a list of checklist photo quality options

Get a list of checklist photo quality options

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (ChecklistPhotoQualityOption)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single checklist photo quality option

Get a single checklist photo quality option by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the checklist photo quality option

Responses

Response Schema: application/json
object (ChecklistPhotoQualityOption)

Response samples

Content type
application/json
{
  • "data": {
    }
}

nutrients

Manage nutrients data

Get a list of nutrients

Get a list of nutrients

Authorizations:
OAuth2
query Parameters
page
integer >= 1

The page of the result set. When not specified the first page will be returned

per_page
integer [ 1 .. 50 ]

The number of objects per page of the result set

Responses

Response Schema: application/json
Array of objects (Nutrient)
object (MetaCollection)
object (LinksCollection)

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Get a single nutrient

Get a single nutrient by its id

Authorizations:
OAuth2
path Parameters
id
required
integer

Id of the nutrient

Responses

Response Schema: application/json
object (Nutrient)

Response samples

Content type
application/json
{
  • "data": {
    }
}